javascript
一个项目有两个pom_实现一个Spring Boot Starter超简单，读 Starter 源码也不在话下...
Spring Boot 對比 Spring MVC 最大的優點就是使用簡單，約定大于配置。不會像之前用 Spring MVC 的時候，時不時被 xml 配置文件搞的暈頭轉向，冷不防還因為 xml 配置上的一點疏忽，導致整個項目莫名其妙的不可用，頓感生活無所依戀，簡稱生無可戀。
這要歸功于組成了 Spring Boot 的各種各樣的 starters，有官方提供的，也有第三方開源出來。可以這么說，基本上你打算用的功能都可以找到，如果沒有找到，那就再找一找。
用 Spring Boot 的功能組件（例如 spring-boot-starter-actuator、 spring-boot-starter-data-redis 等）的步驟非常簡單，用著名的把大象放冰箱的方法來概括的話，有以下三步就可以完成組件功能的使用：
STEP 1
在 pom 文件中引入對應的包，例如：
<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-actuator</artifactId> </dependency> 復制代碼STEP 2
在應用配置文件中加入相應的配置，配置都是組件約定好的，需要查看官方文檔或者相關說明。有些比較復雜的組件，對應的參數和規則也相應的較多，有點可能多大幾十上百了。
STEP 3
以上兩步都正常的情況下，我們就可以使用組件提供的相關接口來開發業務功能了。
沒錯吧，這個過程我們在日常的開發中不知道已經實踐了多少遍。那么 Spring Boot 為什么能做到如此簡單易用呢，它內部是什么樣的工作機制呢，不知道你有沒有研究過。
以下是為了理解 Spring Boot 組件的實現機制而制作的一個 demo starter。理解其中的原理，對我們日后的工作有什么意義呢？
開始實現一個 Spring Boot Starter
下面我們來實現這個簡單的 starter，這個 starter 并沒有什么實際的功能，只是為了做個演示而已。
開始之前，我們要理解一下 spring boot starter 是什么呢？
實際上 starter 并不會包含多少功能代碼，我們可以把它理解成一個「連接包」(我自己造的概念)，按照這個概念來說：它首先是一個包，一個集合，它把需要用的其他功能組件囊括進來，放到自己的 pom 文件中。
然后它是一個連接，把它引入的組件和我們的項目做一個連接，并且在中間幫我們省去復雜的配置，力圖做到使用最簡單。
實現一個 starter 有四個要素：
好了，開始實現我們的 demo
1. 給 starter 起個名字
也就是我們使用它的時候在 pom 中引用的 artifactId。命名有有規則的，官方規定：
官方的 starter 的命名格式為 spring-boot-starter-{name} ，例如上面提到的 spring-boot-starter-actuator。
非官方的 starter 的命名格式為 {name}-spring-boot-starter，我們把自定的 starter 命名為 kite-spring-boot-starter，命名在 pom 文件里。
<groupId>kite.springcloud</groupId> <artifactId>kite-spring-boot-starter</artifactId> <packaging>jar</packaging> <version>1.0-SNAPSHOT</version> 復制代碼2. 引入自動配置包及其它相關依賴包
實現 starter 主要依賴自動配置注解，所以要在 pom 中引入自動配置相關的兩個 jar 包
<dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-configuration-processor</artifactId> </dependency> <dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-autoconfigure</artifactId> </dependency> 復制代碼除此之外，依賴的其他包當然也要引進來。
3. 創建 spring.factories 文件
在 resource/META-INF 目錄下創建名稱為 spring.factories 的文件，為什么在這里？當 Spring Boot 啟動的時候，會在 classpath 下尋找所有名稱為 spring.factories 的文件，然后運行里面的配置指定的自動加載類，將指定類(一個或多個)中的相關 bean 初始化。
例如本例中的配置信息是這樣的：
org.springframework.boot.autoconfigure.EnableAutoConfiguration=kite.springcloud.boot.starter.example.KiteAutoConfigure 復制代碼等號前面是固定的寫法，后面就是我們自定義的自動配置類了，如果有多個的話，用英文逗號分隔開。
4. 編寫自動配置類
自動配置類是用來初始化 starter 中的相關 bean 的。可以說是實現 starter 最核心的功能。
@Configuration @ConditionalOnClass(KiteService.class) @EnableConfigurationProperties(KiteProperties.class) @Slf4j public class KiteAutoConfigure {@Autowiredprivate KiteProperties kiteProperties;@Bean@ConditionalOnMissingBean(KiteService.class)@ConditionalOnProperty(prefix = "kite.example",value = "enabled", havingValue = "true")KiteService kiteService(){return new KiteService(kiteProperties);} } 復制代碼代碼非常簡單，放眼望去，最多的就是各種注解。
@Configuration 這個不用解釋，表示這是個自動配置類，我們平時做項目時也會用到，一般是用作讀取配置文件的時候。
@ConditionalOnClass(KiteService.class) ：
只有在 classpath 中找到 KiteService 類的情況下，才會解析此自動配置類，否則不解析。
@EnableConfigurationProperties(KiteProperties.class)：
啟用配置類。
@Bean：實例化一個 bean 。
@ConditionalOnMissingBean(KiteService.class)：
與 @Bean 配合使用，只有在當前上下文中不存在某個 bean 的情況下才會執行所注解的代碼塊，也就是當前上下文還沒有 KiteService 的 bean 實例的情況下，才會執行 kiteService() 方法，從而實例化一個 bean 實例出來。
@ConditionalOnProperty：
當應用配置文件中有相關的配置才會執行其所注解的代碼塊。
這個類的整體含義就是: 當 classpath 中存在 KiteService 類時解析此配置類，什么情況下才會在 classpath 中存在呢，就是項目引用了相關的 jar 包。并且在上下文中沒有 KiteService 的 bean 實例的情況下，new 一個實例出來，并且將應用配置中的相關配置值傳入。
5. 實現屬性配置類
@Data @ConfigurationProperties("kite.example") public class KiteProperties {private String host;private int port; } 復制代碼配置類很簡單，只有兩個屬性，一個 host ，一個 port 。配置參數以 kite.example 作為前綴。稍后我們在使用這個 starter 的時候會看到如何聲明配置屬性。
6. 實現相關功能類
也就是前面一直提到的 KiteService，其實嚴格來講，這個業務功能類不應該放在 starter 中，應該放在單獨的 jar 包里，但是此處 demo 非常簡單，也就在這里寫了。
@Slf4j public class KiteService {private String host;private int port;public KiteService(KiteProperties kiteProperties){this.host = kiteProperties.getHost();this.port = kiteProperties.getPort();}public void print(){log.info(this.host + ":" +this.port);} } 復制代碼一個構造函數和一個 print 方法。
7. 打包
通過 maven 命令將這個 starter 安裝到本地 maven 倉庫
mvn install 復制代碼也可以通過 mvn package deploy 發布到你的私服
或者發布到中央倉庫。
使用剛創建的 starter
上面已經完成了 starter 的開發，并安裝到了本地倉庫，然后就是在我們的項目中使用它了。
1. 創建項目，在 pom 中引用
<dependency><groupId>kite.springcloud</groupId><artifactId>kite-spring-boot-starter</artifactId><version>1.0-SNAPSHOT</version> </dependency> 復制代碼2. 應用配置項
創建 application.yml ，配置如下:
server:port: 3801 kite:example:enabled: true # 開啟才生效host: 127.0.0.1port: 3801 復制代碼3. 調用 KiteService 的服務方法
@RestController @RequestMapping(value = "use") public class UseController {@Autowiredprivate KiteService kiteService;@GetMapping(value = "print")public void print(){kiteService.print();} } 復制代碼4. 啟動服務，并訪問接口
訪問 /use/print 接口，會發現在日志中打印出了配置信息
2019-05-24 16:45:04.234 INFO 36687 --- [nio-3801-exec-1] k.s.boot.starter.example.KiteService : 127.0.0.1:3801 復制代碼拋磚引玉，如何閱讀其他 starter 源碼
順著上面的思路，我們來看一下官方的 starters 的結構。先來把 Spring Boot 從 github 上 clone 一份下來。用 idea 打開，可以看到項目結構如下
Spring-boot-starters 中就是官方提供的主要 starters，比如 jdbc、redis、security、web 等等。
我們拿 spring-boot-starter-data-redis 這個 starter 作為例子，來說一說官方是怎么組織項目結構的，以及閱讀源碼的順序應該是怎樣的。
1. 展開 Spring-boot-staters 下的 redis starter，我們看到目錄結構如下
其中并沒有 Java 代碼，只有一個 spring.provides 文件，里面的內容如下：
provides: spring-data-redis,lettuce-core 復制代碼意思就是說，本項目依賴 spring-data-redis 和 lettuce-core 這兩個包，并且在 pom 文件中引用了。其目的就是告知使用者在引用此包的時候，不必再引用 provides 中的依賴包了。
2. 然后就是自動注解了，所有 stater 的自動注解類、屬性配置類都放到了 spring-boot-autoconfigure 這個項目下
看到熟悉的 spring.factories 沒有，前面我們自己實現過。這個內容比較多，我們只看 redis 相關的
org.springframework.boot.autoconfigure.data.redis.RedisAutoConfiguration, org.springframework.boot.autoconfigure.data.redis.RedisReactiveAutoConfiguration, org.springframework.boot.autoconfigure.data.redis.RedisRepositoriesAutoConfiguration 復制代碼包含三個自動配置文件，然后順著配置，我們找到所在 package
然后就可以開始閱讀代碼了。其他的 starter 也是同樣的結構。
壯士且慢，先給點個贊吧，總是被白嫖，身體吃不消！
總結
以上是生活随笔為你收集整理的一个项目有两个pom_实现一个Spring Boot Starter超简单，读 Starter 源码也不在话下...的全部內容，希望文章能夠幫你解決所遇到的問題。
- 上一篇： java rsa加密解密_前端实现对请求
- 下一篇： sql跨表查询_跨表查询经常有，何为跨表