手把手带你开发SpringBoot的starter插件

一、开始

SpringBoot与Spring一个很大的区别，就是Springboot有了starter插件这个东西，通过我们引入的一些maven坐标文件来看，像下面这种⬇️

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

<dependency>
    <groupId>org.mybatis.spring.boot</groupId>
    <artifactId>mybatis-spring-boot-starter</artifactId>
  	<version>2.1.4</version>
</dependency>

而常见的包还有这种

<dependency>
   <groupId>org.rxtx</groupId>
   <artifactId>rxtx</artifactId>
   <version>2.1.7</version>
</dependency>

他们的区别就在于，starter插件会在SpringBoot启动时，会将这个插件中的bean一块加载到容器内

二、创建starter-plugin

1.POM

	<!--创建Maven新项目，没有用springboot的脚手架，一定要加上这个parent，要不然都不是一个springboot项目-->
	<parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.4.0</version>
    </parent>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-aop</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-configuration-processor</artifactId>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-autoconfigure</artifactId>
        </dependency>
    </dependencies>

2.编写插件类

配置文件

既然是SpringBoot的插件，那么我们肯定要依赖这个项目的配置文件，所以我们用一个类来进行获取

//这个注解后面的prefix是用来匹配配置文件中的key
@ConfigurationProperties(prefix = "fanxing.datascale")

代码中可以看到定义了几个私有的变量，当启动后，会自动加载配置文件内以
fanxing.datascale开头的配置，例如

fanxing.datascale.host=127.0.0.1
fanxing.datascale.port=8089

程序主类

@Component
public class Test {
    @Resource
    private ApplicationConfig applicationConfig;

    public void test(){
        System.out.println("加载配置信息");
        System.out.println(applicationConfig.getHost());
    }
}

入口类

接下来我们创建一个入口类，来加载我们插件的bean

@EnableConfigurationProperties(ApplicationConfig.class)
@Configuration
public class Main{
    @Bean
    public Test test() {
        return new Test();
    }
}

3.如何让springboot识别到我们这个类

文件

我们在resources文件夹下创建一个META-INF文件夹
然后新建一个叫spring.factories的文件，在文件内容里面打上下面的内容，等于后面的值，填我们的入口类的路径，这样在springboot引入的时候，他就会自动去找我们插件的Configuration类了

org.springframework.boot.autoconfigure.EnableAutoConfiguration=io.github.fxboy.config.Main

4.测试

用maven的install命令安装到本地后，创建一个springboot项目，引入这个插件

在配置文件下输入配置

然后创建好测试类，来调用下Test.test()这个方法，是不是可以打印出来我们的Host配置

四、如何通过像有些插件一样使用@EnableXXX来启动

使用这个方法的话，spring.factories这个文件就可以不需要创建了
首先要自定义一个注解

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
// 使用自动导入配置信息注解，并将我们的入口类放入
@ImportAutoConfiguration(Main.class)
public @interface EnableDataScaleX {
}

这样的话，我们在@SpringBootApplication上就可以使用这个注解来导入了

@EnableDataScaleX
@SpringBootApplication
public class DocApplication {
    public static void main(String[] args) {
        SpringApplication.run(DocApplication.class, args);
    }

}