自定义一个Spring Boot Starter并实现自动装配

目录

 

前言    

开始创建

1.创建模块

2.添加依赖

3.工具类的编写   

4.打包下载

测试

---

前言    

       我们为什么要自定义SpringBoot starter?它有什么作用?

       实际上自定义starter主要是方便在不同工程上简洁方便的使用其中的工具类。下面我将以阿里云文件上传来讲解如何简单快速的自定义一个SpringBoot starter;

开始创建

整体结构：

1.创建模块

       首先在一个工程下创建一个maven模块,模块名为XXX-spring-boot-starter(Springboot框架中的starter都是这么命名的),Artifact Coordinates下的三条就是添加依赖所写的组名、依赖名、版本名。

      然后在这个工程下再创建一个maven模块，用于自动装配，模块名为XXX-spring-boot-autoconfigure。组名和之前的starter处于同一个组。

2.添加依赖

        创建好了之后就需要对分别在这两个模块中添加所需的依赖（也就是修改pom文件）。Starter模块只需要将autoconfigure的坐标加入其中就可以，其他创建maven生产的无用文件夹都可删除。

       接着就是在autoconfigure模块中添加对应的依赖。因为我们需要使用到springboot中的ioc容器，并且需要实现文件上传，是属于web中的内容，因此只需要导入spring-boot-start-web的依赖，相关spring-boot框架的依赖也会导入。其余依赖都是更具具体功能需求添加。 

        spring-boot-configuration-processor  : 该依赖是在配置文件(yml\yaml\properties)中会出现相关提示。

        lombok : 这是用来简化Javabean编写的一个插件,需要在idea下载对应插件然后导入依赖即可使用。

        最后导入阿里云oss需要使用到的依赖及完成依赖的添加。

    4.0.0

    com.mystarter
    aliyun-oss-spring-boot-autoconfigure
    1.0-SNAPSHOT

    
        
            org.springframework.boot
            spring-boot-starter-web
            2.7.10
        


        
        
            org.springframework.boot
            spring-boot-configuration-processor
            2.7.10
        

        
            org.projectlombok
            lombok
            1.18.20
        


        
        
            com.aliyun.oss
            aliyun-sdk-oss
            3.15.1
        

        
        
            javax.xml.bind
            jaxb-api
            2.3.1
        
        
            javax.activation
            activation
            1.1.1
        
        
            org.glassfish.jaxb
            jaxb-runtime
            2.3.3
        

    

     

3.工具类的编写   

        依赖添加完毕后就是工具类的编写,在autoconfigure模块下的src/main/java包下编写所需代码。

        首先编写我们需要使用的工具类:

package com.aliyun_oss;

import com.aliyun.oss.OSS;
import com.aliyun.oss.OSSClientBuilder;
import org.springframework.web.multipart.MultipartFile;
import java.io.IOException;
import java.io.InputStream;
import java.util.UUID;

/**
 * 阿里云 OSS 工具类
 */
public class AliOSSUtils {

    private AliOSSProperties ali;

    //提供一个set方法，手动给这个属性赋值
    public void setAli(AliOSSProperties ali) {
        this.ali = ali;
    }

    /**
     * 实现上传图片到OSS
     */
    public String upload(MultipartFile file) throws IOException {
        // 获取上传的文件的输入流
        InputStream inputStream = file.getInputStream();

        // 避免文件覆盖
        String originalFilename = file.getOriginalFilename();
        String fileName = UUID.randomUUID().toString() + originalFilename.substring(originalFilename.lastIndexOf("."));

        //上传文件到 OSS
        OSS ossClient = new OSSClientBuilder().build(ali.getEndpoint(), ali.getKey(), ali.getSecret());
        ossClient.putObject(ali.getBucket(), fileName, inputStream);

        //文件访问路径
        String url = ali.getEndpoint().split("//")[0] + "//" + ali.getBucket() + "." +
                ali.getEndpoint().split("//")[1] + "/" + fileName;
        System.out.println("url = " + url);
        
       // 关闭ossClient
        ossClient.shutdown();
        return url;// 把上传到oss的路径返回
    }
}

        

        然后创建一个配置类(类上打上@configuration注解即可),再写一个方法将我们需要交给IOC容器管理的对象返回。(只需要在方法上打上@Bean注解,方法内部新建一个工具类对象,return返回该对象即可)

        注 : 这个方法的参数里省略了@Autowird注解,也就是说如果参数对象在IOC容器中有,那将会自动注入。

