Spring Boot中自定义starter

在spring boot中为我们提供了很多的starter，我们可以利用starter提供的自动化配置，很快就能搭建开发环境，其实starter也是基于spring+springmvc基础实现的，下面我们就来看看自己定义一个starter，并且使用它

starter其实就是一个普通的maven项目，当我们把项目创建好后，添加自动化配置类即可

创建普通的maven项目

导入相关的依赖

<?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.zhouym</groupId>
    <artifactId>starterdemo</artifactId>
    <version>1.0-SNAPSHOT</version>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-autoconfigure</artifactId>
            <version>2.1.6.RELEASE</version>
        </dependency>
    </dependencies>

</project>

接下来我们在application.properties文件中定义内容

zhouym.name=zym
zhouym.msg=hello world

创建MyStarterProperties类

用来接收application.properties中注入的值

package com.zhouym.mystarter;

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;

/**
 * 〈〉
 *
 * @author zhouym
 * @create 2019/8/6
 * @since 1.0.0
 */
@Component
@ConfigurationProperties(prefix = "zhouym") 
public class MyStarterProperties {
    private static final String DEFAULT_NAME="shmily";
    private static final String DEFAULT_MSG="hello";
    private String name = DEFAULT_NAME;
    private String msg = DEFAULT_MSG;

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public String getMsg() {
        return msg;
    }

    public void setMsg(String msg) {
        this.msg = msg;
    }
}

这个配置类就是说将application.properties中的属性值注入到这个实例中，@ConfigurationProperties这个注解是属性安全注入，将aplication.properties文件中前缀为zhouym的属性注入到这个类对应的属性中，所以说这个类中的属性要与配置文件中的字段要保持一致，以便我们后面使用

接下来我们再定义一个HelloService类，定义一个方法

创建HelloService类

package com.zhouym.mystarter;

/**
 * 〈〉
 *
 * @author zhouym
 * @create 2019/8/6
 * @since 1.0.0
 */
public class HelloService {

    private String name;
    private String msg;

    public String sayHello(){
        return name + " say " + msg + "!";
    }
    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public String getMsg() {
        return msg;
    }

    public void setMsg(String msg) {
        this.msg = msg;
    }

}

后面调用这个类中的sayhello方法，进行打印
接下来就是要定义我们的自动化配置类HelloServiceAutoConfiguration了

创建自动化配置类

package com.zhouym.mystarter;


import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

/**
 * 〈〉
 *
 * @author zhouym
 * @create 2019/8/6
 * @since 1.0.0
 */
@Configuration
@EnableConfigurationProperties(MyStarterProperties.class)
@ConditionalOnClass(HelloService.class)
public class HelloServiceAutoConfiguration {

    @Autowired
    MyStarterProperties myStarterProperties;

    @Bean
    HelloService helloService(){
        HelloService helloService = new HelloService();
        helloService.setName(myStarterProperties.getName());
        helloService.setMsg(myStarterProperties.getMsg());
        return helloService;
    }
}

解释一下上面的注解：
@Configuration：表示这是一个配置类
@EnableConfigurationProperties：表示使我们之前配置的@ConfigurationProperties生效，让配置的属性注入到HelloService这个Bean中
@ConditionalOnClass：表示这是一个条件注解，当项目的classpath下存在HelloService时，后面的配置才会生效，实际也是利用了反射，获取类信息
自动配置类中首先注入MyStarterProperties ，这个实例中含有我们在 application.properties 中配置的相关数据。
提供一个 HelloService 的实例，将 HelloProperties 中的值注入进去。

以上配置类完成，但是我们会任意打开一个框架的starter发现如下，这个spring.factories文件

我们知道 Spring Boot 项目的启动类都有一个 @SpringBootApplication 注解，注解源码如下：

@SpringBootConfiguration
@EnableAutoConfiguration
@ComponentScan(excludeFilters = {
		@Filter(type = FilterType.CUSTOM, classes = TypeExcludeFilter.class),
		@Filter(type = FilterType.CUSTOM,
				classes = AutoConfigurationExcludeFilter.class) })
public @interface SpringBootApplication {
}

@EnableAutoConfiguration 表示启用 Spring 应用程序上下文的自动配置，该注解会自动导入一个名为 AutoConfigurationImportSelector 的类,而这个类会去读取一个名为 spring.factories 的文件, spring.factories 中则定义需要加载的自动化配置类

所以需要我们在resources目录下创建一个META-INF的文件夹，创建一个spring.factories文件

文件内容：

org.springframework.boot.autoconfigure.EnableAutoConfiguration=com.zhouym.mystarter.HelloServiceAutoConfiguration

定位到你的自动化配置类全路径名
此时我们自定义的starter就完后了，在idea中选择install上传到本地仓库或者私服都可以，我这里就上传到本地仓库了

完成后我们就可以在别的项目引入这个依赖包，就可以使用我们自定义的starter了

使用自定义的starter

创建普通的spring boot项目，在pom文件中导入我们自定义的starter依赖

<dependency>
	<groupId>com.zhouym</groupId>
	<artifactId>starterdemo</artifactId>
	<version>1.0-SNAPSHOT</version>
</dependency>

我们在application.properties文件中配置内容

zhouym.name=boy
zhouym.msg=hello

我们在测试类中进行测试

package com.zhouym.starterexam;

import com.zhouym.mystarter.HelloService;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.junit4.SpringRunner;

@RunWith(SpringRunner.class)
@SpringBootTest
public class StarterexamApplicationTests {

    @Autowired
    HelloService helloService;
    @Test
    public void contextLoads() {
        String msg = helloService.sayHello();
        System.out.println(msg);
    }

}

来看看输出结果