自定义Starter（阿里云oss）

实现步骤：
- 第1步：创建自定义starter模块 **aliyun-oss-spring-boot-starter**（进行依赖管理）
  - 把阿里云OSS所有的依赖统一管理起来
- 第2步：创建autoconfigure模块 **aliyun-oss-spring-boot-autoconfigure**
  - 在starter中引入autoconfigure （我们使用时只需要引入starter起步依赖即可）
- 第3步：在autoconfigure模块**aliyun-oss-spring-boot-autoconfigure**中完成自动配置
  1. 定义一个自动配置类，在自动配置类中将所要配置的bean都提前配置好
  2. 定义配置文件，把自动配置类的全类名定义在配置文件(**META-INF/spring/xxxx.imports**)中
第一步：创建自定义starter模块
创建完starter模块后，删除多余的文件，只保留一个pom.xml文件。最终保留内容如下：

![img1][1]

pom.xml  --starter

<?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>3.2.8</version>
            <relativePath/> 
        </parent>
    
        <groupId>com.aliyun.oss</groupId>
        <artifactId>aliyun-oss-spring-boot-starter</artifactId>
        <version>1.0-SNAPSHOT</version>
    
        <properties>
            <java.version>17</java.version>
        </properties>
    
        <dependencies>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter</artifactId>
            </dependency>
        </dependencies>
    
    </project>

第二步：创建autoconfigure模块

创建完starter模块后，删除多余的文件，只保留 src 和 pom.xml 。最终保留内容如下：

![img2][2]

pom.xml--autoconfigure

<?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>3.2.8</version>
            <relativePath/> 
        </parent>
    
        <groupId>com.aliyun.oss</groupId>
        <artifactId>aliyun-oss-spring-boot-autoconfigure</artifactId>
        <version>1.0-SNAPSHOT</version>
    
        <properties>
            <java.version>17</java.version>
        </properties>
    
        <dependencies>
        
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter</artifactId>
            </dependency>
        </dependencies>
    
    </project>

在starter的pom.xml文件中加入autoconfigure模块依赖

<dependency>
        <groupId>com.aliyun.oss</groupId>
        <artifactId>aliyun-oss-spring-boot-autoconfigure</artifactId>
        <version>1.0-SNAPSHOT</version>
    </dependency>

第三步：在autoconfigure完成自动配置
准备工作：
使用的阿里云OSS部分的代码直接拷贝到autoconfigure模块下，然后进行改造

AliyunOSSOperator：

public class AliyunOSSOperator {
    
        private AliyunOSSProperties aliyunOSSProperties;
    
        public AliyunOSSOperator(AliyunOSSProperties aliyunOSSProperties) {
            this.aliyunOSSProperties = aliyunOSSProperties;
        }
    
        public String upload(byte[] content, String originalFilename) throws Exception {
            String endpoint=aliyunOSSProperties.getEndpoint();
            String bucketName=aliyunOSSProperties.getBucketName();
            // 从环境变量中获取访问凭证。运行本代码示例之前，请确保已设置环境变量OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。
            EnvironmentVariableCredentialsProvider credentialsProvider = CredentialsProviderFactory.newEnvironmentVariableCredentialsProvider();
    
            // 填写Object完整路径，例如202406/1.png。Object完整路径中不能包含Bucket名称。
            //获取当前系统日期的字符串,格式为 yyyy/MM
            String dir = LocalDate.now().format(DateTimeFormatter.ofPattern("yyyy/MM"));
            //根据原始文件名originalFilename, 生成一个新的不重复的文件名
            String newFileName = UUID.randomUUID().toString() + originalFilename.substring(originalFilename.lastIndexOf("."));
            String objectName = dir + "/" + newFileName;
    
            // 创建OSSClient实例。
            OSS ossClient = new OSSClientBuilder().build(endpoint, credentialsProvider);
    
            //文件上传
            try {
                ossClient.putObject(bucketName, objectName, new ByteArrayInputStream(content));
            } finally {
                if (ossClient != null) {
                    ossClient.shutdown();
                }
            }
    
            return endpoint.split("//")[0] + "//" + bucketName + "." + endpoint.split("//")[1] + "/" + objectName;
        }
    
    }

