这才是企业级的oss-spring-boot-starter

标题	地址
记载Minio Docker布置	/post/720661…
Minio控制台详细教程	/post/720697…
SpringBoot集成Minio	/post/720911…
企业级的oss-spring-boot-stater	本文

本文主要解说企业级OSS目标存储服务Spring Boot Starter制造，开箱即用，为项目进行赋能。依据AmazonS3协议，适配市面上的目标存储服务如：阿里云OSS、腾讯COS、七牛云OSS、MInio等等

什么是OSS?

OSS（Object Storage Service），目标存储服务，目标存储服务是一种运用HTTP API存储和检索目标的东西。便是将体系所要用的文件上传到云硬盘上，该云硬盘供给了文件下载、上传、预览等一系列服务，具有版别，权限控制能力，具有数据生命周期管理能力这样的服务以及技能能够统称为OSS

OSS在项目中的运用

OSS目标存储在现在大部分项目中必不可少的存在，如下图所示。

1. 一般项目运用OSS目标存储服务，主要是对图片、文件、音频等目标集中式管理权限控制，管理数据生命周期等等，供给上传，下载，预览，删除等功能。
2. 经过OSS布置前端项目。

什么是AmazonS3

docs.aws.amazon.com/zh_cn/Amazo…

Amazon Simple Storage Service（Amazon S3，Amazon简洁存储服务）是 AWS 最早推出的云服务之一，经过多年的发展，S3 协议在目标存储职业事实上现已成为标准。

1. 供给了一致的接口 REST/SOAP 来一致拜访任何数据
2. 对 S3 来说，存在里边的数据便是目标名（键），和数据（值）
3. 不定量，单个文件最高可达 5TB，可动态扩容。
4. 高速。每个 bucket 下每秒可达 3500 PUT/COPY/POST/DELETE 或 5500 GET/HEAD 请求。
5. 具有版别，权限控制能力
6. 具有数据生命周期管理能力

作为一个目标存储服务，S3 功能真的很完备，职业的标杆，现在市面上大部分OSS目标存储服务都支撑AmazonS3，本文主要解说的便是依据AmazonS3完成咱们自己的 Spring Boot Starter。

阿里云OSS兼容S3

七牛云目标存储兼容S3

腾讯云COS兼容S3

Minio兼容S3

咱们为什么要依据AmazonS3完成 Spring Boot Starter

原因：市面上OSS目标存储服务根本都支撑AmazonS3，咱们封装咱们的自己的starter那么就必须考虑适配，搬迁，可扩展。比喻说咱们今天运用的是阿里云OSS对接阿里云OSS的SDK，后天咱们运用的是腾讯COS对接是腾讯云COS，咱们何不直接对接AmazonS3完成呢，这样后续不需求调整代码，只需求去各个云服务商装备就好了。

创立一个SpringBoot项目

如下图所示：创立一个SpringBoot项目。

咱们取名为oss-spring-boot-starter。

如下图所示，创立成功，让咱们进入制造的进程吧。

找到咱们需求的依靠

打开maven库房，搜索minio

地址【mvnrepository.com/】

这儿咱们挑选第一个，点进去后咱们挑选1.12.423版别，做演示。

<!-- https://mvnrepository.com/artifact/com.amazonaws/aws-java-sdk-s3 -->
<dependency>
    <groupId>com.amazonaws</groupId>
    <artifactId>aws-java-sdk-s3</artifactId>
    <version>1.12.423</version>
</dependency>

本项意图Pom文件

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.7.9</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.qing</groupId>
    <artifactId>oss-spring-boot-starter</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>oss-spring-boot-starter</name>
    <description>Demo oss-spring-boot-starter</description>
    <properties>
        <java.version>1.8</java.version>
        <aws.version>1.12.423</aws.version>
        <hutool.version>5.8.5</hutool.version>
    </properties>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>
        <!-- https://mvnrepository.com/artifact/com.amazonaws/aws-java-sdk-s3 -->
        <dependency>
            <groupId>com.amazonaws</groupId>
            <artifactId>aws-java-sdk-s3</artifactId>
            <version>${aws.version}</version>
        </dependency>
        <dependency>
            <groupId>cn.hutool</groupId>
            <artifactId>hutool-core</artifactId>
            <version>${hutool.version}</version>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>RELEASE</version>
            <scope>compile</scope>
        </dependency>
    </dependencies>
</project>

编写OssProperties

代码如下，注释写的十分清楚了。 @ConfigurationProperties报红不用管后门会处理。

@Data：注解是lombok，生成get set办法的。

@ConfigurationProperties(prefix = “oss”)：将装备文件中oss开头的属性绑定到此目标中

