1. 程式人生 > 程式設計 >阿里雲釋出 Spring Boot 新腳手架工程

阿里雲釋出 Spring Boot 新腳手架工程

背景

相信很多人都使用過 start.spring.io 來初始化自己的 Spring Boot 工程,這個工具為開發者提供了豐富的可選元件,並且可以選擇多種打包方式,大大方便了開發人員的使用。最近,阿里的 Nacos、Sentinel 也進入 start.spring.io 的選項中,進一步的方便開發者使用阿里雲的產品。

阿里雲釋出 Spring Boot 新腳手架工程

但是,生成的工程骨架中,只有元件座標資訊,缺少對應的使用方法和 Demo 程式碼;於是,開發者還是需要去尋找相關使用教程,或者樣例程式碼;如果找的不對,或者是版本不匹匹配,還需要花費不少時間去排查和解決問題;這些問題都在無形中增加使用者的工作量。

我們將對軟體工程的抽象層次自上而下進行切分,會得到如下的幾個層級:行業、解決方案、應用、功能、元件;明顯的, start.spring.io 目前只能提供元件級別的支援。再將元件這層展開,會發現這樣一個生命週期:元件引入、元件配置、功能開發、線上運維。start.spring.io 也只實現了“元件引入”這一功能。

我們的目標是“讓阿里雲成為廣大 Java 開發者最好用的雲”。要實現這個目標,是否可以再向前走幾步,在解決“元件引入”問題的基礎上,將元件的典型使用方法、樣例程式碼、使用說明也加入到工程中呢?

基於這種思考,我們上線了自己的 bootstrap 站點 start.aliyun.com :

https://start.aliyun.com/

當然,本著不重複造輪子的原則,我們不再構建一套工程生成底層框架,而是使用 Spring Initializr 來實現這部分功能。在此之上專注於增加新特性,實現服務廣大開發者的目標。

Spring Initializr:https://github.com/spring-io/initializr

在 start.aliyun.com 中,我們為廣大開發者帶來了如下便利特性:

  • 為每個元件提供了單獨的 DemoCode 和對應的配置樣例(本次已釋出);
  • 工程內建說明,減少使用者查詢文件的困難(部分實現);
  • 開發者只需要做減法,而非加法的使用方式(部分實現);
  • 提供多元件整合的解決方案(開發中);
  • 定期跟進 start.spring.io 的更新,方便大家使用到 spring 的最新功能。

start.aliyun.com:https://start.aliyun.com/

未來,我們還需要再助力開發者這條路上繼續發力,不僅僅是做好元件整合的工作,還要需要繼續向上支援,提供更多功能、服務、應用層級的快速構建能力。

本文,圍繞 spring initializr 框架,以 start.spring.io 為例,全面的給大家介紹如何使用和擴充套件這個框架,以及背後的執行原理。

使用篇

由於 spring-initializr 提供了靈活的擴充套件能力,以及豐富的預設實現;其使用方式也是非常的靈活多變;為了便於說明,我們直接通過 start.spring.io ,看看 Spring 自己是怎麼使用這套框架的。

1. 基本用法

基本用法的原則,是儘量少寫程式碼,甚至是不寫程式碼。只通過配置就可以實現 initializr 工程的建立。

依賴引入

要使用 spring-initializr ,首先要引入這套框架。很簡單,直接依賴 bom 即可:

<dependencyManagement>
 <dependencies>
 <dependency>
 <groupId>io.spring.initializr</groupId>
 <artifactId>initializr-bom</artifactId>
 <version>0.9.0.BUILD-SNAPSHOT</version>
 <type>pom</type>
 <scope>import</scope>
 </dependency>
 </dependencies>
</dependencyManagement>

有了這個 bom 依賴,我們就不用再關心內部元件的版本等資訊了。

一般來說,我們還需要引入具體元件:

