【maven】多子模块maven模板工程archetype创建过程

2023-10-14 06:50
文章标签 maven 模板 模块 创建 过程 工程 多子 archetype

本文主要是介绍【maven】多子模块maven模板工程archetype创建过程，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

最近项目里需要创建一个多模块(子工程)的模板项目，所以研究了一下maven的archetype plugin。

创建了一个包含多个子模块工程的项目模板。记录下过程。

 

 

一个模板工程任务就是创建一个或多个默认的工程，并为每个工程填充好默认的一些文件和配置。同时要抽象出生成的工程需要的一些属性，做到这些属性可动态配置。

在maven里通过定制的archetype来生成项目模板。maven本身内置了很多archetype 工程模板。通过
Java代码   收藏代码
  1. mvn archetype:generate  
命令，mvn会列举出支持的所有项目模板。可以根据需求选择一个模板生成项目工程。
如果这些默认的模板还不够用，或者公司内部还希望定制自己个性化的工程模板，可以自己制作工程模板。
下面讲下archetype的制作过程。工程模板可以通过一个maven的archetype工程来定义。
下面的例子我编写的servicearchetype maven工程，是用来定义一个多模块的工程。

servicearchetype 工程总体结构


 

模板工程主要分为两个部分：

1.模板工程定义资源元文件

这些元文件是生成工程的时候需要用到的。放在src/main/resources/archetype-resources里。这里面的文件是生成模板工程是需要用到的元文件，一般也就是生成项目是默认填充的一些文件。

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

这些文件可以写成velocity模板语法，在文件里使用一些变量，在生成文件的时候，可以选择通过velocity引擎渲染生成。

如以上例子里的src/main/resources/archetype-resources/common/pom.xml:

Java代码   收藏代码
  1. <?xml version="1.0" encoding="UTF-8"?>  
  2. <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"  
  3.     xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">  
  4.     <modelVersion>4.0.0</modelVersion>  
  5.     <groupId>${groupId}</groupId>  
  6.     <artifactId>${appName}.${artifactId}</artifactId>  
  7.     <version>${version}</version>  
  8.   
  9.     <name>${appName}.${artifactId}</name>  
  10.   
  11.     <dependencies>  
  12.     </dependencies>  
  13. </project>  

可以看到里面使用到了groupId，appName，artifactId等变量，这些变量在生成项目文件的时候会通过vilocity引擎进行替换。至于这些变量定义在哪里，可以看下一部分工程描述文件。

可以根据自己项目的类型和需要，定义任意的资源元文件，如java，xml，MANIFEST.MF等等。

 

 

2.模板工程定义描述文件META-INF/maven/archetype-meatdata.xml

有了工程定义元文件还不够。还需要一个东西来描述需要生成工程的结构和文件组成等等，这里可以通过archetype工程定义描述符来定义。

该文件是具体的生成工程规则的描述符。关于工程定义描述文件可以参考maven的官方文档：archetype-descriptor

如下是我写的工程定义描述：

 

