​ Maven Archetype可以理解成Maven项目的模板，相信各位或多或少都是用过。我们刚开始学习maven创建项目时，经常会使用常规的Maven项目模板，例如maven-archetype-quickstart、maven-archetype-webapp；你只需要提供基本的元素（如groupId,artifactId与version等），项目模板就能生成项目的基本结构与POM文件。

​ 在日常工作开发中，项目架手脚搭建是很常见，每次新起一个项目，我们就要进行各种项目配置，其实本质来说项目的基础架构都是大同小异的，所以一般公司开发都会自定义自己的项目模板，有了自定义项目模板，可以快速搭建我们的项目。

一.Maven archetype plugin的了解与使用

注：以下内容是基于Maven 3进行说明

1.使用archetype的一些步骤

​ Maven使用archetype命令 mvn archetype:generate

在控制台输入该命令可以看到Archetype插件会输出一个Archetype列表供用户选择，默认是maven-archetype-quickstart模板。使用maven-archetype-quickstart按回车，下一步就是需要提供一些基本的参数，主要有：

• groupId：想要创建项目的groupId
• artifactId：想要创建项目的artifactId
• version：想要创建项目的version
• package：想要创建项目默认的包名

上述的参数是最常规的，当我们自定义Archetype时，还可以配置额外的配置参数。

根据提示填写好配置后，Archetype插件就会生成项目的骨架。

2.批处理方式使用archetype

​ 有时候用户觉得交互式使用Archetype很麻烦，想一次性输入指令来生成项目架构而不想被交互式破坏。用户可以使用mvn命令的-B选项，要求maven-archetype-plugin以批处理方式运行。不过这样用户要显示声明要使用的Archetype坐标信息，以及要创建项目的groupId、artifactId、version、package等信息，若是Archetype是自定义的，还要输入自己的额外配置参数。例如：

mvn archetype:generate -B \
-DgroupId=com.yibaiwu.demo \
-DartifactId=demo \ 
-Dversion=1.0.0-SNAPSHOT \
-Dpackage=com.yibaiwu.demo \ 
-DarchetypeArtifactId=yibaiwu-archetype-plugin \
-DarchetypeGroupId=com.alias \
-DarchetypeVersion=1.0-SNAPSHOT \

• archetypeArtifactId：Archetype的groupId
• archetypeGroupId：Archetype的artifactId
• archetypeVersion：Archetype的version

3.编写Archetype

下面就介绍一个自定义Archetype的例子。

如上图所示，一个典型的Archetype Maven项目主要包括这几个部分：

• pom.xm：Archetype自身的POM
• src/main/resources/achetype-resource/pom.xml：基于该Archetype生成的项目的POM原型
• src/main/resources/META-INF/maven/achetype-metadata.xml：Archetype的描述文件。
• src/main/resources/archetype-resources/**：其他需要包含在Archetype中的内容，常规的有我们自定编写的一些样例代码、配置文件等。

​ 和其他Maven项目一样，Archetype项目本省也是需要pom.xml文件，该文件包含Archetype的坐标信息，这样Maven才能定位使用它。

<?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><groupId>com.alias</groupId><artifactId>yibaiwu-archetype-plugin</artifactId><version>1.0-SNAPSHOT</version>
</project>

​ 接下来，就是配置Archetype所包含的项目骨架信息，一般编写Archetype时预定义好其要包含的目录结构和文件，同时在必要的地方使用可配置的属性声明代替硬编码。例如，我们的项目坐标信息一般是可配置的。以下是一个简单的POM原型：

<?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><groupId>${groupId}</groupId><artifactId>${artifactId}</artifactId><version>${version}</version><parent><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-parent</artifactId><version>2.1.4.RELEASE</version><relativePath/></parent><dependencies><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-web</artifactId></dependency><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter</artifactId><exclusions><exclusion><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-logging</artifactId></exclusion></exclusions></dependency><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-test</artifactId><scope>test</scope></dependency></dependencies><build><pluginManagement><plugins><plugin><groupId>org.apache.maven.plugins</groupId><artifactId>maven-source-plugin</artifactId><version>3.0.1</version></plugin><plugin><artifactId>maven-deploy-plugin</artifactId><configuration><skip>true</skip></configuration></plugin><plugin><groupId>org.springframework.boot</groupId><artifactId>spring-boot-maven-plugin</artifactId></plugin></plugins></pluginManagement></build>
</project>

​ 接下来就是Archetype最核心的部分，archetype-metadata.xml描述符文件，它位于Archetype项目资源目录的META-INF/maven/子目录下，其主要作用是：一声明哪些目录及文件应该包含在Archetype中；二是这个Archetype使用哪些属性参数。以下是一个Archetype描述符文件。

<?xml version="1.0" encoding="UTF-8"?>
<archetype-descriptor name="sample"><fileSets><fileSet filtered="true" packaged="true"><directory>src/main/java</directory><includes><include>**/*.java</include></includes></fileSet><fileSet filtered="true" packaged="true"><directory>src/test/java</directory><includes><include>**/*.java</include></includes></fileSet><fileSet filtered="true" packaged="false"><directory>src/main/resources</directory><includes><include>**/*.properties</include></includes></fileSet></fileSets><requiredProperties><requiredProperty key="groupId"><defaultValue>com.yibaiwu</defaultValue></requiredProperty></requiredProperties>
</archetype-descriptor>

