快捷導(dǎo)航

詳解Spring Boot配置排序依賴(lài)技巧

更新時(shí)間：2017年11月04日 15:36:51 作者：isea533

本篇文章主要介紹了Spring Boot配置排序依賴(lài)技巧，小編覺(jué)得挺不錯(cuò)的，現(xiàn)在分享給大家，也給大家做個(gè)參考。一起跟隨小編過(guò)來(lái)看看吧

本文主要介紹了Spring Boot配置排序依賴(lài)技巧，分享給大家，具體如下：

Spring Boot - 被錯(cuò)誤使用的注解

我自己曾經(jīng)在 Spring Boot 中集成通用 Mapper 時(shí)，寫(xiě)過(guò)下面的代碼：

@Configuration
@AutoConfigureAfter(MyBatisConfig.class)
public class MyBatisMapperScannerConfig {
//其他
}

這種用法我參考的 mybatis-spring-boot-starter。

由于在我自己這個(gè)例子中可以良好的運(yùn)行，因此我以為 @AutoConfigureAfter 真正起作用了，否則怎么不報(bào)錯(cuò)呢。但是在很長(zhǎng)一段時(shí)間內(nèi)，好多人參考這種用法時(shí)經(jīng)常報(bào)錯(cuò)，這個(gè)配置沒(méi)有起到應(yīng)有的作用。我還一直以為他們用的不對(duì)。

直到昨天我開(kāi)始寫(xiě)自己的 pagehelper-spring-boot-starter 時(shí)，我才發(fā)現(xiàn)，我自己一直以來(lái)都用錯(cuò)了。在我自己例子中，之所以能行，完全是靠運(yùn)氣。

Spring Boot 提供了很多新的注解，但是要注意這個(gè)包下面的所有注解：

org.springframework.boot.autoconfigure

這個(gè)包下面常見(jiàn)的注解有：

@AutoConfigureAfter
@AutoConfigureBefore
@AutoConfigureOrder
@AutoConfigurationPackage
@EnableAutoConfiguration
@SpringBootApplication

前 3 個(gè)是不能在普通項(xiàng)目中使用的，這 3 個(gè)注解是特地用于 autoconfigure 類(lèi)的項(xiàng)目，后面 3 個(gè)注解是可以用于我們自己項(xiàng)目中的。

autoconfigure 類(lèi)項(xiàng)目

Spring Boot Starter 提供了規(guī)范可以讓開(kāi)發(fā)者提供自己的 starter，例如 Spring 官方提供的：

spring-boot-starter
spring-boot-starter-activemq
spring-boot-starter-cache
等等…

還有很多開(kāi)源項(xiàng)目或公司提供的：

modelmapper-spring-boot-starter
hajdbc-spring-boot-starter
camel-spring-boot-starter
mybatis-spring-boot-starter
等等…

在 Spring Boot starter 開(kāi)發(fā)規(guī)范中，項(xiàng)目中會(huì)有一個(gè)空的名為 xxx-spring-boot-starter 的項(xiàng)目，這個(gè)項(xiàng)目主要靠 pom.xml 將所有需要的依賴(lài)引入進(jìn)來(lái)。同時(shí)項(xiàng)目還會(huì)有一個(gè) xxx-spring-boot-autoconfigure 項(xiàng)目，這個(gè)項(xiàng)目主要寫(xiě)帶 @Configuration 注解的配置類(lèi)，在這個(gè)類(lèi)或者類(lèi)中帶 @Bean 的方法上，可以使用和順序有關(guān)的注解，也就是前面提到的自己不能使用的這部分注解。xxx-spring-boot-autoconfigure 就是這里提到的 autoconfigure 類(lèi)項(xiàng)目。

上面的注解只在 AutoConfigurationSorter 類(lèi)中排序時(shí)用到了。被排序的這些類(lèi)，都是通過(guò) xxx-spring-boot-autoconfigure 項(xiàng)目中的 src/resources/META-INF/spring.factories 配置文件獲取的，這個(gè)文件中的配置內(nèi)容一般為：

# Auto Configure
org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
com.github.pagehelper.autoconfigure.PageHelperAutoConfiguration

Spring Boot 只會(huì)對(duì)從這個(gè)文件讀取的配置類(lèi)進(jìn)行排序。

但是你不要以為將自己的配置類(lèi)也配置在 spring.factories 中就能實(shí)現(xiàn)排序，如果你的類(lèi)被自己 Spring Boot 啟動(dòng)類(lèi)掃描到了，這個(gè)類(lèi)的順序會(huì)優(yōu)先于所有通過(guò) spring.factories 讀取的配置類(lèi)。所以當(dāng)你的配置類(lèi)對(duì)順序有要求時(shí)就會(huì)出錯(cuò)。

通過(guò) spring.factories 巧妙使用排序

如果你將自己的配置類(lèi)放到特別的包下，不使用 Spring Boot 啟動(dòng)類(lèi)掃描。完全通過(guò) spring.factories 讀取配置就可以實(shí)現(xiàn)這個(gè)目的。例如下圖的用法：