建站
咨詢
售后
建站咨詢
新聞中心
我們在使用 Spring Boot 的過程中，往往都是在pom.xml里加了一系列的依賴，然后啟支一個包含main方法的Application，一切就OK啦。給你我的感覺，就像是自己要動手做個菜，自己不再需要準備每一部分的原材料，直接購買包裝好的一份菜的原料，下鍋即可。
東風網(wǎng)站制作公司哪家好，找創(chuàng)新互聯(lián)公司！從網(wǎng)頁設(shè)計、網(wǎng)站建設(shè)、微信開發(fā)、APP開發(fā)、響應(yīng)式網(wǎng)站開發(fā)等網(wǎng)站項目制作，到程序開發(fā)，運營維護。創(chuàng)新互聯(lián)公司于2013年創(chuàng)立到現(xiàn)在10年的時間，我們擁有了豐富的建站經(jīng)驗和運維經(jīng)驗，來保證我們的工作的順利進行。專注于網(wǎng)站建設(shè)就選創(chuàng)新互聯(lián)公司。
那我們詳細看下，這份「包裝好」的原料中，到底做了些什么。
添加Starter依賴
這里添加的依賴，除了我們之前在Maven中熟悉的之外，還有一些都是長這個樣子：
名為xxx-starter，比如
org.springframework.boot spring-boot-starter-web org.mybatis.spring.boot mybatis-spring-boot-starter 1.3.2
具體這些starter是怎么起作用的呢，他們什么時候開始工作的?
一切都要從入口處說起。我們以上面的starter為例，看到這個mybatis的starter，其對應(yīng)的pom中，包含這些依賴
org.springframework.boot spring-boot-starter org.springframework.boot spring-boot-starter-jdbc org.mybatis.spring.boot mybatis-spring-boot-autoconfigure org.mybatis mybatis org.mybatis mybatis-spring
我們看到，相當于我們添加了一個Starter的依賴，其背后會引入許多其定義的其他依賴，通過 Maven 的傳遞依賴，這些都會被自動添加了進來。
自動配置
相比傳統(tǒng)的依賴，我們看到其中包含這樣一個：mybatis-spring-boot-autoconfigure，這也是每個Starter的秘密所在：「AutoConfigure」
它會在實現(xiàn)時，考慮應(yīng)用中的其他部分因素，「推斷」你所需要的 Spring 配置。
在Spring Boot中，我們***的感受是配置仿佛都被做好了，直接使用即可，這就是
spring-boot-autoconfigure. 每個starter都有一個名為spring.factories
的文件,存放在META-INF目錄下，其中的內(nèi)容類似下面這個樣子：
- # Auto Configure
- org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
- org.mybatis.spring.boot.autoconfigure.MybatisAutoConfiguration
所有需要自動配置的Class,都需要配置成key是EnableAutoConfiguration的。
我們來看類的內(nèi)部
- @Configuration
- @ConditionalOnClass({SqlSessionFactory.class, SqlSessionFactoryBean.class})
- @ConditionalOnBean({DataSource.class})
- @EnableConfigurationProperties({MybatisProperties.class})
- @AutoConfigureAfter({DataSourceAutoConfiguration.class})
- public class MybatisAutoConfiguration {
Class 之上， 有不少注解來標識，有幾點需要關(guān)注的：
- 其中有標準的 Spring 配置注解 @Configuration
- 幾個@ConditionalXX
- 標識執(zhí)行順序的@AutoConfigureAfter
其中，@ConditionalOnClass 標識 SqlSessionFactory類存在時，執(zhí)行該配置, @ConditionalOnBean標識DataSource Bean在 Spring Context時，執(zhí)行配置。
這些spring.factories是怎么被識別的呢? 這就得夸下 Spring 的FactoriesLoader了。
看下官方文檔說明
- Auto-configuration classes are regular Spring {@link Configuration} beans. They are located using the {@link SpringFactoriesLoader} mechanism (keyed against this class).
- Generally auto-configuration beans are {@link Conditional @Conditional} beans (most
- often using {@link ConditionalOnClass @ConditionalOnClass} and
- {@link ConditionalOnMissingBean @ConditionalOnMissingBean} annotations).
啟動的時候，根據(jù)ClassLoader中的jar，掃描所有 spring.factories，將其中符合條件的過濾出來，執(zhí)行對應(yīng)的配置。重點可以關(guān)注下
- protected List
getAutoConfigurationImportFilters() { - return SpringFactoriesLoader.loadFactories(AutoConfigurationImportFilter.class,
- this.beanClassLoader);
- }
- AutoConfigurationMetadata autoConfigurationMetadata) {
- long startTime = System.nanoTime();
- String[] candidates = StringUtils.toStringArray(configurations);
- boolean[] skip = new boolean[candidates.length];
- boolean skipped = false;
- for (AutoConfigurationImportFilter filter : getAutoConfigurationImportFilters()) {
- invokeAwareMethods(filter);
- boolean[] match = filter.match(candidates, autoConfigurationMetadata);
- for (int i = 0; i < match.length; i++) {
- if (!match[i]) {
- skip[i] = true;
- skipped = true;
- }
- }
- }
- if (!skipped) {
- return configurations;
- }
- List
result = new ArrayList<>(candidates.length); - for (int i = 0; i < candidates.length; i++) {
- if (!skip[i]) {
- result.add(candidates[i]);
- }
- }
- return new ArrayList<>(result);
- }
- public String[] selectImports(AnnotationMetadata annotationMetadata) {
- if (!isEnabled(annotationMetadata)) {
- return NO_IMPORTS;
- }
- AutoConfigurationMetadata autoConfigurationMetadata = AutoConfigurationMetadataLoader
- .loadMetadata(this.beanClassLoader);
- AnnotationAttributes attributes = getAttributes(annotationMetadata);
- List
configurations = getCandidateConfigurations(annotationMetadata, - attributes);
- configurations = removeDuplicates(configurations);
- Set
exclusions = getExclusions(annotationMetadata, attributes); - checkExcludedClasses(configurations, exclusions);
- configurations.removeAll(exclusions);
- configurations = filter(configurations, autoConfigurationMetadata);
- fireAutoConfigurationImportEvents(configurations, exclusions);
- return StringUtils.toStringArray(configurations);
- }
經(jīng)過這里的執(zhí)行之后， filter方法把符合條件的過濾出來了。
創(chuàng)建自定義Starter
經(jīng)過上面兩步，我們大概知道 Starter的工作原理。有時候，我們需要對外提供一些工具組件時，也想以 Starter 的形式提供出來，供別人使用。步驟也還算清晰，照葫蘆畫瓢。
- 先創(chuàng)建自己的模塊
- 增加需要用到的依賴
- 創(chuàng)建對應(yīng)的 AutoConfiguration類
- 創(chuàng)建META-INF/spring.factories 文件
此時，就不需要再將 Spring Boot 做為 Parent依賴，在單獨的依賴中增加
org.springframework.boot spring-boot-autoconfigure 2.0.6.RELEASE org.springframework.boot spring-boot-starter 2.0.6.RELEASE
AutoConfiguration類也簡單，照上面的創(chuàng)建一個
- @Configuration
- @ConditionalOnClass(HelloService.class)
- public class HelloServiceAutoConfiguration {
然后，增加文件
- org.springframework.boot.autoconfigure.EnableAutoConfiguration=com.example.demo.HelloServiceAutoConfiguration
在需要這個服務(wù)的地方，直接引入依賴就OK啦。
【本文為專欄作者“侯樹成”的原創(chuàng)稿件，轉(zhuǎn)載請通過作者微信公眾號『Tomcat那些事兒』獲取授權(quán)】
分享名稱：如何開發(fā)自己的SpringBootStarter
文章位置：http://www.5511xx.com/article/dhcsjod.html