大约便是假如想要运用咱们的jar他的装备文件有这些装备

oss.endpoint=xxx
oss.accessKey=xxx
oss.secretKey=xxx

/**
 * @Author JiaQIng
 * @Description Oss装备类
 * @ClassName OssProperties
 * @Date 2023/3/18 17:51
 **/
@Data
@ConfigurationProperties(prefix = "oss")
public class OssProperties {
    /**
     * 目标存储服务的URL
     */
    private String endpoint;
    /**
     * 区域
     */
    private String region;
    /**
     * true path-style nginx 反向代理和S3默许支撑 pathStyle形式 {http://endpoint/bucketname}
     * false supports virtual-hosted-style 阿里云等需求装备为 virtual-hosted-style 形式{http://bucketname.endpoint}
     * 仅仅url的显示不一样
     */
    private Boolean pathStyleAccess = true;
    /**
     * Access key
     */
    private String accessKey;
    /**
     * Secret key
     */
    private String secretKey;
    /**
     * 最大线程数，默许： 100
     */
    private Integer maxConnections = 100;
}

创立一个接口OssTemplate

OssTemplate：oss模板接口，此接口主要是对oss操作的办法的一个接口，界说为接口主要是满足可扩展准则，便是其他人运用了咱们的jar包，完成此接口能够自界说相关操作。

如下面所示代码：界说了一些对oss操作的办法。

/**
 * @Author JiaQIng
 * @Description oss操作模板
 * @ClassName OssTemplate
 * @Date 2023/3/18 18:15
 **/
public interface OssTemplate {
    /**
     * 创立bucket
     * @param bucketName bucket称号
     */
    void createBucket(String bucketName);
    /**
     * 获取一切的bucket
     * @return
     */
    List<Bucket> getAllBuckets();
    /**
     * 经过bucket称号删除bucket
     * @param bucketName
     */
    void removeBucket(String bucketName);
    /**
     * 上传文件
     * @param bucketName bucket称号
     * @param objectName 文件称号
     * @param stream 文件流
     * @param contextType 文件类型
     * @throws Exception
     */
    void putObject(String bucketName, String objectName, InputStream stream, String contextType) throws Exception;
    /**
     * 上传文件
     * @param bucketName bucket称号
     * @param objectName 文件称号
     * @param stream 文件流
     * @throws Exception
     */
    void putObject(String bucketName, String objectName, InputStream stream) throws Exception;
    /**
     * 获取文件
     * @param bucketName bucket称号
     * @param objectName 文件称号
     * @return S3Object
     */
    S3Object getObject(String bucketName, String objectName);
    /**
     * 获取目标的url
     * @param bucketName
     * @param objectName
     * @param expires
     * @return
     */
    String getObjectURL(String bucketName, String objectName, Integer expires);
    /**
     * 经过bucketName和objectName删除目标
     * @param bucketName
     * @param objectName
     * @throws Exception
     */
    void removeObject(String bucketName, String objectName) throws Exception;
    /**
     * 依据文件前置查询文件
     * @param bucketName bucket称号
     * @param prefix 前缀
     * @param recursive 是否递归查询
     * @return S3ObjectSummary 列表
     */
    List<S3ObjectSummary> getAllObjectsByPrefix(String bucketName, String prefix, boolean recursive);
}

创立OssTemplate的完成类

如下图所示：完成OssTemplate里边的办法，调用AmazonS3JavaSDK的办法完成。

AmazonS3供给了许多的办法，这儿就不写全部的了，公司要用到那些就写那些吧，后续扩展就行。

AmazonS3接口地址如下

docs.aws.amazon.com/AmazonS3/la…

此类解说：便是完成OssTemplate接口，引进AmazonS3客户端调用对应的接口。

运用的注解解说：

@RequiredArgsConstructor：lomnok的注解，代替@Autowired。

@SneakyThrows：lomnok的注解，抛出反常。

/**
 * @Author JiaQIng
 * @Description OssTemplate的完成类
 * @ClassName OssTemplateImpl
 * @Date 2023/3/18 19:02
 **/
