【技术】封装自己的 Maven Archetype Maven 原型

为什么要封装 Maven Archetype？

用过 Maven 构建项目同学都有这样的经历，每次构建完项目都要重新修改一堆配置，才能满足项目的需求。其实在工作中，很多公司也会封装自己的 Maven 原型，为的就是能快速构建一个符合自己需求的项目，免去项目构建后的额外配置。（这边文章仅针对普通 Maven 项目，SpringBoot 不参与讨论）

如何封装 Maven Archetype？

核心步骤

• 通过 IDE 构建普通 Maven 项目，然后进行第一次项目配置。
• 通过磁盘打开项目目录，删除 IDE 的配置信息。
• 打开 CMD，进入项目根路径下，输入 mvn 命令进行构建原型。

具体步骤

构建项目

本案例使用 IDEA 构建项目

步骤1： 点击 New Project ，打开创建工程的窗口

步骤2： 左侧选择 Maven，右侧根据实际需求选择原型或者不选择都行。这里就不选择了，按照空原型创建。

步骤3： 填写项目信息，点击 finish 构建项目。
注意：最终构建出来的原型名字后面会自动拼接archetype，所以这的项目名称可以不带；

步骤4： 按照需求修改配置。以下配置文件仅供参考。
pom.xml

<?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.soft863</groupId>
    <artifactId>soft863-spring</artifactId>
    <version>1.0</version>

    <!-- 配置全局版本号（属性） -->
    <properties>
        <maven.compiler.source>1.8</maven.compiler.source>
        <maven.compiler.target>1.8</maven.compiler.target>
        <spring.version>5.3.26</spring.version>
    </properties>

    <!-- 添加常用依赖 -->
    <dependencies>
        <!-- Junit 测试依赖 -->
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>4.12</version>
            <scope>test</scope>
        </dependency>

        <!-- Spring 相关依赖 -->
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-context</artifactId>
            <version>${spring.version}</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-jdbc</artifactId>
            <version>${spring.version}</version>
        </dependency>

        <!-- Lombok 依赖 -->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>1.18.26</version>
        </dependency>

        <!-- 数据库相关依赖 -->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>8.0.32</version>
        </dependency>
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>druid</artifactId>
            <version>1.2.15</version>
        </dependency>

        <!-- 其他依赖自行添加 -->
    </dependencies>
</project>

构建项目目录。

构建原型 archetype

步骤1： 关闭IDEA，从磁盘打开项目，删除 .idea 目录。只保留 src 和 pom.xml。其他必要目录，自行选择保留。

步骤2： 通过 CMD 进入项目根目录。输入命令构建 archetype。

# 清理项目
mvn clean
# 构建 archetype
# -s 是 Maven 软件的 setting.xml 配置文件目录。如果不配置默认使用【用户/.m2/setting.xml】文件
# -d 配置archetype 的包名。在磁盘本地仓库的目录
mvn -s "D:\00-863\99-InstallSoft\apache-maven-3.8.4\conf\settings.xml" archetype:create-from-project -DpackageName=com.soft863

步骤3： 构建成功之后，在项目的target 中生成 archetype 原型。使用 CMD 进入 target\generated-sources\archetype 目录，输入命令安装到本地仓库

# 清理并安装到本地仓库
mvn clean install

如图，就是我本地仓库中生成的 archetype 原型。jar 包通过压缩软件打开。

• archetype-resources 目录描述未来你希望生成的项目的模板

• META-INF/maven/archetype-metadata.xml文件描述模板中文件的相关信息，如应该包含哪些文件，占位符如何替换等
  更加详细可以看：https://blog.csdn.net/gao_zhennan/article/details/116986244

• 如果最后生成的项目不如意，往往是要修改archetype-metadata.xml文件的

IDEA 导入自定义原型

步骤1： 点击 New Project ，打开创建工程的窗口

步骤2： 左侧选择 Maven，右侧【create from archetype】大勾，然后点击【Add Archetype…】添加原型。

添加信息基于本地仓库信息

GrougId：com.soft863，第一个红框内容
ArtifactId：soft863-spring-archetype，第二个红框内容
Version：1.0，第三个红框内容

步骤3： 添加完毕之后，关闭 IDEA，重新打开，就可以看到自定义的 arthetype 了。后续可以使用自定义的原型构建项目。

如何删除自定义的 Maven Archetype ?

IDEA 导入archetype 后，在 C 盘 "C:\Users\用户名\AppData\Local\JetBrains\IntelliJIdea2021.3\Maven\Indices"目录下自动生成UserArchetypes.xml文件，打开之后内容如下，可以看到自定义的 archetype 信息。

<archetypes>
  <archetype groupId="com.soft863" artifactId="soft863-spring-archetype" version="1.0" />
</archetypes>

如果想删掉所有自定义的 archetype 直接把UserArchetypes.xml文件文件删除即可。
如果想删除一部分，打开文件后删掉指定的<archetype ...>即可。