手写springboot之starter组件

背景

springboot中提供的一个非常重要的特性就是starter组件，spring官方提供了很多starter组件，并且支持第三方编写自己的starter组件集成到spring，本文就介绍下如何自定义starter组件。

手写自定义starter组件

1、创建starter项目，基于springboot创建，pom.xml文件内容如下

<?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.1.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.example</groupId>
    <artifactId>my-starter</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>my-starter</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>

		<!--该依赖可以让我们集成到spring后让编译器智能提示我们的配置信息-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-configuration-processor</artifactId>
            <optional>true</optional>
        </dependency>

    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <configuration>
                	<!--必须定义一下，否则生成的jar是可执行jar，不能被其他项目依赖-->
                    <classifier>exec</classifier>
                </configuration>
            </plugin>
        </plugins>
    </build>

</project>

2、创建一个映射配置文件的类MyProperties，统一管理配置信息

@ConfigurationProperties(prefix = "my.properties")
public class MyProperties {

    private String url;

    private String myName;

    public String getUrl() {
        return url;
    }

    public void setUrl(String url) {
        this.url = url;
    }

    public String getMyName() {
        return myName;
    }

    public void setMyName(String myName) {
        this.myName = myName;
    }

    @Override
    public String toString() {
        return "MyProperties{" +
                "url='" + url + '\'' +
                ", myName='" + myName + '\'' +
                '}';
    }
}

3、创建一个bean，名称为MyService

public class MyService {

    private final MyProperties myProperties;

    public MyService(MyProperties myProperties) {
        this.myProperties = myProperties;
    }

    public void doQuery() {
        System.out.println("doQuery properties:" + myProperties.toString());
    }

}

4、创建配置文件MyConfig

@EnableConfigurationProperties(MyProperties.class)
@Configurable
public class MyConfig {

    @Autowired
    private MyProperties myProperties;
   
    @Bean
    public MyService myService() {
        return new MyService(myProperties);
    }

}

5、resources目录下创建META-INF/spring.factories文件，定义要被spring管理的配置文件
spring.factories内容：

# Auto Configure
org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
com.example.mystarter.config.MyConfig

6、执行mvn install，安装jar包到我们的本地仓库

以上步骤完成，即我们的starter组件已经编写完成，我们可以在项目中直接使用它

7、创建一个springboot创建的web项目，pom.xml依赖我们的starter项目
添加依赖：

   <dependency>
        <groupId>com.example</groupId>
        <artifactId>my-starter</artifactId>
        <version>0.0.1-SNAPSHOT</version>
    </dependency>

8、application.properties文件下可以定义我们的属性，并且idea已经可以自己提示我们了
application.properties配置：

#spring推荐驼峰命名的参数转换为-，即我们定义的是myName，使用时需要改为my-name（也可以使用myName）
my.properties.my-name=jack
my.properties.url=http://localhost:8888

9、定义测试文件

@RestController
public class TestController {

    // 注入我们的service
    @Autowired
    private MyService myService;

    @GetMapping("/testStarter")
    public void testStarter() {
        myService.doQuery();
    }

}

10、浏览器访问测试url：http://localhost:8080/testStarter
输出：

doQuery properties:MyProperties{url='http://localhost:8888', myName='jack'}

由上可见，我们自定义的starter组件在使用时已经可以做到开箱即用了，无需任何配置即可直接使用我们的MyService，这就是springboot非常重要的特性starter组件

Conditional条件注解

虽然我们的starter组件编写完成了，但是如何客户端已经定义了一个bean，名称为myService，那么装配我们的starter组件时必定会报错，因为不能有两个相同名称的bean定义，我们总不能让客户端修改自己的bean的名称吧，所以这时候我们就要使用Conditional条件注解来优化我们的starter组件了,如使用@ConditionalOnMissingBean(name = “myService”)，即当当前spring容器中没有bean的name为myService时装配我们需要的bean，当存在myService的bean时允许用户自己重新配置我们的MyService

@ConditionalOnMissingBean(name = "myService")
@Bean
public MyService myService() {
    return new MyService(myProperties);
}

Conditional相关注解
@ConditionalOnBean：仅仅在当前上下文中存在某个对象时，才会实例化一个Bean。
@ConditionalOnClass：某个class位于类路径上，才会实例化一个Bean。
@ConditionalOnExpression：当表达式为true的时候，才会实例化一个Bean。
@ConditionalOnMissingBean：仅仅在当前上下文中不存在某个对象时，才会实例化一个Bean。
@ConditionalOnMissingClass：某个class类路径上不存在的时候，才会实例化一个Bean。
@ConditionalOnNotWebApplication：不是web应用，才会实例化一个Bean。
@ConditionalOnBean：当容器中有指定Bean的条件下进行实例化。
@ConditionalOnMissingBean：当容器里没有指定Bean的条件下进行实例化。
@ConditionalOnClass：当classpath类路径下有指定类的条件下进行实例化。
@ConditionalOnMissingClass：当类路径下没有指定类的条件下进行实例化。
@ConditionalOnWebApplication：当项目是一个Web项目时进行实例化。
@ConditionalOnNotWebApplication：当项目不是一个Web项目时进行实例化。
@ConditionalOnProperty：当指定的属性有指定的值时进行实例化。
@ConditionalOnExpression：基于SpEL表达式的条件判断。
@ConditionalOnJava：当JVM版本为指定的版本范围时触发实例化。
@ConditionalOnResource：当类路径下有指定的资源时触发实例化。
@ConditionalOnJndi：在JNDI存在的条件下触发实例化。
@ConditionalOnSingleCandidate：当指定的Bean在容器中只有一个，或者有多个但是指定了首选的Bean时触发实例化。

本文只介绍了如何创建starter组件，starter组件原理可参考前文：springboot自动装配组件详解