使用maven创建Archetype

Archetype原型 也就是说为项目生成一个原型，可以把这个项目发布，其他人就可以直接通过命令构建一个原型项目了。

其实我一开始也是不知道maven还有这个功能的，但是在使用的springside的构建项目时候，发现这个功能很好用，就在想，到底是怎么做的呢，后来我就在网上搜索到了这个，

下面就做一个记录。

原文链接

创建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插件)

时间： 2024-10-18 03:21:07

使用maven创建Archetype的相关文章

[转]maven创建自定义的archetype

创建自己的archetype一般有两种方式,比较简单的就是create from project 1.首先使用eclipse创建一个新的maven project,然后把配置好的一些公用的东西放到相应的目录下面    比如说会将一些常用的java代码存放到src/main/java目录下面:    会将一些通用的配置文件放到src/main/resources目录下面: 如果是javeEE工程,还会有一些jsp等等的文件存放到src/main/webapp目录下面 2.然后在maven proj

如何创建Maven的Archetype

原文:http://maven.apache.org/guides/mini/guide-creating-archetypes.html 创建Maven的Archetype是一个相当直接的过程.一个Archetype就是一个非常简单的作品,它包含了你所希望的工程的原型.一个Archetype的组成如下: ?  一个原型描述符(它是位于src/main/resources/META-INF/maven/目录中的archetype.xml文件).这个文件中列出了该原型中包含的所有文件,并且对它们进

使用Maven创建一个Spring MVC Web 项目

使用Maven创建java web 项目(Spring MVC)用到如下工具: 1.Maven 3.2 2.IntelliJ IDEA 13 3.JDK 1.7 4.Spring 4.1.1 released 5.Tomcat7 6.Logback 1.0.13 日志输出组件 接下来开始演示如何用Maven模板创建web项目 1.使用maven-archetype-webapp模板快速创建web项目的骨架结构 打开控制台,进入到你想要创建web项目的目录,然后运行如下命令: 1 $ mvn ar

手写Maven的archetype项目脚手架

一.背景 maven是一个很好的代码构建工具,采用“约定优先于配置”的原则进行项目管理,相信很多的java开发者应该都了解maven并可能在工作当中都是通过maven来管理项目的,在创建的项目的时候,我们往往会使用maven内置的项目骨架也就是archetype来快速生成项目结构.但是在一个团队做开发的过程中,可能仅仅依靠maven预先提供的archetyp可能是不够的,团队之间协作有自己的定义方式,每个人的结构定义风格也不尽相同,在这样的背景下我们有必要去定义一个统一的代码骨架供团队使用,这样

使用IntelliJ IDEA 14和Maven创建java web项目

原文:使用IntelliJ IDEA 14和Maven创建java web项目 http://mark.leanote.com/post/%E4%BD%BF%E7%94%A8IntelliJ-IDEA-14%E5%92%8CMaven%E5%88%9B%E5%BB%BAjava-web%E9%A1%B9%E7%9B%AE 安装Maven 下载安装 去maven官网下载最新版. 解压到安装目录. 配置 右键桌面的计算机图标,属性–>高级系统设置–>环境变量,添加M2_HOME的环境变量,然后将该

Maven3路程（六）用Maven创建Spring3 MVC项目

一.      环境 spring-framework-3.2.4.RELEASE jdk1.7.0_11 Maven3.0.5 eclipse-jee-juno-SR2-win32 二.      创建Web项目 Eclipse中创建Web项目,见前边日志<Maven3路程(三)用Maven创建第一个web项目(1)> 三.      项目依赖,配置pom.xml文件 pom.xml文件如下: <project xmlns="http://maven.apache.org/P

Maven 创建java Web项目，配置Spring，CXF

1.搭建Maven环境 参考文章 Maven3路程(一)环境搭建 http://www.cnblogs.com/leiOOlei/p/3359561.html Maven3路程(二)Eclipse集成Maven http://www.cnblogs.com/leiOOlei/p/3361379.html Maven3路程(三)用Maven创建第一个web项目(1) Maven3路程(三)用Maven创建第一个web项目(2)servlet演示 Maven 配置Spring 参考 http://b

用maven创建java project,再转化为dynamic web project

使用myeclipse 2014创建java project几次都没有成功,还是觉得用maven创建java project然后导入到myeclipse ide中,比较方便. 首先在workspace目录下面创建maven工程,mvn archetype:create -DgroupId=com.test -DartifactId=test.控制台输出如下: [INFO] --------------------------------------------------------------

如何用Maven创建一个普通Java项目

一下内容包括:用Maven创建一个普通Java项目,并把该项目转成IDEA项目,导入到IDEA,最后把这个项目打包成一个jar文件. 有时候运行mvn命令失败,重复运行几次就OK了,无解. 1.用Maven模板创建一个项目 打开控制台,进入到想要创建项目的目录,然后运行如下命令,参数自由填写: 1 mvn archetype:generate -DgroupId={project-packaging} 2 -DartifactId={project-name} 3 -DarchetypeArti