自定义一个springboot starter

1.自定义starter的作用

在我们的日常开发工作中，经常会有一些独立于业务之外的配置模块，比如阿里云oss存储的时候，我们需要一个工具类进行文件上传。我们经常将其放到一个特定的包下，然后如果另一个工程需要复用这块功能的时候，需要将代码硬拷贝到另一个工程，重新集成一遍，这样会非常麻烦。如果我们将这些可独立于业务代码之外的功配置模块封装成一个个starter，复用的时候只需要在 maven pom 中引用依赖即可，让 SpringBoot 为我们完成自动装配，提高开发效率。
2.自定义starter命名规范

SpringBoot提供的 starter 以 spring-boot-starter-xxx 的方式命名的。官方建议自定义的 starter 使用 xxx-spring-boot-starter 命名规则。以区分 SpringBoot 生态提供的 starter。如：mybatis-spring-boot-starter
3.自定义starter的步骤

现在就以自定义阿里云oss工具starter为例步骤如下：

• 新建两个maven模块
  

​                （1）aliyun-oss-spring-boot-autoconfigure：自动配置核心代码
​                （2）aliyun-oss-spring-boot-starter：管理依赖

• 在aliyun-oss-spring-boot-autoconfigure的pom文件中引入以下依赖
  1. <dependencies>
  2.         <dependency>
  3.             <groupId>org.springframework.boot</groupId>
  4.             <artifactId>spring-boot-starter-web</artifactId>
  5.         </dependency>
  6.         <dependency>
  7.             <groupId>com.aliyun.oss</groupId>
  8.             <artifactId>aliyun-sdk-oss</artifactId>
  9.             <version>3.15.1</version>
  10.         </dependency>
  11.         <dependency>
  12.             <groupId>javax.xml.bind</groupId>
  13.             <artifactId>jaxb-api</artifactId>
  14.             <version>2.3.1</version>
  15.         </dependency>
  16.         <dependency>
  17.             <groupId>javax.activation</groupId>
  18.             <artifactId>activation</artifactId>
  19.             <version>1.1.1</version>
  20.         </dependency>
  21.         
  22.         <dependency>
  23.             <groupId>org.glassfish.jaxb</groupId>
  24.             <artifactId>jaxb-runtime</artifactId>
  25.             <version>2.3.3</version>
  26.         </dependency>
  27.         <dependency>
  28.             <groupId>org.springframework.boot</groupId>
  29.             <artifactId>spring-boot-configuration-processor</artifactId>
  30.             <optional>true</optional>
  31.         </dependency>
  32. </dependencies>

  复制代码
