看了 Spring 官網腳手架真香，也撸一個 SpringBoot DDD 微服務的腳手架！

作者：小傅哥

部落格：https://bugstack.cn

沉澱、分享、成長，讓自己和他人都能有所收獲！😄

一、前言

為什麼我們要去造輪子？

造輪子的核心目的，是為了解決通用共性問題的凝練和複用。

雖然市面上已經有了大量成熟穩定用于支撐系統建設的輪子，也就是服務、架構、元件、工具等，但對于一些較大型的公司來說，這些輪子可能并不一定能很好的支撐起系統需要承載的服務體量，這個時候就需要自建一些輪子。

而提倡的不重複造輪子，新造輪子不一定能保證穩定性。一般用在以官網推出的核心輪子上是适合的，比如 SpringBoot、Netty、HBase 等。但對于一些特殊場景的解決方案工具型元件，通常是沒有完全符合的輪子的，就像 SpringBoot 腳手架。

其實每個較大型的公司都會有很多同類技術服務的元件，例如 RPC、資料庫路由、注冊中心、分布式任務、MQ隊列消息等，而這時候腳手架的開發就需要适配這些元件，搭建出符合自己公司技術棧實作需要的系統架構。這不同于一些較小的網際網路公司，可以完全使用 SpringBoot 提供的一整套解決方案

另外，造輪子是個人技術沉澱、也是薪資待遇的積累！别說造不了飛機，隻是你沒有提供場地！

有什麼場景還能造輪子？

用于架構基建下的所有子產品都可以成為輪子，通常我們都是在這些場景下：

負載均衡

、

服務網關

服務治理

架構語言

服務元件

資料承載

架構結構

部署方式

工具插件

，建設需要的輪子。

其實一個較成熟的網際網路公司，大部分場景下的輪子，已基本建造完了。剩下的一般是用于解決業務場景下非業務邏輯的通用性元件，例如，高并發下的緩存熱Key、Redis 層路由、活動邀請的不唯一短碼生成，等等類似這樣的場景。但此類場景的輪子建設也是非常有價值的，在公司層面使用穩定後，還可以推廣到市場獲得一定的認可，以及更好的會被收入到 Apache 項目。

二、什麼是腳手架呢？

What is scaffolding? Is it a term for a particular platform?

Scaffolding is a meta-programming method of building database-backed software applications. It is a technique supported by some model-view-controller frameworks, in which the programmer may write a specification that describes how the application database may be used. The compiler uses this specification to generate code that the application can use to create, read, update and delete database entries, effectively treating the template as a "scaffold" on which to build a more powerful application.

• https://stackoverflow.com/questions/235018/what-is-scaffolding-is-it-a-term-for-a-particular-platform

結合 stackoverflow 上的回答，腳手架是一種元程式設計方法，用于建構基于資料的應用。建立系統架構的程式員編寫一份規格說明書，用于描述怎麼去使用資料庫。而腳手架可以根據這份規則說明書生成相應的架構代碼。我們把這種模式成為腳手架，在腳手架上更高效的建構出

powerful

的應用！

說白了就是簡化具有共性重複操作的簡單工作，不再需要程式員還得一點點粘貼複制，克隆出一個已經存在的架構。隻需要在界面或者公用接口上，傳入必要的參數，就可以建立出一個應用開發架構。

三、誰提供了腳手架？

1、Spring 官網腳手架

• 推薦：⭐⭐⭐⭐
• 連結：https://start.spring.io
• 源碼：https://github.com/spring-io/start.spring.io
• 描述：Spring Initializr 本質上也是一個 Web 應用，它可以通過 Web 界面、Spring Tool Suite、IntelliJ IDEA 等方式，建構出一個基本的 Spring Boot 項目結構。同時可以使用它的源碼進行本地部署

2、阿裡雲腳手架

• 描述：Aliyun Java Initializr 和 Spring Initializr 是同類的 Web 服務，是代碼架構生成器，一鍵生成你的代碼架構，有完善的工具鍊，免費的IDEA插件，友善直接在IDE中生成，同時也非常适合國内使用者的網絡環境。

其實，這兩個腳手架都能很好的生成項目結構，讓程式員可以在統一的标準下快速的進入開發環境。隻是依賴于自身選擇的支撐服務，選擇不同的架構就可以了。

四、手撸一個腳手架！

都有腳手架了，那為什麼要自己撸一個呢？

腳手架的目的是為了在統一的标準下快速建設系統架構，把系統開發過程中需要的配置、元件、服務、測試，一并通過配置引入到系統開發中。

但有些時候在網際網路公司通用的腳手架是不太合适使用的，因為它沒有把公司内的一些自研性質的元件引入進去，也不能很好的融合。如果已經用腳手架生成後還得需要研發人員自己大量複制進去一些特定的元件，就破壞了腳手架本身能力，也是破壞了準則和規範。

是以，需要結合腳手架的開發能力，包裝各類特定元件、服務、配置，實作符合公司領域的統一腳手架。

那麼，本章節就帶着大家看看一個腳手架，該如何開發實作。其實并沒有太複雜，我們可以使用 freemarker 的能力，建構系統架構。

