Maven Archetypes Part 1：从哪里开始?

原文地址

创建初始文件夹和文件

让我为你的archetype创建文件夹

$ mkdir sample-archetype

进入创建的文件夹内，创建接下来需要的文件和子目录

$ cd sample-archetype
$ mkdir -p src/main/resources/archetype-resources
$ mkdir -p src/main/resources/META-INF/maven
$ touch src/main/resources/META-INF/maven/archetype-metadata.xml
$ touch src/main/resources/archetype-resources/pom.xml
$ touch pom.xml

我们需要的文件结构是这样的：

$ tree
.
|____pom.xml
|____src
| |____main
| | |____resources
| | | |____archetype-resources
| | | | |____pom.xml
| | | |____META-INF
| | | | |____maven
| | | | | |____archetype-metadata.xml

以下是对你需要添加文件的说明：
- pom.xml ： 此文件告诉Maven构建archetype artifact。这是非常基础的pom，在archetype的生命周期中无需更改太多。
- src/main/resources/archetype-resources ： Maven寻找此文件夹去生成你的项目。生成项目时，将会过滤并拷贝该文件夹下的文件。
- src/main/resources/archetype-resources/pom.xml ： 这个文件是生成项目的主pom
- src/main/resources/META-INF/maven ： 通过配置这里，告诉Maven哪些文件要包含在生成项目中，哪些参数问用户要，哪些文件需要通过filter过滤。
- src/main/resources/META-INF/maven/archetype-metadata.xml : Maven使用此文件配置你要生成的项目。他的内容包含文件怎样被过滤，还有他们是否应该出现在生成项目中。

编辑pom并更新archetype metadata

好了，现在我们已经获取了所有必须的文件，现在来为archetype项目构建pom（不是生成项目中的pom）。

<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>

  <name>sample-archetype</name>
  <groupId>com.theotherian.archetype</groupId>
  <artifactId>sample-archetype</artifactId>
  <version>1.0-SNAPSHOT</version>
  <packaging>maven-archetype</packaging>

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

    <pluginManagement>
      <plugins>
        <plugin>
          <artifactId>maven-archetype-plugin</artifactId>
          <version>2.1</version>
          <extensions>true</extensions>
        </plugin>
      </plugins>
    </pluginManagement>
  </build>

</project>

现在我们已经完成了archetype的pom文件编写，接下来我们开始编写我们要生成的项目。我们将从生成新项目的pom文件开始。在生成新项目的时候要使用大量的参数，例如${articactId}和${version}。这些参数将用作替换生成项目模板里的占位符参数。添加以下内容到src/main/resources/archetype-resources/pom.xml文件中：

加些来，我们需要更新src/main/resources/META-INF/maven/archetype-metadata.xml文件，将上面的pom文件包含到生成项目当中。

<archetype-descriptor name="sample-archetype">
  <fileSets>
    <fileSet filtered="true">
      <directory></directory>
      <includes>
        <include>pom.xml</include>
      </includes>
    </fileSet>
  </fileSets>
</archetype-descriptor>

install你的archetype然后后利用它创建项目

现在我们完成了所有的基础工作，先将archetype编译安装到仓库

$ mvn clean install

安装archetype还应该将他放入本地仓库local repository（本地仓库在你配置的地方，通常在~/.m2/repository目录下）。更新你的本地catalog（我的系统中在~/.m2/archetype-catalog.xml中），然后加入新的archetype：

<?xml version="1.0" encoding="UTF-8"?>
<archetype-catalog>
  <archetypes>
    <archetype>
      <groupId>com.theotherian.archetype</groupId>
      <artifactId>sample-archetype</artifactId>
      <version>1.0-SNAPSHOT</version>
      <description>Our Sample Archetype</description>
    </archetype>
  </archetypes>
</archetype-catalog>

在加入你的archetype catalog后，允许接下来的命令（创建一个你准备方式新生成项目的文件夹）

$ cd ..
$ mvn archetype:generate -DarchetypeCatalog=local

你可以看到以下的输入内容（或类似）：

[INFO] Building Maven Default Project
[INFO]    task-segment: [archetype:generate] (aggregator-style)
[INFO] ------------------------------------------------------------------------
[INFO] Preparing archetype:generate
[INFO] No goals needed for project - skipping
[INFO] [archetype:generate {execution: default-cli}]
[INFO] Generating project in Interactive mode
[INFO] No archetype defined. Using maven-archetype-quickstart (org.apache.maven.archetypes:maven-archetype-quickstart:1.0)
Choose archetype:
1: local -> sample-archetype (Our Sample Archetype)
Choose a number: :

选择sample-archetype然后按照提示输入相关参数：

Choose a number: : 1
Define value for property 'groupId': : com.theotherian
Define value for property 'artifactId': : sample-project
Define value for property 'version': 1.0-SNAPSHOT:
Define value for property 'package': com.theotherian:
Confirm properties configuration:
groupId: com.theotherian
artifactId: sample-project
version: 1.0-SNAPSHOT
package: com.theotherian
Y:
[WARNING] Don't override file /Users/isimpson/sample-projects/sample-project/pom.xml
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESSFUL
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 34 seconds
[INFO] Finished at: Sun May 23 19:48:56 MDT 2010
[INFO] Final Memory: 16M/80M
[INFO] ------------------------------------------------------------------------

进入文件夹，执行以下命令安装：

$ cd {生成项目所在根目录}
$ mvn clean install

你可以看到以下输入：

$ mvn clean install
[INFO] Scanning for projects...
[INFO]                                                                         
[INFO] ------------------------------------------------------------------------
[INFO] Building sample-project 1.0-SNAPSHOT
[INFO] ------------------------------------------------------------------------
[INFO] 
[INFO] --- maven-clean-plugin:2.4.1:clean (default-clean) @ sample-project ---
[INFO] 
[INFO] --- maven-install-plugin:2.3.1:install (default-install) @ sample-project ---
[INFO] Installing /Users/isimpson/sample-projects/sample-project/pom.xml to /Users/isimpson/.m2/repository/com/theotherian/sample-project/1.0-SNAPSHOT/sample-project-1.0-SNAPSHOT.pom
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 0.480s
[INFO] Finished at: Sat May 12 11:01:18 MDT 2012
[INFO] Final Memory: 3M/81M
[INFO] ------------------------------------------------------------------------

ok，我们已经创建了一个自己的archetype了。