​ 如果fileSet的packaged属性值为true，diretory的值为X，那么archetype-resources下的X目录就会对应地在生成的项目中被创建，在生成的X目录下还会生成一个包目录（及我们输入的package）。如果fileSet的packaged属性值为false，那么Archetype中X目录下的内容会直接被复制到项目的X目录下。一般来说，Java代码都需要放到包路径下，而项目资源文件则不需要。因此，对应的项目资源文件的fileSet的packaged属性为false。

​ fileSet的filtered属性标识使用参数值替换属性声明，如下文件所示。

package ${package};import org.mybatis.spring.annotation.MapperScan;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;@SpringBootApplication(scanBasePackages = {"${package}"})
@MapperScan("${package}.repository")
public class Application {public static void main(String[] args) {SpringApplication.run(Application.class, args);}
}

Archetype编写完成后，使用maven install将其安装到本地仓库，也可以打包上传到私服。接着用户就可以通过制定该Archetype的坐标用它生成项目了：

mvn archetype:generate \
-DgroupId=com.yibaiwu.demo -DartifactId=demo \ 
-Dversion=1.0.0-SNAPSHOT \
-Dpackage=com.yibaiwu.demo \ 
-DarchetypeArtifactId=yibaiwu-archetype-plugin \
-DarchetypeGroupId=com.alias \
-DarchetypeVersion=1.0-SNAPSHOT \

4.配置archetype-metadata.xml生成多项目模块代码

有时候，我们在搭建项目时，对项目进行拆分，划分成不同的模块。此处，我们修改archetype-metadata.xml文件，使之支持生成多个子模块。参考文章：Multi-Module Maven Archetypes

生成多个子模块的诀窍在于使用rootArtifactId,Archetype在生成应用时，将使用artifactId来替换他。

多模块archetype的示例结构如下:

example-archetype
├── pom.xml
└── src├── main└── resources├── META-INF│   └── maven│       └── archetype-metadata.xml└── archetype-resources├── __rootArtifactId__-module1│   ├── pom.xml│   └── src│       ├── main│       │   ├── java│       │   └── resources│       └── test│           └── java│           └── resources├── __rootArtifactId__-module2│   ├── pom.xml│   └── src│       ├── main│       │   ├── java│       │   └── resources│       └── test│           └── java│           └── resources└── pom.xml

archetype-resources目录下，被创建的项目的父pom文件：

<groupId>${groupId}</groupId>
<artifactId>${artifactId}</artifactId>
<version>${version}</version>
<packaging>pom</packaging><modules><module>${rootArtifactId}-module1</module><module>${rootArtifactId}-module2</module>
</modules>

子模块1的POM文件：

<parent><groupId>${groupId}</groupId><artifactId>${rootArtifactId}</artifactId><version>${version}</version>
</parent><artifactId>${artifactId}</artifactId>
<packaging>jar</packaging>

子模块2的POM文件

<parent><groupId>${groupId}</groupId><artifactId>${rootArtifactId}</artifactId><version>${version}</version>
</parent><artifactId>${artifactId}</artifactId>
<packaging>jar</packaging><dependencies><dependency><groupId>${groupId}</groupId><artifactId>${rootArtifactId}-module1</artifactId><version>${version}</version></dependency>
</dependencies>

archetype-metadata.xml文件：

<archetype-descriptor name="${artifactId}"><modules><module id="${rootArtifactId}-module1" dir="__rootArtifactId__-module1" name="${rootArtifactId}-module1"><fileSets><fileSet filtered="true" packaged="true" encoding="UTF-8"><directory>src/main/java</directory></fileSet><fileSet encoding="UTF-8"><directory>src/main/resources</directory></fileSet><fileSet filtered="true" packaged="true" encoding="UTF-8"><directory>src/test/java</directory></fileSet><fileSet encoding="UTF-8"><directory>src/test/resources</directory></fileSet></fileSets></module><module id="${rootArtifactId}-module2" dir="__rootArtifactId__-module2" name="${rootArtifactId}-module2"><fileSets><fileSet filtered="true" packaged="true" encoding="UTF-8"><directory>src/main/java</directory></fileSet><fileSet encoding="UTF-8"><directory>src/main/resources</directory></fileSet><fileSet filtered="true" packaged="true" encoding="UTF-8"><directory>src/test/java</directory></fileSet><fileSet encoding="UTF-8"><directory>src/test/resources</directory></fileSet></fileSets></module></modules>
</archetype-descriptor>

• id：相当于工程的artifactId.
• dir：相当于工程源文件在archetype-resources里对应的directory.
• name：模块的名字.

修改完成后，使用方法也和上面一样，将项目install到本地，然后执行mvn archetype：generate命令：

mvn archetype:generate \
-DgroupId=com.yibaiwu.demo \
-DartifactId=demo \ 
-Dversion=1.0.0-SNAPSHOT \
-Dpackage=com.yibaiwu.demo \ 
-DarchetypeArtifactId=yibaiwu-archetype-plugin \
-DarchetypeGroupId=com.alias \
-DarchetypeVersion=1.0-SNAPSHOT \