手把手教你写Maven的archetype项目脚手架

手把手教你写Maven的archetype项目脚手架

目录一、背景二、手写普通单模块项目的archetype三、手写maven多module的项目骨架archetype1.多模块骨架项目的项目结构2.模板工程定义描述文件3.子模块pom.xml定义如下(以core模块为例)：四、总结

一、背景

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

archetype是在maven-archetype-plugin插件执行generate目标的时候进行配置的，我们经常使用到maven的内嵌的骨架包括：maven-archetype-webapp、maven-archetype-quickstart。前者用来快速搭建一个web工程项目，后者用来快速搭建一个普通的java工程项目。

二、手写普通单模块项目的archetype

单模块项目的archetype脚手架项目的结构

上图中的各个文件详解：

根目录beast-archetype下的pom.xml和一般的maven项目一样主要定义archetype项目的坐标等信息。

所有的项目骨架内容都集中在src/main/resources/archetype-resources文件夹下。

archetype-resources中的pom.xml定义了待生成项目的pom文件的内容，/src/main/java、/src/test/java中分别定义了待生成项目中相应目录下的内容

/src/main/resources/META-INF/maven/archetype-metadata.xml中定义相关的元数据描述(其中该文件的位置固定为resources/META-INF/maven文件夹下,且名称固定为archetype-metadata.xml)。

1.beast-archetype/pom.xml内容如下

xsi:schqWiitemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">

4.0.0

com.thebeastshop

beast-archetype

1.1

jar

beast-archetype

http://maven.apache.org

UTF-8

junit

junit

3.8.1

test

beast-archetype

xsi:schqWiitemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">

4.0.0

com.thebeastshop

beast-archetype

1.1

jar

beast-archetype

http://maven.apache.org

UTF-8

junit

junit

3.8.1

test

beast-archetype

2.src/main/resources/archetype-resources/pom.xml内容如下：

xmlns:xsi="http://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">

4.0.0

${groupId}

${artifactId}

${version}

${artifactId}

junit

junit

3.8.1

test

maven-deploy-plugin

true

org.apache.maven.plugins

maven-archetype-plugin

2.2

1.7

1.7

org.apache.maven.plugins

maven-source-plugin

UTF-8

xmlns:xsi="http://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">

4.0.0

${groupId}

${artifactId}

${version}

${artifactId}

junit

junit

3.8.1

test

maven-deploy-plugin

true

org.apache.maven.plugins

maven-archetype-plugin

2.2

1.7

1.7

org.apache.maven.plugins

maven-source-plugin

UTF-8

其中：上面${}标识的变量都是通过maven中的命令行传进来的，如：mvn archetype:generate -DgroupId=com.thebeastshop

3.src/main/resources/META-INF/maven/archetype-metadata.xml内容如下：

xmlns="http://maven.apache.org/plugins/maven-archetype-plugin/archetype-descriptor/1.0.0"

xmlns:xsi="http://w3.org/2001/XMLSchema-instance"

xsi:schemaLocation="

http://maven.apache.org/plugiqWiitns/maven-archetype-plugin/archetype-descriptor/1.0.0

http://maven.apache.org/xsd/archetype-descriptor-1.0.0.xsd">

src/main/java

**/*.java

src/main/resources

**/*.*

src/test/java

**/*.java

src/test/resources

**/*.*

xmlns="http://maven.apache.org/plugins/maven-archetype-plugin/archetype-descriptor/1.0.0"

xmlns:xsi="http://w3.org/2001/XMLSchema-instance"

xsi:schemaLocation="

http://maven.apache.org/plugiqWiitns/maven-archetype-plugin/archetype-descriptor/1.0.0

http://maven.apache.org/xsd/archetype-descriptor-1.0.0.xsd">

src/main/java

**/*.java

src/main/resources

**/*.*

src/test/java

**/*.java

src/test/resources

**/*.*

说明：

packaged="true"标识src/main/resources/archetype-resources/src/main/java中对应的内容是否要放入到package中,比如package为com.thebeastshop,那么如果该属性为true,则对应的java文件会放到com/thebeastshop文件夹下，也就是包路径下。

filtered="true"标识下面提到的${}是否要进行替换

4.src/main/resources/archetype-resources/src/main/java/Demo.java内容如下：

package ${package};

public class Demo{

public static void main( String[] args )

{

System.out.println( "Hello My Archetype!" );

}

}

5.这样我们就手写好了一个自定义的maven的archetype骨架项目，我们只需要通过mvn clean install 命令把该jar包安装到本地仓库，然后通过本地仓库中的该jar包来生成一个项目看看效果，使用如下命令：

mvn archetype:generate

　　-DgroupId=comthebeastshop

　　-DartifactId=beast-test

　　-Dpackage="com.thebeastshop.test"

　　-DarchetypeGroupId=com.thebeastshop

　　-DarchetypeArtifactId=beast-archetype -DarchetypeVersion=1.1 -X -DarchetypeCatalog=local

三、手写maven多module的项目骨架archetype

1.多模块骨架项目的项目结构

