SpringBoot实现自定义starter

一，使用版本

SpringBoot版本：2.3.5.RELEASE

二，Spring注解说明

@Configuration：指定这个类是个配置类。
@ConditionalOnXXX：在指定条件下，该配置类才会生效。
@AutoConfigureAfter：指定自动配置类的顺序。
@Bean：给容器中添加组件。
@ConfigurationPropertie：结合相关xxxProperties类来绑定相关的配置。
@EnableConfigurationProperties：让xxxProperties生效加入到容器中。

加载说明：自动配置要能加载，就需要将启动就加载的自动配置类，配置在META-INF/spring.factories。
org.springframework.boot.autoconfigure.EnableAutoConfiguration=
org.springframework.boot.autoconfigure.admin.SpringApplicationAdminJmxAutoConfiguration,
org.springframework.boot.autoconfigure.aop.AopAutoConfiguration,\

三，自定义starter的实现

实现模式

1. 启动器只能用来做依赖的导入。
2. 专门来写一个自动配置模块。
3. 工程项目导入启动器，启动器依赖自动配置模块。
4. 启动器命名：自定义启动器名-spring-boot-starter。

启动器模块

启动器模块只需要依赖于自动配置模块，无须做任何配置。

<?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.atguigu</groupId>
    <artifactId>atguigu-spring-boot-starter</artifactId>
    <version>1.0-SNAPSHOT</version>

    <dependencies>
        <dependency>
            <groupId>com.atguigu</groupId>
            <artifactId>atguigu-spring-boot-starter-autoconfigurer</artifactId>
            <version>0.0.1-SNAPSHOT</version>
        </dependency>
    </dependencies>
</project>

自动配置模块

1.自动配置模块pom文件：

<?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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.3.5.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>

    <groupId>com.atguigu</groupId>
    <artifactId>atguigu-spring-boot-starter-autoconfigurer</artifactId>
    <version>0.0.1-SNAPSHOT</version>

    <name>atguigu-spring-boot-starter-autoconfigurer</name>
    <description>Demo project for Spring Boot</description>

    <properties>
        <java.version>1.8</java.version>
    </properties>

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

5. 创建与自动配置映射的properties类。

@ConfigurationProperties(prefix = "atguigu.hello")
public class HelloProperties {

    private String prefix;
    private String suffix;

    public String getPrefix() {
        return prefix;
    }

    public void setPrefix(String prefix) {
        this.prefix = prefix;
    }

    public String getSuffix() {
        return suffix;
    }

    public void setSuffix(String suffix) {
        this.suffix = suffix;
    }
}

6. 声明组件。

public class HelloService {

    private HelloProperties helloProperties;

    public HelloService(HelloProperties helloProperties){
        this.helloProperties = helloProperties;
    }

    public String sayHello(String name){
        return helloProperties.getPrefix() + name + helloProperties.getSuffix();
    }
}

7. 创建自动配置类。

@Configuration
@ConditionalOnWebApplication            // web应用才会生效
@EnableConfigurationProperties(HelloProperties.class)		// 让properties配置文件生效，加入到容器中。
public class HelloAutoConfigurer {

    @Autowired
    HelloProperties helloProperties;

    @Bean
    public HelloService helloService(){
        return new HelloService(helloProperties);
    }
}

8. 在resources下创建META-INF/spring.factories。

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
com.atguigu.starter.config.HelloAutoConfigurer

9. 将自动配置模块和启动器模块安装到本地仓库。
   

四，测试

新建一个SpringBoot工程，将刚刚写的starter导入，并且配置相应的starter属性。

atguigu.hello.prefix=prefix自动配置
atguigu.hello.suffix=suffix自动配置

编写测试类，测试starter自动注入的组件。

@RestController
public class HelloController {

   @Autowired
   HelloService helloService;


   @GetMapping("/hello/{name}")
   public String sayHello(@PathVariable String name){
       return helloService.sayHello(name);
   }
}

注意：helloSevice是自定义starter自动注入且自动配置。