自定义Spring Boot Starter

本文主要介绍如何自定义Spring Boot Starter：

查看 Spring Boot Starter原理

查看Spring Boot 自动装配原理

SpringBoot的Spring Boot Start 机制，可以将繁复的配置，统一集成在一个Starter下，在使用时，使用端只需要引入对应的starter依赖，SpringBoot启动时，会自动通过classpath路径下的类发现需要的Bean，并注册进IOC容器。

Spring Boot提供的Starter命名为 spring-boot-starter-xxx

为与Spring Boot 定义的Starter区分开来，自定义starter一般命名为xxx-spring-boot-starter

以下为自定义mystarter-spring-boot-starter 相关步骤

1.自定义Spring Boot Starter

1.创建artifactId名称为mystarter-spring-boot-starter的maven 工程 ，引入spring-boot-autoconfigure依赖

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
		 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
		 xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
	<modelVersion>4.0.0</modelVersion>

	<groupId>com.kay</groupId>
	<artifactId>mystarter-spring-boot-starter</artifactId>
	<version>1.0-SNAPSHOT</version>

	<dependencies>
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-autoconfigure</artifactId>
			<version>2.2.9.RELEASE</version>
		</dependency>
	</dependencies>
	<build>
		<plugins>
			<plugin>
				<groupId>org.apache.maven.plugins</groupId>
				<artifactId>maven-compiler-plugin</artifactId>
				<version>3.2</version>
				<configuration>
					<source>8</source>
					<target>8</target>
					<encoding>UTF-8</encoding>
				</configuration>
			</plugin>
		</plugins>
	</build>
</project>

2. 定义实体类 MyBean（这个是模拟在Spring Boot启动过程中，被自动创建的类），增加属性field1,field2;生成对应的set get方法，通过@ConfigurationProperties注解指定配置文件中前缀信息

@EnableConfigurationProperties(MyBean.class)
@ConfigurationProperties(prefix = "my.bean")
public class MyBean {
   private String field1;
   private String field2;
   get,set ......
}

3. 定义标记类ConfigMarker   （热插拔技术步骤1 ,此类会被Enable注解Import进上下文，而在MyAutoConfiguration配置类中作为配置类的条件注解）

public class ConfigMarker {

}

4. 定义@EnableMyAutoConfigurationRegister注解，引入ConfigMarker类 (热插拔技术步骤2，项目中使用了 @EnableMyAutoConfigurationRegister注解时 ，spring 才会去加载 ConfigMarker到 上下文)

@Documented
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Import({ConfigMarker.class})
public @interface EnableMyAutoConfigurationRegister {
}

5.编写配置类MyAutoConfiguration  （热插拔技术步骤3，@ConditionalOnBean(ConfigMarker.class) 作为MyAutoConfiguration生效的条件注解，即当项目中使用了@EnableMyAutoConfigurationRegister注解时，ConfigMarker才会被导入项目上下文，此时MyAutoConfiguration配置类才会生效，从而生成MyBean对象）

@Configuration
@ConditionalOnBean(ConfigMarker.class)
public class MyAutoConfiguration {

   @Bean
   public MyBean myBean(){
      return new MyBean();
   }
}

6.  在resources下增加META-INF目录，并添加spring.factories文件，将MyAutoConfiguration的全限定类名添加到key为org.springframework.boot.autoconfigure.EnableAutoConfiguration的value下（SpringBoot自动装配就是读取所有META-INF目录下spring.factories中key为rg.springframework.boot.autoconfigure.EnableAutoConfiguration的类信息，通过判断classpath是否有对应的依赖以及@Condition*等生效条件，从而创建对应的bean对象到IOC容器中）可见Spring Boot自动装配原理

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
com.kay.config.MyAutoConfiguration

2.使用自定义的starter

 1. 引入自定义的starter (注意需要版本信息)

<dependency>
   <groupId>com.kay</groupId>
   <artifactId>mystarter-spring-boot-starter</artifactId>
   <version>1.0-SNAPSHOT</version>
</dependency>

2. 在全局配置文件中MyBean对应的属性信息

my.bean.field1=xxx
my.bean.field2=xxx

3.配置@EnableMyAutoConfigurationRegister注解，开启需要Spring Boot启动自动根据配置文件信息生成对应的实例对象

@EnableMyAutoConfigurationRegister