前言：在某课网上学习到可以使用命令mvn archetype:create-from-project来创建自己的项目模板（文中提及的项目模板即原型 archetype），对此我十分感兴趣。但是，遗憾的是，老师没有介绍如何去构建这样一个特殊的项目，用于创建项目模板。于是，本着面向“度娘”编程的原则，去网上查了下，结果不是十多年前的“古董”文章，就是流程不清楚，有的需要部署到私服，有的包含大量jar包，十分繁琐。项目的组成也不清楚，连最重要的文件archetype-metadata.xml都不介绍。因此，想写一篇简单易懂的文章来介绍下这部分内容。

一、项目结构

为了方便理解，本文将基于Maven 3(ver3.6.3)和IntelliJ IDEA 2021环境展开。项目简介：本archetype项目模板为webapp的模板，对maven自带的webapp做了部分更符合实际开发情况的修改。例如，修改了web.xml中约束2.3(dtd)为3.1(xsd)、在pom.xml中添加了开发必要的依赖servlet和jsp的api等等。

1、整体结构

Archetype项目结构如下如图所示，此项目由两部分组成（并且他们都在resources目录下)：

1.archetype-resources 目录描述未来你希望生成的项目的模板
2.META-INF/maven/archetype-metadata.xml文件描述模板中文件的相关信息，如应该包含哪些文件，占位符如何替换等

至于，下面这个目录如何创建，你可以先通过模板maven-archetype-quickstart创建项目，然后再手动创建这些目录及文件。
在这里插入图片描述

2、archetype-resources

本部分介绍项目模板中的各文件的内容及注意事项，大部分内容都可以根据自己项目的需要进行配置，为了便于理解，这里使用了最简单、常用的配置。

HelloServlet.java

package ${package};import javax.servlet.http.HttpServlet;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.annotation.WebServlet;
import java.io.IOException;@WebServlet(value="/helloServlet", name="helloServlet")
public class HelloServlet extends HttpServlet {@Overrideprotected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {resp.getWriter().println("<h1>Hello Servlet!</h1>");}@Overrideprotected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {resp.getWriter().println("<h1>Hello Servlet!</h1>");}
}

注意:类的包名使用了占位符${package}，会根据你使用maven创建项目时提供的参数替换此包名，并创建相应目录，将此文件放在包名对应的目录下。本文件通过注解的方式注册了此Servlet，当然在web.xml中配置也可以，不在介绍。

web.xml 修改约束为常用的web3.1版本

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee"xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_3_1.xsd"version="3.1"><welcome-file-list><welcome-file>index.jsp</welcome-file></welcome-file-list>
</web-app>

index.jsp

<html>
<body>
<h2>Hello World!</h2>
</body>
</html>

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/maven-v4_0_0.xsd"><modelVersion>4.0.0</modelVersion><packaging>war</packaging><groupId>${groupId}</groupId><artifactId>${artifactId}</artifactId><version>${version}</version><name>${artifactId}</name><url>http://maven.apache.org</url><dependencies><!-- https://mvnrepository.com/artifact/javax.servlet/javax.servlet-api --><dependency><groupId>javax.servlet</groupId><artifactId>javax.servlet-api</artifactId><version>3.1.0</version><scope>provided</scope></dependency><!-- https://mvnrepository.com/artifact/javax.servlet.jsp/javax.servlet.jsp-api --><dependency><groupId>javax.servlet.jsp</groupId><artifactId>javax.servlet.jsp-api</artifactId><version>2.3.1</version><scope>provided</scope></dependency></dependencies><build><plugins><plugin><groupId>org.apache.tomcat.maven</groupId><artifactId>tomcat7-maven-plugin</artifactId><version>2.2</version></plugin></plugins></build>
</project>

注意：$ {groupId}、$ {artifactId}、$ {artifactId}等占位符会根据你创建maven项目时指定的参数进行替换。此外，还添加了Sevlet和JSP的依赖及tomcat插件。

3、archetype-metadata.xml(重要)

<?xml version="1.0" encoding="UTF-8"?>
<archetype-descriptor name="basic"><fileSets><fileSet filtered="true" packaged="true"><directory>src/main/java</directory><includes><include>**/*.java</include></includes></fileSet><fileSet filtered="false"><directory>src/main/webapp</directory></fileSet></fileSets>
</archetype-descriptor>

属性介绍：

archetype-descriptor：项目模板描述符，name属性给本项目模板起了一个名字，不重要；

fileSet：描述了本项目模板包含哪些在archetype-resources中定义的文件，以及对文件如何处理；
filtered属性决定是否使用 Velocity engine （字面翻译为速度引擎），如果不使用速度引擎，表示不做任何处理，项目模板中直接包含在directory中定义的目录及文件，如“src/main/webapp”不用做任何处理，所以filtered=“false”；
如果使用速度引擎，表示在模板中可以通过include指定的模式包含满足条件的文件；更重要的可以使用创建项目时用户提供的参数来替换占位符。如src/main/java下的$ {package}需要被替换，所以filtered=“true”

packaged属性决定$ {package}是否有效，
如果packaged=“true”，表示占位符有效，会根据用户创建项目时提供的package参数替换占位符（并且创建包名对应的目录，把该文件放在该目录下，包名和目录要保持一致），如果用户未提供package参数，则使用groupId参数作为包名，推荐使用。
如果package=“false”，表示包名使用“硬编码方式”，即不使用占位符，在java文件中写死包名，如“package
org.example;”,这种方式十分不灵活，因此不推荐使用；

3. pom.xml不用在fileSet中指明，会自动包含进入项目模板；

补充属性：

<archetype-descriptor name="basic"><requiredProperties><requiredProperty key="property-with-default"><defaultValue>default-value</defaultValue></requiredProperty><requiredProperty key="property-without-default"/></requiredProperties>
...
</archetype-descriptor>

还可以为创建项目时使用到的必要参数groupId、artifactId、version和package指定默认值，如公司项目的groupId可能是固定的，就可以在这里配置默认值，当在命令行创建项目时，不指定该参数就会使用默认值;

<requiredProperty key="property-without-default"/>表示给必要参数未设置默认值，在命令行创建项目时，必须为该属性提供值；

另外，值得一提的是，如果在这里为package属性设置了默认值，就不会使用groupId作为替换的包名了。换句话说，替换包名占位符的优先级是命令行输入的package参数值>package默认值>groupId。

4、项目根目录下的pom.xml文件

使用archetype项目骨架时需要用到该项目的坐标信息，定义如下：

<?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.0http://maven.apache.org/maven-v4_0_0.xsd"><modelVersion>4.0.0</modelVersion><packaging>jar</packaging><name>servlet3-webapp-archetype</name><groupId>com.company</groupId><artifactId>servlet3-webapp-archetype</artifactId><version>1.0.0</version>
</project>