<dependency>
 <groupId>io.spring.initializr</groupId>
 <artifactId>initializr-generator-spring</artifactId>
 </dependency>
 <dependency>
 <groupId>io.spring.initializr</groupId>
 <artifactId>initializr-version-resolver</artifactId>
 </dependency>
 <dependency>
 <groupId>io.spring.initializr</groupId>
 <artifactId>initializr-web</artifactId>
 </dependency>

具體每個子模組的用途,這裡列出來,供讀者參考:

  • initializr-actuator: 監控診斷的附加資訊,這個暫時忽略;
  • initializr-bom: 便於外部使用的bom依賴;
  • initializr-docs: 使用文件;
  • initializr-generator: 核心工程生成庫;
  • initializr-generator-spring: 用於生成典型的spring boot工程;
  • initializr-generator-test: 測試框架;
  • initializr-metadata: 專案各個方面的元資料基礎結構;
  • initializr-service-sample: 基本使用案例;
  • initializr-version-resolver:版本號解析能力;
  • initializr-web: 提供給三方客戶端使用的web入口。

基本配置

完成了框架引入,就需要做一些基礎配置了支援哪些語言:Java、groovy、Kotlin支援哪些版本:1.8、11、13支援哪些打包方式:jar、war

將這些資訊全部配置到 application.yml 檔案中,如下:

  • 完成了框架引入,就需要做一些基礎配置了
  • 支援哪些語言:Java、groovy、Kotlin
  • 支援哪些版本:1.8、11、13
  • 支援哪些打包方式:jar、war
initializr:
 packagings:
 - name: Jar
 id: jar
 default: true
 - name: War
 id: war
 default: false
 javaVersions:
 - id: 13
 default: false
 - id: 11
 default: false
 - id: 1.8
 name: 8
 default: true
 languages:
 - name: Java
 id: java
 default: true
 - name: Kotlin
 id: kotlin
 default: false
 - name: Groovy
 id: groovy
 default: false

其中 name 是可選的, id 是必填的。

每個配置項下,可以有一個預設值(將 default 這是為 true 即可),除了這些基本配置,我們還需要定義可以支援的專案型別:

initializr:
 types:
 - name: Maven Project
 id: maven-project
 description: Generate a Maven based project archive.
 tags:
 build: maven
 format: project
 default: true
 action: /starter.zip
 - name: Maven POM
 id: maven-build
 description: Generate a Maven pom.xml.
 tags:
 build: maven
 format: build
 default: false
 action: /pom.xml
 - name: Gradle Project
 id: gradle-project
 description: Generate a Gradle based project archive.
 tags:
 build: gradle
 format: project
 default: false
 action: /starter.zip
 - name: Gradle Config
 id: gradle-build
 description: Generate a Gradle build file.
 tags:
 build: gradle
 format: build
 default: false
 action: /build.gradle

預設情況下, initializr 已經支援 4 種專案型別:

  • /pom.xml 生成一個 Maven 的 pom.xml 配置檔案
  • /build.gradle 生成 Gradle 的配置檔案
  • /starter.zip 生成 zip 方式壓縮的工程檔案
  • /starter.tgz 生成以 tgz 方式壓縮的工程檔案

通過 tags 標籤,我們可以定義不同配型的編譯方式 (build) 和打包格式(format)。

配置基本依賴

完成了基本配置以後,就可以配置可選的依賴元件了。

依賴配置以 dependency 為 key ,同樣配置在 application.yml 的 initializr 下面,這裡給出一個簡單的樣例:

initializr:
 dependencies:
 - name: Web
 content:
 - name: Web
 id: web
 description: Full-stack web development with Tomcat and Spring MVC
 - name: Developer Tools
 content:
 - name: Spring Boot DevTools
 id: devtools
 groupId: org.springframework.boot
 artifactId: spring-boot-devtools
 description: Provides fast application restarts,LiveReload,and configurations for enhanced development experience.
 - name: Lombok
 id: lombok
 groupId: org.projectlombok
 artifactId: lombok
 description: Java annotation library which helps to reduce boilerplate code.

