Maven实战: 创建自定义archetype

在手动创建SpringBoot应用中，我们讲过手动创建SpringBoot工程是比较麻烦的，尤其是公司内部不有自定义扩展和集成的情况下。利用Maven的archetype:generate能基于项目模板生成功能，自定义模板能让整个创建过程自动化，这样既能大大降低创建和集成SpringBoot的复杂度，还能做到公司内部的标准化。要自定义archetype，需要做7个步骤:

  1. 创建archetype的工程
  2. 定义archetype的pom，方便在mvn archetype:generate时引用当前模板
  3. 定义archetype的描述文件，配置哪些属性/文件/模块应该包含在生成的项目内，位于 src/main/resources/META-INF/maven/archetype-metadata.xml
  4. 定义原型的pom，编辑后作为新生成项目的pom，位于 src/main/resources/archetype-resources/pom.xml
  5. 定义原型的文件，编辑后作为新生成项目的内容，位于 src/main/resources/archetype-resources/
  6. 安装archetype到仓库，供后续生成项目时使用
  7. 使用自定义archetype生成项目

1. 创建工程

其实archetype也是普通的Maven工程，可以通过maven-archetype-quickstart能生成一个简单的Maven项目，我们将它命名为DiveInSpringArchetype

mvn archetype:generate -DarchetypeGroupId=org.apache.maven.archetypes -DarchetypeArtifactId=maven-archetype-quickstart -DarchetypeVersion=1.4 -DgroupId=com.keyniu.dis -DartifactId=DiveInSpringArchetype -Dversion=0.1 -Dpackage=com.keyniu.dis -DinteractiveMode=false

这和我们之前创建的项目完全一样，整个目录树看起来是这样的

2. 定义archetype的pom

在DiveInSpringArchetype根目录下已经生成了pom.xml文件，我们修改一下pom.xml的内容，只保留GAV信息，添加archetype-packaging扩展

<?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.keyniu.dis</groupId><artifactId>DiveInSpringArchetype</artifactId><version>0.1</version><build><extensions><extension><groupId>org.apache.maven.archetype</groupId><artifactId>archetype-packaging</artifactId><version>3.1.1</version></extension></extensions></build>
</project>

3. 定义archetype的描述文件

接着来定义archetype-metadata.xml，这个文件存放在src/main/resources/META-INF/maven/archetype-metadata.xml，重点关注下面3个点

  1. archetype-descriptor.name，值必须和artifactId相同
  2. requiredProperty，在archetype:generate时，由用户输入，可以在工程内部引用，通过filtered=true，替换引用的变量
  3. fileSet，设置那些文件包含在生成的工程中，为了后续验证，可以在src/main/java、srce/main/resources创建一个模板文件
<?xml version="1.0" encoding="UTF-8"?><archetype-descriptor name="DiveInSpringArchetype"><requiredProperties><requiredProperty key="env"><defaultValue>prod</defaultValue></requiredProperty></requiredProperties><fileSets><fileSet filtered="true" packaged="true" encoding="UTF-8"><directory>src/main/java</directory><includes><include>**/*.java</include></includes></fileSet><fileSet filtered="true" encoding="UTF-8"><directory>src/main/resources</directory><includes><include>**/*.xml</include><include>**/*.factories</include><include>**/*.yaml</include><include>**/*.yml</include><include>**/*.properties</include></includes></fileSet></fileSets></archetype-descriptor>

4. 定义原型的pom

接着要创建src/main/resources/archetype-resources目录下，预定义要放入目标工程的内容，首先是放在原型的pom.xml文件，pom.xml能引用环境变量，包括执行archetype:generate时传入的GAV信息

<?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 https://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>${artifactId}</name><dependencies><dependency><groupId>junit</groupId><artifactId>junit</artifactId><version>4.12</version><scope>test</scope></dependency></dependencies>
</project>

5. 定义原型的文件

src/main/resources/archetype-resources除了能定义pom.xml，还可以放正常工程的文件，比如src/main/resources/archetype-resources/src/main/java里我们可以放AppConfig.java类，内容如下

package ${package};@ApplicationPath("${env}")
public class AppConfig extends Application {
}

这里的package ${package}；根据调用mvn archetype:generate -Dpackage=xxx的值将AppConfig.java放到指定的包中。除此以外，我们还在src/main/resources/archetype-resources/src/main/resources中定义了一个application.properties文件，最终整个工程的结构是下面这样的。

6. 安装archetype到仓库

到这一步archetype创建完成了，现在可以将这个自定义archetype安装到本地仓库

mvn clean package install

7. 使用自定义archetype

现在一切准备就绪了，是时候用自定义archetype来创建工程了，通过执行命令

mvn archetype:generate -DarchetypeGroupId=com.keyniu.dis -DarchetypeArtifactId=DiveInSpringArchetype -DarchetypeVersion=0.1-DgroupId=com.keyniu.generate.example -DartifactId=GenExa -Dversion=0.1 -Dpackage=com.keyniu.gen.exa -DinteractiveMode=false

