集成項目模板插件

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

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

從項目生成模板

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

生成模板原型文件

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

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

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

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

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

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

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

這樣生成的原型就忽略掉那些無用的文件了。細心的同學會發(fā)現(xiàn)生成原型中的pom.xml的坐標變成了：

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

<name>template-archetype</name>

安裝生成的原型

我們需要跳轉(zhuǎn)的target/generated-sources/archetype下執(zhí)行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>

后續(xù)使用時maven會從這里檢索我們本地的模板撕予。

利用原型生成項目

接下來驗證一下效果鲫惶，從本地原型生成項目需要執(zhí)行：

mvn archetype:generate -DarchetypeCatalog=local

創(chuàng)建項目步驟都在這里

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

分享模板

模板分享基于Maven遠程倉庫实抡，首先你要在你的setting.xml中配置一個遠程倉庫并且擁有deploy的權(quán)限欠母。然后在target/generated-sources/archetype下執(zhí)行mvn deploy就行了欢策。這里有兩種方式來使用遠程的原型模版。

IDEA添加Maven原型模板

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

IDEA添加原型模板

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

命令行

就像使用本地原型創(chuàng)建項目一樣六水，這里給你一套命令執(zhí)行就可以了：

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>

項目模版生成在項目研發(fā)中很重要掷贾，可以讓我們的項目能保持一致性睛榄，也方便后續(xù)轉(zhuǎn)微服務(wù)或者維護升級。

關(guān)注公眾號：碼農(nóng)小胖哥想帅，獲取更多資訊

個人博客：https://felord.cn