dependencies 下定義分組。分組的作用是便於展示和快速查詢,所以不需要 id ,只需要 name 資訊;每個分組的 content 是分組的具體內容,也就是這個分組下的元件定義;支援以列表形式定義多個;另外,每個分組都可以設定當前分組內元件公用的配置資訊。

每一依賴,包含如下的基本資訊:

  • id:元件的唯一識別符號
  • groupId & artifactId:元件的座標
  • name:顯示名稱
  • description:描述資訊,主要用於展示用途
  • version:元件版本

關於 groupId & artifactId:如果設定了座標,生成的專案裡會使用這裡的座標定位元件;但是如果沒有設定座標,框架會認為這是一個標準的 spring-boot 元件,自動新增 spring-boot-starter-{id} 作為生成的依賴座標。

關於 version:如果直接在元件上設定版本資訊,框架會直接使用這個值作為元件依賴的版本;但是很多時候,元件的版本會受到 spring-boot 版本的影響,此時就需要對版本做特殊的定義 & 管理。

配置依賴版本管理

這裡需要先了解一下版本命名規則:一個典型的版本,一般包含如下 4 個資訊:大版本、小版本、修正版本、版本限定符。

版本範圍有一個上界和下界,可以方括號 [] 或者圓括號 () 表示。方括號代表上下界的閉區間,圓括號代表上下界的開區間。

例如:“[1.1.6.RELEASE,1.3.0.M1)”代表所有從 1.1.6.RELEASE 到 1.3.0.M1 之間所有的版本(包含 1.1.6.RELEASE ,但不包含 1.3.0.M1 )。

同時,可以使用單一版本號作為版本範圍,例如 “1.2.0.RELEASE”。單一版本號的版本範圍代表“從這個版本以及之後的所有版本”。

如果需要使用“最新的 Release 版本”的概念,可以使用一個字母 x 代表具體的版本號。

例如, 1.4.x.BUILD-SNAPSHOT 代表 1.4.x 的最新快照版本。

再比如:如果需要表達,從 1.1.0.RELEASE 到 1.3.x 之間的所有版本,可以用[1.1.0.RELEASE,1.3.x.RELEASE]來表達。

另外,版本限定符也是有順序的(升序):

  • M:里程碑版本
  • RC:釋出候選版本
  • RELEASE:釋出版本
  • BUILD-SNAPSHOT:為開發構建的快照版本

所以快照版本是所有限定符裡優先順序最高的。假設某個元件需要 Spring Boot 的最新版本,可以使用 1.5.x.BUILD-SNAPSHOT (假設 1.5 版是 Spring Boot 的最新版本)。

最後,版本範圍中討論的版本,指的都是 Spring Boot的版本,而不是元件自己的版本。

前面介紹了,可以使用 version 屬性定義元件的具體版本號;但是,如果元件版本與Spring Boot 的版本存在關聯關係,就需要使用 compatibilityRange 來配置依賴的版本範圍。

compatibilityRange 可以定義在兩個地方:

直接定義在元件(或 Bom )上

這種定義方式,代表元件只支援 Spring Boot 的某一個版本範圍,例如下面的配置:

initializr:
 dependencies:
 - name: Stuff
 content:
 - name: Foo
 id: foo
 ...
 compatibilityRange: 1.2.0.M1
 - name: Bar
 id: bar
 ...
 compatibilityRange: "[1.5.0.RC1,2.0.0.M1)"

Foo 可以支援 Spring boot 1.2.0 之後的所有版本;而Bar只能支援 Spring Boot 1.5.0 到 2.0.0 之間的版本,且不包含 2.0.0 ;

定義在元件的 mappgin 屬性下

可以支援在 Spring Boot 不同版本之下對元件做不同的設定(可以重置元件部分或者是所有的屬性),下面的例子中對 artifactId 做了特殊定義:

initializr:
 dependencies:
 - name: Stuff
 content:
 - name: Foo
 id: foo
 groupId: org.acme.foo
 artifactId: foo-spring-boot-starter
 compatibilityRange: 1.3.0.RELEASE
 mappings:
 - compatibilityRange: "[1.3.0.RELEASE,1.3.x.RELEASE]"
 artifactId: foo-starter
 - compatibilityRange: "1.4.0.RELEASE"

這個例子中, foo 在 Spring Boot 的 1.3 使用 foo-starter 作為座標的 artifactId ;在 1.4.0.RELEASE 以及之後的版本中,還是使用 foo-spring-boot-starter 作為 artifactId 的值;

使用 Bom 管理版本:有時候,需要使用 Bom 的方式管理元件版本;此時不需要對元件單獨設定版本號。

要使用 Bom ,首先要配置 Bom 定義:

initializr:
 env:
 boms:
 my-api-bom:
 groupId: org.acme
 artifactId: my-api-dependencies
 version: 1.0.0.RELEASE
 repositories: my-api-repo-1

注意:Bom 資訊,定義在 initializr.env.boms下面。

其屬性和依賴元件基本一致,都是座標、版本;同時, Bom 也支援版本範圍管理。

完成了 Bom 的定義,就需要在元件中引用 Bom :

initializr:
 dependencies:
 - name: Other
 content:
 - name: My API
 id : my-api
 groupId: org.acme
 artifactId: my-api
 bom: my-api-bom

一旦使用者選擇了 my-api 元件,框架會自動為生成的專案添加了 my-api-dependencies 的 Bom 依賴;

2. 高階定製

啟用快取

如果你啟動過 start.spring.io 專案,你會在日誌裡發現這樣的輸出 “Fetching boot metadata from spring.io/project_metadata/spring-boot” 為了避免過於頻繁的檢查 Spring Boot 版本,官方是建議配合快取一起使用。

首先需要引入快取框架:

<dependency>
 <groupId>javax.cache</groupId>
 <artifactId>cache-api</artifactId>
</dependency>
<dependency>
 <groupId>org.ehcache</groupId>
 <artifactId>ehcache</artifactId>
</dependency>

然後,在 SpringBootApplication 類上增加 @EnableCaching 註解:

阿里雲釋出 Spring Boot 新腳手架工程

如果需要自己定義快取,可以調整如下快取配置:

阿里雲釋出 Spring Boot 新腳手架工程

增加 Demo程式碼:由於不同的元件有不同的功能,如果需要為專案增加 Demo 程式碼。

為不同的元件增加獨立配置:還記得原理篇中提到的 spring.factories 嗎?對,我們要增加自己的配置項,就需要在這裡增加針對不同元件樣例程式碼的擴充套件入口。

io.spring.initializr.generator.project.ProjectGenerationConfiguration=\
com.alibaba.alicloud.initializr.extension.dependency.springboot.SpringCloudProjectGenerationConfiguration

在 SpringCloudProjectGenerationConfiguration 中,我們通過 ConditionalOnRequestedDependency 註解來識別不同元件:

@ProjectGenerationConfiguration
public class SpringCloudAlibabaProjectGenerationConfiguration {
 private final InitializrMetadata metadata;
 private final ProjectDescription description;
 private final IndentingWriterFactory indentingWriterFactory;
 private final TemplateRenderer templateRenderer;
 public SpringCloudAlibabaProjectGenerationConfiguration(InitializrMetadata metadata,ProjectDescription description,IndentingWriterFactory indentingWriterFactory,TemplateRenderer templateRenderer) {
  this.metadata = metadata;
  this.description = description;
  this.indentingWriterFactory = indentingWriterFactory;
  this.templateRenderer = templateRenderer;
 }
 @Bean
 @ConditionalOnRequestedDependency("sca-oss")
 public OSSDemoCodeContributor ossContributor() {
  return new OSSDemoCodeContributor(description,templateRenderer);
 }
 ......
}