1. 工程架構

EasyRiggerInitializr
└── src
    ├── main
    │   ├── java
    │   │   └── cn.bugstack.initializr.rigger
    │   │       ├── application
    │   │       │		└── IProjectGenerator.java
    │   │       ├── domain
    │   │       │		├── model
    │   │       │		│   └── ApplicationInfo.java	    
    │   │       │		│   └── ProjectInfo.java	
    │   │       │		└── service
    │   │       │		    ├── module
    │   │       │		    │		├── impl
    │   │       │		    │  	│   ├── GenerationApplication.java
    │   │       │		    │  	│   ├── GenerationIgnore.java
    │   │       │		    │  	│   ├── GenerationPackageInfo.java
    │   │       │		    │  	│   ├── GenerationPom.java
    │   │       │		    │  	│   ├── GenerationTest.java    
    │   │       │		    │  	│   └── GenerationYml.java     
    │   │       │		    │   └── BaseModule.java    
    │   │       │		    └── ProjectGeneratorImpl.java
    │   │       └── RiggerApplication.java
    │   └── resources	
    │       ├── generator
    │       │  	├── application.ftl
    │       │  	├── ignore.ftl 
    │       │  	├── package-info.ftl 
    │       │  	├── pom.ftl 
    │       │  	├── test.ftl     
    │       │  	└── yml.ftl    
    │       └── application.yml
    └── test
         └── java
             └── cn.bugstack.initializr.rigger.test
                 └── ApiTest.java
           

整個用于建立腳手架的工程并不複雜，主要就是通過 freemarker 對各類定義的 ftl 模闆檔案，生成對應的系統架構結構。這裡包括：工程主體、架構結構、啟動類、配置檔案、測試類等，也可以結合自身需求把對應 ORM 的類和映射關系生成出來。

整個工程結構偏 DDD 層次結構，domain 領域中建設了所有的生成方式，resources/generator 定義生成模闆，其他地方就沒有太大的差異了。

接下來簡單介紹下這個工程的代碼，讓大家可以了解這樣的工程是如何開發的，也可以通過這樣工程繼續完善成自己需要的結構。

2. 應用層定義生成類接口

cn.bugstack.initializr.rigger.application.IProjectGenerator.java

public interface IProjectGenerator {

    void generator(ProjectInfo projectInfo) throws Exception;

}
           

• DDD 的分層結構，通常都會在 application 這個比較薄的層定義接口，再有 domain 領域層做相應的實作。
• 這個接口的定義主要是為了，讓外部調用方可以通過此接口建立工程架構。

3. FTL 模闆定義

什麼是 FreeMarker?

FreeMarker 是一款 模闆引擎： 即一種基于模闆和要改變的資料， 并用來生成輸出文本(HTML網頁，電子郵件，配置檔案，源代碼等)的通用工具。 它不是面向最終使用者的，而是一個Java類庫，是一款程式員可以嵌入他們所開發産品的元件。

模闆編寫為FreeMarker Template Language (FTL)。它是簡單的，專用的語言， 不是 像PHP那樣成熟的程式設計語言。 那就意味着要準備資料在真實程式設計語言中來顯示，比如資料庫查詢和業務運算， 之後模闆顯示已經準備好的資料。在模闆中，你可以專注于如何展現資料， 而在模闆之外可以專注于要展示什麼資料。

• FreeMarker 線上手冊：http://freemarker.foofun.cn

3.1 application.ftl

package ${packageName};

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class ${className} {

    public static void main(String[] args) {
        SpringApplication.run(${className}.class, args);
    }

}
           

3.2 pom.ftl

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.1.6.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>${groupId}</groupId>
    <artifactId>${artifactId}</artifactId>
    <version>${version}</version>
    <name>${name}</name>
    <description>${description}</description>
    
</project>
           

3.3 yml.ftl

server:
  port: 8081
           

以上，隻是用于生成架構檔案的基礎 ftl 檔案，有需要一些特殊判斷和邏輯的，可以參考FreeMarker 線上手冊，編寫自己需要的 ftl 檔案。

4. FTL 生成檔案

cn.bugstack.initializr.rigger.domain.service.module.impl.GenerationApplication.java

@Service
public class GenerationApplication extends BaseModule {

    private Logger logger = LoggerFactory.getLogger(GenerationApplication.class);

    public void doGeneration(ProjectInfo projectInfo, String projectsRoot, String lastPackageName, StringBuffer applicationJavaName) throws Exception {

        ApplicationInfo applicationInfo = new ApplicationInfo(
                projectInfo.getGroupId() + "." + lastPackageName,
                applicationJavaName.toString()
        );

        String packagePath = applicationInfo.getPackageName().replace(".", "/") + "/";

        File file = new File(projectsRoot + projectInfo.getArtifactId() + "/src/main/java/" + packagePath,
                applicationInfo.getClassName() + ".java");

        // 寫入檔案
        super.writeFile(file, "application.ftl", applicationInfo);

        logger.info("建立主入口類 Application.java {}", file.getPath());
    }

}
           

