架構師必備技能:Maven Archetype生成項目模板

基本每個公司的項目都有一套模板，只要開新項目直接複製一份改改包名和一些配置就初始化了一個新項目。這種方式有點繁瑣，有沒有通過命令甚至是可視化的方式從一個模板項目初始化項目。Maven其實有提供這種能力，這就是基於原型（Archetype）的生成項目。

集成項目模板插件

首先需要在模板項目中集成Maven原型插件：

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

從項目生成模板

從項目生成模板只需要三步。

生成模板原型文件

Maven插件允許我們從已有項目生成一個模板項目。在項目根目錄下執行mvn archetype:create-from-project命令即可將該項目生成一個項目模板，生成的項目原型被保存在路徑target/generated-sources/archetype下。

但是這個存在一個問題，一些和項目模板源碼無關的文件也會被加入模板中，比如IDEA中的.iml文件、.idea目錄下的文件。這些“垃圾”文件需要在生成模板時被忽略。

如果您正在學習Spring Boot，推薦一個連載多年還在繼續更新的免費教程：http://blog.didispace.com/spring-boot-learning-2x/

maven-archetype-plugin提供了一個屬性配置可以幫助我們實現該能力。在原始項目的根目錄（或者你喜歡的其它目錄）編寫一個.properties文件：

# 原型的座標 必須聲明
archetype.groupId=cn.felord
# 最好按照約定以-archetype結尾
archetype.artifactId=template-archetype
archetype.version=1.0
# 需要忽略的文件夾和文件類型 英文逗號隔開
excludePatterns=**/.idea/**,**/*.iml

這時候執行生成的命令就需要指定該配置文件了：

mvn archetype:create-from-project -Darchetype.properties=./archetype.properties

❝

注意：路徑爲配置文件和根目錄的相對路徑。

這樣生成的原型就忽略掉那些無用的文件了。細心的同學會發現生成原型中的pom.xml的座標變成了：

<groupId>cn.felord</groupId>
<artifactId>template-archetype</artifactId>
<version>1.0</version>
<packaging>maven-archetype</packaging>

<name>template-archetype</name>

安裝生成的原型

我們需要跳轉的target/generated-sources/archetype下執行mvn install

安裝原型庫到本地

在我們本地maven repository目錄（通常是~/.m2）下會把當前原型註冊到archetype-catalog.xml中：

<?xml version="1.0" encoding="UTF-8"?>
<archetype-catalog xsi:schemaLocation="http://maven.apache.org/plugins/maven-archetype-plugin/archetype-catalog/1.0.0 http://maven.apache.org/xsd/archetype-catalog-1.0.0.xsd"
    xmlns="http://maven.apache.org/plugins/maven-archetype-plugin/archetype-catalog/1.0.0"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <archetypes>
    <archetype>
      <groupId>cn.felord</groupId>
      <artifactId>template-archetype</artifactId>
      <version>1.0</version>
      <description>spring security learning demo</description>
    </archetype>
  </archetypes>
</archetype-catalog>

後續使用時maven會從這裏檢索我們本地的模板。

利用原型生成項目

接下來驗證一下效果，從本地原型生成項目需要執行：

mvn archetype:generate -DarchetypeCatalog=local

創建項目步驟都在這裏

然後一個新項目就誕生了。

分享模板

模板分享基於Maven遠程倉庫，首先你要在你的setting.xml中配置一個遠程倉庫並且擁有deploy的權限。然後在target/generated-sources/archetype下執行mvn deploy就行了。這裏有兩種方式來使用遠程的原型模版。

IDEA添加Maven原型模板

點擊New Project然後選擇Maven，勾選Create from archetype點擊Add Archetype彈出對話框：

IDEA添加原型模板

然後模板就被添加到模板列表了，選中添加的模板點擊下一步就可以使用了。

命令行

就像使用本地原型創建項目一樣，這裏給你一套命令執行就可以了：

mvn archetype:generate \
 -DgroupId=cn.felord.demo    \
 -DartifactId=demo-project   \
 -Dversion=1.0.0       \
 -Dpackage=cn.felord.demo   \
 -DarchetypeGroupId=cn.felord  \
 -DarchetypeArtifactId=template-archetype  \
 -DarchetypeVersion=1.0  \
 -DinteractiveMode=false    

❝

如果你想通過交互命令生成，就把前三個選項和最後一個DinteractiveMode去掉試試。

不要忘了把下面的遠程倉庫配置到setting.xml;

  <repository>
    <id>archetype</id>
     <!-- 倉庫地址 -->  
    <url>https://repository.domain.com/path/to/repo/</url>
  </repository>
  
  <!-- 倉庫的認證信息 -->
  <server>
    <id>archetype</id>
    <username>repousername</username>
    <password>xxx.felord.cn</password>
  </server>

項目模版生成在項目研發中很重要，可以讓我們的項目能保持一致性，也方便後續轉微服務或者維護升級，是每一個立志成爲Java架構師的開發者必備的一個技能。

往期推薦

如何更快地將string轉換成int/long

OAuth2 服務器Keycloak中的Realm

Java 17 將至，可能帶來哪些新特性呢？

機械妖姬上門要源碼後續結果來了！

重磅消息：Spring 6 和Spring Boot 3

本文分享自微信公衆號 - 程序猿DD（didispace）。
如有侵權，請聯繫 [email protected] 刪除。
本文參與“OSC源創計劃”，歡迎正在閱讀的你也加入，一起分享。