上面的程式碼,會在選擇了 sca-oss 元件時,建立一個 OSSDemoCodeContributor 用於對應 Demo 程式碼的生成。

生成具體的 Demo 程式碼:繼續以 OSSDemoCodeContributor 為例,它是一個 ProjectContributor ,會在專案檔案空間建立完成了呼叫。我們需要為這個 Contributor 在例項化時增加生成過程中需要的元資料資訊,例如 ProjectDescription 。

程式碼生成過程,比較簡單,可以直接複用框架中就提供的 mstache 模板引擎。

我們直接將 Demo 程式碼,以模板的形式,放置在 resources 資料夾之下:

阿里雲釋出 Spring Boot 新腳手架工程

然後,我們再通過模板引擎,解析這些模板檔案,再拷貝到專案目錄下即可:

private void writeCodeFile(TemplateRenderer templateRenderer,Language langeuage,Map<String,Object> params,Path path,String temp) throws IOException {
 ......
 Path pkgPath = 生成包路徑
 Path filePath = 成成程式碼檔案路徑
 // 渲染模板
 String code = templateRenderer.render(temp,params);
 // demo 檔案寫入
 Files.createDirectories(pkgPath);
 Files.write(filePath,code.getBytes("UTF-8"));
 }

除了模板程式碼以外,我們通常還需要在 applicatioin.properties 檔案寫入模組的配置資訊。

這裡,我們依然可以使用程式碼生成的方式:建立模板、解析模板,追加檔案的方式來實現。具體程式碼這裡就不貼了,讀者可以自己發揮。

原理篇

原理篇,主要介紹 spring.initializr 是如何實現專案工程構建的,以及作為一個框架,如何提供豐富的擴充套件能力的。

在原理篇,我們將 initializr 的執行分為兩個階段:啟動階段和生成階段。

  • 啟動階段:啟動應用,載入配置,擴充套件資訊初始化;
  • 生成階段:一個專案生成,從收到請求,到返回內容的完整流程。

1. 啟動階段

再開始啟動流程之前,先要看一下 initializr 的擴充套件體系。

整個架構大量使用了 spring 的 spi 機制,我們來看一下一共有哪些 spring.factories :

  • initializr-generator/src/main/resources/META-INF/spring.factories
  • initializr-generator-spring/src/main/resources/META-INF/spring.factories
  • initializr-web/src/main/resources/META-INF/spring.factories
  • initializr-actuator/src/main/resources/META-INF/spring.factories
  • start-site/src/main/resources/META-INF/spring.factories

其中只有一個在 start.spring.io 中,其他 4 個都在 initializr 工程中(各 spring.factories 的具體內容見參考資料)。

不過要注意,這些 spring.factories 定義,僅僅代表了各個 SPI 有哪些擴充套件。不同spi的實現建立和使用完全是在不同的階段進行的。

在應用啟動階段,其實只有一個 spi 會被載入(暫不考慮 actuator):io.spring.initializr.web.autoconfigure.InitializrAutoConfiguration 。

