学习笔记：Maven的ArcheType的学习笔记

摘要：
    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文件夹，该文件夹的内容如下：
  1. │  pom.xml
  2. │  
  3. ├─src
  4. │  ├─main
  5. │  │  └─resources
  6. │  │      ├─archetype-resources
  7. │  │      │  │  .classpath
  8. │  │      │  │  .project
  9. │  │      │  │  pom.xml
  10. │  │      │  │  
  11. │  │      │  ├─.settings
  12. │  │      │  │      org.eclipse.core.resources.prefs
  13. │  │      │  │      org.eclipse.jdt.core.prefs
  14. │  │      │  │      org.eclipse.m2e.core.prefs
  15. │  │      │  │      
  16. │  │      │  └─src
  17. │  │      │      ├─main
  18. │  │      │      │  └─java
  19. │  │      │      │          Application.java
  20. │  │      │      │          Quote.java
  21. │  │      │      │          Value.java
  22. │  │      │      │          
  23. │  │      │      └─test
  24. │  │      │          └─java
  25. │  │      │                  AppTest.java
  26. │  │      │                  
  27. │  │      └─META-INF
  28. │  │          └─maven
  29. │  │                  archetype-metadata.xml
  30. │  │                  
  31. │  └─test
  32. │      └─resources
  33. │          └─projects
  34. │              └─basic
  35. │                      archetype.properties
  36. │                      goal.txt
  37. │                      
  38. └─target
  39.     │  gs-rest-service-yang-archetype-0.0.1-SNAPSHOT.jar
  40.     │  
  41.     ├─classes
  42.     │  ├─archetype-resources
  43.     │  │  │  .classpath
  44.     │  │  │  .project
  45.     │  │  │  pom.xml
  46.     │  │  │  
  47.     │  │  ├─.settings
  48.     │  │  │      org.eclipse.core.resources.prefs
  49.     │  │  │      org.eclipse.jdt.core.prefs
  50.     │  │  │      org.eclipse.m2e.core.prefs
  51.     │  │  │      
  52.     │  │  └─src
  53.     │  │      ├─main
  54.     │  │      │  └─java
  55.     │  │      │          Application.java
  56.     │  │      │          Quote.java
  57.     │  │      │          Value.java
  58.     │  │      │          
  59.     │  │      └─test
  60.     │  │          └─java
  61.     │  │                  AppTest.java
  62.     │  │                  
  63.     │  └─META-INF
  64.     │      └─maven
  65.     │              archetype-metadata.xml
  66.     │              
  67.     ├─gs-rest-service-yang-archetype-0.0.1-SNAPSHOT
  68.     │  ├─archetype-resources
  69.     │  │  │  .classpath
  70.     │  │  │  .project
  71.     │  │  │  pom.xml
  72.     │  │  │  
  73.     │  │  ├─.settings
  74.     │  │  │      org.eclipse.core.resources.prefs
  75.     │  │  │      org.eclipse.jdt.core.prefs
  76.     │  │  │      org.eclipse.m2e.core.prefs
  77.     │  │  │      
  78.     │  │  └─src
  79.     │  │      ├─main
  80.     │  │      │  └─java
  81.     │  │      │          Application.java
  82.     │  │      │          Quote.java
  83.     │  │      │          Value.java
  84.     │  │      │          
  85.     │  │      └─test
  86.     │  │          └─java
  87.     │  │                  AppTest.java
  88.     │  │                  
  89.     │  └─META-INF
  90.     │      └─maven
  91.     │              archetype-metadata.xml
  92.     │              
  93.     └─test-classes
  94.         └─projects
  95.             └─basic
  96.                     archetype.properties
  97.                     goal.txt
