自定义Maven Archetype模板工程

Maven Archetype介绍

什么是Maven Archetype

Archetype是一个Maven项目的模板工具包，它定义了一类项目的基本架构。Archetype为开发人员提供了创建Maven项目的模板，同时它也可以根据已有的Maven项目生成参数化的模板。

官方文档：https://maven.apache.org/archetype/index.html

为什么要有模板工程

开发新项目就需要搭建新工程，但是搭建新工程是非常繁琐耗时的过程，如果每新起一个项目都由不同的开发人员搭建一个新的工程，由于开发人员代码风格各不相同，搭建的工程可能千差万别，对后续的统一管理维护，监控运维是灾难的。基于这些痛点，希望能够达到以下目标：

• 统一研发框架，统一规范项目结构、通用配置，统一依赖版本，约定大于配置。
• 提升研发效率，减少搭建项目的时间，集成基础中间件、基础util工具类等快速开发组件，做到开箱即用。
• 降低项目维护成本，易于组内成员学习，在相互协作时能快速上手。

创建模板工程的三种方式

1、搭建一个服务demo

每次需要创建一个新服务项目时候，就拉取下模板工程的代码，进行开发

2、spring boot initialier

3、基于maven的archetype，本文重点讲述基于maven的archetype创建模板工程的方式

在IDEA中，我们可以通过File - New Project – Maven – Create from archetype，选择某个archetype快速创建模板工程

常用的archetype

maven-archetype-quickstart

默认的Archetype，基本内容包括：

• 一个包含junit依赖声明的pom.xml
• src/main/java主代码目录及一个名为App的类
• src/test/java测试代码目录及一个名为AppTest的测试用例

maven-archetype-webapp

一个最简单的Maven war项目模板，当需要快速创建一个Web应用的时候可以使用它。生成的项目内容包括：

• 一个packaging为war且带有junit依赖声明的pom.xml
• src/main/webapp/目录
• src/main/webapp/index.jsp文件
• src/main/webapp/WEB-INF/web.xml文件

自定义一个Maven模板工程

自定义Maven模板工程步骤如下

官方介绍：https://maven.apache.org/archetype/maven-archetype-plugin/advanced-usage.html

ps：如果是maven多模块项目，在根目录下执行mvn archetype:create-from-project，mvn install后，会在本地的maven仓库，按照maven坐标创建对应的archetype文件

生成模板

在maven项目下，执行如下命令

mvn archetype:create-from-project
1

进入 target 目录下的 archetype 目录

cd target/generated-sources/archetype
1

安装archetype project到本地仓库

mvn install
1

接着就能在自己的maven仓库目录下看到 archetype-catalog.xml，里面多了刚才生成的模板

archetype-catalog.xml内容类似如下

<?xml version="1.0" encoding="UTF-8"?>
<archetype-catalog xsi:schemaLocation="http://maven.apache.org/plugins/maven-archetype-plugin/archetype-catalog/1.0.0 http://maven.apache.org/xsd/archetype-catalog-1.0.0.xsd"
    xmlns="http://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.jourwon.spring.boot</groupId>
      <artifactId>spring-boot-maven-archetype-single-module-archetype</artifactId>
      <version>1.0.0</version>
      <description>Spring Boot整合Maven Archetype模板工程-单模块</description>
    </archetype>
  </archetypes>
</archetype-catalog>

1
2
3
4
5
6
7
8
9
10
11
12
13
14

上传模板到仓库(此步骤可选)

需要在 target/generated-sources/archetype 目录下的 pom 文件中加入仓库地址，例如如下示范

<!--运行 mvn deploy 时上传构件到本地仓库 -->
<distributionManagement>
    <repository>
      <id>xxx-releases</id>
      <name>Nexus Release Repository</name>
      <url>http://xxx.com/nexus/content/repositories/xxx-release/</url>
    </repository>
    <snapshotRepository>
      <id>xxx-snapshots</id>
      <name>Nexus Snapshot Repository</name>
      <url>http://xxx.com/nexus/content/repositories/xxx-test/</url>
    </snapshotRepository>
</distributionManagement>
1
2
3
4
5
6
7
8
9
10
11
12
13

接着在 archetype 目录下，执行 deploy 命令

mvn deploy
1

只要开发人员maven的settings配置了该仓库地址，就可以一起使用这个模板工程

使用模板工程

依次点击 File -> New -> Project，按照下图新增maven模板工程，填写maven模板工程的 GroupId、ArtifactId、Version ，Repository项可选，如有可填写 maven 私服地址。

注意：模板工程的ArtifactId后缀有-archetype

选中第一步新增的maven模板工程，点击 Next 填写自己项目的GroupId、ArtifactId、Version，一直点击 Next 完成项目生成。

点击Finish

生成项目结构如下，至此，Maven模板工程已经生成，可以进行业务代码的编写了。