@RequiredArgsConstructor
public class OssTemplateImpl implements OssTemplate {
    private final AmazonS3 amazonS3;
    /**
     * 创立Bucket
     * AmazonS3：https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html
     * @param bucketName bucket称号
     */
    @Override
    @SneakyThrows
    public void createBucket(String bucketName) {
        if ( !amazonS3.doesBucketExistV2(bucketName) ) {
            amazonS3.createBucket((bucketName));
        }
    }
    /**
     * 获取一切的buckets
     * AmazonS3：https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBuckets.html
     * @return
     */
    @Override
    @SneakyThrows
    public List<Bucket> getAllBuckets() {
        return amazonS3.listBuckets();
    }
    /**
     * 经过Bucket称号删除Bucket
     * AmazonS3：https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html
     * @param bucketName
     */
    @Override
    @SneakyThrows
    public void removeBucket(String bucketName) {
        amazonS3.deleteBucket(bucketName);
    }
    /**
     * 上传目标
     * @param bucketName bucket称号
     * @param objectName 文件称号
     * @param stream 文件流
     * @param contextType 文件类型
     * AmazonS3：https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html
     */
    @Override
    @SneakyThrows
    public void putObject(String bucketName, String objectName, InputStream stream, String contextType) {
        putObject(bucketName, objectName, stream, stream.available(), contextType);
    }
    /**
     * 上传目标
     * @param bucketName bucket称号
     * @param objectName 文件称号
     * @param stream 文件流
     * AmazonS3：https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html
     */
    @Override
    @SneakyThrows
    public void putObject(String bucketName, String objectName, InputStream stream) {
        putObject(bucketName, objectName, stream, stream.available(), "application/octet-stream");
    }
    /**
     * 经过bucketName和objectName获取目标
     * @param bucketName bucket称号
     * @param objectName 文件称号
     * @return
     * AmazonS3：https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html
     */
    @Override
    @SneakyThrows
    public S3Object getObject(String bucketName, String objectName) {
        return amazonS3.getObject(bucketName, objectName);
    }
    /**
     * 获取目标的url
     * @param bucketName
     * @param objectName
     * @param expires
     * @return
     * AmazonS3：https://docs.aws.amazon.com/AmazonS3/latest/API/API_GeneratePresignedUrl.html
     */
    @Override
    @SneakyThrows
    public String getObjectURL(String bucketName, String objectName, Integer expires) {
        Date date = new Date();
        Calendar calendar = new GregorianCalendar();
        calendar.setTime(date);
        calendar.add(Calendar.DAY_OF_MONTH, expires);
        URL url = amazonS3.generatePresignedUrl(bucketName, objectName, calendar.getTime());
        return url.toString();
    }
    /**
     * 经过bucketName和objectName删除目标
     * @param bucketName
     * @param objectName
     * AmazonS3：https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html
     */
    @Override
    @SneakyThrows
    public void removeObject(String bucketName, String objectName) {
        amazonS3.deleteObject(bucketName, objectName);
    }
    /**
     * 依据bucketName和prefix获取目标集合
     * @param bucketName bucket称号
     * @param prefix 前缀
     * @param recursive 是否递归查询
     * @return
     * AmazonS3：https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjects.html
     */
    @Override
    @SneakyThrows
    public List<S3ObjectSummary> getAllObjectsByPrefix(String bucketName, String prefix, boolean recursive) {
        ObjectListing objectListing = amazonS3.listObjects(bucketName, prefix);
        return objectListing.getObjectSummaries();
    }
    /**
     *
     * @param bucketName
     * @param objectName
     * @param stream
     * @param size
     * @param contextType
     * @return
     */
    @SneakyThrows
    private PutObjectResult putObject(String bucketName, String objectName, InputStream stream, long size,
                                     String contextType)  {
        byte[] bytes = IOUtils.toByteArray(stream);
        ObjectMetadata objectMetadata = new ObjectMetadata();
        objectMetadata.setContentLength(size);
        objectMetadata.setContentType(contextType);
        ByteArrayInputStream byteArrayInputStream = new ByteArrayInputStream(bytes);
        // 上传
        return amazonS3.putObject(bucketName, objectName, byteArrayInputStream, objectMetadata);
    }
}

创立OssAutoConfiguration

OssAutoConfiguration：主动安装装备类，主动安装的bean有AmazonS3和OssTemplate

所运用的注解：

@RequiredArgsConstructor：lomnok的注解，代替@Autowired。

@EnableConfigurationProperties(OssProperties.class)：主动安装咱们的装备类

@Bean：声明式bean。

@ConditionalOnMissingBean：修饰bean的一个注解，当你的bean被注册之后，注册相同类型的bean，就不会成功，它会保证你的bean只要一个，即你的实例只要一个。多个会报错。

@ConditionalOnBean(AmazonS3.class)：当给定的在bean存在时,则实例化当前Bean。

/**
 * @Author JiaQIng
 * @Description oss装备bean
 * @ClassName OssAConfiguration
 * @Date 2023/3/18 18:23
 **/
