背景

相信很多人都使用過(guò) start.spring.io 來(lái)初始化自己的 Spring Boot 工程，這個(gè)工具為開(kāi)發(fā)者提供了豐富的可選組件，并且可以選擇多種打包方式，大大方便了開(kāi)發(fā)人員的使用。最近，阿里的 Nacos、Sentinel 也進(jìn)入 start.spring.io 的選項(xiàng)中，進(jìn)一步的方便開(kāi)發(fā)者使用阿里云的產(chǎn)品。

但是，生成的工程骨架中，只有組件坐標(biāo)信息，缺少對(duì)應(yīng)的使用方法和 Demo 代碼；于是，開(kāi)發(fā)者還是需要去尋找相關(guān)使用教程，或者樣例代碼；如果找的不對(duì)，或者是版本不匹匹配，還需要花費(fèi)不少時(shí)間去排查和解決問(wèn)題；這些問(wèn)題都在無(wú)形中增加用戶的工作量。

我們將對(duì)軟件工程的抽象層次自上而下進(jìn)行切分，會(huì)得到如下的幾個(gè)層級(jí)：行業(yè)、解決方案、應(yīng)用、功能、組件；明顯的， start.spring.io 目前只能提供組件級(jí)別的支持。再將組件這層展開(kāi)，會(huì)發(fā)現(xiàn)這樣一個(gè)生命周期：組件引入、組件配置、功能開(kāi)發(fā)、線上運(yùn)維。start.spring.io 也只實(shí)現(xiàn)了“組件引入”這一功能。

我們的目標(biāo)是“讓阿里云成為廣大 Java 開(kāi)發(fā)者最好用的云”。要實(shí)現(xiàn)這個(gè)目標(biāo)，是否可以再向前走幾步，在解決“組件引入”問(wèn)題的基礎(chǔ)上，將組件的典型使用方法、樣例代碼、使用說(shuō)明也加入到工程中呢？

基于這種思考，我們上線了自己的 bootstrap 站點(diǎn) start.aliyun.com ：

https://start.aliyun.com/

當(dāng)然，本著不重復(fù)造輪子的原則，我們不再構(gòu)建一套工程生成底層框架，而是使用 Spring Initializr 來(lái)實(shí)現(xiàn)這部分功能。在此之上專(zhuān)注于增加新特性，實(shí)現(xiàn)服務(wù)廣大開(kāi)發(fā)者的目標(biāo)。

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

在 start.aliyun.com 中，我們?yōu)閺V大開(kāi)發(fā)者帶來(lái)了如下便利特性：

• 為每個(gè)組件提供了單獨(dú)的 DemoCode 和對(duì)應(yīng)的配置樣例（本次已發(fā)布）；
• 工程內(nèi)置說(shuō)明，減少用戶查找文檔的困難（部分實(shí)現(xiàn)）；
• 開(kāi)發(fā)者只需要做減法，而非加法的使用方式（部分實(shí)現(xiàn)）；
• 提供多組件集成的解決方案（開(kāi)發(fā)中）；
• 定期跟進(jìn) start.spring.io 的更新，方便大家使用到 spring 的最新功能。

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

未來(lái)，我們還需要再助力開(kāi)發(fā)者這條路上繼續(xù)發(fā)力，不僅僅是做好組件集成的工作，還要需要繼續(xù)向上支持，提供更多功能、服務(wù)、應(yīng)用層級(jí)的快速構(gòu)建能力。

本文，圍繞 spring initializr 框架，以 start.spring.io 為例，全面的給大家介紹如何使用和擴(kuò)展這個(gè)框架，以及背后的運(yùn)行原理。

使用篇

由于 spring-initializr 提供了靈活的擴(kuò)展能力，以及豐富的默認(rèn)實(shí)現(xiàn)；其使用方式也是非常的靈活多變；為了便于說(shuō)明，我們直接通過(guò) start.spring.io ，看看 Spring 自己是怎么使用這套框架的。

