摘要：
Archetype是什么？它由哪些文件组成？如何创建和安装自己的archtype，如何使用自己创建的archetype？
一、Archetype是什么
Archetype其实就是一个Maven的Project模板，以方便用户快速创建maven的Project。有官方提供的Archetype，用户也可以创建自己的Archetype，比如我们公司的所有工程都使用相同的groupId，都将包含相同的库文件，那么我们就可以创建一个自己的archetype，然后大家下载过去安装在自己的本地。或者放在一个内部服务器上，然后大家在自己的eclipse上配置好该服务器catogries.xml文件的路径；
下图是官方提供的Archetype的生命周期，现在只要了解，后续将详细介绍。
二、Archetype工程的组成
一个典型的archetype包含如下组成部分：
1）Archetype descriptor（archetype.xml），这个文件位于路径src/main/resources/META-INF/maven/，那就除了所有将要包含在archetype中的文件，并且给他们做了分类以便Archetype的生成机制可以正确的处理它们;
2）Archetype插件将要拷贝的原型文件，位于路径，src/main/resources/archetype-resources/；
3）pom.xml原型文件，位于路径：src/main/resources/archetype-resources
4）这个工程本身自己的pom.xml；
三、如何生成Archetype
首先基于一个用户已有的工程，使用mvn archetype:create-from-project 就可以在该project的target\generate-sources\archetype生成了一个archetype。
比如我刚刚在gs-rest-service-yang工程内运行了mvn archetype:create-from-project命令，然后在target子目录下声称了generated-sources文件夹，文件夹内包含了archetype文件夹，该文件夹的内容如下：
│ pom.xml│├─src│ ├─main│ │ └─resources│ │ ├─archetype-resources│ │ │ │ .classpath│ │ │ │ .project│ │ │ │ pom.xml│ │ │ ││ │ │ ├─.settings│ │ │ │ org.eclipse.core.resources.prefs│ │ │ │ org.eclipse.jdt.core.prefs│ │ │ │ org.eclipse.m2e.core.prefs│ │ │ ││ │ │ └─src│ │ │ ├─main│ │ │ │ └─java│ │ │ │ Application.java│ │ │ │ Quote.java│ │ │ │ Value.java│ │ │ ││ │ │ └─test│ │ │ └─java│ │ │ AppTest.java│ │ ││ │ └─META-INF│ │ └─maven│ │ archetype-metadata.xml│ ││ └─test│ └─resources│ └─projects│ └─basic│ archetype.properties│ goal.txt│└─target│ gs-rest-service-yang-archetype-0.0.1-SNAPSHOT.jar│├─classes│ ├─archetype-resources│ │ │ .classpath│ │ │ .project│ │ │ pom.xml│ │ ││ │ ├─.settings│ │ │ org.eclipse.core.resources.prefs│ │ │ org.eclipse.jdt.core.prefs│ │ │ org.eclipse.m2e.core.prefs│ │ ││ │ └─src│ │ ├─main│ │ │ └─java│ │ │ Application.java│ │ │ Quote.java│ │ │ Value.java│ │ ││ │ └─test│ │ └─java│ │ AppTest.java│ ││ └─META-INF│ └─maven│ archetype-metadata.xml│├─gs-rest-service-yang-archetype-0.0.1-SNAPSHOT│ ├─archetype-resources│ │ │ .classpath│ │ │ .project│ │ │ pom.xml│ │ ││ │ ├─.settings│ │ │ org.eclipse.core.resources.prefs│ │ │ org.eclipse.jdt.core.prefs│ │ │ org.eclipse.m2e.core.prefs│ │ ││ │ └─src│ │ ├─main│ │ │ └─java│ │ │ Application.java│ │ │ Quote.java│ │ │ Value.java│ │ ││ │ └─test│ │ └─java│ │ AppTest.java│ ││ └─META-INF│ └─maven│ archetype-metadata.xml│└─test-classes└─projects└─basicarchetype.propertiesgoal.txt
可以看到上面有一些.setting, .class, .project的文件，这些是多余的。
所以我们在搭建好样板工程之后，在使用mvn archetype:create-from-project命令之前，要先把项目中不相关的工程文件、中间文件删除。
清除之后重新声称的结构如下：
│ pom.xml│├─src│ ├─main│ │ └─resources│ │ ├─archetype-resources│ │ │ │ pom.xml│ │ │ ││ │ │ └─src│ │ │ ├─main│ │ │ │ └─java│ │ │ │ Application.java│ │ │ │ Quote.java│ │ │ │ Value.java│ │ │ ││ │ │ └─test│ │ │ └─java│ │ │ AppTest.java│ │ ││ │ └─META-INF│ │ └─maven│ │ archetype-metadata.xml│ ││ └─test│ └─resources│ └─projects│ └─basic│ archetype.properties│ goal.txt│└─target│ gs-rest-service-yang-archetype-0.0.1-SNAPSHOT.jar│├─classes│ ├─archetype-resources│ │ │ pom.xml│ │ ││ │ └─src│ │ ├─main│ │ │ └─java│ │ │ Application.java│ │ │ Quote.java│ │ │ Value.java│ │ ││ │ └─test│ │ └─java│ │ AppTest.java│ ││ └─META-INF│ └─maven│ archetype-metadata.xml│└─test-classes└─projects└─basicarchetype.propertiesgoal.txt
四、生成Archetype如何安装
在上文创建了archetype之后，进入到target\generate-sources\archetype目录，然后在命令行执行：
mvn install
则输出如下信息，特别是installing这段，表示就安装成功了。
[INFO] Scanning for projects...[INFO][INFO] ------------------------------------------------------------------------[INFO] Building gs-rest-service-yang-archetype 0.0.1-SNAPSHOT[INFO] ------------------------------------------------------------------------[INFO][INFO] --- maven-resources-plugin:3.0.2:resources (default-resources) @ gs-rest-service-yang-archetype ---[WARNING] Using platform encoding (GBK actually) to copy filtered resources, i.e. build is platform dependent![INFO] Copying 6 resources[INFO][INFO] --- maven-resources-plugin:3.0.2:testResources (default-testResources) @ gs-rest-service-yang-archetype ---[WARNING] Using platform encoding (GBK actually) to copy filtered resources, i.e. build is platform dependent![INFO] Copying 2 resources[INFO][INFO] --- maven-archetype-plugin:3.0.0:jar (default-jar) @ gs-rest-service-yang-archetype ---[INFO] Building archetype jar: D:\WORK\personal\2.src\3.spring\gs-rest-service-yang-2\target\generated-sources\archetype\target\gs-rest-service-yang-archetype-0.0.1-SNAPSHOT[INFO][INFO] --- maven-archetype-plugin:3.0.0:integration-test (default-integration-test) @ gs-rest-service-yang-archetype ---[INFO] Processing Archetype IT project: basic[INFO] ----------------------------------------------------------------------------[INFO] Using following parameters for creating project from Archetype: gs-rest-service-yang-archetype:0.0.1-SNAPSHOT[INFO] ----------------------------------------------------------------------------[INFO] Parameter: groupId, Value: archetype.it[INFO] Parameter: artifactId, Value: basic[INFO] Parameter: version, Value: 0.1-SNAPSHOT[INFO] Parameter: package, Value: it.pkg[INFO] Parameter: packageInPathFormat, Value: it/pkg[INFO] Parameter: version, Value: 0.1-SNAPSHOT[INFO] Parameter: package, Value: it.pkg[INFO] Parameter: groupId, Value: archetype.it[INFO] Parameter: artifactId, Value: basic[INFO] Project created from Archetype in dir: D:\WORK\personal\2.src\3.spring\gs-rest-service-yang-2\target\generated-sources\archetype\target\test-classes\projects\basic\project\basic[INFO][INFO] --- maven-install-plugin:2.5.2:install (default-install) @ gs-rest-service-yang-archetype ---[INFO] Installing D:\WORK\personal\2.src\3.spring\gs-rest-service-yang-2\target\generated-sources\archetype\target\gs-rest-service-yang-archetype-0.0.1-SNAPSHOT.jar to C:\Users\yangg\.m2\repository\com\huajiesolar\gs-rest-service-yang-archetype\0.0.1-SNAPSHOT\gs-rest-service-yang-archetype-0.0.1-SNAPSHOT.jar[INFO] Installing D:\WORK\personal\2.src\3.spring\gs-rest-service-yang-2\target\generated-sources\archetype\pom.xml to C:\Users\yangg\.m2\repository\com\huajiesolar\gs-rest-service-yang-archetype\0.0.1-SNAPSHOT\gs-rest-service-yang-archetype-0.0.1-SNAPSHOT.pom[INFO][INFO] --- maven-archetype-plugin:3.0.0:update-local-catalog (default-update-local-catalog) @ gs-rest-service-yang-archetype ---[INFO] ------------------------------------------------------------------------[INFO] BUILD SUCCESS[INFO] ------------------------------------------------------------------------[INFO] Total time: 2.073 s[INFO] Finished at: 2017-02-21T22:35:47+08:00[INFO] Final Memory: 14M/153M[INFO] ------------------------------------------------------------------------
安装之后主要做了两件事情：
1） 将文件安装到mvn缓存目录，在我本机就是C:\Users\yangg\.m2\repository\com\huajiesolar\gs-rest-service-yang-archetype，该文件夹下的目录结构如下：
| maven-metadata-local.xml|\---0.0.1-SNAPSHOTgs-rest-service-yang-archetype-0.0.1-SNAPSHOT.jargs-rest-service-yang-archetype-0.0.1-SNAPSHOT.pommaven-metadata-local.xml_remote.repositories
2）创建了文件 C:\Users\yangg\.m2\repository\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.huajiesolar</groupId><artifactId>gs-rest-service-yang-archetype</artifactId><version>0.0.1-SNAPSHOT</version><description>Parent pom providing dependency and plugin management for applicationsbuilt with Maven</description></archetype></archetypes></archetype-catalog>
五、使用上文创建的archetype
有2种使用方式：
1）通过命令行使用
找到一个空目录，然后执行如下命令：
mvn archetype:generate -DarchetypeCatalog=local
此时会给出上文安装的archetype，选择即可，如下：
[INFO] Scanning for projects...[INFO][INFO] ------------------------------------------------------------------------[INFO] Building Maven Stub Project (No POM) 1[INFO] ------------------------------------------------------------------------[INFO][INFO] >>> maven-archetype-plugin:3.0.0:generate (default-cli) > generate-sources @ standalone-pom >>>[INFO][INFO] <<< maven-archetype-plugin:3.0.0:generate (default-cli) < generate-sources @ standalone-pom <<<[INFO][INFO] --- maven-archetype-plugin:3.0.0:generate (default-cli) @ standalone-pom ---[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 -> com.huajiesolar:gs-rest-service-yang-archetype (Parent pom providing dependency and plugin management for applicationsbuilt with Maven)Choose a number or apply filter (format: [groupId:]artifactId, case sensitive contains): :
2）通过eclipse使用
因为C:\Users\yangg\.m2\repository\archetype-catalog.xml是新创建的，所以需要在ecliplse的 file -》new-》maven projects对话框中，在选择archetype页面上，如下图
点击上文的config按钮，弹出如下界面：
点击add local catalog ...按钮，在弹出的对话框中选择上文新声称的catalog文件：
点击Ok即可。
然后在界面上就可以选择新创建的archetype模板了。
附录：参考资料：
《Maven实战》