Maven Archetype使用——自定义项目模板

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