AliyunOSSProperties：

@Data
    
    @ConfigurationProperties(prefix = "aliyun.oss")
    public class AliyunOSSProperties {
        private String endpoint;
        private String bucketName;
    }

![img3][3]

拷贝过来后，还缺失一些相关的依赖，需要把相关依赖也拷贝过来：

<dependency>
        <groupId>org.projectlombok</groupId>
        <artifactId>lombok</artifactId>
    </dependency>
    
    
    <dependency>
        <groupId>com.aliyun.oss</groupId>
        <artifactId>aliyun-sdk-oss</artifactId>
        <version>3.17.4</version>
    </dependency>
    <dependency>
        <groupId>javax.xml.bind</groupId>
        <artifactId>jaxb-api</artifactId>
        <version>2.3.1</version>
    </dependency>
    <dependency>
        <groupId>javax.activation</groupId>
        <artifactId>activation</artifactId>
        <version>1.1.1</version>
    </dependency>
    
    <dependency>
        <groupId>org.glassfish.jaxb</groupId>
        <artifactId>jaxb-runtime</artifactId>
        <version>2.3.3</version>
    </dependency>

不能用 @Component 注解声明bean，那就需要按照 starter 的定义规范，定义一个自动配置类，在自动配置类中声明bean。

定义一个自动配置类 AliOSSAutoConfiguration 了，在自动配置类当中来声明 AliOSSOperator 的bean对象。

AliyunOSSAutoConfiguration ：

@Configuration
    @EnableConfigurationProperties(AliyunOSSProperties.class)
    public class AliyunOSSAutoConfiguration {
        
        @Bean
        public AliyunOSSOperator aliyunOSSOperator(AliyunOSSProperties aliyunOSSProperties) {
            return new AliyunOSSOperator(aliyunOSSProperties);
        }
        
    }

AliyunOSSOperator 的代码中需要增加一个有参构造，将 AliyunOSSProperties 对象传递给工具类。代码改造如下：

![img4][4]

!!!
<font color="#a416af">在 aliyun-oss-spring-boot-autoconfigure 模块中的resources下，新建自动配置文件 METAINF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports</font>
!!!
将自动配置类的全类名，配置在文件中，这样在springboot启动的时候，就会加载到这份文件，并加载到其中的配置类了。

配置内容如下：

com.aliyun.oss.AliyunOSSAutoConfiguration
![img5][5]

到此呢，这个 aliyun-oss-spring-boot-stater 就定义好了，哪里要想使用，就可以直接导入依赖，直接注入使用了。

**打包：**
不同包下的项目也可以使用，通过依赖导入

![打包][6]

**测试：**
1). 在导入的test工程中引入阿里云starter依赖

<dependency>
        <groupId>com.aliyun.oss</groupId>
        <artifactId>aliyun-oss-spring-boot-starter</artifactId>
        <version>1.0-SNAPSHOT</version>
    </dependency>

2). 在工程中的 application.yml 中配置阿里云OSS的配置信息

#阿里oss
    aliyun:
      oss:
        endpoint: https://oss-cn-shenzhen.aliyuncs.com
        bucketName: possible7

3). 在test工程中的 UploadController 类编写代码

package com.itheima.controller;
    
    import com.aliyun.oss.AliyunOSSOperator;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.web.bind.annotation.PostMapping;
    import org.springframework.web.bind.annotation.RestController;
    import org.springframework.web.multipart.MultipartFile;
    
    @RestController
    public class UploadController {
        
        @Autowired
        private AliyunOSSOperator aliyunOSSOperator;
        
        @PostMapping("/upload")
        public String upload(MultipartFile image) throws Exception {
            //上传文件到阿里云 OSS
            String url = aliyunOSSOperator.upload(image.getBytes(), image.getOriginalFilename());
            return url;
        }
        
    }

[1]: https://possible.vip/blog/typecho/2025/09/2025-09-04T09:20:47.png
  [2]: https://possible.vip/blog/typecho/2025/09/2025-09-04T09:21:49.png
  [3]: https://possible.vip/blog/typecho/2025/09/2025-09-04T09:24:09.png
  [4]: https://possible.vip/blog/typecho/2025/09/2025-09-04T09:27:01.png
  [5]: https://possible.vip/blog/typecho/2025/09/2025-09-04T09:29:29.png
  [6]: https://possible.vip/blog/typecho/2025/09/2025-09-04T09:30:04.png

