创建archetype是一个非常简单的过程。archetype就是一个非常简单的构件,它包含了你想创建的工程的模型。archetype由这些东西组成:
- 一个archetype描述符(archetype descriptor)(src/main/resources/META-INF/maven目录下的archetype.xml)。这个文件列出了包含在archetype中的所有文件并将这些文件分类,因此archetype生成机制才能正确的处理。
- 原型文件(prototype files),archetype插件会复制这些文件(目录: src/main/resources/archetype-resources/)
- 原型POM(prototype pom)(pom.xml in: src/main/resources/archetype-resources)
- archetype的POM(pom.xml 在archetype的根目录下)
创建原型需要以下几个步骤:
1. 为archetype构件创建一个新工程和pom.xml
一个archetype构件的pom.xml示例看起来像这样:
<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> <groupId>my.groupId</groupId> <artifactId>my-archetype-id</artifactId> <version>1.0-SNAPSHOT</version> <packaging>jar</packaging> </project>
你需要修改的仅仅是groupId, artifactId 和 version。这三个参数在后面从命令行调用archetype:generate是会用到。
2. 创建archetype描述符
archetype描述符是一个名为archetype.xml的文件,这个文件必须放在src/main/resources/META-INF/maven/ 目录下。在quickstart archetype中你可以找到一个archetype描述符的例子:
<archetype xmlns="http://maven.apache.org/plugins/maven-archetype-plugin/archetype/1.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/plugins/maven-archetype-plugin/archetype/1.0.0 http://maven.apache.org/xsd/archetype-1.0.0.xsd"> <id>quickstart</id> <sources> <source>src/main/java/App.java</source> </sources> <testSources> <source>src/test/java/AppTest.java</source> </testSources> </archetype> <id>标签应该和archetype的pom.xml中的artifactId一样。
<allowPartial>true</allowPartial>标签是可选的,它使得archetype:generate可以在一个已存在的工程中运行。
<sources>, <resources>, <testSources>, <testResources> 和 <siteResources>标签则代表工程中不同的部分:
- <sources> = src/main/java
- <resources> = src/main/resources
- <testSources> = src/test/java
- <testResources> = src/test/resources
- <siteResources> = src/site
<sources> 和<testSources>都能包含<source>元素来指定源文件。
<testResources>和<siteResources>能包含<resource>元素来指定资源文件。
将其他的资源,比如src/main/webapp目录放在<resource>标签中。
在这一点上,你可以指定要创建的单独的文件,但不能是空目录。
因此,上面展示的quickstart archetype 定义的目录结构为:
archetype |-- pom.xml `-- src `-- main `-- resources |-- META-INF | `-- maven | `--archetype.xml `-- archetype-resources |-- pom.xml `-- src |-- main | `-- java | `-- App.java `-- test `-- java `-- AppTest.java
3. 创建原型文件和原型pom.xml
下一个要创建的archetype组件是原型pom.xml。每一个pom.xml都要做的,就是不要忘记设置artifactId和groupId作为变量 ( ${artifactId} / ${groupId} )。这两个变量都将在archetype:generate从命令行运行时被初始化。
一个原型pom.xml的例子如下:
<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> <groupId>${groupId}</groupId> <artifactId>${artifactId}</artifactId> <version>${version}</version> <packaging>jar</packaging> <name>A custom project</name> <url>http://www.myorganization.org</url> <dependencies> <dependency> <groupId>junit</groupId> <artifactId>junit</artifactId> <version>3.8.1</version> <scope>test</scope> </dependency> </dependencies> </project>
4. 安装archetype并运行archetype插件
现在你可以准备安装这个archetype:
mvn install
现在你已经创建了一个archetype,你可以试着在你的本地系统上使用下面的命令。使用这个命令,你需要制定你想要使用的archetype的全部信息(groupId, artifactId, version)和你想要创建的新工程的信息(artifactId和groupId)。别放了你的archetype的版本(如果你没有包含版本信息,你的archetype创建操作可能会得到一个关于版本的失败信息:RELEASE was not found)
mvn archetype:generate / -DarchetypeGroupId=<archetype-groupId> / -DarchetypeArtifactId=<archetype-artifactId> / -DarchetypeVersion=<archetype-version> / -DgroupId=<my.groupid> / -DartifactId=<my-artifactId>
如果你觉得你的archetype很好用,你可以将它和其他构件一起部署(提交到ibiblio),这样这个archetype就能被其他Maven用户使用了。
创建Archetype的其他方式
作为手工创建archetype目录结构的替代方案,你可以简单的这样做
mvn archetype:generate -DgroupId=[your project's group id] -DartifactId=[your project's artifact id] -DarchetypeArtifactId=maven-archetype-archetype
这样的话,你现在可以自定义archetype.xml和archetype-resources目录的内容,接着,继续第四步骤(安装archetype并运行archetype插件)。
原创文章,作者:ItWorker,如若转载,请注明出处:https://blog.ytso.com/115947.html