• 關于 ftl 檔案的使用，無論在用于生成那一層的檔案，基本都是通用。這裡隻展示一下關于 Application.java 的建立。
• 主要包括了，定義入參

  ApplicationInfo

  、定義檔案位置

  /src/main/java/

  、以及寫入到檔案

  super.writeFile

  ，這三方面。

5. 建立架構入口

cn.bugstack.initializr.rigger.domain.service.ProjectGeneratorImpl.java

@Service
public class ProjectGeneratorImpl implements IProjectGenerator {

    private Logger logger = LoggerFactory.getLogger(ProjectGeneratorImpl.class);

    @Resource
    private GenerationApplication generationApplication;
    @Resource
    private GenerationYml generationYml;
    @Resource
    private GenerationPom generationPom;
    @Resource
    private GenerationTest generationTest;
    @Resource
    private GenerationIgnore generationIgnore;
    @Resource
    private GenerationPackageInfo generationPackageInfo;

    @Override
    public void generator(ProjectInfo projectInfo) throws Exception {

        URL resource = this.getClass().getResource("/");
        String projectsRoot = resource.getFile() + "/projects/";

        String lastPackageName = projectInfo.getArtifactId().replaceAll("-", "").toLowerCase();
        //啟動類名稱
        String[] split = projectInfo.getArtifactId().split("-");
        StringBuffer applicationJavaName = new StringBuffer();
        Arrays.asList(split).forEach(s -> {
            applicationJavaName.append(s.substring(0, 1).toUpperCase() + s.substring(1));
        });
        applicationJavaName.append("Application");

        // 1. 建立  Application.java
        generationApplication.doGeneration(projectInfo, projectsRoot, lastPackageName, applicationJavaName);

        // 2. 生成 application.yml
        generationYml.doGeneration(projectInfo, projectsRoot);

        // 3. 生成 pom.xml
        generationPom.doGeneration(projectInfo, projectsRoot);

        // 4. 建立測試類 ApiTest.java
        generationTest.doGeneration(projectInfo, projectsRoot, lastPackageName, applicationJavaName);

        // 5. 生成 .gitignore
        generationIgnore.doGeneration(projectInfo, projectsRoot);

        // 6. DDD 四層描述檔案
        generationPackageInfo.doGeneration(projectInfo, projectsRoot, lastPackageName, applicationJavaName);

    }

}
           

ProjectGeneratorImpl

類，就是應用層接口

IProjectGenerator

在領域層的具體實作。這裡包括了如下内容：

1. 建立 Application.java
2. 生成 application.yml
3. 生成 pom.xml
4. 建立測試類 ApiTest.java
5. 生成 .gitignore
6. DDD 四層描述檔案

綜上，就是整個腳手架生成的簡要介紹，其實并沒有多複雜，主要就是 ftl 檔案的定義和使用，這種建立腳手架的方式還是很友善的。

6. 測試驗證

單元測試

@Test
public void test_IProjectGenerator() throws Exception {
    ProjectInfo projectInfo = new ProjectInfo(
            "cn.bugstack.demo",
            "web-test",
            "1.0.0-SNAPSHOT",
            "web-test",
            "Demo project for Spring Boot"
    );
    iProjectGenerator.generator(projectInfo);
}
           

測試結果

• 腳手架把建立出來的工程生成到 test-classes 下，這個路徑也可以配置到其他路徑裡。
• 有了新生成的工程就可以通過 IDEA 打開了，與我們手動建立的工程是一樣的。

五、源碼下載下傳

• 源碼下載下傳：https://github.com/fuzhengwei/EasyRiggerInitializr
• 項目介紹：SpringBoot 腳手架，簡化項目建構。目前的項目工程還比較簡單，非常适合新人學習使用。後續我們會在這個版本的基礎上陸續完善一些功能，把RPC、MQ、注冊中心、網關、等各類元件融合進來，友善選擇性的建構和擴充。

六、總結

• 站在公司角度不重複造輪子是為了各部門職責和資源的成本，但對個人來說，不能因為一句不重複造輪子，就放棄了對知識棧深入學習的機會。
• 沒有這些根基的學習，也壓根不會了解技術的遷移、服務的提取、元件的凝練。反反複複的總是做一些 API 的應用包殼，對個人技術上也就沒有什麼成長。
• 最後說回來，哪怕公司不需要你造輪子，沒關系，你可以造給自己，可以分享到 Github 社群。一方面是自己的學習彙總，另一方面也是對技術的沉澱和貢獻。

七、系列推薦

• 方案設計：基于IDEA插件開發和位元組碼插樁技術，實作研發傳遞品質自動分析
• 技術掃盲：關于低代碼程式設計的可持續性傳遞設計和分析
• 工作兩三年了，整不明白架構圖都畫啥？
• 網際網路架構的演變過程
• 領域驅動設計架構基于SpringCloud搭建微服務

公衆号：bugstack蟲洞棧 | 作者小傅哥多年從事一線網際網路 Java 開發的學習曆程技術彙總，旨在為大家提供一個清晰詳細的學習教程，側重點更傾向編寫Java核心内容。如果能為您提供幫助，請給予支援(關注、點贊、分享)！