实现步骤：

第1步：创建自定义starter模块 aliyun-oss-spring-boot-starter（进行依赖管理）
- 把阿里云OSS所有的依赖统一管理起来
第2步：创建autoconfigure模块 aliyun-oss-spring-boot-autoconfigure
- 在starter中引入autoconfigure （我们使用时只需要引入starter起步依赖即可）
第3步：在autoconfigure模块aliyun-oss-spring-boot-autoconfigure中完成自动配置
1. 定义一个自动配置类，在自动配置类中将所要配置的bean都提前配置好
2. 定义配置文件，把自动配置类的全类名定义在配置文件(META-INF/spring/xxxx.imports)中
  第一步：创建自定义starter模块
  创建完starter模块后，删除多余的文件，只保留一个pom.xml文件。最终保留内容如下：

pom.xml --starter

<?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>3.2.8</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>

    <groupId>com.aliyun.oss</groupId>
    <artifactId>aliyun-oss-spring-boot-starter</artifactId>
    <version>1.0-SNAPSHOT</version>

    <properties>
        <java.version>17</java.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>
    </dependencies>

</project>

第二步：创建autoconfigure模块

创建完starter模块后，删除多余的文件，只保留 src 和 pom.xml 。最终保留内容如下：

pom.xml--autoconfigure

<?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>3.2.8</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>

    <groupId>com.aliyun.oss</groupId>
    <artifactId>aliyun-oss-spring-boot-autoconfigure</artifactId>
    <version>1.0-SNAPSHOT</version>

    <properties>
        <java.version>17</java.version>
    </properties>

    <dependencies>
    
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>
    </dependencies>

</project>

在starter的pom.xml文件中加入autoconfigure模块依赖

<dependency>
    <groupId>com.aliyun.oss</groupId>
    <artifactId>aliyun-oss-spring-boot-autoconfigure</artifactId>
    <version>1.0-SNAPSHOT</version>
</dependency>

第三步：在autoconfigure完成自动配置
准备工作：
使用的阿里云OSS部分的代码直接拷贝到autoconfigure模块下，然后进行改造

AliyunOSSOperator：

public class AliyunOSSOperator {

    private AliyunOSSProperties aliyunOSSProperties;

    public AliyunOSSOperator(AliyunOSSProperties aliyunOSSProperties) {
        this.aliyunOSSProperties = aliyunOSSProperties;
    }

    public String upload(byte[] content, String originalFilename) throws Exception {
        String endpoint=aliyunOSSProperties.getEndpoint();
        String bucketName=aliyunOSSProperties.getBucketName();
        // 从环境变量中获取访问凭证。运行本代码示例之前，请确保已设置环境变量OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。
        EnvironmentVariableCredentialsProvider credentialsProvider = CredentialsProviderFactory.newEnvironmentVariableCredentialsProvider();

        // 填写Object完整路径，例如202406/1.png。Object完整路径中不能包含Bucket名称。
        //获取当前系统日期的字符串,格式为 yyyy/MM
        String dir = LocalDate.now().format(DateTimeFormatter.ofPattern("yyyy/MM"));
        //根据原始文件名originalFilename, 生成一个新的不重复的文件名
        String newFileName = UUID.randomUUID().toString() + originalFilename.substring(originalFilename.lastIndexOf("."));
        String objectName = dir + "/" + newFileName;

        // 创建OSSClient实例。
        OSS ossClient = new OSSClientBuilder().build(endpoint, credentialsProvider);

        //文件上传
        try {
            ossClient.putObject(bucketName, objectName, new ByteArrayInputStream(content));
        } finally {
            if (ossClient != null) {
                ossClient.shutdown();
            }
        }

        return endpoint.split("//")[0] + "//" + bucketName + "." + endpoint.split("//")[1] + "/" + objectName;
    }

}

AliyunOSSProperties：

@Data

