SpringBoot自定义starter

---

一、如何编写自动配置？

@Configuration //指定这是一个配置类
@ConditionalOnXXX //在指定条件成立的情况下自动配置类生效
@AutoConfigureAfter //指定自动配置类的顺序
@Bean //给容器中添加组件

@ConfigurationProperties //结合相关的xxxProperties类来绑定相关的配置
@EnableConfigurationProperties //让xxxProperties类生效并加入到容器中

注意：自动配置类要能自动加载，需要将启动就要加载的自动配置类，配置到classpath下的META-INF/spring.factories文件中，如下图

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
org.springframework.boot.autoconfigure.admin.SpringApplicationAdminJmxAutoConfiguration,\
org.springframework.boot.autoconfigure.aop.AopAutoConfiguration,\
org.springframework.boot.autoconfigure.amqp.RabbitAutoConfiguration

二、启动器的模式

启动器模块是一个空JAR文件，仅提供辅助性依赖管理，这些依赖可能用于自动装配或者其他类库。(也就是说启动器模块和自动配置模块需要分成两个module来写)

官方命名模式

• 前缀：“spring-boot-starter-”
• 模式：spring-boot-starter-模块名
• 举例：spring-boot-starter-web

自定义命名模式

• 后缀："-spring-boot-starter"
• 模式：模块-spring-boot-starter
• 举例：mybatis-spring-boot-starter

三、具体的操作步骤

1、创建一个空工程

2、在空工程中创建两个Module项目，第一个是Maven，第二个是spring项目（该项目不引入任何模块）

Maven项目用来做启动器，就是下图的tansun-spring-boot-starter项目；spring项目用来做自动配置模块，如下图的tansun-spring-boot-starter-autoconfigurer。

3、在启动器的pom文件中引入自动配置模块

该依赖来自，自动装配模块的pom文件

4、去除模块中多余的组件

必删除组件：

• spring boot的核心配置文件application.properties
• java文件夹下的主程序文件
• pom文件中的spring-boot-starter-test依赖
• 用于测试的test整个文件夹

5、创建属性配置文件（用于在核心配置文件中进行配置）

该属性配置类需要添上注解@ConfigurationProperties(prefix = “xxx”)，表明这是一个属性配置类

6、创建场景业务并调用属性配置类中的属性

这里的属性配置类对象不需要注入，会在之后的自动配置文件中进行注入

7、创建自动配置类

这里的属性配置类对象需要注入

8、在classpath（类路径）下添加META-INF/spring.factories文件并写入需要自动装配的自动配置类

9、将自动配置包和启动器都装配到仓库中

图中的操作步骤必须一致，否则无法构建成功

下图是自动装配成功的标志

通过以上九个步骤，一个场景启动器就大致创建完成了，下面是使用方式。

四、场景启动器使用方式

创建一个新的项目来测试我们所创建的场景是否有用。该项目必须要是web项目，因为我们的自动配置类配置的适用场景是在web项目环境下才能启动。

1、在创建好的新项目的pom文件中引入我们自定义的starter

2、创建一个Controller来调用自定义场景启动器的业务方法

3、在spring boot的核心配置文件中写入属性配置项

4、启动测试项目，并访问localhost:8080/hello?name=zhangshan地址

如果出现上述访问结果，那么恭喜你，你成功创建了一个场景启动器！！！