这跟单模块项目区别不大，但是有几个概念需要说明：

“__rootArtifactId__”占位符会被parent项目的artifactId替换

${rootArtifactId}也会被parent项目的artifactId替换

src/main/resources/archetype-resources里必须要有一个顶级pom文件（如果是单工程就是工程pom文件），同时子文件夹代表了模块定义

2.模板工程定义描述文件

META-INF/maven/archetype-metadata.xml

xmlns="http://maven.apache.org/plugins/maven-archetype-plugin/archetype-descriptor/1.0.0"

xmlns:xsi="http://w3.org/2001/XMLSchema-instance"

xsi:schemaLocation="

http://maven.apache.org/plugins/maven-archetype-plugin/archetype-descriptor/1.0.0

http://maven.apache.org/xsd/archetype-descriptor-1.0.0.xsd">

com.thebeastshop

test

com.thebeastshop.test

src/main/java

**/*.*

src/test/java

**/*.*

src/main/resources

**/*.*

src/test/resources

**/*.*

src/main/java

qWiit **/*.*

src/test/java

**/*.*

src/main/resources

**/*.*

src/test/resources

**/*.*

src/main/java

**/*.*

src/test/java

qWiit

**/*.*

src/main/resources

**/*.*

mapper

src/test/resources

**/*.*

src/main/java

**/*.*

src/test/java

qWiit

**/*.*

src/main/resources

**/*.*

src/test/resources

**/*.*

src/main/assembly

**/*.*

src/main/bin

**/*.*

src/main/java

**/*.*

src/test/java

**/*.*

src/main/resources

**/*.*

src/test/resources

**/*.*

xmlns="http://maven.apache.org/plugins/maven-archetype-plugin/archetype-descriptor/1.0.0"

xmlns:xsi="http://w3.org/2001/XMLSchema-instance"

xsi:schemaLocation="

http://maven.apache.org/plugins/maven-archetype-plugin/archetype-descriptor/1.0.0

http://maven.apache.org/xsd/archetype-descriptor-1.0.0.xsd">

com.thebeastshop

test

com.thebeastshop.test

src/main/java

**/*.*

src/test/java

**/*.*

src/main/resources

**/*.*

src/test/resources

**/*.*

src/main/java

qWiit **/*.*

src/test/java

**/*.*

src/main/resources

**/*.*

src/test/resources

**/*.*

src/main/java

**/*.*

src/test/java

qWiit

**/*.*

src/main/resources

**/*.*

mapper

src/test/resources

**/*.*

src/main/java

**/*.*

src/test/java

qWiit

**/*.*

src/main/resources

**/*.*

src/test/resources

**/*.*

src/main/assembly

**/*.*

src/main/bin

**/*.*

src/main/java

**/*.*

src/test/java

**/*.*

src/main/resources

**/*.*

src/test/resources

**/*.*

属性变量定义

com.thebeastshop

test

com.thebeastshop.test

这些属性可以在资源元文件里的任意一个文件里通过${var}来引用，所以的元文件最终都可以选择通过velocity引擎来执行替换后生成。

默认的属性有：groupId，artifactId，packeage，version等

项目子模块定义

...

...

...

...

...

module有三个属性，解释如下：

id ：定义子模块工程的artifactId.

dir ：子模块工程源文件在archetype-resources里对应的directory.

name ：子模块的名字.

3.子模块pom.xml定义如下(以core模块为例)：

xmlns:xsi="http://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">

4.0.0

com.thebeastshop

${rootArtifactId}

${version}

${artifactId}

${artifactId}

com.thebeastshop

${rootArtifactId}-api

${api.version}

com.thebeastshop

${rootArtifactId}-dao

${project.parent.version}

maven-deploy-plugin

true

xmlns:xsi="http://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">

4.0.0

com.thebeastshop

${rootArtifactId}

${version}

${artifactId}

${artifactId}

com.thebeastshop

${rootArtifactId}-api

${api.version}

com.thebeastshop

${rootArtifactId}-dao

${project.parent.version}

maven-deploy-plugin

true

其中${rootArtifactId}就代表父项目的artifactId.

4.我们和单模块脚手架工程一样，通过mvn clean install命令把该脚手架项目安装到本地maven仓库，然后就可以使用该项目来快速生成新项目结构了，生成命令如下：

mvn archetype:generate

　　-DgroupId=com.thebeastshop

　　-DartifactId=ddd

　　-Dversion=1.0.0-SNAPSHOT

　　-DarchetypeGroupId=com.thebeastshop

　　-DarchetypeArtifactId=beast-archetype

　　-DarchetypeVersion=1.3-SNAPSHOT -X -DarchetypeCatalog=local

我们就会看到生成好的项目结构如下：

多模块项目脚手架源码：https://github.com/hafizzhang/beast-archetype

四、总结

版权声明：本文内容由网络用户投稿，版权归原作者所有，本站不拥有其著作权，亦不承担相应法律责任。如果您发现本站中有涉嫌抄袭或描述失实的内容，请联系我们jiasou666@gmail.com 处理，核实后本网站将在24小时内删除侵权内容。