前言

前幾個(gè)月和隔壁組的老王閑聊，他說(shuō)項(xiàng)目的供應(yīng)商離職率居高不下，最近還有開(kāi)發(fā)剛接手ESB訂閱發(fā)布接口才兩周就提出離職，而他能做的就只有苦笑和默默地接過(guò)這個(gè)爛攤子了。
而然幸福的家庭總是相似的，而不幸的我卻因業(yè)務(wù)變革走上了和老王一樣的道路。單單是接口的開(kāi)發(fā)居然能迫使一位開(kāi)發(fā)毅然決然地離職，我既不相信是人性的扭曲，更不信是道德的淪喪。
拋開(kāi)這個(gè)富有色彩的故事而言，我發(fā)現(xiàn)原來(lái)的項(xiàng)目存在如下問(wèn)題：

• 有使用任何現(xiàn)代依賴(lài)管理和構(gòu)建工具(如Maven, Gradle)，直接把所依賴(lài)的Jar包存放在項(xiàng)目目錄下的lib目錄中，日積月累導(dǎo)致lib目錄下存放大量無(wú)用Jar包；
• 沒(méi)有使用代碼版本管理工具管理代碼；
• 技術(shù)文檔欠缺，全靠師傅帶徒弟的方式傳授框架使用方式和開(kāi)發(fā)流程；
• 機(jī)械性配置項(xiàng)多，而后來(lái)的開(kāi)發(fā)人員大多只能依葫蘆畫(huà)瓢添加配置，既容易出錯(cuò)同時(shí)又增加問(wèn)題排查的難度。
• 針對(duì)前兩個(gè)問(wèn)題，我們只需梳理出必須的依賴(lài)項(xiàng)并加入Maven或Gradle管理，然后托管到Git即可。
• 而后兩者則可以通過(guò)spring-boot-starter將必選依賴(lài)項(xiàng)和配置統(tǒng)一管理，并附上相關(guān)技術(shù)文檔；然后通過(guò)模板模式和注解簡(jiǎn)化開(kāi)發(fā)流程，提供Demo降低入門(mén)難度。
• 最后就可以把具體的業(yè)務(wù)功能開(kāi)發(fā)交給供應(yīng)商處理，我們專(zhuān)心做好過(guò)程管理和驗(yàn)收即可。

本文將著重分享spring-boot-starter開(kāi)發(fā)的事項(xiàng)，請(qǐng)坐好扶穩(wěn)！

命名規(guī)范

在自定義starter前我們總要思考如何命名我們的starter，而官方提供如下的命名規(guī)范：

1.官方的starter以spring-boot-starter作為前綴命名項(xiàng)目
如：spring-boot-starter-web

2.非官方的則以spring-boot-starter作為后綴命名項(xiàng)目
如：mybatis-spring-boot-starter

項(xiàng)目結(jié)構(gòu)

通過(guò)Spring Initializr或Spring Boot CLI創(chuàng)建項(xiàng)目結(jié)構(gòu)后，將pom.xml的相關(guān)項(xiàng)目修改為如下內(nèi)容

<parent>
 <groupId>org.springframework.boot</groupId>
 <artifactId>spring-boot-starter-parent</artifacId>
 <version>2.3.1.RELEASE</version>
 <relativePath/>
</parent>

<dependencies>
 <dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter</artifactId>
 </dependency>

 <!-- 下面為自定義Starter的依賴(lài)項(xiàng) -->
</dependencies>

<build>
 <plugins>
  <plugin>
   <groupId>org.apache.maven.plugins</groupId>
   <artifactId>maven-compiler-plugin</artifactId>
   <configuration>
	<source>1.8</source>
	<target>1.8</target>
   </configuration>
  </plugin>
  <plugin>
   <groupId>org.apache.maven.plugins</groupId>
   <artifactId>maven-source-plugin</artifactId>
   <version>2.4</version>
   <executions>
	<execution>
	 <goals>
	  <goal>jar</goal>
	 </goals>
	</execution>
   </executions>
  </plugin>
 </plugins>
</build>

在starter中我們會(huì)定義SpringBean的注冊(cè)配置和屬性配置，如ESB訂閱服務(wù)的配置項(xiàng)目為

@Configuration
@EnableConfigurationProperties({EsbServerProperties.class})
public class EsbServerConfiguration {
  @Bean
  public SpringBus springBus(){
    return new SpringBus();
  }

  @Bean
  public LoggingFeature loggingFeature(){
    return new LoggingFeature();
  }

  @Bean
  public List<JMSConfigFeature> jmsConfigFeatures(EsbServerProperties props) throws JMSException {
    List<JMSConfigFeature> features = new ArrayList<>();
     
    /** 
     * 這里會(huì)使用EsbServerProperties的屬性構(gòu)建Bean實(shí)例
     */

    return features;
  }
}