执行成功后整个GenExa工程的结构如下，AppConfig.java会正确的放入到对于的包中。

通过这一整套的流程，我们能做到的是创建任意格式的模板，可以在pom.xml、代码、配置中预定义所有的集成。不过用它的创建一个完整工程的模板还是有点麻烦的，我们编辑archetype-resources目录，而这个目录是没有包结构，不支持IDE错误提示的。mvn提供了一个命令来支持这种场景，这个我们在下一篇讲解。

A. 参考资料

  • Maven Archetype Plugin – Create an archetype from a multi-module project
  • Maven – Guide to Creating Archetypes

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.mzph.cn/diannao/22331.shtml

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈email:809451989@qq.com，一经查实，立即删除！

相关文章

【UML用户指南】-07-对基本结构建模-公共机制

【UML用户指南】-07-对基本结构建模-公共机制

目录 1、术语和概念 1.1、注解&#xff08;note&#xff09; 1.2、修饰 1.3、衍型 1.4、标记值 1.5、约束 1.6、标准元素 1.7、外廓&#xff08;profile&#xff09; 2、对新特性建模 3、对新语义建模 注解 &#xff08;note&#xff09;是附加在元素或元素集上用来表…
阅读更多...
ICLR24大模型提示(2/11) | BatchPrompt：多样本批量提示事半功倍

ICLR24大模型提示(2/11) | BatchPrompt：多样本批量提示事半功倍

【摘要】由于大型语言模型 (LLM) 的 token 限制不断增加&#xff0c;使得长上下文成为输入&#xff0c;使用单个数据样本进行提示可能不再是一种有效的方式。提高效率的一个直接策略是在 token 限制内对数据进行批处理&#xff08;例如&#xff0c;gpt-3.5-turbo 为 8k&#xf…
阅读更多...
Python08 循环

Python08 循环

循环1. while2. for循环控制1.back 退出当前循环2.continue 结束本次继续下次循环 i 0 while i < 10:print(f我正在学习python {i})i1 #循环增量 print(while 结束)while True:print(f我正在学习python {i})if i > 20:break #退出循环i1 #循环增量 print(while2 结束)# …
阅读更多...
如何管理和维护组件库？

如何管理和维护组件库？

管理和维护组件库是一个关键的任务&#xff0c;因为它直接关系到产品的稳定性和功能的实现。以下是一些有效的方法来管理和维护组件库&#xff1a; 创建清晰的命名和文件结构&#xff1a;为每个组件分配一个有意义的名称&#xff0c;并根据功能和类型进行有层次的分类。确保文件…
阅读更多...
【Python机器学习】无监督学习——不同类型的预处理

【Python机器学习】无监督学习——不同类型的预处理

之前学习过&#xff0c;一些算法&#xff08;比如神经网络和SVM&#xff09;对数据缩放非常敏感。因此&#xff0c;通常的做法是对特征进行调节&#xff0c;使数据更适合于这些算法。通常来说&#xff0c;这是对数据的一种简单的按照特征的缩放和移动。举例&#xff1a; impor…
阅读更多...
js图片跟随鼠标移动效果

js图片跟随鼠标移动效果

js原生代码 要实现图片跟随鼠标移动的效果&#xff0c;可以使用JavaScript原生的mousemove事件以及CSS的transform属性。 HTML代码&#xff1a; <div id"container"><img id"image" src"path_to_image.jpg" alt"Image">…
阅读更多...
【python】成功解决“ModuleNotFoundError: No module named ‘graphviz’”错误的全面指南

【python】成功解决“ModuleNotFoundError: No module named ‘graphviz’”错误的全面指南

成功解决“ModuleNotFoundError: No module named ‘graphviz’”错误的全面指南 一、引言 在Python编程中&#xff0c;当尝试导入一个不存在的模块时&#xff0c;你会遇到ModuleNotFoundError错误。当你看到“ModuleNotFoundError: No module named ‘graphviz’”这样的错…
阅读更多...
vue无需引入第三方， 将web页面内容直接下载为docx

vue无需引入第三方， 将web页面内容直接下载为docx

vue无需引入第三方&#xff0c; 将web页面内容直接下载为docx 将web页面内容重绘 html &#xff0c;通过 a 标签直接下载 通过写行内样式&#xff0c;控制docx中的文字图效果 let echHtmlWithIf ;if (this.chartImg.length) {if (this.exceed10Min) {echHtmlWithIf <div…
阅读更多...
Linux线程安全：线程互斥

Linux线程安全：线程互斥

一、线程互斥的概念 1.1临界资源与互斥的关系 临界资源&#xff1a;多线程执行流共享的资源就叫做临界资源。 临界区&#xff1a;每个线程内部&#xff0c;访问临界资源的代码&#xff0c;就叫做临界区。 互斥&#xff1a;任何时刻&#xff0c;互斥保证有且只有一个执行流进入…
阅读更多...
《数字图像处理-OpenCV/Python》第15章：图像分割

《数字图像处理-OpenCV/Python》第15章：图像分割

