手把手教你制作一個基于DDD的Maven腳手架，省時省力還省心！

作者：飄渺Jam 2024-12-03 08:49:01

為什么要這樣做？這是因為默認情況下，腳手架模板會忽略空的文件夾，而我們通過添加 .keep 文件，能夠保證在后續創建項目時，這些空文件夾會被自動生成，包名也能對得上。

有粉絲問我：“用DDD開發項目時，每個業務模塊都要包含四個分層：接口層（Interface Layer）、應用層（Application Layer）、領域層（Domain Layer）、基礎設施層（Infrastructure Layer）。問題來了，每次創建一個新的業務模塊，都得手動創建這四個Maven模塊，手動添加簡直太麻煩了！有沒有什么更快捷的方式？”

別擔心，今天就來解決這個問題：手把手教你如何制作一個Maven腳手架，輕松提高開發效率，避免重復勞動，直接提升幸福感！

1、生成腳手架原型工程

步驟一：創建基于DDD的多模塊項目 ddd-archetype

首先，創建一個基于DDD的多模塊項目 ddd-archetype，在這個項目中，我們需要添加DDD的分層模型。看圖：

圖片

在每個具體的模塊中，我們要創建DDD需要的 java package，并且在這些空包中創建一個名為 .keep 的空文件。

同時，在ddd-archetype項目的 pom.xml 文件中，需要引入 maven-archetype 插件，通過此插件可以生成腳手架原型工程文件。

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-archetype-plugin</artifactId>
            <version>3.3.1</version>
        </plugin>
    </plugins>
</build>

再創建一個名為 archetype.properties 的配置文件，內容如下：

excludePatterns=.idea/*,.git,*.iml,.idea/
gitignore=.gitignore

好了，準備工作完成，接下來進入最重要的步驟！

步驟二：生成原型文件

接著，打開IDEA，找到右側的 Maven 插件管理器，選擇并執行 archetype:create-from-project 命令，這樣就能生成原型文件了！

圖片

執行完后，你會在 ddd-archetype 項目的 target 文件夾下找到生成的原型工程。在這個原型文件里，已經生成了五個模塊目錄。這就是我們準備好的“模板”，未來的新項目都可以直接用它來快速搭建！

圖片

打開生成的文件可以發現有不少占位符，解釋如下：

_rootArtifactId_：文件夾名替換用。比如：_rootArtifactId_-dao，用來動態獲取父工程的 ArtifactId。
${rootArtifactId}：保存用戶輸入的值作為項目名，簡單來說，它就是你在創建項目時輸入的名字。
${artifactId}：如果項目只有一個模塊，這個值跟 ${rootArtifactId} 相同；如果有多個模塊，它會被替換成每個模塊的名字。
${groupId}：你為項目提供的 groupId，Maven 會在提示時詢問你。
${version}：就是版本號，老實說，它可以是你想要的任何數字，但通常我們會用 1.0-SNAPSHOT。

2、將腳手架安裝到本地

接下來，我們要做的就是安裝這個腳手架。進入剛剛生成的原型文件夾，執行 mvn clean install 命令，安裝腳手架到本地。

$ pwd                                                                     
D:\GitSpace\ddd-archetype\target\generated-sources\archetype

$ mvn clean install

執行完后，你會看到類似如下的日志，表示腳手架安裝成功：

[INFO] --- maven-archetype-plugin:3.3.1:update-local-catalog (default-update-local-catalog) @ ddd-archetype-archetype ---
[INFO] Updated local archetypes catalog D:\maven\repository\archetype-catalog.xml
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time:  1.526 s
[INFO] Finished at: 2024-12-02T16:01:52+08:00
[INFO] ------------------------------------------------------------------------

安裝成功后，archetype-catalog.xml 文件會被更新，這個文件決定了在哪里尋找可以運行的原型來生成目標項目。打開它，你會看到自己剛剛創建的腳手架內容：

<archetype>
    <groupId>com.jianzh5</groupId>
    <artifactId>ddd-archetype-archetype</artifactId>
    <version>1.0-SNAPSHOT</version>
    <description>ddd-archetype-archetype</description>
</archetype>

3、應用腳手架，快速生成DDD項目

好了，最后一步，開始用腳手架創建你的DDD項目！在IDEA中，創建新項目時，先配置 Maven Catalogs，如下圖所示，添加一個名為 ddd 的 Catalog，Location 選擇 archetype-catalog.xml 所在目錄（在我這里是 D:\maven\repository）。

圖片