手寫Maven的archetype專案腳手架

阿豪聊乾貨發表於2017-09-18

一、背景

　　maven是一個很好的程式碼構建工具，採用“約定優先於配置”的原則進行專案管理，相信很多的java開發者應該都瞭解maven並可能在工作當中都是通過maven來管理專案的，在建立的專案的時候，我們往往會使用maven內建的專案骨架也就是archetype來快速生成專案結構。但是在一個團隊做開發的過程中，可能僅僅依靠maven預先提供的archetyp可能是不夠的，團隊之間協作有自己的定義方式，每個人的結構定義風格也不盡相同，在這樣的背景下我們有必要去定義一個統一的程式碼骨架供團隊使用，這樣做的好處是當團隊需要開始一個新專案的時候，可以利用自定義的maven骨架一鍵生成專案。

　　archetype是在maven-archetype-plugin外掛執行generate目標的時候進行配置的，我們經常使用到maven的內嵌的骨架包括：maven-archetype-webapp、maven-archetype-quickstart。前者用來快速搭建一個web工程專案，後者用來快速搭建一個普通的java工程專案。

二、手寫普通單模組專案的archetype

單模組專案的archetype腳手架專案的結構

上圖中的各個檔案詳解：

根目錄beast-archetype下的pom.xml和一般的maven專案一樣主要定義archetype專案的座標等資訊。
所有的專案骨架內容都集中在src/main/resources/archetype-resources資料夾下。
archetype-resources中的pom.xml定義了待生成專案的pom檔案的內容，/src/main/java、/src/test/java中分別定義了待生成專案中相應目錄下的內容
/src/main/resources/META-INF/maven/archetype-metadata.xml中定義相關的後設資料描述(其中該檔案的位置固定為resources/META-INF/maven資料夾下,且名稱固定為archetype-metadata.xml)。

1.beast-archetype/pom.xml內容如下

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

    <groupId>com.thebeastshop</groupId>
    <artifactId>beast-archetype</artifactId>
    <version>1.1</version>
    <packaging>jar</packaging>

    <name>beast-archetype</name>
    <url>http://maven.apache.org</url>

    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    </properties>

    <dependencies>
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>3.8.1</version>
            <scope>test</scope>
        </dependency>
    </dependencies>
    <build>
        <finalName>beast-archetype</finalName>
    </build>
</project>

2.src/main/resources/archetype-resources/pom.xml內容如下：

<?xml version="1.0"?>
<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>
    <groupId>${groupId}</groupId>
    <artifactId>${artifactId}</artifactId>
    <version>${version}</version>
    <name>${artifactId}</name>
    
    <dependencies>
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>3.8.1</version>
            <scope>test</scope>
        </dependency>
    </dependencies>

    <build>
        <plugins>
             <plugin> 
                 <artifactId>maven-deploy-plugin</artifactId> 
                 <configuration> 
                    <skip>true</skip> 
                 </configuration> 
             </plugin>
        </plugins>
        <pluginManagement>
            <plugins>
                <plugin>
                    <groupId>org.apache.maven.plugins</groupId>
                    <artifactId>maven-archetype-plugin</artifactId>
                    <version>2.2</version>
                    <configuration>
                        <source>1.7</source>
                        <target>1.7</target>
                    </configuration>
                </plugin>
                <plugin>
                    <groupId>org.apache.maven.plugins</groupId>
                    <artifactId>maven-source-plugin</artifactId>
                    <configuration>
                        <encoding>UTF-8</encoding>
                    </configuration>
                </plugin>
            </plugins>
        </pluginManagement>
    </build>
</project>

其中：上面${}標識的變數都是通過maven中的命令列傳進來的，如：mvn archetype:generate -DgroupId=com.thebeastshop

3.src/main/resources/META-INF/maven/archetype-metadata.xml內容如下：