package com.aliyun_oss;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

/**
 * 定义一个配置类,将AliOSSProperties和AliOSSUtils 交给IOC容器管理
    这要做一个配置类
        只有一个目标，
            1. 就是要把AliOSSProperties 交给IOC容器管理！
                @EnableConfigurationProperties(AliOSSProperties.class)
            2. 还要把AliOSSUtils 交给IOC容器管理！
                @Bean

 */
@Configuration
@EnableConfigurationProperties(AliOSSProperties.class)
public class AliOSSAutoConfigure {

    @Bean
    public AliOSSUtils utils(@Autowired AliOSSProperties properties){
        AliOSSUtils ossUtils = new AliOSSUtils();
        ossUtils.setAli(properties);
        return ossUtils;
    }
}

       

        因为阿里云文件上传需要使用到个人账号,所以这里将其做成一个javabean对象,通过配置文件注入。只需要打上@configurationProperties(prefix = “ali.oss”)注解,就会从该模块的配置文件中找到对应的属性注入。

        其中prefix的值代表着属性前缀，类中变量名就是属性名。

        而我们之后需要用在别的工程中，不可能将阿里云个人密钥定义在这个模块，所以我们需要在自动装配类上打上@EnableConfigurationProperties（AliOSSProperties.class）注解,这样我们使用该工具类时，就会把我们工程的配置文件中对应的属性注入进去。

package com.aliyun_oss;

import lombok.Data;
import org.springframework.boot.context.properties.ConfigurationProperties;

/**
 * 定义一个JavaBean将配置文件的相关属性注入其中
 *
    1. 创建一个JavaBean， 定义对应的属性。
        1.1 配置文件的KEY叫什么名字，属性就写什么名字
    2. 在类上面打上注解 ConfigurationProperties, 配置了前缀 prefix.
    3. 还需要把这个类交给IOC容器管理，还需要提供get和 set方法
        @Component  和 @Data
 */
@Data
@ConfigurationProperties(prefix = "ali.oss")
public class AliOSSProperties {

    /**
     * 请配置阿里云OSS的endpoint
     */
    private String endpoint;
    private String key;
    private String secret;
    private String bucket;
}

        工具类编写完成后,只剩最后一步,那就是在Springboot中导入我们的自动装配类,也就是在包src/resource中,新建一个文件夹META-INF在这个文件夹中再创建一个Spring文件夹,文件夹中创建一个org.springframework.boot.autoconfigure.AutoConfiguration.import文件。文件中加入我们的自动配置类(写该类的全路径名,也就是在java包下的所有包名加上自动配置类名)。

4.打包下载

        到这里，所有编写工作已经完成，我们需要对其进行打包下载，将其下载到我们maven的本地仓库，这样我们就可以在其他工程中导入依赖使用了。

        注：我们没有使用到测试，下载时需要将生命周期中的测试禁用，不然会产生错误。

        点击idea右侧的Maven，打开我们的autoconfigure模块，选则生命周期（Lifecycle），选中test，然后点击上侧蓝色圆圈闪电图标禁用测试，接着双击install下载即可。

        Starter模块也是同理，点击install下载。

        注：两个模块都需要下载，只下载一个无法生效。

        到这里自定义Springboot starter已经全部完成，接下来就可以在别的工程中导入依赖使用了。

测试

        添加依赖，编写配置文件（配置文件4条数据需要从阿里云个人账户中获取）

        书写上传文件controller启动测试。

        使用postman访问测试：

 

        Idea结果显示：

         文件上传成功，这也标志着自定义的starter已经正式生效，希望以上内容对正在阅读的你有所帮助。