摘要：先來(lái)看代碼吧，一會(huì)松哥再慢慢解釋關(guān)于這一段自動(dòng)配置，解釋如下首先注解表明這是一個(gè)配置類(lèi)。本文的案例，松哥已經(jīng)上傳到上了，地址。

我們使用 Spring Boot，基本上都是沉醉在它 Stater 的方便之中。Starter 為我們帶來(lái)了眾多的自動(dòng)化配置，有了這些自動(dòng)化配置，我們可以不費(fèi)吹灰之力就能搭建一個(gè)生產(chǎn)級(jí)開(kāi)發(fā)環(huán)境，有的小伙伴會(huì)覺(jué)得這個(gè) Starter 好神奇呀！其實(shí) Starter 也都是 Spring + SpringMVC 中的基礎(chǔ)知識(shí)點(diǎn)實(shí)現(xiàn)的，今天松哥就來(lái)帶大家自己來(lái)擼一個(gè) Starter ，慢慢揭開(kāi) Starter 的神秘面紗！

核心知識(shí)

其實(shí) Starter 的核心就是條件注解 @Conditional ，當(dāng) classpath 下存在某一個(gè) Class 時(shí)，某個(gè)配置才會(huì)生效，前面松哥已經(jīng)帶大家學(xué)習(xí)過(guò)不少 Spring Boot 中的知識(shí)點(diǎn)，有的也涉及到源碼解讀，大伙可能也發(fā)現(xiàn)了源碼解讀時(shí)總是會(huì)出現(xiàn)條件注解，其實(shí)這就是 Starter 配置的核心之一，大伙有興趣可以翻翻歷史記錄，看看松哥之前寫(xiě)的關(guān)于 Spring Boot 的文章，這里我就不再重復(fù)介紹了。

定義自己的 Starter

定義

所謂的 Starter ，其實(shí)就是一個(gè)普通的 Maven 項(xiàng)目，因此我們自定義 Starter ，需要首先創(chuàng)建一個(gè)普通的 Maven 項(xiàng)目，創(chuàng)建完成后，添加 Starter 的自動(dòng)化配置類(lèi)即可，如下：

    org.springframework.boot
    spring-boot-autoconfigure
    2.1.4.RELEASE

配置完成后，我們首先創(chuàng)建一個(gè) HelloProperties 類(lèi)，用來(lái)接受 application.properties 中注入的值，如下：

@ConfigurationProperties(prefix = "javaboy")
public class HelloProperties {
    private static final String DEFAULT_NAME = "江南一點(diǎn)雨";
    private static final String DEFAULT_MSG = "牧碼小子";
    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;
    }
}

這個(gè)配置類(lèi)很好理解，將 application.properties 中配置的屬性值直接注入到這個(gè)實(shí)例中， @ConfigurationProperties 類(lèi)型安全的屬性注入，即將 application.properties 文件中前綴為 javaboy 的屬性注入到這個(gè)類(lèi)對(duì)應(yīng)的屬性上， 最后使用時(shí)候，application.properties 中的配置文件，大概如下：

javaboy.name=zhangsan
javaboy.msg=java

關(guān)注類(lèi)型安全的屬性注入，讀者可以參考松哥之前的這篇文章：Spring Boot中的yaml配置簡(jiǎn)介，這篇文章雖然是講 yaml 配置，但是關(guān)于類(lèi)型安全的屬性注入和 properties 是一樣的。

配置完成 HelloProperties 后，接下來(lái)我們來(lái)定義一個(gè) HelloService ，然后定義一個(gè)簡(jiǎn)單的 say 方法， HelloService 的定義如下：

public class HelloService {
    private String msg;
    private String name;
    public String sayHello() {
        return name + " say " + msg + " !";
    }
    public String getMsg() {
        return msg;
    }
    public void setMsg(String msg) {
        this.msg = msg;
    }
    public String getName() {
        return name;
    }
    public void setName(String name) {
        this.name = name;
    }
}

這個(gè)很簡(jiǎn)單，沒(méi)啥好說(shuō)的。

接下來(lái)就是我們的重軸戲，自動(dòng)配置類(lèi)的定義，用了很多別人定義的自定義類(lèi)之后，我們也來(lái)自己定義一個(gè)自定義類(lèi)。先來(lái)看代碼吧，一會(huì)松哥再慢慢解釋：

@Configuration
@EnableConfigurationProperties(HelloProperties.class)
@ConditionalOnClass(HelloService.class)
public class HelloServiceAutoConfiguration {
    @Autowired
    HelloProperties helloProperties;

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

關(guān)于這一段自動(dòng)配置，解釋如下：

首先 @Configuration 注解表明這是一個(gè)配置類(lèi)。

@EnableConfigurationProperties 注解是使我們之前配置的 @ConfigurationProperties 生效，讓配置的屬性成功的進(jìn)入 Bean 中。

@ConditionalOnClass 表示當(dāng)項(xiàng)目當(dāng)前 classpath 下存在 HelloService 時(shí)，后面的配置才生效。

自動(dòng)配置類(lèi)中首先注入 HelloProperties ，這個(gè)實(shí)例中含有我們?cè)?application.properties 中配置的相關(guān)數(shù)據(jù)。

