為什么選擇starter同時兼容spring boot 1和spring boot 2
- 從用戶角度來看
如果不在一個starter里兼容俗孝，比如用版本號來區(qū)分，spring boot 1的用戶使用1.浮声，spring boot 2用戶使用2.虚婿，這樣用戶升級會有很大困擾。
另外泳挥，我們的starter是以日期為版本號的然痊，如果再分化，則就會出現(xiàn)2018-06-stable-boot1羡洁，2018-06-stable-boot2玷过，這樣子很丑陋爽丹。
- 從開發(fā)者角度來看
要同時維護兩個分支筑煮，修改代碼時要合到兩個分支上辛蚊，發(fā)版本時要同時兩個。如果有統(tǒng)一的bom文件真仲，也需要維護兩份袋马。工作量翻倍，而且很容易出錯秸应。
因此虑凛，我們決定在同一個代碼分支里，同時支持spring boot 1/2软啼。減少開發(fā)維護成本桑谍，減少用戶使用困擾。
編寫兼容的starter的難點
spring boot starter的代碼入口都是在各種@Configuration類里祸挪，這為我們編寫兼容starter提供了條件锣披。
但還是有一些難點：
- 某些類不兼容，比如在spring boot 2里刪除掉了
- 代碼模塊贿条，maven依賴怎樣組織
- 怎樣保證starter在spring boot 1/2里都能正常工作
通過ASM分析現(xiàn)有的starter里不兼容的類
springboot-classchecker可以從jar包里掃描出哪些類在spring boot 2里不存在的雹仿。
工作原理：springboot-classchecker自身在pom.xml里依賴的是spring boot 2，掃描jar包里通過ASM分析到所有的String整以，提取出類名之后胧辽，再嘗試在ClassLoader里加載，如果加載不到公黑，則說明這個類在spring boot 2里不存在邑商。
例如掃描demo-springboot1-starter.jar：
mvn clean package
java -jar target/classchecker-0.0.1-SNAPSHOT.jar demo-springboot1-starter.jar
結果是：
path: demo-springboot1-starter.jar
org.springframework.boot.actuate.autoconfigure.ConditionalOnEnabledHealthIndicator
org.springframework.boot.actuate.autoconfigure.EndpointAutoConfiguration
org.springframework.boot.actuate.autoconfigure.HealthIndicatorAutoConfiguration
那么這些類在spring boot 2在哪里了？
實際上是改了package：
org.springframework.boot.actuate.autoconfigure.health.ConditionalOnEnabledHealthIndicator
org.springframework.boot.actuate.autoconfigure.endpoint.EndpointAutoConfiguration
org.springframework.boot.actuate.autoconfigure.health.HealthIndicatorAutoConfiguration
通過掃描20多個starter jar包帆调，發(fā)現(xiàn)不兼容的類有：
- org.springframework.boot.env.PropertySourcesLoader
- org.springframework.boot.autoconfigure.jdbc.DataSourceBuilder
- org.springframework.boot.bind.RelaxedDataBinder
- Endpoint/HealthIndicator 相關的類
可以總結：
- spring boot核心的類奠骄，autoconfigure相關的沒有改動
- 大部分修改的是Endpoint/HealthIndicator 相關的類
spring-boot-utils兼容工具類
BinderUtils
在spring boot 1里，注入環(huán)境變量有時需要用到RelaxedDataBinder：
MyProperties myProperties = new MyProperties();
MutablePropertySources propertySources = environment.getPropertySources();
new RelaxedDataBinder(myProperties, "spring.my").bind(new PropertySourcesPropertyValues(propertySources));
在spring boot 2里番刊，RelaxedDataBinder刪除掉了含鳞，新的寫法是用Binder：
Binder binder = Binder.get(environment);
MyProperties myProperties = binder.bind("spring.my", MyProperties.class).get();
通過BinderUtils，則可以同時支持spring boot1/2：
MyProperties myProperties = BinderUtils.bind(environment, "spring.my", MyProperties.class);
Starter代碼模塊組織
下面以實際的一個starter來說明芹务。
spring boot web應用的mappings信息蝉绷，可以在/mappings endpoint查詢到。但是這么多endpoint枣抱，它們都提供了哪些url熔吗？
endpoints-spring-boot-starter的功能是展示所有endpoints的url mappings信息
endpoints-spring-boot-starter里需要給spring boot 1/2同時提供endpoint功能，代碼模塊如下：
endpoints-spring-boot-starter
|__ endpoints-spring-boot-autoconfigure1
|__ endpoints-spring-boot-autoconfigure2
- endpoints-spring-boot-autoconfigure1模塊在pom.xml里依賴的是spring boot 1相關的jar佳晶，并且都設置為<optional>true</optional>
- endpoints-spring-boot-autoconfigure2的配置類似
- endpoints-spring-boot-starter依賴autoconfigure1 和 autoconfigure2
- 如果有公共的邏輯桅狠，可以增加一個commons模塊
Endpoint兼容
以endpoints-spring-boot-autoconfigure1模塊為例說明怎樣處理。
- EndPointsEndPoint類繼承自spring boot 1的AbstractMvcEndpoint：
@ConfigurationProperties("endpoints.endpoints")
public class EndPointsEndPoint extends AbstractMvcEndpoint {
- 通過@ManagementContextConfiguration引入
@ManagementContextConfiguration
public class EndPointsEndPointManagementContextConfiguration {
@Bean
@ConditionalOnMissingBean
@ConditionalOnEnabledEndpoint("endpoints")
public EndPointsEndPoint EndPointsEndPoint() {
EndPointsEndPoint endPointsEndPoint = new EndPointsEndPoint();
return endPointsEndPoint;
}
}
- 在META-INF/resources/spring.factories里配置
org.springframework.boot.actuate.autoconfigure.ManagementContextConfiguration=\
io.github.hengyunabc.endpoints.autoconfigure1.EndPointsEndPointManagementContextConfiguration
因為org.springframework.boot.actuate.autoconfigure.ManagementContextConfiguration是只在spring boot 1里，在spring boot 2的應用里不會加載它中跌，所以autoconfigure1模塊天然兼容spring boot 2咨堤。
那么類似的，autoconfigure2模塊里在**META-INF/resources/spring.factories**配置的是
org.springframework.boot.actuate.autoconfigure.web.ManagementContextConfiguration=\
io.github.hengyunabc.endpoints.autoconfigure2.ManagementApplicationcontextHolderConfiguration
仔細對比漩符，可以發(fā)現(xiàn)是spring boot 2下面修改了ManagementContextConfiguration的包名一喘，所以對于Endpoint天然是兼容的，不同的模塊自己編繹就可以了嗜暴。
HealthIndicator的兼容
類似Endpoint的處理凸克，spring boot 1/2的代碼分別放不同的autoconfigure模塊里，然后各自的@Configuration類分別使用@ConditionalOnSpringBoot1/@ConditionalOnSpringBoot2來判斷闷沥。
通過集成測試保證兼容性
還是以endpoints-spring-boot-autoconfigure1模塊為例萎战。
這個模塊是為spring boot 1準備的，則它的集成測試要配置為spring boot 2舆逃。
參考相關的代碼：查看
- 在springboot2demo/pom.xml里依賴spring boot 2
- 在verify.groovy里檢測應用是否啟動成功
總結
- 通過ASM分析現(xiàn)有的starter里不兼容的類
- 配置注入通過BinderUtils解決
- 各自的@Configuration類分別用@ConditionalOnSpringBoot1/@ConditionalOnSpringBoot2來判斷
- 代碼分模塊：commons放公共邏輯, autoconfigure1/autoconfigure2 對應 spring boot 1/2的自動裝配撞鹉，starter給應用依賴
- Endpoint的Configuration入口是ManagementContextConfiguration，因為spring boot 2里修改了package颖侄，所以直接在spring.factories里配置即可
- 通過集成測試保證兼容性
- 如果某一天鸟雏，不再需要支持spring boot 1了，則直接把autoconfigure1模塊去掉即可