1. 基本用法

基本用法的原則，是盡量少寫(xiě)代碼，甚至是不寫(xiě)代碼。只通過(guò)配置就可以實(shí)現(xiàn) initializr 工程的創(chuàng)建。

依賴引入

要使用 spring-initializr ，首先要引入這套框架。很簡(jiǎn)單，直接依賴 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>

有了這個(gè) bom 依賴，我們就不用再關(guān)心內(nèi)部組件的版本等信息了。

一般來(lái)說(shuō)，我們還需要引入具體組件：

<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>

具體每個(gè)子模塊的用途，這里列出來(lái)，供讀者參考：

• initializr-actuator: 監(jiān)控診斷的附加信息，這個(gè)暫時(shí)忽略；
• initializr-bom: 便于外部使用的bom依賴；
• initializr-docs: 使用文檔；
• initializr-generator: 核心工程生成庫(kù)；
• initializr-generator-spring: 用于生成典型的spring boot工程；
• initializr-generator-test: 測(cè)試框架；
• initializr-metadata: 項(xiàng)目各個(gè)方面的元數(shù)據(jù)基礎(chǔ)結(jié)構(gòu)；
• initializr-service-sample: 基本使用案例；
• initializr-version-resolver:版本號(hào)解析能力；
• initializr-web: 提供給三方客戶端使用的web入口。

基本配置

完成了框架引入，就需要做一些基礎(chǔ)配置了支持哪些語(yǔ)言：Java、groovy、Kotlin支持哪些版本：1.8、11、13支持哪些打包方式：jar、war

將這些信息全部配置到 application.yml 文件中，如下：

• 完成了框架引入，就需要做一些基礎(chǔ)配置了
• 支持哪些語(yǔ)言：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 是必填的。

每個(gè)配置項(xiàng)下，可以有一個(gè)默認(rèn)值（將 default 這是為 true 即可），除了這些基本配置，我們還需要定義可以支持的項(xiàng)目類(lèi)型：

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

默認(rèn)情況下， initializr 已經(jīng)支持 4 種項(xiàng)目類(lèi)型：

• /pom.xml 生成一個(gè) Maven 的 pom.xml 配置文件
• /build.gradle 生成 Gradle 的配置文件
• /starter.zip 生成 zip 方式壓縮的工程文件
• /starter.tgz 生成以 tgz 方式壓縮的工程文件

通過(guò) tags 標(biāo)簽，我們可以定義不同配型的編譯方式 (build) 和打包格式（format）。

配置基本依賴

完成了基本配置以后，就可以配置可選的依賴組件了。

依賴配置以 dependency 為 key ，同樣配置在 application.yml 的 initializr 下面，這里給出一個(gè)簡(jiǎn)單的樣例：

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 信息；每個(gè)分組的 content 是分組的具體內(nèi)容，也就是這個(gè)分組下的組件定義；支持以列表形式定義多個(gè)；另外，每個(gè)分組都可以設(shè)置當(dāng)前分組內(nèi)組件公用的配置信息。

每一依賴，包含如下的基本信息：

• id：組件的唯一標(biāo)識(shí)符
• groupId & artifactId：組件的坐標(biāo)
• name：顯示名稱(chēng)
• description：描述信息，主要用于展示用途
• version：組件版本

關(guān)于 groupId & artifactId：如果設(shè)置了坐標(biāo)，生成的項(xiàng)目里會(huì)使用這里的坐標(biāo)定位組件；但是如果沒(méi)有設(shè)置坐標(biāo)，框架會(huì)認(rèn)為這是一個(gè)標(biāo)準(zhǔn)的 spring-boot 組件，自動(dòng)添加 spring-boot-starter-{id} 作為生成的依賴坐標(biāo)。

關(guān)于 version：如果直接在組件上設(shè)置版本信息，框架會(huì)直接使用這個(gè)值作為組件依賴的版本；但是很多時(shí)候，組件的版本會(huì)受到 spring-boot 版本的影響，此時(shí)就需要對(duì)版本做特殊的定義 & 管理。