可以看到上面有一些.setting, .class, .project的文件，这些是多余的。
所以我们在搭建好样板工程之后，在使用mvn archetype:create-from-project命令之前，要先把项目中不相关的工程文件、中间文件删除。
清除之后重新声称的结构如下：

  1. │  pom.xml
  2. │  
  3. ├─src
  4. │  ├─main
  5. │  │  └─resources
  6. │  │      ├─archetype-resources
  7. │  │      │  │  pom.xml
  8. │  │      │  │  
  9. │  │      │  └─src
  10. │  │      │      ├─main
  11. │  │      │      │  └─java
  12. │  │      │      │          Application.java
  13. │  │      │      │          Quote.java
  14. │  │      │      │          Value.java
  15. │  │      │      │          
  16. │  │      │      └─test
  17. │  │      │          └─java
  18. │  │      │                  AppTest.java
  19. │  │      │                  
  20. │  │      └─META-INF
  21. │  │          └─maven
  22. │  │                  archetype-metadata.xml
  23. │  │                  
  24. │  └─test
  25. │      └─resources
  26. │          └─projects
  27. │              └─basic
  28. │                      archetype.properties
  29. │                      goal.txt
  30. │                      
  31. └─target
  32.     │  gs-rest-service-yang-archetype-0.0.1-SNAPSHOT.jar
  33.     │  
  34.     ├─classes
  35.     │  ├─archetype-resources
  36.     │  │  │  pom.xml
  37.     │  │  │  
  38.     │  │  └─src
  39.     │  │      ├─main
  40.     │  │      │  └─java
  41.     │  │      │          Application.java
  42.     │  │      │          Quote.java
  43.     │  │      │          Value.java
  44.     │  │      │          
  45.     │  │      └─test
  46.     │  │          └─java
  47.     │  │                  AppTest.java
  48.     │  │                  
  49.     │  └─META-INF
  50.     │      └─maven
  51.     │              archetype-metadata.xml
  52.     │              
  53.     └─test-classes
  54.         └─projects
  55.             └─basic
  56.                     archetype.properties
  57.                     goal.txt

四、生成Archetype如何安装
    在上文创建了archetype之后，进入到target\generate-sources\archetype目录，然后在命令行执行：
    mvn install
    则输出如下信息，特别是installing这段，表示就安装成功了。
  1. [INFO] Scanning for projects...
  2. [INFO]
  3. [INFO] ------------------------------------------------------------------------
  4. [INFO] Building gs-rest-service-yang-archetype 0.0.1-SNAPSHOT
  5. [INFO] ------------------------------------------------------------------------
  6. [INFO]
  7. [INFO] --- maven-resources-plugin:3.0.2:resources (default-resources) @ gs-rest-service-yang-archetype ---
  8. [WARNING] Using platform encoding (GBK actually) to copy filtered resources, i.e. build is platform dependent!
  9. [INFO] Copying 6 resources
  10. [INFO]
  11. [INFO] --- maven-resources-plugin:3.0.2:testResources (default-testResources) @ gs-rest-service-yang-archetype ---
  12. [WARNING] Using platform encoding (GBK actually) to copy filtered resources, i.e. build is platform dependent!
  13. [INFO] Copying 2 resources
  14. [INFO]
  15. [INFO] --- maven-archetype-plugin:3.0.0:jar (default-jar) @ gs-rest-service-yang-archetype ---
  16. [INFO] Building archetype jar: D:\WORK\personal\2.src\3.spring\gs-rest-service-yang-2\target\generated-sources\archetype
  17. \target\gs-rest-service-yang-archetype-0.0.1-SNAPSHOT
  18. [INFO]
  19. [INFO] --- maven-archetype-plugin:3.0.0:integration-test (default-integration-test) @ gs-rest-service-yang-archetype ---
  20. [INFO] Processing Archetype IT project: basic
  21. [INFO] ----------------------------------------------------------------------------
  22. [INFO] Using following parameters for creating project from Archetype: gs-rest-service-yang-archetype:0.0.1-SNAPSHOT
  23. [INFO] ----------------------------------------------------------------------------
  24. [INFO] Parameter: groupId, Value: archetype.it
  25. [INFO] Parameter: artifactId, Value: basic
  26. [INFO] Parameter: version, Value: 0.1-SNAPSHOT
  27. [INFO] Parameter: package, Value: it.pkg
  28. [INFO] Parameter: packageInPathFormat, Value: it/pkg
  29. [INFO] Parameter: version, Value: 0.1-SNAPSHOT
  30. [INFO] Parameter: package, Value: it.pkg
  31. [INFO] Parameter: groupId, Value: archetype.it
  32. [INFO] Parameter: artifactId, Value: basic
  33. [INFO] Project created from Archetype in dir: D:\WORK\personal\2.src\3.spring\gs-rest-service-yang-2\target\generated-so
  34. urces\archetype\target\test-classes\projects\basic\project\basic
  35. [INFO]
  36. [INFO] --- maven-install-plugin:2.5.2:install (default-install) @ gs-rest-service-yang-archetype ---
  37. [INFO] Installing D:\WORK\personal\2.src\3.spring\gs-rest-service-yang-2\target\generated-sources\archetype\target\gs-re
  38. st-service-yang-archetype-0.0.1-SNAPSHOT.jar to C:\Users\yangg\.m2\repository\com\huajiesolar\gs-rest-service-yang-arche
  39. type\0.0.1-SNAPSHOT\gs-rest-service-yang-archetype-0.0.1-SNAPSHOT.jar
  40. [INFO] Installing D:\WORK\personal\2.src\3.spring\gs-rest-service-yang-2\target\generated-sources\archetype\pom.xml to C
  41. :\Users\yangg\.m2\repository\com\huajiesolar\gs-rest-service-yang-archetype\0.0.1-SNAPSHOT\gs-rest-service-yang-archetyp
  42. e-0.0.1-SNAPSHOT.pom
  43. [INFO]
  44. [INFO] --- maven-archetype-plugin:3.0.0:update-local-catalog (default-update-local-catalog) @ gs-rest-service-yang-arche
  45. type ---
  46. [INFO] ------------------------------------------------------------------------
  47. [INFO] BUILD SUCCESS
  48. [INFO] ------------------------------------------------------------------------
  49. [INFO] Total time: 2.073 s
  50. [INFO] Finished at: 2017-02-21T22:35:47+08:00
  51. [INFO] Final Memory: 14M/153M
  52. [INFO] ------------------------------------------------------------------------

