当前位置：首页 > news >正文

idea生成自定义Maven原型(archetype)项目工程模板

news 来源：原创 2025/8/29 11:15:58

一、什么是Maven原型（Maven archetype）

引自官网的介绍如下：
Maven原型插件官网地址
在这里插入图片描述
这里采用DeepSeek助手翻译如下：

Maven 原型
什么是原型？
简而言之，原型是一个 Maven 项目模板工具包。原型被定义为一种原始模式或模型，同类的所有其他事物都是由此衍生而来。这个名字很贴切，因为我们试图提供一个系统，该系统能以一致的方式生成 Maven 项目。原型将帮助作者为用户创建 Maven 项目模板，并为用户提供生成这些项目模板的参数化版本的方法。
使用原型提供了一种很好的方式，能让开发人员以与项目或组织采用的最佳实践相一致的方式快速上手。在 Maven 项目中，我们使用原型，通过提供一个示例项目，来尽可能快地让我们的用户启动并运行项目。这个示例项目展示了 Maven 的许多特性，同时向新用户介绍 Maven 所采用的最佳实践。新用户在几秒钟内就可以拥有一个可运行的 Maven 项目，以此作为跳板来进一步研究 Maven 的更多特性。我们还努力使原型机制具有可添加性，也就是说，允许将项目的一部分捕获到一个原型中，这样项目的某些部分或方面就可以添加到现有项目中。一个很好的例子就是 Maven 站点原型。例如，如果你已经使用了快速入门原型来生成一个可运行的项目，那么你可以通过在这个现有项目中使用站点原型，快速为该项目创建一个站点。你可以使用原型做任何类似这样的事情。
你可能希望在你的组织内规范 J2EE 开发，所以你可能想要为 EJB、WAR 或者你的 Web 服务提供原型。一旦这些原型被创建并部署到你组织的资源库中，组织内的所有开发人员都可以使用它们。

个人理解，Maven原型就是用于生成可自定义的，包含公用所需要的，能直接运行使用的Maven项目模板。是为了后续能帮助开发者更快速的生成和模板一致的项目工程，使得用户不需要重新整理项目骨架，直接使用默认的模板骨架，或在模板骨架上做修改即可。

二、Maven原型（Maven archetype）应用

1.在项目pom.xml文件中引入maven-archetype-plugin原型插件

这里我通常找Maven依赖的仓库地址如下，便于选择对应的版本：
https://mvnrepository.com/artifact/org.apache.maven.plugins/maven-archetype-plugin

首先，找到自己要作为脚手架模板的项目，或者自己新建项目，然后自定义项目骨架目录，创建基础配置以及工具类等等。然后在项目pom.xml中加入maven-archetype-plugin插件。

这里我先使用idea开发工具创建Java项目，然后自定义修改项目骨架，加入子项目目录，构成简单的聚合项目。项目结构如下图：
在这里插入图片描述
聚合项目展开后骨架目录截图：

在项目父级pom.xml文件中加入maven-archetype-plugin插件，这里我选的是最新版本3.3.1，版本看情况选择就好，如下图：

2.使用Maven原型（archetype）打包构建Maven原型项目

构建命令如下：
archetype:create-from-project

Maven官网介绍：
此命令目标读取您的源文件和资源文件、其参数值以及您在.property文件中指定的属性，并使用它们使用Maven原型打包创建Maven原型项目。如果你构建了最终的项目，它将创建原型。然后，您可以使用此原型创建与原始项目类似的新项目。

命令说明-引自官网介绍如下：
Maven官网介绍archetype:create-from-project命令地址
archetype:create-from-project命令：表示从当前项目创建原型项目。

点击idea右侧maven图标，打开maven面板，选择父级工程名，找到插件，选择archetype:create-from-project命令，直接双击该命令，命令执行完后，会在父级项目目录下生成target目录。如下图：
在这里插入图片描述
archetype:create-from-project命令执行成功截图如下：

命令执行成功后，在父级根目录下，会生成target目录文件（也就是自己自定义的项目脚手架工程）。如下图：

最后我们可以把生成的脚手架项目模板加入到Maven中，便于后续创建项目时，可直接选择，来生成自定义的Maven模板项目，方便后续开发搭建项目工程。

3.添加项目模板到Maven中

找到target目录 -> generated-source -> archetype目录。如下图：
在这里插入图片描述
再使用idea打开archetype目录。如下图：

打开Maven面板，并执行install命令

install命令执行成功之后，执行archetype:crawl命令，此时Maven会搜索并更新本地或远程仓库中的archetype。

‌archetype:crawl
archetype:crawl命令的主要作用是搜索并更新仓库中的archetype。‌
具体来说，当你执行mvn archetype:crawl命令时，Maven会搜索并更新本地或远程仓库中的archetype。

这个命令的作用包括：

a.搜索仓库中的archetype‌：Maven会遍历仓库中的所有archetype，找到所有可用的模板。
b.更新archetype目录‌：根据搜索结果，更新本地仓库中的archetype目录，生成或更新archetype-catalog.xml文件，该文件包含了仓库中所有可用的archetype信息。

此时会在本地Maven仓库里生成archetype-catalog.xml原型目录配置文件如下：
archetype-catalog Maven官网配置说明

C:\Users\18292\.m2\repository\archetype-catalog.xml

在这里插入图片描述 archetype-catalog.xml是标准的目录文件，其中包含有关原型的信息，以便用户可以从任意数量的目录中获得原型列表以生成新项目。
生成的archetype-catalog.xml文件内容如下：

<?xml version="1.0" encoding="UTF-8"?>
<archetype-catalog xsi:schemaLocation="https://maven.apache.org/plugins/maven-archetype-plugin/archetype-catalog/1.0.0 https://maven.apache.org/xsd/archetype-catalog-1.0.0.xsd"xmlns="https://maven.apache.org/plugins/maven-archetype-plugin/archetype-catalog/1.0.0"xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"><archetypes><archetype><groupId>com.learn</groupId><artifactId>learn-project-archetype</artifactId><version>1.0-SNAPSHOT</version><description>learn-project</description></archetype></archetypes>
</archetype-catalog>

三、测试使用idea工具构建新Maven项目

idea创建项目，File -> New -> Project。如下图：

a.选择Maven原型方式创建项目
b.自定义项目名称
c.指定项目存放目录
d.添加自定义的原型项目模板，在弹窗中填写上面生成的archetype-catalog.xml文件中原型项目的内容，点击Add添加。

在这里插入图片描述

点击创建按钮后，直接使用idea打开，等待Maven加载，加载完成后，会直接生成和自定义模板项目一样结构的Maven项目。如下图：

至此，使用Maven原型构建自定义项目模板完成。有个情况是，每次创建Maven项目，都需要手动添加本地的Archetype项目原型才可以创建。

针对这个问题，我们可以这样处理，在创建项目时，更改Catalog选项，直接选择自己本地原型配置文件。首先点击Manage catalogs按钮，添加本地自定义生成的archetype-catalog.xml配置文件。如下图：
在这里插入图片描述

配置好后，在Catalog配置上，我们选择我们刚添加的archetype-catalog.xml配置，会自动在下面Archetype下拉选择中列出我们自己的原型配置，直接选择，然后点击Create创建按钮，就可以生成对应的模板项目。如下图：
在这里插入图片描述
如此，后续创建新Maven项目时，就可以直接选择我们自定义的项目模板，来构建新项目了，便于项目框架统一管理，便于后续新项目的开发和维护。