<?xml version="1.0" encoding="UTF-8"?>
<archetype-descriptor  name="beast-archetype"
        xmlns="http://maven.apache.org/plugins/maven-archetype-plugin/archetype-descriptor/1.0.0"
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xsi:schemaLocation="
            http://maven.apache.org/plugins/maven-archetype-plugin/archetype-descriptor/1.0.0
            http://maven.apache.org/xsd/archetype-descriptor-1.0.0.xsd">

    <requiredProperties>
        <requiredProperty key="package-name" />
    </requiredProperties>

    <fileSets>
        <fileSet filtered="true" packaged="true" encoding="UTF-8">
            <directory>src/main/java</directory>
            <includes>
                <include>**/*.java</include>
            </includes>
        </fileSet>
        <fileSet filtered="true" encoding="UTF-8">
            <directory>src/main/resources</directory>
            <includes>
                <include>**/*.*</include>
            </includes>
        </fileSet>
        <fileSet filtered="true" packaged="true" encoding="UTF-8">
            <directory>src/test/java</directory>
            <includes>
                <include>**/*.java</include>
            </includes>
        </fileSet>
        <fileSet encoding="UTF-8">
            <directory>src/test/resources</directory>
            <includes>
                <include>**/*.*</include>
            </includes>
        </fileSet>
    </fileSets>
</archetype-descriptor>

說明：

packaged="true"標識src/main/resources/archetype-resources/src/main/java中對應的內容是否要放入到package中,比如package為com.thebeastshop,那麼如果該屬性為true,則對應的java檔案會放到com/thebeastshop資料夾下，也就是包路徑下。
filtered="true"標識下面提到的${}是否要進行替換

4.src/main/resources/archetype-resources/src/main/java/Demo.java內容如下：

package ${package};

public class Demo{
    public static void main( String[] args )
    {
        System.out.println( "Hello My Archetype!" );
    }
}

5.這樣我們就手寫好了一個自定義的maven的archetype骨架專案，我們只需要通過mvn clean install 命令把該jar包安裝到本地倉庫，然後通過本地倉庫中的該jar包來生成一個專案看看效果，使用如下命令：

 mvn archetype:generate 
　　-DgroupId=comthebeastshop 
　　-DartifactId=beast-test 
　　-Dpackage="com.thebeastshop.test" 
　　-DarchetypeGroupId=com.thebeastshop 
　　-DarchetypeArtifactId=beast-archetype -DarchetypeVersion=1.1 -X -DarchetypeCatalog=local

三、手寫maven多module的專案骨架archetype

1.多模組骨架專案的專案結構

這跟單模組專案區別不大，但是有幾個概念需要說明：

“__rootArtifactId__”佔位符會被parent專案的artifactId替換
${rootArtifactId}也會被parent專案的artifactId替換
src/main/resources/archetype-resources裡必須要有一個頂級pom檔案（如果是單工程就是工程pom檔案），同時子資料夾代表了模組定義

2.模板工程定義描述檔案：META-INF/maven/archetype-metadata.xml

