Maven Archetype 自定义项目模板：高效开发的最佳实践

文章目录

前言
一、Maven Archetype
二、创建自定义 Maven Archetype
三、定制 Archetype 模板
四、手动创建 Archetype 模板项目
五、FAQ
- 5.1 如何删除自定义的模板
- 5.2 是否可以在模板中使用空文件夹
六、小结
推荐阅读

前言

在软件开发中，标准化和快速初始化项目结构能够显著提升开发效率。Maven Archetype 插件提供了创建自定义项目骨架模板的功能，使我们能够轻松生成预定义结构的项目。本文将详细介绍如何创建一个自定义的项目模板，从而提高日常的开发效率。

一、Maven Archetype

Maven Archetype 是一种用于生成项目结构的模板，可以帮助开发者快速创建一个预定义的项目骨架。Maven 自带了一些常见的 Archetype 模板，如 maven-archetype-quickstart、maven-archetype-webapp 等，但在实际开发中，我们可能需要根据团队的标准或个人喜好创建自定义的 Archetype。

二、创建自定义 Maven Archetype

在命令行使用 mvn archetype:generate 命令创建一个基础项目
将这个基础项目改造成我们需要的模板形式
使用 mvn archetype:create-from-project 命令将这个基础项目转换成模板。这个命令将在 target/generated-sources 目录下生成一个名为 archetype 的项目。
使用 idea 打开 target/generated-sources/archetype 项目，执行 mvn clean install 命令将项目安装到本地
在命令行使用 mvn archetype:generate 命令，选择我们自定义的模板生成项目

填写项目的基本信息

如果大家不熟悉使用命令行，可以直接在 idea 中使用模板创建项目

不过这种方式不能选择模板，需要手动填写模板信息比较麻烦，大家可根据自身情况选择方案。
项目生成了，但是生成的项目存在一些额外的东西，我们先手动处理一下
打开项目，查看项目的工程结构

三、定制 Archetype 模板

刚才的模板中生成了额外的 .idea 目录，我们并不需要在模板中创建这个目录。此时，我们需要定制这个模板。我们可以打开之前生成的 archetype 项目。

在 archetype 项目中删掉我们不需要的模板和配置。

对该项目重新执行 mvn install 命令安装模板，之后使用模板创建的项目就不会有这个多余的目录了。

四、手动创建 Archetype 模板项目

我们还可以手动搭建一个 Archetype 模板项目。

新建一个 maven 项目

pom 文件中引入项目依赖

<!-- XML 文件的声明，指定了使用 XML 1.0 版本和 UTF-8 编码 -->
<?xml version="1.0" encoding="UTF-8"?>
<!-- 定义了 project 元素及其命名空间 -->
<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.example</groupId>
  <artifactId>spring-boot-template-archetype</artifactId>
  <version>1.0.0</version>
  
  <!-- 项目的打包类型，这里是 maven-archetype，表示这是一个 Maven 原型项目 -->
  <packaging>maven-archetype</packaging>

  <!-- 项目的名称 -->
  <name>spring-boot-template-archetype</name>

  <build>
    <extensions>
      <extension>
        <groupId>org.apache.maven.archetype</groupId>
        <artifactId>archetype-packaging</artifactId>
        <version>3.2.1</version>
      </extension>
    </extensions>

    <pluginManagement>
      <plugins>
        <plugin>
          <artifactId>maven-archetype-plugin</artifactId>
          <version>3.2.1</version>
        </plugin>
      </plugins>
    </pluginManagement>
  </build>
</project>