开源：如何自定义spring boot starter

Posted 2022-03-08 码上实战

本文demo: https://github.com/flyhero/easy-log

或者 如图：

5. 验证

5.1 添加依赖

在hello-example下pom.xml中添加我们自定义的 hello-spring-boot-starter：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
    <groupId>com.example</groupId>
    <artifactId>hello-spring-boot-starter</artifactId>
    <version>0.0.1-SNAPSHOT</version>
</dependency>

5.2 配置信息

在 application.yaml 或 application.properties 中配置如下：

hello.test.enable=true
hello.test.name=Mr.Wang
hello.test.url=https://github.com/flyhero

5.3 创建controller类

@RestController
public class HelloController 

    @Autowired
    private HelloService helloService;

    @GetMapping("/test")
    public String test()
        return helloService.sayHello();
    

5.4 请求接口

从相应的结果可知，我们定义的starter已经生效了。

6. demo

本文demo可参考：https://github.com/flyhero/easy-log

自定义spring boot start

参考技术A 1.创建maven项目
引入如下依赖

2.定义实体,接收配置文件自定义配置

3.定义AutoConfiguration, 完成bean加载

这里XXX为自定义类,根据实际需要定义并返回对应bean即可
4.在src/main/resources新建文件夹META-INF，然后新建一个spring.factories文件
配置装配路径

以上已完成对spring boot start的定义

自动化配置注解介绍,如下：
@Configuration：这个配置就不用多做解释了，我们一直在使用；
@EnableConfigurationProperties：这是一个开启使用配置参数的注解，value值就是我们配置实体参数映射的ClassType，将配置实体作为配置来源；
SpringBoot内置条件注解
@ConditionalOnXxx相关的注解为条件注解，也是我们配置的关键，可以把这些注解理解为具有Xxx条件：
@ConditionalOnBean：当SpringIoc容器内存在指定Bean的条件
@ConditionalOnClass：当Spring Ioc容器内存在指定Class的条件；
@ConditionalOnExpression：基于SpEL表达式作为判断条件
@ConditionalOnJava：基于JVM版本作为判断条件
@ConditionalOnMissingBean：当SpringIoc容器内不存在指定Bean的条件
@ConditionalOnMissingClass：当SpringIoc容器内不存在指定Class的条件
@ConditionalOnNotWebApplication：当前项目不是Web项目的条件
@ConditionalOnProperty：指定的属性是否有指定的值；
@ConditionalOnResource：类路径是否有指定的值
@ConditionalOnSingleCandidate：当指定Bean在SpringIoc容器内只有一个，或者虽然有多个但是指定首选的Bean；
@ConditionalOnWebApplication：当前项目是Web项目的条件
以上注解都是元注解@Conditional演变而来的，根据不用的条件对应创建以上的具体条件注解。
截止到项目我们还没有完成自动化配置starter，我们先来了解Starter自动化配置原理：
在注解@SpringBootApplication上存在一个开启自动化配置的注解@EnableAutoConfiguration来完成自动化配置，
注解源码如下所示：

在@EnableAutoConfiguration注解内使用到了@import注解来完成导入配置的功能，而EnableAutoConfigurationImportSelector内部则是使用了SpringFactoriesLoader.loadFactoryNames方法进行扫描具有META-INF/spring.factories文件的jar包。我们可以先来看下spring-boot-autoconfigure包内的spring.factories文件内容，如下所示：

可以看到配置的结构形式是Key=>Value形式，多个Value时使用,隔开，目的是为了完成自动化配置，所以我们spring.factories配置中Key则是需要使用：org.springframework.boot.autoconfigure.EnableAutoConfiguration

补充
配置文件中,自定义配置是有提示的~~