Maven Archetype

最新推荐文章于 2024-05-09 12:36:26 发布

罗小爬EX

最新推荐文章于 2024-05-09 12:36:26 发布

阅读量2.5w

点赞数 7

分类专栏：架构设计 Java & Spring 文章标签： maven java

本文链接：https://blog.csdn.net/luo15242208310/article/details/120411215

版权

Java & Spring 同时被 2 个专栏收录

57 篇文章 1 订阅

订阅专栏

架构设计

16 篇文章 18 订阅

订阅专栏

最开始接触到maven archetype，是在通过idea创建project时，可以选择Maven -> Create from archetype，
在输入project的GAV后，就可以很方便的初始化一个maven工程，如下图：
在这里插入图片描述
Maven Archetype（原型）是代码工程的抽象（模版），它本身也是一种遵循特定规范的maven project，
通过Maven Archetype定义出project的骨架、模版，然后通过mvn archetype:generate命令可以快速的生成project，
使用Maven Archetype的好处如下：
（1）规范化组织内部的project结构、标准、依赖（即定义可复用的最佳实践）
（2）使开发者可以方便、快速地生成project

Maven Archetype工程结构

archetype本身也是一个maven工程，但是较普通maven工程的3个不同之处如下：
1、根pom需要添加org.apache.maven.archetype:archetype-packaging扩展且packaging为maven-archetype

<?xml version="1.0" encoding="UTF-8"?>
<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>com.baeldung.archetypes</groupId>
    <artifactId>maven-archetype</artifactId>
    <version>1.0-SNAPSHOT</version>
    <name>maven-archetype</name>
    <!-- packaging为maven-archetype --> 
    <packaging>maven-archetype</packaging>
    <description>Archetype used to generate rest application based on jaxrs 2.1</description>

    <build>
        <extensions>
        	<!-- 添加org.apache.maven.archetype:archetype-packaging扩展 -->
            <extension>
                <groupId>org.apache.maven.archetype</groupId>
                <artifactId>archetype-packaging</artifactId>
                <version>${archetype-packaging.version}</version>
            </extension>
        </extensions>
        <!--.... -->
    </build>

    <properties>
        <maven.compiler.source>1.8</maven.compiler.source>
        <maven.compiler.target>1.8</maven.compiler.target>
        <archetype-packaging.version>3.0.1</archetype-packaging.version>
    </properties>

</project>

2、src/main/resources/archetype-resources
archetype-resources目录下放的即为模版代码、模版配置文件、模版pom等等，
通过archetype创建工程时会将此目录的模版拷贝到新生成的工程中，
在此目录的文件均可通过${propName}引用archetype-metadata.xml中配置的属性，
且存在如下几个常用的特殊属性：
（1）groupId、artifactId、version对应新建project的maven GAV（即对应mvn archetype:create -DgroupId, -DartifactId, -Dversion参数）
（2）rootArtifactId对应多模块项目的parent模块的artifactId
（3）package对应代码包（即groupId指定的包结构）

3、src/main/resources/META-INF/maven/archetype-metadata.xml
用于描述archetype元数据metadata（包括待拷贝的模版文件、属性…）的描述文件

maven-archetype工程目录示例如下：

archetype-root
├── pom.xml  "archetype工程本身的pom"
└── src
    └── main
        ├── java
        └── resources 
            ├── archetype-resources "需要生成的代码、配置、pom模板"
            │   ├── pom.xml
            │   └── src
            └── META-INF
                └── maven
                    └── archetype-metadata.xml "archetype描述文件"

archetype-metadata.xml示例如下：