• 在aliyun-oss-spring-boot-autoconfigure的java里面的对应的包里新建三个文件
  AliOSSProperties.java
  1. package com.minqiliang;
  4. import org.springframework.boot.context.properties.ConfigurationProperties;
  6. @ConfigurationProperties("aliyun.oss")
  7. public class AliOSSProperties {
  8.     private String endpoint;
  9.     private String accessKeyId;
  10.     private String accessKeySecret;
  11.     private String bucketName;
  13.     /**
  14.      * 获取
  15.      * @return endpoint
  16.      */
  17.     public String getEndpoint() {
  18.         return endpoint;
  19.     }
  21.     /**
  22.      * 设置
  23.      * @param endpoint
  24.      */
  25.     public void setEndpoint(String endpoint) {
  26.         this.endpoint = endpoint;
  27.     }
  29.     /**
  30.      * 获取
  31.      * @return accessKeyId
  32.      */
  33.     public String getAccessKeyId() {
  34.         return accessKeyId;
  35.     }
  37.     /**
  38.      * 设置
  39.      * @param accessKeyId
  40.      */
  41.     public void setAccessKeyId(String accessKeyId) {
  42.         this.accessKeyId = accessKeyId;
  43.     }
  45.     /**
  46.      * 获取
  47.      * @return accessKeySecret
  48.      */
  49.     public String getAccessKeySecret() {
  50.         return accessKeySecret;
  51.     }
  53.     /**
  54.      * 设置
  55.      * @param accessKeySecret
  56.      */
  57.     public void setAccessKeySecret(String accessKeySecret) {
  58.         this.accessKeySecret = accessKeySecret;
  59.     }
  61.     /**
  62.      * 获取
  63.      * @return bucketName
  64.      */
  65.     public String getBucketName() {
  66.         return bucketName;
  67.     }
  69.     /**
  70.      * 设置
  71.      * @param bucketName
  72.      */
  73.     public void setBucketName(String bucketName) {
  74.         this.bucketName = bucketName;
  75.     }
  76. }

  复制代码
  AliOSSUtils.java
  1. package com.minqiliang;
  3. import com.aliyun.oss.OSS;
  4. import com.aliyun.oss.OSSClientBuilder;
  5. import org.springframework.web.multipart.MultipartFile;
  7. import java.io.IOException;
  8. import java.io.InputStream;
  9. import java.util.UUID;
  11. /**
  12. * 阿里云 OSS 工具类
  13. */
  15. public class AliOSSUtils {
  17.     private AliOSSProperties aliOSSProperties;
  19.     public AliOSSProperties getAliOSSProperties() {
  20.         return aliOSSProperties;
  21.     }
  23.     public void setAliOSSProperties(AliOSSProperties aliOSSProperties) {
  24.         this.aliOSSProperties = aliOSSProperties;
  25.     }
  27.     /**
  28.      * 实现上传图片到OSS
  29.      */
  30.     public String upload(MultipartFile file) throws IOException {
  31.         String endpoint = aliOSSProperties.getEndpoint();
  32.         String accessKeyId = aliOSSProperties.getAccessKeyId();
  33.         String accessKeySecret = aliOSSProperties.getAccessKeySecret();
  34.         String bucketName = aliOSSProperties.getBucketName();
  35.         // 获取上传的文件的输入流
  36.         InputStream inputStream = file.getInputStream();
  38.         // 避免文件覆盖
  39.         String originalFilename = file.getOriginalFilename();
  40.         String fileName = UUID.randomUUID().toString() + originalFilename.substring(originalFilename.lastIndexOf("."));
  42.         //上传文件到 OSS
  43.         OSS ossClient = new OSSClientBuilder().build(endpoint, accessKeyId, accessKeySecret);
  44.         ossClient.putObject(bucketName, fileName, inputStream);
  46.         //文件访问路径
  47.         String url = endpoint.split("//")[0] + "//" + bucketName + "." + endpoint.split("//")[1] + "/" + fileName;
  48.         // 关闭ossClient
  49.         ossClient.shutdown();
  50.         return url;// 把上传到oss的路径返回
  51.     }
  53. }

  复制代码
  AliyunOssAutoConfigration.java
  1. package com.minqiliang;
  3. import org.springframework.boot.context.properties.EnableConfigurationProperties;
  4. import org.springframework.context.annotation.Bean;
  5. import org.springframework.context.annotation.Configuration;
  7. @Configuration
  8. @EnableConfigurationProperties(AliOSSProperties.class)
  9. public class AliyunOssAutoConfigration {
  11.     @Bean
  12.     public AliOSSUtils aliOSSUtils(AliOSSProperties aliOSSProperties){
  13.         AliOSSUtils aliossUtils = new AliOSSUtils();
  14.         aliossUtils.setAliOSSProperties(aliOSSProperties);
  15.         return  aliossUtils;
  16.     }
  17. }

  复制代码
• aliyun-oss-spring-boot-autoconfigure的resources文件加下新建META_INF/spring文件夹，然后再在spring文件夹里新建org.springframework.boot.autoconfigure.AutoConfiguration.imports文件，文件内容为AliyunOssAutoConfigration类的全类名，如下
  1. com.minqiliang.AliyunOssAutoConfigration

  复制代码
• 在aliyun-oss-spring-boot-starter的pom文件里引入aliyun-oss-spring-boot-autoconfigure依赖
  1. <dependencies>
  2.         <dependency>
  3.             <groupId>org.springframework.boot</groupId>
  4.             <artifactId>spring-boot-starter</artifactId>
  5.         </dependency>
  6.         <dependency>
  7.             <groupId>com.minqiliang</groupId>
  8.             <artifactId>aliyun-oss-spring-boot-autoconfigure</artifactId>
  9.             <version>0.0.1-SNAPSHOT</version>
  10.         </dependency>
  11. </dependencies>

  复制代码
• 目录结构如下
  
  
• 执行clean和install，把自定义的starter安装到本地仓库
  