配置依賴版本管理

這里需要先了解一下版本命名規(guī)則：一個(gè)典型的版本，一般包含如下 4 個(gè)信息：大版本、小版本、修正版本、版本限定符。

版本范圍有一個(gè)上界和下界，可以方括號(hào) [] 或者圓括號(hào) () 表示。方括號(hào)代表上下界的閉區(qū)間，圓括號(hào)代表上下界的開(kāi)區(qū)間。

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

同時(shí)，可以使用單一版本號(hào)作為版本范圍，例如 “1.2.0.RELEASE”。單一版本號(hào)的版本范圍代表“從這個(gè)版本以及之后的所有版本”。

如果需要使用“最新的 Release 版本”的概念，可以使用一個(gè)字母 x 代表具體的版本號(hào)。

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

再比如：如果需要表達(dá)，從 1.1.0.RELEASE 到 1.3.x 之間的所有版本，可以用[1.1.0.RELEASE,1.3.x.RELEASE]來(lái)表達(dá)。

另外，版本限定符也是有順序的（升序）：

• M：里程碑版本
• RC：發(fā)布候選版本
• RELEASE：發(fā)布版本
• BUILD-SNAPSHOT：為開(kāi)發(fā)構(gòu)建的快照版本

所以快照版本是所有限定符里優(yōu)先級(jí)最高的。假設(shè)某個(gè)組件需要 Spring Boot 的最新版本，可以使用 1.5.x.BUILD-SNAPSHOT (假設(shè) 1.5 版是 Spring Boot 的最新版本)。

最后，版本范圍中討論的版本，指的都是 Spring Boot的版本，而不是組件自己的版本。

前面介紹了，可以使用 version 屬性定義組件的具體版本號(hào)；但是，如果組件版本與Spring Boot 的版本存在關(guān)聯(lián)關(guān)系，就需要使用 compatibilityRange 來(lái)配置依賴的版本范圍。

compatibilityRange 可以定義在兩個(gè)地方：

直接定義在組件（或 Bom ）上

這種定義方式，代表組件只支持 Spring Boot 的某一個(gè)版本范圍，例如下面的配置：

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 之后的所有版本；而B(niǎo)ar只能支持 Spring Boot 1.5.0 到 2.0.0 之間的版本，且不包含 2.0.0 ；

定義在組件的 mappgin 屬性下

可以支持在 Spring Boot 不同版本之下對(duì)組件做不同的設(shè)置（可以重置組件部分或者是所有的屬性），下面的例子中對(duì) 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"

這個(gè)例子中， foo 在 Spring Boot 的 1.3 使用 foo-starter 作為坐標(biāo)的 artifactId ；在 1.4.0.RELEASE 以及之后的版本中，還是使用 foo-spring-boot-starter 作為 artifactId 的值；

使用 Bom 管理版本：有時(shí)候，需要使用 Bom 的方式管理組件版本；此時(shí)不需要對(duì)組件單獨(dú)設(shè)置版本號(hào)。

要使用 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下面。

其屬性和依賴組件基本一致，都是坐標(biāo)、版本；同時(shí)， 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 組件，框架會(huì)自動(dòng)為生成的項(xiàng)目添加了 my-api-dependencies 的 Bom 依賴；

2. 高級(jí)定制

啟用緩存

如果你啟動(dòng)過(guò) start.spring.io 項(xiàng)目，你會(huì)在日志里發(fā)現(xiàn)這樣的輸出 “Fetching boot metadata from spring.io/project_metadata/spring-boot” 為了避免過(guò)于頻繁的檢查 Spring Boot 版本，官方是建議配合緩存一起使用。

首先需要引入緩存框架：

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

然后，在 SpringBootApplication 類(lèi)上增加 @EnableCaching 注解:

如果需要自己定義緩存，可以調(diào)整如下緩存配置：