@Configuration
@EnableConfigurationProperties(InitializrProperties.class)
public class InitializrAutoConfiguration {
 @Bean
 @ConditionalOnMissingBean
 public ProjectDirectoryFactory projectDirectoryFactory()
 @Bean
 @ConditionalOnMissingBean
 public IndentingWriterFactory indentingWriterFactory()
 @Bean
 @ConditionalOnMissingBean(TemplateRenderer.class)
 public MustacheTemplateRenderer templateRenderer(Environment environment,ObjectProvider<CacheManager> cacheManager)
 @Bean
 @ConditionalOnMissingBean
 public InitializrMetadataUpdateStrategy initializrMetadataUpdateStrategy(RestTemplateBuilder restTemplateBuilder,ObjectMapper objectMapper)
 @Bean
 @ConditionalOnMissingBean(InitializrMetadataProvider.class)
 public InitializrMetadataProvider initializrMetadataProvider(InitializrProperties properties,InitializrMetadataUpdateStrategy initializrMetadataUpdateStrategy)
 @Bean
 @ConditionalOnMissingBean
 public DependencyMetadataProvider dependencyMetadataProvider()
 @Configuration
 @ConditionalOnWebApplication
 static class InitializrWebConfiguration {
 @Bean
 InitializrWebConfig initializrWebConfig()
 @Bean
 @ConditionalOnMissingBean
 ProjectGenerationController<ProjectRequest> projectGenerationController(
 InitializrMetadataProvider metadataProvider,ApplicationContext applicationContext)
 @Bean
 @ConditionalOnMissingBean
 ProjectMetadataController projectMetadataController(InitializrMetadataProvider metadataProvider,DependencyMetadataProvider dependencyMetadataProvider)
 @Bean
 @ConditionalOnMissingBean
 CommandLineMetadataController commandLineMetadataController(InitializrMetadataProvider metadataProvider,TemplateRenderer templateRenderer)
 @Bean
 @ConditionalOnMissingBean
 SpringCliDistributionController cliDistributionController(InitializrMetadataProvider metadataProvider)
 }
}

這裡會做如下幾件事情:

  • 初始化元資料 Provider
  • 建立模板引擎
  • 建立目錄、縮排工廠
  • 初始化 web 配置
  • 建立 spring mvc 的 web 入口
  • 各種 ProjectGenerationController

其中最關鍵的元資料載入部分,使用了 EnableConfigurationProperties 註解,將 spring 環境中的配置項寫到 InitializrProperties 上:

阿里雲釋出 Spring Boot 新腳手架工程

在 application.yml 檔案中,可以找到如下的配置資訊,這裡就是實際的專案依賴關係元資料的配置儲存點:

阿里雲釋出 Spring Boot 新腳手架工程

2. 生成階段

生成階段,spring-initializr 使用了一個很有意思的實現方式:initializr 框架會為每一次專案生成,建立一個獨立的 context 用於存放生成流程中需要使用到的各種 bean 。

先來一張時序圖:

阿里雲釋出 Spring Boot 新腳手架工程

藍色的類,是在應用啟動階段就完成了建立和資料填充;其生命週期和整個應用一致;黃色的類,會在具體的專案構建過程中生成;其生命週期在一次專案生成流程之內結束。

從上面的時序圖中可以看出:一個典型的建立行為,通常從 ProjectGenerationController收到web端的建立請求開始,通過 ProjectGenerationInvoker 這個中間層轉換,最終進入 ProjectGenerator 的核心構建流程。

主幹流程

下圖,是 ProjectGenerator 的核心構建流程:

阿里雲釋出 Spring Boot 新腳手架工程

106 行,通過 contextFactory 構建了一個新的 ProjectGenerationContext 。

看一下這個context的繼承關係,原來於spring提供的AnnotationConfigApplicationContext 。

再結合 110 行的 refresh() 方法,是不是發現了什麼?就是 spring 的 ApplicationContext 的重新整理流程。

阿里雲釋出 Spring Boot 新腳手架工程

107 行的 resolve 方法,向 context 中註冊了一個 ProjectDescription的Provider,程式碼如下:

阿里雲釋出 Spring Boot 新腳手架工程

由於註冊的是 Provider ,所以這段邏輯會在 Context 執行 refresh 時執行。

這裡的 ProjectDescriptionCustomizer 就是針對 ProjectDescription 的擴充套件,用於對使用者傳入的 ProjectDescription 做調整。這裡主要是一些強制依賴關係的調整,例如語言版本等。

這時候再看 108 行,這裡向 Context 註冊一個 Configuration 。

那麼這個 Configuration 包含了什麼內容呢?一起來看下面這段程式碼:

阿里雲釋出 Spring Boot 新腳手架工程

ProjectGenerationConfiguration!!!前面提到的 spring.factories 中有很多這個 SPI 的實現(參見參考資料)。

