開啟Spring Initializr個性化之旅-有解無憂

Every good Spring Boot project usually starts at https://start.spring.io/

— Josh Long

202006201751FnpKSR11

背景介紹，自己的專案或者公司的專案一般需要維護很多定制化的模塊時，都是上傳到maven私服中方便使用，但存在一個問題，每次需要相關的package需要去翻檔案或者看bom，不能在建專案的時間直接引入，參考了start.spring.io，嘗試搭建自己的spring initializr服務，同時整合自己的一些package，提供個性化服務，快速開發，

目標

基本框架

18077Y13ii51

Spring Initializr 提供核心REST API，可以整合到UI或者IDE（如Intellij IDEA），直接生成專案
https://start.spring.io 提供web界面，強依賴于 Spring Initializr，顯示資料來源于 Spring Properties，定制化主要是使用 Spring Initializr 提供的SPI
除此之外，Spring.io 提供 Spring Boot metadata endpoint，Spring Initializr 會使用metadata作為外部資料源，以確保生成的Spring Boot版本是最新的

個性化

https://start.spring.io/ 雖然已經提供了非常優秀的Spring Boot Start，但在某些場景下，仍然需要做一些定制化，比如：

由于網路限制，需要搭建一個自己的實體
定制化自己的UI界面
提供一些自己的配置或依賴，如公司內部的starter

Spring Initializr 是一個使用Spring Boot搭建的模塊化應用，所以還是很容易擴展的

版本

由于官方Spring Initializr以及提供了bom，所以我們直接基于最新的bom版本搭建即可，

<dependencyManagement>
    <dependencies>
      <dependency>
        <groupId>io.spring.initializr</groupId>
        <artifactId>initializr-bom</artifactId>
        <version>0.8.0.RELEASE</version>
        <type>pom</type>
        <scope>import</scope>
      </dependency>
    </dependencies>
  </dependencyManagement>

搭建流程

準備

兩個組件

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

initializr 是必須的，ui界面是可選的，

個性化

定制組態檔

可以基于 InitializrProperties 定義 application.yml，產出核心依賴，Spring Initializr 也允許我們使用 InitializrMetadataProvider 定義metadata，因此，我們可以創建一個 CustomInitializrProperties 類來讀取不同組態檔的配置項，

@Configuration
@EnableConfigurationProperties(CustomInitializrProperties.class)
public class CustomInitializrConfiguration {

  @Bean
  public DefaultInitializrMetadataProvider customInitializrMetadataProvider(InitializrProperties initializrProperties,
      CustomInitializrProperties customInitializrProperties,
      InitializrMetadataUpdateStrategy initializrMetadataUpdateStrategy) {
    InitializrMetadata meta = InitializrMetadataBuilder.fromInitializrProperties(customInitializrProperties.getInitializr())
        .withInitializrProperties(initializrProperties, true).build();
    return new DefaultInitializrMetadataProvider(meta, initializrMetadataUpdateStrategy);
  }
}


@Data
@ConfigurationProperties("custom")
public class CustomInitializrProperties {
  @NestedConfigurationProperty
  InitializrProperties initializr = new InitializrProperties();
}

配置是通過 StartApplication 來加載的，但由于應用并沒有使用組件掃描，我們需要在組態檔里進行自定義設定：

custom:
  initializr:
    dependencies:
      - name: Custom Dependencies
        content:
          - name: Custom dependency
            id: custom-dependency
            groupId: your.domain
            artifactId: custom-artifact
            starter: false
            description: My first custom dependency for the Spring Initializr

通過這種自定義的依賴配置，我們就可以控制配置項的合并和顯示順序，

Initializr擴展

通過組態檔自定義依賴，并不是總能滿足我們的需求，有時候我們還需要自定義一些代碼片段，這個時候就需要使用 Spring Initializr 提供的一些擴展鉤子：

BuildCustomizer：定義Maven/Gradle構建程序，如增加maven build插件
ProjectContributor：定義一些個性化的專案目錄或者檔案
MainSourceCodeCustomizer, MainCompilationUnitCustomizer, MainApplicationTypeCustomizer, TestSourceCodeCustomizer, TestApplicationTypeCustomizer：專案的原始碼生成或修改，而不局限于專案語言
GitIgnoreCustomizer：定義gitignore檔案
HelpDocumentCustomizer：定義 HELP.md檔案
ProjectDescriptionCustomizer：通常用于適應專案描述，例如自動解決框架版本和語言級別的無效組合，

舉例，如果我們需要在生成專案中增加maven插件，則需要使用一種所謂的“偽”依賴（ pseudo dependency），首先我們需要定義一個像這樣的依賴：

custom:
  initializr:
    dependencies:
      - name: Custom Dependencies
        content:
          - name: Custom Maven Plugin
            id: custom-maven-plugin
            groupId: your.domain
            artifactId: custom-maven-plugin
            version: 1.0.0
            starter: false
            description: Configures custom Maven plugin integration for project scans

接著，我們定義兩個 BuildCustomizer：一個用來增加maven依賴插件，一個用來移除插件，

@ProjectGenerationConfiguration
@ConditionalOnRequestedDependency("custom-maven-plugin")
public class CustomMavenPluginConfiguration {

  @Bean
  public BuildCustomizer<MavenBuild> customPluginConfigurer() {
    return (MavenBuild build) -> {
      build.dependencies().ids().filter(it -> it.equals("custom-maven-plugin"))
          .findFirst()
          .map(r -> build.dependencies().get(r)).map(r -> {
        build.plugins().add(r.getGroupId(), r.getArtifactId(),
            (plugin) -> plugin.execution("my-execution",
                (first) -> first.goal("scan").configuration((conf) -> {conf.add("failOnSeverity", "MAJOR");})
            ));
        return build;
      }).orElse(build);
    };
  }


  @Bean
  public BuildCustomizer<MavenBuild> customPluginDependencyRemoval() {
    return build -> build.dependencies().remove("custom-maven-plugin");
  }
}

注意使用注解，Spring Initializr 自身并不會使用這些自動化配置，而是在生成專案時使用的，但需要spring.factories注冊這些配置

io.spring.initializr.generator.project.ProjectGenerationConfiguration=\
  io.spring.start.site.extension.StartProjectGenerationConfiguration, \
  io.spring.start.site.CustomMavenPluginConfiguration

最終產生的pom類似這樣：

<plugin>
    <groupId>your.domain</groupId>
    <artifactId>custom-maven-plugin</artifactId>
    <version>1.0.0</version>
    <executions>
        <execution>
            <id>my-execution</id>
            <goals>
                <goal>scan</goal>
            </goals>
            <configuration>
                <failOnSeverity>MAJOR</failOnSeverity>
            </configuration>
        </execution>
    </executions>
</plugin>

結語

拋磚引玉，這篇文章只是簡單介紹了Spring Initializr的一些定制化方法，更多更好的擴展方式還需要你去發現，

本文由歧途老農創作，采用 CC BY 4.0 CN 協議進行許可，可自由轉載、參考，但需署名作者且注明文章出處，

轉載請註明出處，本文鏈接：https://www.uj5u.com/houduan/150228.html

標籤：Java

上一篇：前后端訪問資料互動跨域問題

下一篇：會話技術