增加 Demo代碼：由于不同的組件有不同的功能，如果需要為項(xiàng)目增加 Demo 代碼。

為不同的組件增加獨(dú)立配置：還記得原理篇中提到的 spring.factories 嗎？對(duì)，我們要增加自己的配置項(xiàng)，就需要在這里增加針對(duì)不同組件樣例代碼的擴(kuò)展入口。

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

在 SpringCloudProjectGenerationConfiguration 中，我們通過(guò) ConditionalOnRequestedDependency 注解來(lái)識(shí)別不同組件：

@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);
 }
 ......
}

上面的代碼，會(huì)在選擇了 sca-oss 組件時(shí)，創(chuàng)建一個(gè) OSSDemoCodeContributor 用于對(duì)應(yīng) Demo 代碼的生成。

生成具體的 Demo 代碼：繼續(xù)以 OSSDemoCodeContributor 為例，它是一個(gè) ProjectContributor ，會(huì)在項(xiàng)目文件空間創(chuàng)建完成了調(diào)用。我們需要為這個(gè) Contributor 在實(shí)例化時(shí)增加生成過(guò)程中需要的元數(shù)據(jù)信息，例如 ProjectDescription 。

代碼生成過(guò)程，比較簡(jiǎn)單，可以直接復(fù)用框架中就提供的 mstache 模板引擎。

我們直接將 Demo 代碼，以模板的形式，放置在 resources 文件夾之下：

然后，我們?cè)偻ㄟ^(guò)模板引擎，解析這些模板文件，再拷貝到項(xiàng)目目錄下即可：

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 文件寫(xiě)入
 Files.createDirectories(pkgPath);
 Files.write(filePath, code.getBytes("UTF-8"));
 }

除了模板代碼以外，我們通常還需要在 applicatioin.properties 文件寫(xiě)入模塊的配置信息。

這里，我們依然可以使用代碼生成的方式：創(chuàng)建模板、解析模板，追加文件的方式來(lái)實(shí)現(xiàn)。具體代碼這里就不貼了，讀者可以自己發(fā)揮。

原理篇

原理篇，主要介紹 spring.initializr 是如何實(shí)現(xiàn)項(xiàng)目工程構(gòu)建的，以及作為一個(gè)框架，如何提供豐富的擴(kuò)展能力的。

在原理篇，我們將 initializr 的執(zhí)行分為兩個(gè)階段：?jiǎn)?dòng)階段和生成階段。

• 啟動(dòng)階段：?jiǎn)?dòng)應(yīng)用，加載配置，擴(kuò)展信息初始化；
• 生成階段：一個(gè)項(xiàng)目生成，從收到請(qǐng)求，到返回內(nèi)容的完整流程。

1. 啟動(dòng)階段

再開(kāi)始啟動(dòng)流程之前，先要看一下 initializr 的擴(kuò)展體系。

整個(gè)架構(gòu)大量使用了 spring 的 spi 機(jī)制，我們來(lái)看一下一共有哪些 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

其中只有一個(gè)在 start.spring.io 中，其他 4 個(gè)都在 initializr 工程中（各 spring.factories 的具體內(nèi)容見(jiàn)參考資料）。

不過(guò)要注意，這些 spring.factories 定義，僅僅代表了各個(gè) SPI 有哪些擴(kuò)展。不同spi的實(shí)現(xiàn)創(chuàng)建和使用完全是在不同的階段進(jìn)行的。

在應(yīng)用啟動(dòng)階段，其實(shí)只有一個(gè) spi 會(huì)被加載（暫不考慮 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)
 }
}

這里會(huì)做如下幾件事情：

• 初始化元數(shù)據(jù) Provider
• 創(chuàng)建模板引擎
• 創(chuàng)建目錄、縮進(jìn)工廠
• 初始化 web 配置
• 創(chuàng)建 spring mvc 的 web 入口
• 各種 ProjectGenerationController