<?xml version="1.0" encoding="UTF-8"?>
<archetype-descriptor  name="beast-archetype"
        xmlns="http://maven.apache.org/plugins/maven-archetype-plugin/archetype-descriptor/1.0.0"
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xsi:schemaLocation="
            http://maven.apache.org/plugins/maven-archetype-plugin/archetype-descriptor/1.0.0
            http://maven.apache.org/xsd/archetype-descriptor-1.0.0.xsd">

    <requiredProperties>
        <requiredProperty key="groupId">
            <defaultValue>com.thebeastshop</defaultValue>
        </requiredProperty>
        <requiredProperty key="artifactId">
            <defaultValue>test</defaultValue>
        </requiredProperty>
        <requiredProperty key="package">
            <defaultValue>com.thebeastshop.test</defaultValue>
        </requiredProperty>
    </requiredProperties>

    <modules>
        <module id="${rootArtifactId}-api" name="${rootArtifactId}-api" dir="__rootArtifactId__-api">
            <fileSets>
                <fileSet filtered="true" encoding="UTF-8" packaged="true">
                    <directory>src/main/java</directory>
                    <includes>
                        <include>**/*.*</include>
                    </includes>
                </fileSet>
                <fileSet filtered="true" encoding="UTF-8" packaged="true">
                    <directory>src/test/java</directory>
                    <includes>
                        <include>**/*.*</include>
                    </includes>
                </fileSet>
                <fileSet encoding="UTF-8">
                    <directory>src/main/resources</directory>
                    <includes>
                        <include>**/*.*</include>
                    </includes>
                </fileSet>
                <fileSet encoding="UTF-8">
                    <directory>src/test/resources</directory>
                    <includes>
                        <include>**/*.*</include>
                    </includes>
                </fileSet>
            </fileSets>
        </module>
        <module id="${rootArtifactId}-core" name="${rootArtifactId}-core" dir="__rootArtifactId__-core">
            <fileSets>
                <fileSet filtered="true" encoding="UTF-8" packaged="true">
                    <directory>src/main/java</directory>
                    <includes>
                        <include>**/*.*</include>
                    </includes>
                </fileSet>
                <fileSet filtered="true" encoding="UTF-8" packaged="true">
                    <directory>src/test/java</directory>
                    <includes>
                        <include>**/*.*</include>
                    </includes>
                </fileSet>
                <fileSet filtered="true" encoding="UTF-8">
                    <directory>src/main/resources</directory>
                    <includes>
                        <include>**/*.*</include>
                    </includes>
                </fileSet>
                <fileSet encoding="UTF-8">
                    <directory>src/test/resources</directory>
                    <includes>
                        <include>**/*.*</include>
                    </includes>
                </fileSet>
            </fileSets>
        </module>
        <module id="${rootArtifactId}-dao" name="${rootArtifactId}-dao" dir="__rootArtifactId__-dao">
            <fileSets>
                <fileSet filtered="true" encoding="UTF-8" packaged="true">
                    <directory>src/main/java</directory>
                    <includes>
                        <include>**/*.*</include>
                    </includes>
                </fileSet>
                <fileSet filtered="true" encoding="UTF-8" packaged="true">
                    <directory>src/test/java</directory>
                    <includes>
                        <include>**/*.*</include>
                    </includes>
                </fileSet>
                <fileSet filtered="true" encoding="UTF-8">
                    <directory>src/main/resources</directory>
                    <includes>
                        <include>**/*.*</include>
                        <include>mapper</include>
                    </includes>
                </fileSet>
                <fileSet encoding="UTF-8">
                    <directory>src/test/resources</directory>
                    <includes>
                        <include>**/*.*</include>
                    </includes>
                </fileSet>
            </fileSets>
        </module>
        <module id="${rootArtifactId}-main" name="${rootArtifactId}-main" dir="__rootArtifactId__-main">
            <fileSets>
                <fileSet filtered="true" encoding="UTF-8" packaged="true">
                    <directory>src/main/java</directory>
                    <includes>
                        <include>**/*.*</include>
                    </includes>
                </fileSet>
                <fileSet filtered="true" encoding="UTF-8" packaged="true">
                    <directory>src/test/java</directory>
                    <includes>
                        <include>**/*.*</include>
                    </includes>
                </fileSet>
                <fileSet filtered="true" encoding="UTF-8">
                    <directory>src/main/resources</directory>
                    <includes>
                        <include>**/*.*</include>
                    </includes>
                </fileSet>
                <fileSet encoding="UTF-8">
                    <directory>src/test/resources</directory>
                    <includes>
                        <include>**/*.*</include>
                    </includes>
                </fileSet>
                <fileSet encoding="UTF-8">
                    <directory>src/main/assembly</directory>
                    <includes>
                        <include>**/*.*</include>
                    </includes>
                </fileSet>
                <fileSet encoding="UTF-8">
                    <directory>src/main/bin</directory>
                    <includes>
                        <include>**/*.*</include>
                    </includes>
                </fileSet>
            </fileSets>
        </module>
        <module id="${rootArtifactId}-mybatisGen" name="${rootArtifactId}-mybatisGen" dir="__rootArtifactId__-mybatisGen">
            <fileSets>
                <fileSet filtered="true" encoding="UTF-8" packaged="true">
                    <directory>src/main/java</directory>
                    <includes>
                        <include>**/*.*</include>
                    </includes>
                </fileSet>
                <fileSet filtered="true" encoding="UTF-8" packaged="true">
                    <directory>src/test/java</directory>
                    <includes>
                        <include>**/*.*</include>
                    </includes>
                </fileSet>
                <fileSet encoding="UTF-8">
                    <directory>src/main/resources</directory>
                    <includes>
                        <include>**/*.*</include>
                    </includes>
                </fileSet>
                <fileSet encoding="UTF-8">
                    <directory>src/test/resources</directory>
                    <includes>
                        <include>**/*.*</include>
                    </includes>
                </fileSet>
            </fileSets>
        </module>
    </modules>