• 新建一个aliyun-starter-test模块，进行测试，目录结构如下：
  
  
• UploadController.java
  1. package com.example.controller;
  3. import com.example.pojo.Result;
  4. import com.minqiliang.AliOSSUtils;
  5. import org.springframework.beans.factory.annotation.Autowired;
  6. import org.springframework.web.bind.annotation.PostMapping;
  7. import org.springframework.web.bind.annotation.RestController;
  8. import org.springframework.web.multipart.MultipartFile;
  10. import java.io.IOException;
  12. @RestController
  13. public class UploadController {
  15.     @Autowired
  16.     private AliOSSUtils aliOSSUtils;
  18.     @PostMapping("upload")
  19.     public Result upload(MultipartFile image) throws IOException {
  20.         String url = aliOSSUtils.upload(image);
  21.         return Result.success(url);
  22.     }
  23. }

  复制代码
  Result.java
  1. package com.example.pojo;
  3. public class Result {
  4.     private Integer code;//响应码，1 代表成功; 0 代表失败
  5.     private String msg;  //响应信息 描述字符串
  6.     private Object data; //返回的数据
  8.     public Result() {
  9.     }
  11.     public Result(Integer code, String msg, Object data) {
  12.         this.code = code;
  13.         this.msg = msg;
  14.         this.data = data;
  15.     }
  18.     //增删改 成功响应
  19.     public static Result success(){
  20.         return new Result(1,"success",null);
  21.     }
  22.     //查询 成功响应
  23.     public static Result success(Object data){
  24.         return new Result(1,"success",data);
  25.     }
  26.     //失败响应
  27.     public static Result error(String msg){
  28.         return new Result(0,msg,null);
  29.     }
  31.     /**
  32.      * 获取
  33.      * @return code
  34.      */
  35.     public Integer getCode() {
  36.         return code;
  37.     }
  39.     /**
  40.      * 设置
  41.      * @param code
  42.      */
  43.     public void setCode(Integer code) {
  44.         this.code = code;
  45.     }
  47.     /**
  48.      * 获取
  49.      * @return msg
  50.      */
  51.     public String getMsg() {
  52.         return msg;
  53.     }
  55.     /**
  56.      * 设置
  57.      * @param msg
  58.      */
  59.     public void setMsg(String msg) {
  60.         this.msg = msg;
  61.     }
  63.     /**
  64.      * 获取
  65.      * @return data
  66.      */
  67.     public Object getData() {
  68.         return data;
  69.     }
  71.     /**
  72.      * 设置
  73.      * @param data
  74.      */
  75.     public void setData(Object data) {
  76.         this.data = data;
  77.     }
  79.     public String toString() {
  80.         return "Result{code = " + code + ", msg = " + msg + ", data = " + data + "}";
  81.     }
  82. }

  复制代码
• pom文件引入aliyun-oss-spring-boot-starter依赖
  1. <dependencies>
  2.         <dependency>
  3.             <groupId>org.springframework.boot</groupId>
  4.             <artifactId>spring-boot-starter-web</artifactId>
  5.         </dependency>
  7.         <dependency>
  8.             <groupId>org.springframework.boot</groupId>
  9.             <artifactId>spring-boot-starter-test</artifactId>
  10.             <scope>test</scope>
  11.         </dependency>
  12.         <dependency>
  13.             <groupId>com.minqiliang</groupId>
  14.             <artifactId>aliyun-oss-spring-boot-starter</artifactId>
  15.             <version>0.0.1-SNAPSHOT</version>
  16.         </dependency>
  17. </dependencies>

  复制代码
• application.yml里配置自己的阿里云oss信息，如下
  1. aliyun:
  2.   oss:
  3.     endpoint: 填写自己的
  4.     accessKeyId: 填写自己的
  5.     accessKeySecret: 填写自己的
  6.     bucketName: 填写自己的

  复制代码
• 启动测试项目，使用postman上传一个文件，结果如下，说明starter配置成功
  1. {
  2.     "code": 1,
  3.     "msg": "success",
  4.     "data": "https://tlias-manage.oss-cn-hangzhou.aliyuncs.com/8713ed3d-751c-4d54-8a64-239b1ccb0da4.jpg"
  5. }

  复制代码

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！