《数字图像处理-OpenCV/Python》第15章&#xff1a;图像分割 本书京东 优惠购书链接 https://item.jd.com/14098452.html 本书CSDN 独家连载专栏 https://blog.csdn.net/youcans/category_12418787.html 第15章&#xff1a;图像分割 图像分割是由图像处理到图像分析的关键步骤…
阅读更多...
对 SQL 说“不”~

对 SQL 说“不”~

开发人员注意&#xff01; 您在当前的应用程序架构中是否面临这些问题&#xff1f; 对 SQL 数据库的高吞吐量。SQL 数据库中的瓶颈。 内存数据存储将是解决问题的方案。Redis 是市场上最受欢迎的内存数据存储和缓存选项。Redis 拥有广泛的生态系统&#xff0c;因为主要科技巨…
阅读更多...
Vue3视图渲染技术

Vue3视图渲染技术

1. 模版语言 Vue 使用一种基于 HTML 的模板语法&#xff0c;使我们能够声明式地将其组件实例的数据绑定到呈现的 DOM 上。所有的 Vue 模板都是语法层面合法的 HTML&#xff0c;可以被符合规范的浏览器和 HTML 解析器解析。在底层机制中&#xff0c;Vue 会将模板编译成高度优化…
阅读更多...
54.WEB渗透测试-信息收集- 端口、目录扫描、源码泄露（2）

54.WEB渗透测试-信息收集- 端口、目录扫描、源码泄露（2）

免责声明&#xff1a;内容仅供学习参考&#xff0c;请合法利用知识&#xff0c;禁止进行违法犯罪活动&#xff01; 内容参考于&#xff1a; 易锦网校会员专享课 上一个内容&#xff1a;53.WEB渗透测试-信息收集-端口、目录扫描、源码泄露&#xff08;1&#xff09; 关于源码…
阅读更多...
TypeScript 在前端开发中的应用

TypeScript 在前端开发中的应用

TypeScript 在前端开发中的应用非常广泛。以下是一些常见的应用场景&#xff1a; 类型检查&#xff1a;TypeScript 是 JavaScript 的超集&#xff0c;它引入了静态类型检查。在开发过程中&#xff0c;TypeScript 编译器可以帮助开发者捕捉潜在的类型错误&#xff0c;提前发现并…
阅读更多...
Nginx作为下载站点

Nginx作为下载站点

grep -Ev ^$|# /usr/local/nginx/conf/nginx.conf > /opt/nginx.txt cat /opt/nginx.txt > /usr/local/nginx/conf/nginx.conf用上面的指令提取最小化的配置文件 vim /usr/local/nginx/conf/nginx.conf [rootlocalhost ~]# cat /usr/local/nginx/conf/nginx.conf worker…
阅读更多...
uniapp+vue3+ts+百度人脸检测

uniapp+vue3+ts+百度人脸检测

百度人脸检测&#xff1a;https://console.bce.baidu.com/ai/?fromai1#/ai/face/overview/index 免费资源包用完需要付费。 1、百度开通人脸检测 创建应用&#xff1a;https://console.bce.baidu.com/ai/?fromai1#/ai/face/app/list 新建组->新建用户 实名认证->领…
阅读更多...
Vue 的响应式系统原理

Vue 的响应式系统原理

Vue 的响应式系统是其核心功能之一,它允许数据模型发生变化时自动更新视图。这个机制使得 Vue 能够高效地跟踪依赖关系,并在数据发生变化时仅更新必要的部分,而不是全局重新渲染。 Vue 的响应式系统原理主要包括以下几个方面: 1&#xff1a;数据观测: Vue 使用 Object.define…
阅读更多...
JS百题斩~秒懂数据的作用域（超详细）

JS百题斩~秒懂数据的作用域（超详细）

数据的作用域 定义&#xff1a;作用域是运行时代码中的变量&#xff0c;函数和对象的可访问性。通俗的意思就是数据在哪个范围是有效可用的&#xff0c;出了这个范围就不能用了。 作用域在哪&#xff0c;关键看在哪里定义的。 ES6之前没有块级作用域。 1.JS有两种作用域&…
阅读更多...
解决linux系统求前N月月份的bug

解决linux系统求前N月月份的bug

日常工作中&#xff0c;需要获取某个日期&#xff08;20240531&#xff09;的前N个月&#xff0c;通常会写命令 date -d "20240531 last-month" %Y%m 我期望得到202404 但是很意外&#xff1a; 经过几轮测试&#xff0c;发现只要月内天数超过30天&#xff0c;即所有…
阅读更多...
短视频动画脚本：成都鼎茂宏升文化传媒公司

短视频动画脚本：成都鼎茂宏升文化传媒公司

短视频动画脚本&#xff1a;创作与魅力的探索 在数字化时代的浪潮中&#xff0c;短视频动画以其独特的魅力迅速崛起&#xff0c;成为大众娱乐和信息传播的重要载体。成都鼎茂宏升文化传媒公司作为一名原创文章编辑&#xff0c;我深入探索了短视频动画脚本的创作过程&#xff0…
阅读更多...
最新文章

Copyright @ 2022~2023