屬性配置項(xiàng)

// 從application.yml等配置文件中讀取并綁定esb.server.destination等屬性值
@Data
@ConfigurationProperties("esb.server")
public class EsbServerProperties {
  String destination;
  int currConsumers = 1;
  String channel;
  int ccsid = 1205;
  int transportType = 1;
  List<String> connectionNameLists;
  boolean replyError = false;
  String replySuccessText = "Success";
  String replyErrorText = "Failure";
}

到這里我們已經(jīng)完成一個(gè)基本的starter的功能

1. 通過(guò)@ConfigurationProperties定義該starter注冊(cè)bean時(shí)需要的屬性集合
2. 通過(guò)@Configuration定義該starter注冊(cè)的bean

但引用該starter的項(xiàng)目要如何啟用配置呢？其實(shí)有兩種方式，分別為手動(dòng)和自動(dòng)，其中我們會(huì)著重講解自動(dòng)啟用配置。

手動(dòng)啟用配置

所謂手動(dòng)啟用配置其實(shí)就是在SpringBoot入口類(lèi)上添加啟用配置用的自定義注解，針對(duì)上面的EsbServerConfiguration我們可以自定義EnableESBSrv注解

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Import({EsbServerConfiguration.class})
public @interface EnableEsbSrv {
}

然后入口類(lèi)的@SpringBootApplication注解前后添加@EnableEsbSrv即可。

讓人省心省力的自動(dòng)啟用配置

自動(dòng)啟用配置即只需在pom.xml中引入所依賴(lài)的starter，然后啟用應(yīng)用即可自動(dòng)啟用該starter的@Configuration所注解的類(lèi)從而注冊(cè)Bean和讀取屬性配置。
而這一切都是由AutoConfigurationImportSelector來(lái)操刀，而我們可以通過(guò)@EnableAutoConfiguration或@SpringBootApplication等實(shí)例化AutoConfigurationImportSelector類(lèi)，配合菜譜resources/META-INF/spring.factories實(shí)現(xiàn)自動(dòng)化配置的功能。
具體手法就是：將EsbServerConfiguration的全限類(lèi)名稱(chēng)寫(xiě)在resources/META-INF/spring.factories的org.springframework.boot.autoconfigure.EnableAutoConfiguration下， 若存在多個(gè)則用逗號(hào)分隔。

org.springframework.boot.autoconfigure.EnableAutoConfiguration = \
com.john.starter.EsbServerConfiguration,\
com.john.starter.OtherConfiguration

好與更好——集成IDE智能提示

應(yīng)用啟動(dòng)時(shí)會(huì)將application.yml中對(duì)應(yīng)的配置項(xiàng)綁定到@ConfigurationProperties標(biāo)注的類(lèi)實(shí)例上，那么對(duì)于應(yīng)用開(kāi)發(fā)人員而言日常工作就是修改application.yml的配置項(xiàng)。但I(xiàn)DE又缺少配置項(xiàng)的智能提示，那就很低效了。幸虧Spring Boot早就為我們提供好解決方案，分為手工和自動(dòng)兩種。為了效率當(dāng)然是可以自動(dòng)就不用手動(dòng)的了。

1.Starter項(xiàng)目的工作引入spring-boot-configuration-processor依賴(lài)項(xiàng);

<dependency>
 <groupId>org.springframework.boot</groupId>
 <artifactId>spring-boot-configuration-processor</artifactId>
 <optional>true</optional>
</dependency>

2.若src/resources/META-INF/spring-configuration-metadata.json不存在，那么執(zhí)行mvn compile時(shí)會(huì)生成target/classes/META-INF/spring-configuration-metadata.json;

3.復(fù)制target/classes/META-INF/spring-configuration-metadata.json到src/resources/META-INF/spring-configuration-metadata.json即可。

業(yè)務(wù)系統(tǒng)項(xiàng)目的工作

1.引入spring-boot-configuration-processor依賴(lài)項(xiàng);

<dependency>
 <groupId>org.springframework.boot</groupId>
 <artifactId>spring-boot-configuration-processor</artifactId>
 <optional>true</optional>
</dependency>

IDEA安裝Spring Assistant插件，并啟用Enable annotation processing(勾選 Settings/Build, Execution & Deployment/Compiles/Annotation Processors/Enable annotation processing)。

總結(jié)

spring-boot-starter非常適合用于團(tuán)隊(duì)的技術(shù)積累和沉淀，不過(guò)想恰到好處地應(yīng)用起來(lái)，不僅要需要深入Spring內(nèi)部原理還要梳理清楚業(yè)務(wù)邏輯。后續(xù)我們?cè)偕钊胩接慡pring內(nèi)核的事情吧！

到此這篇關(guān)于聊一聊帶智能提示的spring-boot-starter的文章就介紹到這了,更多相關(guān)springboot starter智能提示內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

最新評(píng)論