原來,initializr 的整個擴充套件體系,在這裡才開始建立例項;

ProjectGenerator 的 109 行,對一個 consumer 做了 accept 操作;其實就是呼叫了下面的程式碼:

阿里雲釋出 Spring Boot 新腳手架工程

這裡通過 setParent 將應用的主上下文設定為這次 ProjectGenerationContext 的父節點。

並且向這次 ProjectGenerationContext 中註冊了元資料物件。

最後,在 ProjectGenerator 的 112 行,呼叫了 projectAssetGenerator 的 generate 方法,實現如下:

阿里雲釋出 Spring Boot 新腳手架工程

通過上面的程式碼可以發現,這裡對實際的工程構建工作,其實就是很多的 ProjectContributor 共同疊加;

至此,主幹流程已經結束了。

我們可以發現,在主幹流程中,沒有做任何寫檔案的操作(只建立了根資料夾);它僅僅是定義了一套資料載入、擴充套件載入的機制與流程,將所有的具體實現都作為擴充套件的一部分。

擴充套件流程

spring-initializr 提供了 2 種主要擴充套件途徑:ProjectContributor 和 xxxxxCustomizer。

阿里雲釋出 Spring Boot 新腳手架工程

從方法簽名就可以看出,入參只有一個專案的根路徑,其職責就是向這個路徑下些人專案檔案。這個擴充套件點非常的靈活,幾乎可以支援任何的程式碼、配置檔案寫入工作。

實現過程中,可以通過 ProjectGenerationContext 獲取相關依賴,然後通過自定義邏輯完成檔案生成工作。

下面是 initializr 和 start.spring.io 提供的 ProjectContributor 實現:

阿里雲釋出 Spring Boot 新腳手架工程

拿幾個主要的實現看看:

  • MavenBuildProjectContributor:寫入 maven 專案 pom.xml 檔案;
  • WebFoldersContributor:建立 web 專案的資原始檔夾;
  • ApplicationPropertiesContributor:寫入 application.properties 檔案;
  • MainSourceCodeProjectContributor:寫入應用入口類 xxxApplication.java 檔案;
  • HelpDocumentProjectContributor:寫入幫助文件 HELP.md 檔案。

相對於 ProjectContributor,xxxxxCustomizer 不是一個統一的介面,我把他理解為一種感念和與之對應的命名習慣;每個 Customizer 都有自己明確的名字,同時也對應了明確的觸發邏輯和職責邊界。

下面列出框架提供的 Customizer 的說明:

  • MainApplicationTypeCustomizer:自定義 MainApplication 類;
  • MainCompilationUnitCustomizer:自定義 MainApplication 編譯單元;
  • MainSourceCodeCustomizer:自定義 MainApplication 原始碼;
  • BuildCustomizer:自定義專案構建工具的配置內容;
  • GitIgnoreCustomizer:自定義專案的 .gitignore 檔案;
  • HelpDocumentCustomizer:自定義專案的幫助文件;
  • InitializrMetadataCustomizer:自定義專案初始化配置元資料;這個 Customizer 比較特殊,框架會在首次載入元資料配置時呼叫;
  • ProjectDescriptionCustomizer:自定義 ProjectDescription ;即在生成專案檔案之前,允許調整專案描述資訊;
  • ServletInitializerCustomizer:自定義 web 應用在類上的配置內容;
  • TestApplicationTypeCustomizer:自定義測試 Application 類;
  • TestSourceCodeCustomizer:自定義測試 Application 類的原始碼。

參考資料

1. 相關連結initializr 說明文件

https://docs.spring.io/initializr/docs/current-SNAPSHOT/reference/html/

spring-initializr 專案地址

https://github.com/spring-io/initializr

start.spring.io 專案地址

https://github.com/spring-io/start.spring.io

2. spring.factories 明細