</archetype-descriptor>

屬性變數定義

<requiredProperties>
    <requiredProperty key="groupId">
        <defaultValue>com.thebeastshop</defaultValue>
    </requiredProperty>
    <requiredProperty key="artifactId">
        <defaultValue>test</defaultValue>
    </requiredProperty>
    <requiredProperty key="package">
        <defaultValue>com.thebeastshop.test</defaultValue>
    </requiredProperty>
</requiredProperties>

這些屬性可以在資源元檔案裡的任意一個檔案裡通過${var}來引用，所以的元檔案最終都可以選擇通過velocity引擎來執行替換後生成。
預設的屬性有：groupId，artifactId，packeage，version等

專案子模組定義

<modules>
    <module id="${rootArtifactId}-api" name="${rootArtifactId}-api" dir="__rootArtifactId__-api">
        ...
    </module>
    <module id="${rootArtifactId}-core" name="${rootArtifactId}-core" dir="__rootArtifactId__-core">
        ...
    </module>
    <module id="${rootArtifactId}-dao" name="${rootArtifactId}-dao" dir="__rootArtifactId__-dao">
        ...
    </module>
    <module id="${rootArtifactId}-main" name="${rootArtifactId}-main" dir="__rootArtifactId__-main">
        ...
    </module>
    <module id="${rootArtifactId}-mybatisGen" name="${rootArtifactId}-mybatisGen" dir="__rootArtifactId__-mybatisGen">
        ...
    </module>
</modules>

module有三個屬性，解釋如下：
id     ：定義子模組工程的artifactId.
dir    ：子模組工程原始檔在archetype-resources裡對應的directory.
name   ：子模組的名字.

3.子模組pom.xml定義如下(以core模組為例)：

<?xml version="1.0"?>
<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>com.thebeastshop</groupId>
        <artifactId>${rootArtifactId}</artifactId>
        <version>${version}</version>
    </parent>

    <artifactId>${artifactId}</artifactId>
    <name>${artifactId}</name>
    
    <dependencies>
        <dependency>
            <groupId>com.thebeastshop</groupId>
            <artifactId>${rootArtifactId}-api</artifactId>
            <version>${api.version}</version>
        </dependency>
        <dependency>
            <groupId>com.thebeastshop</groupId>
            <artifactId>${rootArtifactId}-dao</artifactId>
            <version>${project.parent.version}</version>
        </dependency>
    </dependencies>
    
    <build>
        <plugins>
             <plugin> 
                 <artifactId>maven-deploy-plugin</artifactId> 
                 <configuration> 
                    <skip>true</skip> 
                 </configuration> 
             </plugin>
        </plugins>
    </build>
</project>

其中${rootArtifactId}就代表父專案的artifactId.