安装之后主要做了两件事情：
1） 将文件安装到mvn缓存目录，在我本机就是C:\Users\yangg\.m2\repository\com\huajiesolar\gs-rest-service-yang-archetype，该文件夹下的目录结构如下：
  1. |   maven-metadata-local.xml
  2. |   
  3. \---0.0.1-SNAPSHOT
  4.         gs-rest-service-yang-archetype-0.0.1-SNAPSHOT.jar
  5.         gs-rest-service-yang-archetype-0.0.1-SNAPSHOT.pom
  6.         maven-metadata-local.xml
  7.         _remote.repositories   
2）创建了文件 C:\Users\yangg\.m2\repository\archetype-catalog.xml文件，文件内容如下：
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <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"
  3.     xmlns="http://maven.apache.org/plugins/maven-archetype-plugin/archetype-catalog/1.0.0"
  4.     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  5.   <archetypes>
  6.     <archetype>
  7.       <groupId>com.huajiesolar</groupId>
  8.       <artifactId>gs-rest-service-yang-archetype</artifactId>
  9.       <version>0.0.1-SNAPSHOT</version>
  10.       <description>Parent pom providing dependency and plugin management for applications
  11. 		built with Maven</description>
  12.     </archetype>
  13.   </archetypes>
  14. </archetype-catalog>

五、使用上文创建的archetype
有2种使用方式：
1）通过命令行使用
    找到一个空目录，然后执行如下命令：
    mvn archetype:generate -DarchetypeCatalog=local
    此时会给出上文安装的archetype，选择即可，如下：
  1. [INFO] Scanning for projects...
  2. [INFO]
  3. [INFO] ------------------------------------------------------------------------
  4. [INFO] Building Maven Stub Project (No POM) 1
  5. [INFO] ------------------------------------------------------------------------
  6. [INFO]
  7. [INFO] >>> maven-archetype-plugin:3.0.0:generate (default-cli) > generate-sources @ standalone-pom >>>
  8. [INFO]
  9. [INFO] <<< maven-archetype-plugin:3.0.0:generate (default-cli) < generate-sources @ standalone-pom <<<
  10. [INFO]
  11. [INFO] --- maven-archetype-plugin:3.0.0:generate (default-cli) @ standalone-pom ---
  12. [INFO] Generating project in Interactive mode
  13. [INFO] No archetype defined. Using maven-archetype-quickstart (org.apache.maven.archetypes:maven-archetype-quickstart:1.0)
  14. Choose archetype:
  15. 1: local -> com.huajiesolar:gs-rest-service-yang-archetype (Parent pom providing dependency and plugin management for applications
  16.                 built with Maven)
  17. 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实战》











posted @ 2017-02-21 23:01  拿走不谢  阅读(5257)  评论(0)    收藏  举报