Xml代码   收藏代码
  1. <?xml version="1.0" encoding="UTF-8"?>  
  2. <archetype-descriptor name="servicearchetype">  
  3.     <requiredProperties>  
  4.         <requiredProperty key="appName">  
  5.             <defaultValue>helloworld</defaultValue>  
  6.         </requiredProperty>  
  7.         <requiredProperty key="groupId">  
  8.             <defaultValue>com.alibaba.china.app</defaultValue>  
  9.         </requiredProperty>  
  10.         <requiredProperty key="artifactId">  
  11.             <defaultValue>helloworld</defaultValue>  
  12.         </requiredProperty>  
  13.         <requiredProperty key="package">  
  14.             <defaultValue>com.alibaba.china.app</defaultValue>  
  15.         </requiredProperty>  
  16.     </requiredProperties>  
  17.     <modules>  
  18.         <module id="service.common" dir="common" name="service.common">  
  19.             <fileSets>  
  20.                 <fileSet filtered="true" encoding="UTF-8" packaged="true">  
  21.                     <directory>src/main/java</directory>  
  22.                     <includes>  
  23.                         <include>**/*.java</include>  
  24.                         <include>**/*.txt</include>  
  25.                     </includes>  
  26.                 </fileSet>  
  27.                 <fileSet filtered="true" encoding="UTF-8" packaged="true">  
  28.                     <directory>src/test/java</directory>  
  29.                     <includes>  
  30.                         <include>**/*.java</include>  
  31.                     </includes>  
  32.                 </fileSet>  
  33.                 <fileSet filtered="true" encoding="UTF-8" packaged="false">  
  34.                     <directory>src/main/resources</directory>  
  35.                     <includes>  
  36.                         <include>**/*.*</include>  
  37.                     </includes>  
  38.                 </fileSet>  
  39.                 <fileSet filtered="true" encoding="UTF-8" packaged="false">  
  40.                     <directory>src/test/resources</directory>  
  41.                     <includes>  
  42.                         <include>**/*.*</include>  
  43.                     </includes>  
  44.                 </fileSet>  
  45.                 <fileSet filtered="true" encoding="UTF-8">  
  46.                     <directory></directory>  
  47.                     <includes>  
  48.                         <include>pom.xml</include>  
  49.                     </includes>  
  50.                 </fileSet>  
  51.             </fileSets>  
  52.         </module>  
  53.         <module id="service.core" dir="core" name="service.core">  
  54.             <fileSets>  
  55.                 <fileSet filtered="true" encoding="UTF-8" packaged="true">  
  56.                     <directory>src/main/java</directory>  
  57.                     <includes>  
  58.                         <include>**/*.java</include>  
  59.                         <include>**/*.txt</include>  
  60.                     </includes>  
  61.                 </fileSet>  
  62.                 <fileSet filtered="true" encoding="UTF-8" packaged="true">  
  63.                     <directory>src/test/java</directory>  
  64.                     <includes>  
  65.                         <include>**/*.java</include>  
  66.                     </includes>  
  67.                 </fileSet>  
  68.                 <fileSet filtered="true" encoding="UTF-8" packaged="false">  
  69.                     <directory>src/main/resources</directory>  
  70.                     <includes>  
  71.                         <include>**/*.*</include>  
  72.                     </includes>  
  73.                 </fileSet>  
  74.                 <fileSet filtered="true" encoding="UTF-8" packaged="false">  
  75.                     <directory>src/test/resources</directory>  
  76.                     <includes>  
  77.                         <include>**/*.*</include>  
  78.                     </includes>  
  79.                 </fileSet>  
  80.                 <fileSet filtered="true" encoding="UTF-8">  
  81.                     <directory></directory>  
  82.                     <includes>  
  83.                         <include>pom.xml</include>  
  84.                     </includes>  
  85.                 </fileSet>  
  86.             </fileSets>  
  87.         </module>  
  88.         <module id="service.dal" dir="dal" name="service.dal">  
  89.             <fileSets>  
  90.                 <fileSet filtered="true" encoding="UTF-8" packaged="true">  
  91.                     <directory>src/main/java</directory>  
  92.                     <includes>  
  93.                         <include>**/*.java</include>  
  94.                         <include>**/*.txt</include>  
  95.                     </includes>  
  96.                 </fileSet>  
  97.                 <fileSet filtered="true" encoding="UTF-8" packaged="true">  
  98.                     <directory>src/test/java</directory>  
  99.                     <includes>  
  100.                         <include>**/*.java</include>  
  101.                     </includes>  
  102.                 </fileSet>  
  103.                 <fileSet filtered="true" encoding="UTF-8" packaged="false">  
  104.                     <directory>src/main/resources</directory>  
  105.                     <includes>  
  106.                         <include>**/*.*</include>  
  107.                     </includes>  
  108.                 </fileSet>  
  109.                 <fileSet filtered="true" encoding="UTF-8" packaged="false">  
  110.                     <directory>src/test/resources</directory>  
  111.                     <includes>  
  112.                         <include>**/*.*</include>  
  113.                     </includes>  
  114.                 </fileSet>  
  115.                 <fileSet filtered="true" encoding="UTF-8">  
  116.                     <directory></directory>  
  117.                     <includes>  
  118.                         <include>pom.xml</include>  
  119.                     </includes>  
  120.                 </fileSet>  
  121.             </fileSets>  
  122.         </module>  
  123.         <module id="service.deploy" dir="deploy" name="service.deploy">  
  124.             <fileSets>  
  125.                 <fileSet filtered="true" encoding="UTF-8" packaged="false">  
  126.                     <directory>src/main/resources</directory>  
  127.                     <includes>  
  128.                         <include>**/*.*</include>  
  129.                     </includes>  
  130.                 </fileSet>  
  131.                 <fileSet filtered="true" encoding="UTF-8">  
  132.                     <directory></directory>  
  133.                     <includes>  
  134.                         <include>pom.xml</include>  
  135.                     </includes>  
  136.                 </fileSet>  
  137.             </fileSets>  
  138.         </module>  
  139.         <module id="service.refrence" dir="refrence" name="service.refrence">  
  140.             <fileSets>  
  141.                 <fileSet filtered="true" encoding="UTF-8" packaged="true">  
  142.                     <directory>src/main/java</directory>  
  143.                     <includes>  
  144.                         <include>**/*.java</include>  
  145.                         <include>**/*.txt</include>  
  146.                     </includes>  
  147.                 </fileSet>  
  148.                 <fileSet filtered="true" encoding="UTF-8" packaged="true">  
  149.                     <directory>src/test/java</directory>  
  150.                     <includes>  
  151.                         <include>**/*.java</include>  
  152.                     </includes>  
  153.                 </fileSet>  
  154.                 <fileSet filtered="true" encoding="UTF-8" packaged="false">  
  155.                     <directory>src/main/resources</directory>  
  156.                     <includes>  
  157.                         <include>**/*.*</include>  
  158.                     </includes>  
  159.                 </fileSet>  
  160.                 <fileSet filtered="true" encoding="UTF-8" packaged="false">  
  161.                     <directory>src/test/resources</directory>  
  162.                     <includes>  
  163.                         <include>**/*.*</include>  
  164.                     </includes>  
  165.                 </fileSet>  
  166.                 <fileSet filtered="true" encoding="UTF-8">  
  167.                     <directory></directory>  
  168.                     <includes>  
  169.                         <include>pom.xml</include>  
  170.                     </includes>  
  171.                 </fileSet>  
  172.             </fileSets>  
  173.         </module>  
  174.     </modules>  
  175. </archetype-descriptor>  
 

工程描述定义是个xml文件，符的几个重要标签定义解释如下

1.属性变量定义 
工程定义里需要用到的属性。

如

Xml代码   收藏代码
  1. <requiredProperties>  
  2.     <requiredProperty key="appName">  
  3.         <defaultValue>helloworld</defaultValue>  
  4.     </requiredProperty>  
  5.     <requiredProperty key="groupId">  
  6.         <defaultValue>com.alibaba.china.app</defaultValue>  
  7.     </requiredProperty>  
  8.     <requiredProperty key="artifactId">  
  9.         <defaultValue>helloworld</defaultValue>  
  10.     </requiredProperty>  
  11.     <requiredProperty key="package">  
  12.         <defaultValue>com.alibaba.china.app</defaultValue>  
  13.     </requiredProperty>  
  14. </requiredProperties>  
 


这些属性可以在资源元文件里的任意一个文件里通过${var}来引用，所以的元文件最终都可以选择通过velocity引擎来执行替换后生成。
默认的属性有：groupId，artifactId，packeage，version等。如在元文件里定义pom文件可以用：
     <groupId>${groupId}</groupId>
     <artifactId>${artifactId}</artifactId>
     <packaging>pom</packaging>
     <version>${version}</version>

2.项目子模块定义 
可选，在定义多工程时才需要。如：

Xml代码   收藏代码
  1. < modules>  
  2.        < module id= "service.common" dir = "common" name= "service.common" >  
  3.         .......  
  4.       < /module>  
  5.        < module id= "service.core" dir = "core" name= "service.core" >  
  6.         .......  
  7.       < /module>  
  8.       </modules>  

 

module有三个属性，解释如下：
id     ：相当于工程的artifactId.
dir    ：相当于工程源文件在archetype-resources里对应的directory.
name   ：模块的名字.

3.项目文件集定义

fileSets/fileSet*  文件集合定义
如

Xml代码   收藏代码
  1. <fileSet filtered="true" encoding="UTF-8" packaged="true">  
  2.      <directory>src/main/java</directory>  
  3.      <includes>  
  4.           <include>**/*.java</include>  
  5.           <include>**/*.txt</include>  
  6.      </includes>  
  7. </fileSet>  
 


以上代表将archetype-resources里的src/main/java目录及内容作为新工程的目录和内容。里面的每个文件生成都会使用velocity模板引擎渲染，以替换变量。同时当packaged=true是表示会在生成这些新文件的时候，前面加上默认的包。
些属性做到可配置的变量。

 

 

总结

通过以上两部分定义之后，执行命令mvn clean install就将archetype安装到本地仓库了。

再通过如下命令：

Java代码   收藏代码
  1. mvn  archetype:generate -DarchetypeCatalog=local  

 选择你定义的工程archetype，同时通过交互输入需要的属性变量，就会默认生成好你定义的工程。

一下工程结构是我上面根据例子里定义的archetype生成的多子模块工程：


 

archtype定义工程源码见附件。

  • servicearchetype.rar (12.4 KB)
  • 下载次数: 343
  • 查看图片附件

这篇关于【maven】多子模块maven模板工程archetype创建过程的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


http://www.chinasem.cn/article/208847。

相关文章

MySQL分表自动化创建的实现方案

MySQL分表自动化创建的实现方案

《MySQL分表自动化创建的实现方案》在数据库应用场景中,随着数据量的不断增长,单表存储数据可能会面临性能瓶颈,例如查询、插入、更新等操作的效率会逐渐降低,分表是一种有效的优化策略,它将数据分散存储在... 目录一、项目目的二、实现过程（一）mysql 事件调度器结合存储过程方式1. 开启事件调度器2. 创
阅读更多...
SpringBoot项目中Maven剔除无用Jar引用的最佳实践

SpringBoot项目中Maven剔除无用Jar引用的最佳实践

《SpringBoot项目中Maven剔除无用Jar引用的最佳实践》在SpringBoot项目开发中,Maven是最常用的构建工具之一,通过Maven,我们可以轻松地管理项目所需的依赖,而,... 目录1、引言2、Maven 依赖管理的基础概念2.1 什么是 Maven 依赖2.2 Maven 的依赖传递机
阅读更多...
mysql外键创建不成功/失效如何处理

mysql外键创建不成功/失效如何处理

《mysql外键创建不成功/失效如何处理》文章介绍了在MySQL5.5.40版本中,创建带有外键约束的`stu`和`grade`表时遇到的问题,发现`grade`表的`id`字段没有随着`studen... 当前mysql版本：SELECT VERSION();结果为：5.5.40。在复习mysql外键约
阅读更多...
Window Server创建2台服务器的故障转移群集的图文教程

Window Server创建2台服务器的故障转移群集的图文教程

《WindowServer创建2台服务器的故障转移群集的图文教程》本文主要介绍了在WindowsServer系统上创建一个包含两台成员服务器的故障转移群集,文中通过图文示例介绍的非常详细,对大家的... 目录一、 准备条件二、在ServerB安装故障转移群集三、在ServerC安装故障转移群集，操作与Ser
阅读更多...
Window Server2016 AD域的创建的方法步骤

Window Server2016 AD域的创建的方法步骤

《WindowServer2016AD域的创建的方法步骤》本文主要介绍了WindowServer2016AD域的创建的方法步骤,文中通过图文介绍的非常详细,对大家的学习或者工作具有一定的参考学习价... 目录一、准备条件二、在ServerA服务器中常见AD域管理器：三、创建AD域，域地址为“test.ly”
阅读更多...
关于Maven生命周期相关命令演示

关于Maven生命周期相关命令演示

《关于Maven生命周期相关命令演示》Maven的生命周期分为Clean、Default和Site三个主要阶段,每个阶段包含多个关键步骤,如清理、编译、测试、打包等,通过执行相应的Maven命令,可以... 目录1. Maven 生命周期概述1.1 Clean Lifecycle1.2 Default Li
阅读更多...
关于Maven中pom.xml文件配置详解

关于Maven中pom.xml文件配置详解

《关于Maven中pom.xml文件配置详解》pom.xml是Maven项目的核心配置文件,它描述了项目的结构、依赖关系、构建配置等信息,通过合理配置pom.xml,可以提高项目的可维护性和构建效率... 目录1. POM文件的基本结构1.1 项目基本信息2. 项目属性2.1 引用属性3. 项目依赖4. 构
阅读更多...
SpringBoot 整合 Grizzly的过程

SpringBoot 整合 Grizzly的过程

《SpringBoot整合Grizzly的过程》Grizzly是一个高性能的、异步的、非阻塞的HTTP服务器框架,它可以与SpringBoot一起提供比传统的Tomcat或Jet... 目录为什么选择 Grizzly？Spring Boot + Grizzly 整合的优势添加依赖自定义 Grizzly 作为
阅读更多...
mysql-8.0.30压缩包版安装和配置MySQL环境过程

mysql-8.0.30压缩包版安装和配置MySQL环境过程

《mysql-8.0.30压缩包版安装和配置MySQL环境过程》该文章介绍了如何在Windows系统中下载、安装和配置MySQL数据库,包括下载地址、解压文件、创建和配置my.ini文件、设置环境变量... 目录压缩包安装配置下载配置环境变量下载和初始化总结压缩包安装配置下载下载地址：https://d
阅读更多...
Python在固定文件夹批量创建固定后缀的文件(方法详解)

Python在固定文件夹批量创建固定后缀的文件(方法详解)

《Python在固定文件夹批量创建固定后缀的文件(方法详解)》文章讲述了如何使用Python批量创建后缀为.md的文件夹,生成100个,代码中需要修改的路径、前缀和后缀名,并提供了注意事项和代码示例,... 目录1. python需求的任务2. Python代码的实现3. 代码修改的位置4. 运行结果5.
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2