其中最關(guān)鍵的元數(shù)據(jù)加載部分，使用了 EnableConfigurationProperties 注解，將 spring 環(huán)境中的配置項(xiàng)寫(xiě)到 InitializrProperties 上：

在 application.yml 文件中，可以找到如下的配置信息，這里就是實(shí)際的項(xiàng)目依賴關(guān)系元數(shù)據(jù)的配置存儲(chǔ)點(diǎn)：

2. 生成階段

生成階段，spring-initializr 使用了一個(gè)很有意思的實(shí)現(xiàn)方式：initializr 框架會(huì)為每一次項(xiàng)目生成，創(chuàng)建一個(gè)獨(dú)立的 context 用于存放生成流程中需要使用到的各種 bean 。

先來(lái)一張時(shí)序圖：

藍(lán)色的類(lèi)，是在應(yīng)用啟動(dòng)階段就完成了創(chuàng)建和數(shù)據(jù)填充；其生命周期和整個(gè)應(yīng)用一致；黃色的類(lèi)，會(huì)在具體的項(xiàng)目構(gòu)建過(guò)程中生成；其生命周期在一次項(xiàng)目生成流程之內(nèi)結(jié)束。

從上面的時(shí)序圖中可以看出：一個(gè)典型的創(chuàng)建行為，通常從 ProjectGenerationController收到web端的創(chuàng)建請(qǐng)求開(kāi)始，通過(guò) ProjectGenerationInvoker 這個(gè)中間層轉(zhuǎn)換，最終進(jìn)入 ProjectGenerator 的核心構(gòu)建流程。

主干流程

下圖，是 ProjectGenerator 的核心構(gòu)建流程：

106 行，通過(guò) contextFactory 構(gòu)建了一個(gè)新的 ProjectGenerationContext 。

看一下這個(gè)context的繼承關(guān)系，原來(lái)于spring提供的AnnotationConfigApplicationContext 。

再結(jié)合 110 行的 refresh() 方法，是不是發(fā)現(xiàn)了什么？就是 spring 的 ApplicationContext 的刷新流程。

107 行的 resolve 方法，向 context 中注冊(cè)了一個(gè) ProjectDescription的Provider，代碼如下：

由于注冊(cè)的是 Provider ，所以這段邏輯會(huì)在 Context 執(zhí)行 refresh 時(shí)運(yùn)行。

這里的 ProjectDescriptionCustomizer 就是針對(duì) ProjectDescription 的擴(kuò)展，用于對(duì)用戶傳入的 ProjectDescription 做調(diào)整。這里主要是一些強(qiáng)制依賴關(guān)系的調(diào)整，例如語(yǔ)言版本等。

這時(shí)候再看 108 行，這里向 Context 注冊(cè)一個(gè) Configuration 。

那么這個(gè) Configuration 包含了什么內(nèi)容呢？一起來(lái)看下面這段代碼：

ProjectGenerationConfiguration！??！前面提到的 spring.factories 中有很多這個(gè) SPI 的實(shí)現(xiàn)（參見(jiàn)參考資料）。

原來(lái)，initializr 的整個(gè)擴(kuò)展體系，在這里才開(kāi)始創(chuàng)建實(shí)例；

ProjectGenerator 的 109 行，對(duì)一個(gè) consumer 做了 accept 操作；其實(shí)就是調(diào)用了下面的代碼：

這里通過(guò) setParent 將應(yīng)用的主上下文設(shè)置為這次 ProjectGenerationContext 的父節(jié)點(diǎn)。

并且向這次 ProjectGenerationContext 中注冊(cè)了元數(shù)據(jù)對(duì)象。

最后，在 ProjectGenerator 的 112 行，調(diào)用了 projectAssetGenerator 的 generate 方法，實(shí)現(xiàn)如下：

通過(guò)上面的代碼可以發(fā)現(xiàn)，這里對(duì)實(shí)際的工程構(gòu)建工作，其實(shí)就是很多的 ProjectContributor 共同疊加；