<archetype-descriptor
        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
        http://maven.apache.org/plugins/maven-archetype-plugin/archetype-descriptor/1.0.0"
        xmlns="http://maven.apache.org/plugins/maven-archetype-plugin/archetype-descriptor/1.0.0"
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        name="${artifactId}">

	<!-- 
	定义属性requiredProperties.requiredProperty（支持多个），
	key对应属性名称，defaultValue指定属性的默认值，
	archetype-resources下的模版文件可以通过${requiredProperty.key}的方式进行引用，
	可以在执行mvn archetype:create时通过-DpropKey的形式进行设置，如下为-Dname=sam
	-->
    <requiredProperties>
        <requiredProperty key="name">
            <defaultValue>tom</defaultValue>
        </requiredProperty>
    </requiredProperties>

	<!--
	指定archetype-resources下的哪些文件被用于生成新project（即需要被拷贝到新project），
	filtered表示是否需要过滤文件，即是否需要将占位符${propKey}替换为具体属性值，
	packaged表示需要创建package对应的目录层级
	-->
    <fileSets>
        <fileSet filtered="true" packaged="true">
            <directory>src/main/java</directory>
            <includes>
                <include>**/*.java</include>
            </includes>
        </fileSet>
    </fileSets>

	<!--
	若想生成多module项目，则需通过modules配置多个module，
	具体使用可参见下文的【创建支持生成多模块的Maven Archetype】
	-->
    <modules>
        <module name="sub-module"></module>
    </modules>

</archetype-descriptor>

创建Maven Archetype

创建archetype有2中方式，
1、手动创建maven project， 然后添加之前提到archetype的特定依赖（pom、src/resources/archetype-resources、src/resources/META-INF/maven/archetype-metadata.xml）
2、通过mvn archetype:generate命令自动生成archetype
如下命令指定使用org.apache.maven.archetypes:maven-archetype-archetype，生成com.luo:luo-archetype的maven archetype工程

mvn archetype:generate -B ^
  -DarchetypeGroupId=org.apache.maven.archetypes ^
  -DarchetypeArtifactId=maven-archetype-archetype ^
  -DgroupId=com.luo ^
  -DartifactId=luo-archetype

执行命令后生成工程目录结构如下：
在这里插入图片描述
注：
自动方式用的不熟，文件名、pom依赖也有点奇怪😂
都是手动创建，又或者将其他的archetype拷贝后进行修改

创建非多模块工程的archetype可以参见 baeldung/maven-archetype上的示例，
我已经将单独的archetype示例上传到Github/marqueeluo/maven-archetype-Baeldung-demo上，其目录结构如下图：
在这里插入图片描述

要创建自己的archetype，可以直接clone该项目，需要修改的地方主要包括：
1、在archetype-resources/src/main/java下编写java模板
其中java文件直接放在archetype-resources/src/main/java目录下，java文件中通过package ${package};设置包，
具体的包目录创建可通过在archetype-metadata.xml设置packaged=true来进行自动创建且包名同groupId
在这里插入图片描述

2、在archetype-resource/src/main/resources编写配置文件模板
示例中的配置文件单独放在liberty/config，但是spring生态更喜欢放在resources目录下，
在将配置文件放在resources目录之后，还需修改archetype-metadata.xml中fileSet.directory为src/main/resources

    <fileSets>
        ...
        <fileSet>
            <directory>src/main/resources</directory>
        </fileSet>
    </fileSets>

3、在archetype-resource下编写工程的pom.xml模板
即修改模板工程的pom文件
4、修改archetype-metadata.xml描述文件，配置属性、模板文件拷贝

具体的修改位置参见下图，且在1、2、3步骤中均可通过${propKey}的形式引用archetype-metadata.xml requiredProperties中定义的属性
在这里插入图片描述

创建支持生成多模块的Maven Archetype

创建支持生成多模块的Maven Archetype示例，可参见我之前创建的github/marqueeluo/openfeign-archetype，
该archetype创建一个支持openfeign接口定义的多模块项目，项目的模块定义如下：
API： openfeign接口定义（支持springMvc contract）、参数定义、返回结果定义
SERVICE： 依赖API，具体的业务逻辑实现，同时亦可依赖其项目的API模块，通过FeignClient形式调用其他服务
WEB： 依赖SERVICE，实现API中定义的Openfeign接口，并调用SERVICE模块处理业务
在这里插入图片描述

创建多module archetype的关键点就是rootArtifactId的使用，
1、在模块目录中使用"__rootArtfactId__"占位符，
maven会自动替换其为全局的artifactId，即在执行mvn archetype:generate -DartifactId时设置的artifactId
在这里插入图片描述
2、在模板pom中使用${rootArtifactId}表示全局artifactId
根（parent）模板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>pom</packaging>
    <description>Demo project for Openfeign</description>
    <modules>
        <module>${rootArtifactId}-api</module>
        <module>${rootArtifactId}-service</module>
        <module>${rootArtifactId}-web</module>
    </modules>
	...
    <dependencyManagement>
        <dependencies>
            <!-- 管理模块依赖 -->
            <dependency>
                <groupId>${groupId}</groupId>
                <artifactId>${rootArtifactId}-api</artifactId>
                <version>${project.version}</version>
            </dependency>
            <dependency>
                <groupId>${groupId}</groupId>
                <artifactId>${rootArtifactId}-service</artifactId>
                <version>${project.version}</version>
            </dependency>
            <dependency>
                <groupId>${groupId}</groupId>
                <artifactId>${rootArtifactId}-web</artifactId>
                <version>${project.version}</version>
            </dependency>
        </dependencies>
    </dependencyManagement>

</project>

子模块pom.xml

<?xml version="1.0" encoding="UTF-8"?>
<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">
    <parent>
        <groupId>${groupId}</groupId>
        <artifactId>${rootArtifactId}</artifactId>
        <version>${version}</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>${artifactId}</artifactId>

    <dependencies>
        <!-- 依赖api -->
        <dependency>
            <groupId>${groupId}</groupId>
            <artifactId>${rootArtifactId}-api</artifactId>
        </dependency>
    </dependencies>

</project>

3、在archetype-metadata.xml中配置多module及其对应的模板文件

<archetype-descriptor
        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
        http://maven.apache.org/plugins/maven-archetype-plugin/archetype-descriptor/1.0.0"
        xmlns="http://maven.apache.org/plugins/maven-archetype-plugin/archetype-descriptor/1.0.0"
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        name="${artifactId}">

    ...

    <modules>
        <module id="${rootArtifactId}-api" dir="__rootArtifactId__-api" name="${rootArtifactId}-api">
            <fileSets>
                <fileSet filtered="true" packaged="true" encoding="UTF-8">
                    <directory>src/main/java</directory>
                </fileSet>
                <fileSet encoding="UTF-8">
                    <directory>src/main/resources</directory>
                </fileSet>
                <fileSet filtered="true" packaged="true" encoding="UTF-8">
                    <directory>src/test/java</directory>
                </fileSet>
                <fileSet encoding="UTF-8">
                    <directory>src/test/resources</directory>
                </fileSet>
            </fileSets>
        </module>
        <module id="${rootArtifactId}-service" dir="__rootArtifactId__-service" name="${rootArtifactId}-service">
            <fileSets>
                <fileSet filtered="true" packaged="true" encoding="UTF-8">
                    <directory>src/main/java</directory>
                </fileSet>
                <fileSet encoding="UTF-8">
                    <directory>src/main/resources</directory>
                </fileSet>
                <fileSet filtered="true" packaged="true" encoding="UTF-8">
                    <directory>src/test/java</directory>
                </fileSet>
                <fileSet encoding="UTF-8">
                    <directory>src/test/resources</directory>
                </fileSet>
            </fileSets>
        </module>
        <module id="${rootArtifactId}-web" dir="__rootArtifactId__-web" name="${rootArtifactId}-web">
            <fileSets>
                <fileSet filtered="true" packaged="true" encoding="UTF-8">
                    <directory>src/main/java</directory>
                </fileSet>
                <fileSet encoding="UTF-8">
                    <directory>src/main/resources</directory>
                </fileSet>
                <fileSet filtered="true" packaged="true" encoding="UTF-8">
                    <directory>src/test/java</directory>
                </fileSet>
                <fileSet encoding="UTF-8">
                    <directory>src/test/resources</directory>
                </fileSet>
            </fileSets>
        </module>
    </modules>

</archetype-descriptor>

之后即可在各自的模块目录下定义对应的代码、配置等等，
如果需要在${package}下再创建子包，如package ${package}.api;，
则可以在对应的archetype-resources/…/src/main/java下新建api文件夹，然后其下的代码中均通过package ${package}.api;形式定义包即可
在这里插入图片描述

archetype项目编写完成后，即可install本地maven仓库、deploy远程maven私服，
然后通过如下命令生成新的openfeign项目

# 其中-DarchetypeGroupId、-DarchetypeArtifactId、-DarchetypeVersion为archetype工程所对应的GAV
# 而-DgroupId、-DartifactId、-Dversion为新生成project对应的GAV
# 亦可通过-D设置archetype-metadata.xml requiredProperties中定义的属性
# -DoutputDirectory设置生成代码的输出目录，默认命令执行目录
mvn archetype:generate -DarchetypeGroupId=com.luo.openfeign.archetypes ^
                       -DarchetypeArtifactId=openfeign-archetype ^
                       -DarchetypeVersion=1.0.0-SNAPSHOT ^
                       -DoutputDirectory=D:/luo-demo ^
                       -DgroupId=com.luo.demo ^
                       -DartifactId=openfeign-demo-new ^
                       -Dversion=1.0.0-SNAPSHOT

在idea中添加自定义Maven Archetype

创建Project，点击菜单File -> New -> Project 后，选择Maven类型并点击add Archetype
在这里插入图片描述
输入archetype的GAV并点击OK

如上添加自定义archetype后，既可在下次新建project时选择自定义的maven archetype，
输入新生成project的GAV
在这里插入图片描述
点击下一步即可编辑相关属性（在archetype-meta.xml requiredProperties中定义的属性）

点击Finish后即可使用自定义的archetype创建新的工程

参考：
https://www.baeldung.com/maven-archetype
multi-module-maven-archetypes
https://maven.apache.org/guides/mini/guide-creating-archetypes.html

罗小爬EX

关注

7
点赞
踩
26

收藏

觉得还不错? 一键收藏
打赏
1
评论
Maven Archetype

参考：https://www.baeldung.com/maven-archetypemulti-module-maven-archetypesmaven-archetype工程目录archetype-root/├── pom.xml -----archetype根pom└── src └── main ├── java └── resources ├── archetype-resources ---------resourc
复制链接

扫一扫