@Configuration
@RequiredArgsConstructor
@EnableConfigurationProperties(OssProperties.class)
public class OssAutoConfiguration {
    @Bean
    @ConditionalOnMissingBean
    public AmazonS3 ossClient(OssProperties ossProperties) {
        // 客户端装备，主要是大局的装备信息
        ClientConfiguration clientConfiguration = new ClientConfiguration();
        clientConfiguration.setMaxConnections(ossProperties.getMaxConnections());
        // url以及region装备
        AwsClientBuilder.EndpointConfiguration endpointConfiguration = new AwsClientBuilder.EndpointConfiguration(
                ossProperties.getEndpoint(), ossProperties.getRegion());
        // 凭证装备
        AWSCredentials awsCredentials = new BasicAWSCredentials(ossProperties.getAccessKey(),
                ossProperties.getSecretKey());
        AWSCredentialsProvider awsCredentialsProvider = new AWSStaticCredentialsProvider(awsCredentials);
        // build amazonS3Client客户端
        return AmazonS3Client.builder().withEndpointConfiguration(endpointConfiguration)
                .withClientConfiguration(clientConfiguration).withCredentials(awsCredentialsProvider)
                .disableChunkedEncoding().withPathStyleAccessEnabled(ossProperties.getPathStyleAccess()).build();
    }
    @Bean
    @ConditionalOnBean(AmazonS3.class)
    public OssTemplate ossTemplate(AmazonS3 amazonS3){
        return new OssTemplateImpl(amazonS3);
    }
}

ClientConfiguration目标

客户端装备，主要是大局的装备信息

看下图，有许多的装备，有的指定了默许值有的没有，能够到AmazonS3的官方文档熟悉相关装备，装备你所需求指定的装备信息等。

只要你真正的理解那些装备的效果才干避免线上的bug。 有兴趣的同学能够看一下。

创立咱们的spring.factories

在resources目录下新增META-INF包，下面新建spring.factories文件。

这种形式也是”约好大于装备”的体现。读过spring-boot源码的同学应该知道，这儿就不给咱们解说了。

如下图所示：

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
  com.qing.oss.OssAutoConfiguration

履行install打包到咱们的本地库房

把springboot工程的启动类，装备文件干掉，干掉Test包。

最重要的是干掉pom文件的spring-boot-maven-plugin，要不然install报错。

<build>
    <plugins>
        <plugin>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-maven-plugin</artifactId>
        </plugin>
    </plugins>
</build>

这样咱们的一个oss-spring-boot-starter就完成了。

履行install打包成jar到咱们的本地库房。

到咱们的本地库房就能看到咱们的oss-spring-boot-starter

测验

创立一个spring-boot工程当作咱们的测验工程

这儿就不演示怎么创立项目了。直接看下图吧

pom文件新增咱们的oss-spring-boot-starter依靠

新增版别大局装备

    <properties>
        <oss.version>0.0.1-SNAPSHOT</oss.version>
    </properties>

新增oss-spring-boot-starter依靠

        <dependency>
            <groupId>com.qing</groupId>
            <artifactId>oss-spring-boot-starter</artifactId>
            <version>${oss.version}</version>
        </dependency>

改写maven后能够看到咱们依靠加进来了。

处理打包没有注释的问题

能够发现咱们的依靠没有注释没有Javadoc注释。

在咱们的oss-string-boot-starter的pom文件下加入下面插件，重新install一下就好了。

    <build>
        <plugins>
            <!-- 在打好的jar包中保存javadoc注释,实际会另外生成一个xxxxx-sources.jar -->
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-source-plugin</artifactId>
                <executions>
                    <execution>
                        <id>attach-sources</id>
                        <goals>
                            <goal>jar</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>

在咱们的测验项目里边改写一下maven能够看到现已带注释了。

装备文件添加oss-spring-boot-starter所需求的装备

这儿填写你的阿里云，腾讯cos,七牛云，minio等等的装备。

下面我给咱们演示的是Minio

oss.endpoint=xxx
oss.accessKey=xxx
oss.secretKey=xxx

编写测验办法

如下图所示，编写测验办法，履行测验办法成功。

@SpringBootTest
class TestOssSpringBpptStarterApplicationTests {
    @Autowired
    private OssTemplate ossTemplate;
    @Test
    void contextLoads() {
        ossTemplate.createBucket("oss02");
    }
}

到我的Minio中查看发现测验成功。

跋文

本文主要解说企业级OSS目标存储服务Spring Boot Starter制造，开箱即用，为项目进行赋能。依据AmazonS3协议，适配市面上的大部分目标存储服务如：阿里云OSS、腾讯COS、七牛云OSS、MInio等等

怎么制造spring-boot-starter，看这篇就够了。

怎么制造oss-spring-boot-starter，看这篇就够了。

源码：github.com/hujiaqing78…

希望您能给个三连，这对我很重要，您的支撑是我创作的动力。