@ConfigurationProperties(prefix = "aliyun.oss")
public class AliyunOSSProperties {
    private String endpoint;
    private String bucketName;
}

拷贝过来后，还缺失一些相关的依赖，需要把相关依赖也拷贝过来：

<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
</dependency>

<!--阿里云OSS-->
<dependency>
    <groupId>com.aliyun.oss</groupId>
    <artifactId>aliyun-sdk-oss</artifactId>
    <version>3.17.4</version>
</dependency>
<dependency>
    <groupId>javax.xml.bind</groupId>
    <artifactId>jaxb-api</artifactId>
    <version>2.3.1</version>
</dependency>
<dependency>
    <groupId>javax.activation</groupId>
    <artifactId>activation</artifactId>
    <version>1.1.1</version>
</dependency>
<!-- no more than 2.3.3-->
<dependency>
    <groupId>org.glassfish.jaxb</groupId>
    <artifactId>jaxb-runtime</artifactId>
    <version>2.3.3</version>
</dependency>

不能用 @Component 注解声明bean，那就需要按照 starter 的定义规范，定义一个自动配置类，在自动配置类中声明bean。

定义一个自动配置类 AliOSSAutoConfiguration 了，在自动配置类当中来声明 AliOSSOperator 的bean对象。

AliyunOSSAutoConfiguration ：

@Configuration
@EnableConfigurationProperties(AliyunOSSProperties.class)
public class AliyunOSSAutoConfiguration {
    
    @Bean
    public AliyunOSSOperator aliyunOSSOperator(AliyunOSSProperties aliyunOSSProperties) {
        return new AliyunOSSOperator(aliyunOSSProperties);
    }
    
}

AliyunOSSOperator 的代码中需要增加一个有参构造，将 AliyunOSSProperties 对象传递给工具类。代码改造如下：

在 aliyun-oss-spring-boot-autoconfigure 模块中的resources下，新建自动配置文件 METAINF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports

将自动配置类的全类名，配置在文件中，这样在springboot启动的时候，就会加载到这份文件，并加载到其中的配置类了。

配置内容如下：

com.aliyun.oss.AliyunOSSAutoConfiguration

到此呢，这个 aliyun-oss-spring-boot-stater 就定义好了，哪里要想使用，就可以直接导入依赖，直接注入使用了。

打包：
不同包下的项目也可以使用，通过依赖导入

测试：
1). 在导入的test工程中引入阿里云starter依赖

<dependency>
    <groupId>com.aliyun.oss</groupId>
    <artifactId>aliyun-oss-spring-boot-starter</artifactId>
    <version>1.0-SNAPSHOT</version>
</dependency>

2). 在工程中的 application.yml 中配置阿里云OSS的配置信息

#阿里oss
aliyun:
  oss:
    endpoint: https://oss-cn-shenzhen.aliyuncs.com
    bucketName: possible7

3). 在test工程中的 UploadController 类编写代码

package com.itheima.controller;

import com.aliyun.oss.AliyunOSSOperator;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.multipart.MultipartFile;

@RestController
public class UploadController {
    
    @Autowired
    private AliyunOSSOperator aliyunOSSOperator;
    
    @PostMapping("/upload")
    public String upload(MultipartFile image) throws Exception {
        //上传文件到阿里云 OSS
        String url = aliyunOSSOperator.upload(image.getBytes(), image.getOriginalFilename());
        return url;
    }
    
}

最后修改：2025 年 09 月 09 日

如果觉得我的文章对你有用，请随意赞赏

自定义Starter（阿里云oss）

发表评论取消回复
使用cookie技术保留您的个人信息以便您下次快速评论，继续评论表示您已同意该条款

宝塔安装gitea

福理

黎大

平潭

自定义Starter（阿里云oss）

自定义Starter（阿里云oss）

文件上传-基础

平潭

福理

宝塔安装gitea

自定义Starter（阿里云oss）

发表评论 取消回复 使用cookie技术保留您的个人信息以便您下次快速评论，继续评论表示您已同意该条款

自定义Starter（阿里云oss）

发表评论取消回复
使用cookie技术保留您的个人信息以便您下次快速评论，继续评论表示您已同意该条款