initializr-generator/src/main/resources/META-INF/spring.factoriesio.spring.initializr.generator.buildsystem.BuildSystemFactory=\
io.spring.initializr.generator.buildsystem.gradle.GradleBuildSystemFactory,\
io.spring.initializr.generator.buildsystem.maven.MavenBuildSystemFactory
io.spring.initializr.generator.language.LanguageFactory=\
io.spring.initializr.generator.language.groovy.GroovyLanguageFactory,\
io.spring.initializr.generator.language.java.JavaLanguageFactory,\
io.spring.initializr.generator.language.kotlin.KotlinLanguageFactory
io.spring.initializr.generator.packaging.PackagingFactory=\
io.spring.initializr.generator.packaging.jar.JarPackagingFactory,\
io.spring.initializr.generator.packaging.war.WarPackagingFactory

initializr-generator-spring/src/main/resources/META-INF/spring.factories:

io.spring.initializr.generator.project.ProjectGenerationConfiguration=\
io.spring.initializr.generator.spring.build.BuildProjectGenerationConfiguration,\
io.spring.initializr.generator.spring.build.gradle.GradleProjectGenerationConfiguration,\
io.spring.initializr.generator.spring.build.maven.MavenProjectGenerationConfiguration,\
io.spring.initializr.generator.spring.code.SourceCodeProjectGenerationConfiguration,\
io.spring.initializr.generator.spring.code.groovy.GroovyProjectGenerationConfiguration,\
io.spring.initializr.generator.spring.code.java.JavaProjectGenerationConfiguration,\
io.spring.initializr.generator.spring.code.kotlin.KotlinProjectGenerationConfiguration,\
io.spring.initializr.generator.spring.configuration.ApplicationConfigurationProjectGenerationConfiguration,\
io.spring.initializr.generator.spring.documentation.HelpDocumentProjectGenerationConfiguration,\
io.spring.initializr.generator.spring.scm.git.GitProjectGenerationConfiguration

initializr-web/src/main/resources/META-INF/spring.factories:

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
io.spring.initializr.web.autoconfigure.InitializrAutoConfiguration
org.springframework.boot.env.EnvironmentPostProcessor=\
io.spring.initializr.web.autoconfigure.CloudfoundryEnvironmentPostProcessor

initializr-actuator/src/main/resources/META-INF/spring.factories:

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
io.spring.initializr.actuate.autoconfigure.InitializrActuatorEndpointsAutoConfiguration,\
io.spring.initializr.actuate.autoconfigure.InitializrStatsAutoConfiguration

start-site/src/main/resources/META-INF/spring.factories:

io.spring.initializr.generator.project.ProjectGenerationConfiguration=\
io.spring.start.site.extension.build.gradle.GradleProjectGenerationConfiguration,\
io.spring.start.site.extension.build.maven.MavenProjectGenerationConfiguration,\
io.spring.start.site.extension.dependency.DependencyProjectGenerationConfiguration,\
io.spring.start.site.extension.dependency.springamqp.SpringAmqpProjectGenerationConfiguration,\
io.spring.start.site.extension.dependency.springboot.SpringBootProjectGenerationConfiguration,\
io.spring.start.site.extension.dependency.springcloud.SpringCloudProjectGenerationConfiguration,\
io.spring.start.site.extension.dependency.springdata.SpringDataProjectGenerationConfiguration,\
io.spring.start.site.extension.dependency.springintegration.SpringIntegrationProjectGenerationConfiguration,\
io.spring.start.site.extension.dependency.springrestdocs.SpringRestDocsProjectGenerationConfiguration,\
io.spring.start.site.extension.description.DescriptionProjectGenerationConfiguration,\
io.spring.start.site.extension.code.kotin.KotlinProjectGenerationConfiguration

到此這篇關於阿里雲釋出 Spring Boot 新腳手架,真香的文章就介紹到這了,更多相關Spring Boot 腳手架內容請搜尋我們以前的文章或繼續瀏覽下面的相關文章希望大家以後多多支援我們!