4.我們和單模組腳手架工程一樣，通過mvn clean install命令把該腳手架專案安裝到本地maven倉庫，然後就可以使用該專案來快速生成新專案結構了，生成命令如下：

mvn archetype:generate 
　　-DgroupId=com.thebeastshop 
　　-DartifactId=ddd 
　　-Dversion=1.0.0-SNAPSHOT
　　-DarchetypeGroupId=com.thebeastshop 
　　-DarchetypeArtifactId=beast-archetype 
　　-DarchetypeVersion=1.3-SNAPSHOT -X -DarchetypeCatalog=local

我們就會看到生成好的專案結構如下：

多模組專案腳手架原始碼：https://github.com/hafizzhang/beast-archetype

四、總結

　　在工作中，我們通常要有“偷懶”意識，通過摸索來開發出類似專案腳手架一樣的工具來提升自己工作的效率。不能整天都是渾渾噩噩的過去，而且表面上看上去很難的東西實際上並不見得一定就如想象中的難。程式猿還是要有所追求，哈哈~

Maven Archetype 多 Module 自定義程式碼腳手架
2022-01-14
Maven
Java如何搭建腳手架（自動生成通用程式碼），建立自定義的archetype(專案模板)
2021-09-04
Java
Dva手腳架搭建React專案
2020-06-17
React
簡單vue專案腳手架
2019-02-16
Vue
使用腳手架搭建VUE專案
2018-08-07
Vue
用 yeoman 打造自己的專案腳手架
2018-08-20
微信小程式--專案腳手架的搭建
2018-09-21
微信小程式
Flask實戰腳手架-專案建立
2021-09-09
Flask
【 Vue 】 Vue 使用腳手架建立專案
2020-11-28
Vue
前端部署腳手架專網專案實踐
2022-01-17
前端
Net通用應用的專案框架腳手架
2024-03-18
框架
使用 .NET CLI 構建專案腳手架
2021-03-09
用腳手架搭建一個 vue 專案
2021-02-28
Vue
自己搭建一個vue專案(腳手架)
2018-05-28
Vue
vue-cli腳手架專案構成
2018-02-05
Vue
vue-cli3.0腳手架+typescript專案建立
2018-08-08
VueTypeScript
vue腳手架
2018-09-28
Vue
Node腳手架編寫初學者教程
2017-06-26
七天接手react專案系列 —— react 腳手架建立專案
2022-03-20
React
SpringBoot2.1腳手架（種子）專案
2018-12-10
Spring Boot
spring cloud腳手架專案(十一)logback配置
2020-10-20
SpringCloud
vue - Vue腳手架
2022-05-05
Vue
vue腳手架工具
2018-07-20
Vue
webpack 配置react腳手架配置檔案
2017-03-08
WebReact
寫一個屬於你的前端腳手架工具
2019-03-03
前端
使用Maven命令列快速建立專案骨架（archetype）
2014-06-06
Maven命令列
前端工程化: 腳手架+物料庫快速生成新專案
2019-04-02
前端
讓我們用gulp寫個前端腳手架
2019-03-04
前端
Maven Archetype
2024-03-18
Maven
vue腳手架基礎
2020-11-21
Vue
plop小型腳手架工具
2020-11-23
vue 腳手架配置及檔案介紹
2019-03-31
Vue
從零搭建Spring Boot腳手架（4）：手寫Mybatis通用Mapper
2020-08-07
Spring BootMyBatisAPP
不會手寫vue-cli腳手架，leader竟要辭退我！
2021-09-09
Vue
從零開始製作cli工具，快速建立專案腳手架
2019-05-11
9102年：手寫一個Vue的腳手架【極致優化版】
2019-05-17
Vue優化
原生純淨的Boot腳手架
2021-08-11
boot
腳手架的開發總結
2019-01-10

手寫Maven的archetype專案腳手架

一、背景

二、手寫普通單模組專案的archetype

相關文章