Maven Archetype 多 Module 自定义代码脚手架
大部分公司都会有一个通用的模板项目,帮助你快速创建一个项目。通常,这个项目需要集成一些公司内部的中间件、单元测试、标准的代码格式、通用的代码分层等等。
今天,就利用 Maven 的 Archetype 插件来简单实现这一功能。
通过上面的图很清楚可以看到,实际利用这个插件机制就简单的几个步骤:
- archetype:create-from-project ,根据自己的项目代码生成原型项目
- 通过 install 等命令生成原型文件
- archetype:generate,通过原型生成目标项目
看起来挺简单的,但是你会发现你用网上搜到的资料来玩的话,你生成的项目特别傻X,包括官方的文档,我也真是没搞明白他们为何那么牛逼,一步两步。。就他妈好了?
一堆问题,比如 module 名称不会变、包名变了代码中没变,依赖报错一大堆问题,还是有必要说下中间要怎么做的。
创建Archetype
首先,准备好我们自己的模板项目,保证代码都是OK的。
进入项目根目录,执行命令:
mvn archetype:create-from-project
然后项目根目录下会生成target
文件夹,这个很简单,不会有任何障碍,你看下面的图,注意看每个模块的名字,这是我改过的!!
你生成应该会发现他不长这样,这就是问题啊!接着往下看吧。
这里最核心的部分就在于怎么修改target/generated-sources/src/main/resources/archetype-resources
下的文件。
如果不修改直接继续的话,最终生成的项目会发现module的名称不会变,包名也不会变,代码里引用的会有一堆报错。
接着,我们看看咋改的,这一堆破问题。
修改父pom
首先,找到根目录的pom
文件,会发现缺少module信息,这个必须加上。
<modules>
<module>${rootArtifactId}-client</module>
<module>${rootArtifactId}-common</module>
<module>${rootArtifactId}-service</module>
<module>${rootArtifactId}-facade</module>
<module>${rootArtifactId}-starter</module>
</modules>
父pom依赖引用的每个module也要修改,groupId 和 artifactId 按照我给出的方式来改,不要写死!!
<dependencyManagement>
<dependencies>
<dependency>
<groupId>${groupId}</groupId>
<artifactId>${rootArtifactId}-client</artifactId>
<version>${project.version}</version>
</dependency>
... ...
</dependencies>
</dependencyManagement>
修改module
这个就是图中的问题,默认生成的module可能就是模板项目的名字,需要修改成类似__rootArtifactId__-client
这种形式,注意是双下划线。
然后module中的互相引用 groupId 和 artifactId 按照父 pom 的方式对应修改。
archetype-metadata 修改
找到META-INF/maven/archetype-metadata.xml
文件,修改modules相关的部分,重点注意看 id 、dir、name 的修改方式。
<modules>
<module id="${rootArtifactId}-client" dir="__rootArtifactId__-client" name="${rootArtifactId}-client">
<fileSets>
<fileSet filtered="true" packaged="true" encoding="UTF-8">
<directory>src/main/java</directory>
<includes>
<include>**/*.java</include>
</includes>
</fileSet>
</fileSets>
</module>
... ...
</modules>
修改完成之后,进入 target/generated-sources/archetype
目录,执行命令:
mvn install
顺便执行下mvn deploy
上传到nexus。
使用Archetype
经过上面的步骤,原型 Archetype 已经创建完成,其实最大的坑也就是上面那部分,花了老半天时间,简直坑爹啊。
下面看看怎么使用吧,两种使用方式。
命令行
随便进入你想保存项目的路径,执行命令。
mvn archetype:generate -DarchetypeCatalog=local
依次按照提示输入 groupId、artifactId 即可完成创建。
那怎么给其他人使用?
你的本地maven仓库目录(比如~/.m2/repository)有一个文件archetype-catalog.xml
,共享给其他人就行了。
<?xml version="1.0" encoding="UTF-8"?>
<archetype-catalog xsi:schemaLocation="http://maven.apache.org/plugins/maven-archetype-plugin/archetype-catalog/1.0.0 http://maven.apache.org/xsd/archetype-catalog-1.0.0.xsd"
xmlns="http://maven.apache.org/plugins/maven-archetype-plugin/archetype-catalog/1.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<archetypes>
<archetype>
<groupId>com.example</groupId>
<artifactId>template-archetype</artifactId>
<version>1.0.0-SNAPSHOT</version>
<description>Example Project</description>
</archetype>
</archetypes>
</archetype-catalog>
IDEA
新建项目,选择 Maven,勾选 Create from archetype,选择 Add Archetype...
接着,输入我们自定义的 Archetype 的 GroupId、ArtifactId、Version 信息。
Add 成功之后就可以在列表中看到我们自己的 archetype,然后按照流程创建即可。
Maven Archetype 多 Module 自定义代码脚手架的更多相关文章
- maven archetype生成自定义项目原型(模板)
maven archetype可以将一个项目做成项目原型,之后只需要以此原型来创建项目,那么初始创建的项目便具有原型项目中的一切配置和代码.通俗讲就是一个项目模板. eclipse中那些快速生成mav ...
- 自定义项目脚手架- Maven Archetypes
在上篇Intellij修改archetype Plugin配置 中我们已经简单介绍了关于archetype的作用. 简单来说maven archetype插件就是创建项目的脚手架,你可以通过命令行或者 ...
- 自定义Maven Archetype模板
1. 目的 自定义Maven Archetype模板目的为了把自己辛苦搭建的基础项目可以作为模板, 方便以后可以快速的创建类似项目,免去每次搭建的麻烦 2.把基础项目打包生成archetype项目 在 ...
- 老大说新项目的结构和 xxx 项目一样就可以了,我 ……(使用 Maven Archetype 快速创建项目)
前言 又要开发新项目了,还是创建新项目,怎么办?老大说按照 xxx 项目的结构创建一个新项目就可以了. 公众号:liuzhihangs,记录工作学习中的技术.开发及源码笔记:时不时分享一些生活中的见闻 ...
- 创建并使用maven archetype的随笔
maven骨架archetype的意义在于一些项目的基础项:如引入的maven组件,例如eureka,ribben等,不希望每次新建项目都重复做一遍,还有例如公司规范的log格式,单元测试工具等,在新 ...
- 使用mavan构建自定义项目脚手架
首先抛出一个问题是为什么要构建自定义的脚手架,maven已经为了我么提供了很多脚手架,方便我们快速的创建一个普通java项目或者是web项目,然而在实际开发中,例如银行项目,大部分都是ssm架构,我们 ...
- maven archetype二三事
maven plugin 创建maven archetype 骨架的plugin是 <plugin> <groupId>org.apache.maven.plugins< ...
- Maven-003-私人定制 maven archetype
在使用 Maven 创建项目模块的时候,依据其默认的 archetype 模板,创建出的目录.及默认的单元测试工具为 JUnit 3.8.1,而且有些常用的资源文件目录.配置文件(例如:Log4J 的 ...
- Maven Archetype简介以及搭建
为什么会写这篇文章,因为公司先在构建项目骨架都是用的 maven archetype ,身为一个上进的渣渣猿,自己还是有必要了解下这个东西的. Archetype介绍 Archetype 是一个 Ma ...
随机推荐
- 阿里面试题: (a,b,c)组合索引, 查询语句select...from...where a=.. and c=..走索引吗?
面试官:(a,b,c)组合索引,查询语句select...from...where a=.. and c=..走索引吗应聘者: 最佳左前缀法,如果索引了多列,要遵守最左前缀法则,否则索引失效 按最左前 ...
- 万字长文入门 Redis 命令、事务、锁、订阅、性能测试
作者:痴者工良 Redis 基本数据类型 Redis 中,常用的数据类型有以下几种: String:字符串类型,二进制安全字符串: Hash:哈希表: List 列表:链表结构,按照插入顺序排序的字符 ...
- 复杂SQL案例:用户退款信息查询
供参考: select t3.course_id 课程id, t3.user_id 用户ID, u.user_full_name 姓名, -- u.phone, concat(u.company,' ...
- velocity使用foreach进行遍历时$velocityCount不起作用
把$velocityCount替换成$foreach.count 例如 #if($foreach.count != $columns.size()),#end
- centos使用docker安装redis ,并设置外网访问
拉取镜像 docker pull redis:4.0 在主机/data/redis/conf目录下新建redis.conf文件vim /data/redis/conf/redis.conf # Red ...
- windows系统中远程登录ubuntu18服务器的桌面
下载:http://www.c-nergy.be/products.html 也可以直接服务器里 wget https://www.c-nergy.be/downloads/xRDP/xrdp-ins ...
- JAVA直接连接Redis
引入maven <dependency> <groupId>redis.clients</groupId> <artifactId>jedis</ ...
- TensorFlow.NET机器学习入门【7】采用卷积神经网络(CNN)处理Fashion-MNIST
本文将介绍如何采用卷积神经网络(CNN)来处理Fashion-MNIST数据集. 程序流程如下: 1.准备样本数据 2.构建卷积神经网络模型 3.网络学习(训练) 4.消费.测试 除了网络模型的构建, ...
- 什么是UE模型?
书接上文:不知怎么选,用RFM模型看舔狗质量! 这里要注意一个问题,我这里是因为内部信息敏感,才抽象成舔狗,大家不要以为我真的在说舔狗...... UE模型即Unit Economics,是指单体经济 ...
- python+openpyxl 获取最大行数,不是真正想获取的行数,导致替换时,报”NoneType' object has no attribute 'find'
问题描述: 使用excel对接口的数据进行管理,添加接口数据时,可能习惯性选择多行,设置了格式,导致多选了很多空行也被设置了格式,在读取这个sheet的最大行数时,发现有问题,获取到了为None的空行 ...