提供一個(gè) HelloService 的實(shí)例，將 HelloProperties 中的值注入進(jìn)去。

做完這一步之后，我們的自動(dòng)化配置類(lèi)就算是完成了，接下來(lái)還需要一個(gè) spring.factories 文件，那么這個(gè)文件是干嘛的呢？大家知道我們的 Spring Boot 項(xiàng)目的啟動(dòng)類(lèi)都有一個(gè) @SpringBootApplication 注解，這個(gè)注解的定義如下：

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

大家看到這是一個(gè)組合注解，其中的一個(gè)組合項(xiàng)就是 @EnableAutoConfiguration ，這個(gè)注解是干嘛的呢？

@EnableAutoConfiguration 表示啟用 Spring 應(yīng)用程序上下文的自動(dòng)配置，該注解會(huì)自動(dòng)導(dǎo)入一個(gè)名為 AutoConfigurationImportSelector 的類(lèi),而這個(gè)類(lèi)會(huì)去讀取一個(gè)名為 spring.factories 的文件, spring.factories 中則定義需要加載的自動(dòng)化配置類(lèi)，我們打開(kāi)任意一個(gè)框架的 Starter ，都能看到它有一個(gè) spring.factories 文件，例如 MyBatis 的 Starter 如下：

那么我們自定義 Starter 當(dāng)然也需要這樣一個(gè)文件，我們首先在 Maven 項(xiàng)目的 resources 目錄下創(chuàng)建一個(gè)名為 META-INF 的文件夾，然后在文件夾中創(chuàng)建一個(gè)名為 spring.factories 的文件，文件內(nèi)容如下：

org.springframework.boot.autoconfigure.EnableAutoConfiguration=org.javaboy.mystarter.HelloServiceAutoConfiguration

在這里指定我們的自動(dòng)化配置類(lèi)的路徑即可。

如此之后我們的自動(dòng)化配置類(lèi)就算完成了。

本地安裝

如果在公司里，大伙可能需要將剛剛寫(xiě)好的自動(dòng)化配置類(lèi)打包，然后上傳到 Maven 私服上，供其他同事下載使用，我這里就簡(jiǎn)單一些，我就不上傳私服了，我將這個(gè)自動(dòng)化配置類(lèi)安裝到本地倉(cāng)庫(kù)，然后在其他項(xiàng)目中使用即可。安裝方式很簡(jiǎn)單，在 IntelliJ IDEA 中，點(diǎn)擊右邊的 Maven Project ，然后選擇 Lifecycle 中的 install ，雙擊即可，如下：

雙擊完成后，這個(gè) Starter 就安裝到我們本地倉(cāng)庫(kù)了，當(dāng)然小伙伴也可以使用 Maven 命令去安裝。

使用 Starter

接下來(lái)，我們來(lái)新建一個(gè)普通的 Spring Boot 工程，這個(gè) Spring Boot 創(chuàng)建成功之后，加入我們自定義 Starter 的依賴，如下：

    org.javaboy
    mystarter
    1.0-SNAPSHOT

此時(shí)我們引入了上面自定義的 Starter ，也即我們項(xiàng)目中現(xiàn)在有一個(gè)默認(rèn)的 HelloService 實(shí)例可以使用，而且關(guān)于這個(gè)實(shí)例的數(shù)據(jù)，我們還可以在 application.properties 中進(jìn)行配置，如下：

javaboy.name=牧碼小子
javaboy.msg=java

配置完成后，方便起見(jiàn)，我這里直接在單元測(cè)試方法中注入 HelloSerivce 實(shí)例來(lái)使用，代碼如下：

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

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

執(zhí)行單元測(cè)試方法，打印日志如下：

好了，一個(gè)簡(jiǎn)單的自動(dòng)化配置類(lèi)我們就算完成了，是不是很簡(jiǎn)單！

總結(jié)

本文主要帶領(lǐng)小伙伴自己徒手?jǐn)]一個(gè) Starter ，使用這種方式幫助大家揭開(kāi) Starter 的神秘面紗！大伙有問(wèn)題可以留言討論。

本文的案例，松哥已經(jīng)上傳到 GitHub上了，地址：github.com/lenve/javab… 。

關(guān)注公眾號(hào)牧碼小子，專注于 Spring Boot+微服務(wù)，定期視頻教程分享，關(guān)注后回復(fù) Java ，領(lǐng)取松哥為你精心準(zhǔn)備的 Java 干貨！