无论是使用内置的 Archetype 还是创建自定义的 Archetype，它都能显著提高开发效率

Maven Archetype 是 Maven 提供的一种模板机制，用于快速生成项目结构。它可以帮助开发者基于预定义的模板创建新项目，从而减少重复工作并遵循最佳实践。以下是关于 Maven Archetype 的详细介绍和使用方法：

1. Maven Archetype 简介

Maven Archetype 是一个项目模板，包含以下内容：

• 预定义的项目结构（如 src/main/java、src/test/java 等）。
• 默认的 pom.xml 文件。
• 示例代码和配置文件。

通过 Archetype，开发者可以快速生成符合特定框架或技术栈的项目。

2. 内置 Archetype

Maven 提供了一些内置的 Archetype，例如：

• maven-archetype-quickstart：生成一个简单的 Maven 项目，包含一个主类和一个测试类。
• maven-archetype-webapp：生成一个基本的 Web 应用项目。
• maven-archetype-j2ee-simple：生成一个简单的 J2EE 项目。

3. 使用 Maven Archetype 创建项目

以下是使用 Maven Archetype 创建新项目的步骤：

3.1 使用命令行创建项目

运行以下命令，基于 Archetype 生成项目：

mvn archetype:generate \
    -DgroupId=com.example \
    -DartifactId=my-project \
    -DarchetypeArtifactId=maven-archetype-quickstart \
    -DinteractiveMode=false

参数说明：

• -DgroupId：项目的 Group ID（通常是公司或组织名称）。
• -DartifactId：项目的 Artifact ID（通常是项目名称）。
• -DarchetypeArtifactId：使用的 Archetype 名称。
• -DinteractiveMode=false：禁用交互模式，直接使用默认值。

3.2 交互模式

如果省略 -DinteractiveMode=false，Maven 会进入交互模式，提示您输入 Group ID、Artifact ID 等信息。

3.3 生成的项目结构

生成的项目结构如下：

my-project/
├── pom.xml
├── src/
│   ├── main/
│   │   └── java/
│   │       └── com/example/
│   │           └── App.java
│   └── test/
│       └── java/
│           └── com/example/
│               └── AppTest.java

4. 自定义 Archetype

如果您需要创建自定义的 Archetype，可以按照以下步骤操作：

4.1 创建 Archetype 项目

使用以下命令生成一个 Archetype 项目：

mvn archetype:generate \
    -DgroupId=com.example \
    -DartifactId=my-custom-archetype \
    -DarchetypeArtifactId=maven-archetype-archetype \
    -DinteractiveMode=false

4.2 修改模板

在生成的 Archetype 项目中，修改 src/main/resources/archetype-resources 目录下的文件，定义您的项目模板。

4.3 安装 Archetype

运行以下命令将自定义 Archetype 安装到本地 Maven 仓库：

mvn install

4.4 使用自定义 Archetype

使用以下命令基于自定义 Archetype 生成项目：

mvn archetype:generate \
    -DgroupId=com.example \
    -DartifactId=my-new-project \
    -DarchetypeGroupId=com.example \
    -DarchetypeArtifactId=my-custom-archetype \
    -DinteractiveMode=false

5. 常用 Archetype 列表

以下是一些常用的 Maven Archetype：

6. 查找 Archetype

如果您不确定使用哪个 Archetype，可以通过以下命令列出所有可用的 Archetype：

mvn archetype:generate -Dfilter=org.apache.maven.archetypes:

7. 总结

Maven Archetype 是一个强大的工具，可以帮助开发者快速生成项目结构。无论是使用内置的 Archetype 还是创建自定义的 Archetype，它都能显著提高开发效率。

Fork me on GitHub

Overview
Modules
Project Documentation
Maven Projects
ASF

Maven Archetype

Apache/ Maven/ Maven Archetype/ About [Edit]
| Last Published: 2019-08-19
Version: 3.1.2

Overview
Introduction
Maven Archetype Plugin
License
Download
Modules
Maven Archetype Models
Maven Archetype Common
Maven Archetype Plugin
Maven Archetype Packaging
Project Documentation
Project Information
    About
    Summary
    Dependency Information
    Project Modules
    Team
    Source Code Management
    Issue Management
    Mailing Lists
    Dependency Management
    Dependency Convergence
    CI Management
    Plugin Management
    Plugins
    Distribution Management
Project Reports
Maven Projects
Archetype
Artifact Resolver
Doxia
JXR
Maven
Parent POMs
Plugins
Plugin Testing
Plugin Tools
Resource Bundles
SCM
Shared Components
Skins
Surefire
Wagon
ASF
How Apache Works
Foundation
Sponsoring Apache
Thanks

Follow ASFMavenProject
Built by Maven
Maven Archetype
What is Archetype?

In short, Archetype is a Maven project templating toolkit. An archetype is defined as an original pattern or model from which all other things of the same kind are made. The names fits as we are trying to provide a system that provides a consistent means of generating Maven projects. Archetype will help authors create Maven project templates for users, and provides users with the means to generate parameterized versions of those project templates.

Using archetypes provides a great way to enable developers quickly in a way consistent with best practices employed by your project or organization. Within the Maven project we use archetypes to try and get our users up and running as quickly as possible by providing a sample project that demonstrates many of the features of Maven while introducing new users to the best practices employed by Maven. In a matter of seconds a new user can have a working Maven project to use as a jumping board for investigating more of the features in Maven. We have also tried to make the Archetype mechanism additive and by that we mean allowing portions of a project to be captured in an archetype so that pieces or aspects of a project can be added to existing projects. A good example of this is the Maven site archetype. If, for example, you have used the quick start archetype to generate a working project you can then quickly create a site for that project by using the site archetype within that existing project. You can do anything like this with archetypes.

You may want to standardize J2EE development within your organization so you may want to provide archetypes for EJBs, or WARs, or for your web services. Once these archetypes are created and deployed in your organization’s repository they are available for use by all developers within your organization.
Using an Archetype

To create a new project based on an Archetype, you need to call mvn archetype:generate goal, like the following:

mvn archetype:generate

Please refer to Archetype Plugin Page for more details.
Content

Maven Archetype is composed of several modules:
Module Description
maven-archetype-plugin Archetype Plugin to use archetypes with Maven,
archetype-packaging Archetype lifecycle and packaging definition,
archetype-models Descriptors classes and reference documentation,
archetype-common Core classes,
archetype-testing Components used internally to test Maven Archetype,