自定义Spring Boot Starter

在使用Spring Boot开发的时候，我们会用到各种各样的Spring-boot-Starter，不过那些Starter都是常用的，在不同的公司，因不同的业务场景，内部的库也不同，有时需要做一个自己的starter，方便后面加快开发速度。

知识点

• @ConfigurationProperties starter的配置属性
• @EnableConfigurationProperties 启用配置属性
• spring.factories 可以指定自动配置类
• spring-configuration-metadata.json 配置属性的补全功能

过程

做一下演示，内部的代码不方便公开。

1. 新建XXXProperties类，这个类名可以自定义，以Properties为结尾是为了方便标识这个类是Properties功能。

比如RedisProperties

image.png

我们新建TestProperties，这里我省略了getter和setter，自己写的时候加上

@Data
@ConfigurationProperties(prefix = "test")
public class TestProperties {
    private String name;
    private String desc;

    private Nest nest;
    public static class Nest {
        private String nestName;
    }
}

2. 新建真正的配置类，类名为TestAutoConfigurer，这个根据自己的选择，建合适的类名

参考Redis的

image.png

我们自己的

@Configuration
@EnableConfigurationProperties(TestProperties.class)
public class TestAutoConfigurer {

    private TestProperties testProperties;

    public TestAutoConfigurer(TestProperties testProperties) {
        this.testProperties = testProperties;
    }

    ...
}

3. 建立好上面两个类之后，根据业务建立，以及配置的属性就可以建立Bean了。一般会用到@conditonalOnMissingBean(xxBean.class)

   
   image.png

4. 配置，运行并且测试
   配置文件里面

test:
  name: aihe
  nest:
    nestName: nestAihe

image.png

可以看到已经注入进来了。

5. Spring Boot在启动的时候会默认扫描当前包目录下的所有内容，当前包下带有Spring相关注解的都会生效。

假如我们的自动配置类，不在当前包下怎么办呢？
在resource目录下新建这两个文件

image.png

6. spring.factories指定自动配置类，这样Spring Boot一定会启用指定的配置类。

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
me.aihe.ShiroCasAutoConfigurer

7. spring-configuration-metadata.json用来做配置的时候自动补全的功能, 如图所示的自动补全，spring-configuration-metadata.json这个文件作用。

   
   image.png

这个文件主要分为两部分，一个groups一个properties,其余的因为是json格式，比较容易理解，自己写就好了

image.png

8. 都写好之后，就可以打包测试，供下次使用了。最后的文件结构如下

   
   image.png

最后

主要介绍了下Spring Boot starter的简单制作，感兴趣的可以自己试试。

参考

• Spring Configration Metadata