至此，主干流程已經(jīng)結(jié)束了。

我們可以發(fā)現(xiàn)，在主干流程中，沒(méi)有做任何寫(xiě)文件的操作（只創(chuàng)建了根文件夾）；它僅僅是定義了一套數(shù)據(jù)加載、擴(kuò)展加載的機(jī)制與流程，將所有的具體實(shí)現(xiàn)都作為擴(kuò)展的一部分。

擴(kuò)展流程

spring-initializr 提供了 2 種主要擴(kuò)展途徑：ProjectContributor 和 xxxxxCustomizer。

從方法簽名就可以看出，入?yún)⒅挥幸粋€(gè)項(xiàng)目的根路徑，其職責(zé)就是向這個(gè)路徑下些人項(xiàng)目文件。這個(gè)擴(kuò)展點(diǎn)非常的靈活，幾乎可以支持任何的代碼、配置文件寫(xiě)入工作。

實(shí)現(xiàn)過(guò)程中，可以通過(guò) ProjectGenerationContext 獲取相關(guān)依賴，然后通過(guò)自定義邏輯完成文件生成工作。

下面是 initializr 和 start.spring.io 提供的 ProjectContributor 實(shí)現(xiàn)：

拿幾個(gè)主要的實(shí)現(xiàn)看看：

• MavenBuildProjectContributor：寫(xiě)入 maven 項(xiàng)目 pom.xml 文件；
• WebFoldersContributor：創(chuàng)建 web 項(xiàng)目的資源文件夾；
• ApplicationPropertiesContributor：寫(xiě)入 application.properties 文件；
• MainSourceCodeProjectContributor：寫(xiě)入應(yīng)用入口類(lèi) xxxApplication.java 文件；
• HelpDocumentProjectContributor：寫(xiě)入幫助文檔 HELP.md 文件。

相對(duì)于 ProjectContributor，xxxxxCustomizer 不是一個(gè)統(tǒng)一的接口，我把他理解為一種感念和與之對(duì)應(yīng)的命名習(xí)慣；每個(gè) Customizer 都有自己明確的名字，同時(shí)也對(duì)應(yīng)了明確的觸發(fā)邏輯和職責(zé)邊界。

下面列出框架提供的 Customizer 的說(shuō)明：

• MainApplicationTypeCustomizer：自定義 MainApplication 類(lèi)；
• MainCompilationUnitCustomizer：自定義 MainApplication 編譯單元；
• MainSourceCodeCustomizer：自定義 MainApplication 源碼；
• BuildCustomizer：自定義項(xiàng)目構(gòu)建工具的配置內(nèi)容；
• GitIgnoreCustomizer：自定義項(xiàng)目的 .gitignore 文件；
• HelpDocumentCustomizer：自定義項(xiàng)目的幫助文檔；
• InitializrMetadataCustomizer：自定義項(xiàng)目初始化配置元數(shù)據(jù)；這個(gè) Customizer 比較特殊，框架會(huì)在首次加載元數(shù)據(jù)配置時(shí)調(diào)用；
• ProjectDescriptionCustomizer：自定義 ProjectDescription ；即在生成項(xiàng)目文件之前，允許調(diào)整項(xiàng)目描述信息；
• ServletInitializerCustomizer：自定義 web 應(yīng)用在類(lèi)上的配置內(nèi)容；
• TestApplicationTypeCustomizer：自定義測(cè)試 Application 類(lèi)；
• TestSourceCodeCustomizer：自定義測(cè)試 Application 類(lèi)的源碼。

參考資料

1. 相關(guān)鏈接initializr 說(shuō)明文檔

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

spring-initializr 項(xiàng)目地址

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

start.spring.io 項(xiàng)目地址

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

2. spring.factories 明細(xì)

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

到此這篇關(guān)于阿里云發(fā)布 Spring Boot 新腳手架，真香的文章就介紹到這了,更多相關(guān)Spring Boot 腳手架內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

最新評(píng)論