maven archtype模板

maven archtype模板

背景

目前的情况下我司经常会需要有本地部署且额外写程序对接的情况，故我写了一个模板，但是我希望能够通过模板快速创建项目，并可以自定义配置，maven的Archetype很符合我的要求。

前提

假设我现在已经有了一个SpringBoot模板项目，包含了各种依赖，写好了Bean和Configuration等

生成模板

<!-- 添加maven插件 -->
 <plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-archetype-plugin</artifactId>
    <version>3.2.1</version>
</plugin>

# 在项目根目录生成模板
mvn archetype:create-from-project

可以看到在target下面生成了一个目录archetype

# 进入目录
cd target/generated-sources/archetype
# 安装到本地仓库
mvn install

install之后可以在我们的maven仓库中看到

使用模板

本地

在命令行执行
mvn archetype:generate -DarchetypeCatalog=local

打开新项目查看，可以看到pom文件的信息都是我们的刚刚配置的
说明最简单的操作已经成功了

远端

# 本质上是从仓库拉取，本地没有就找远端仓库，必要情况下可以配置仓库地址
# interactiveMode = false表示不使用交互模式
# 前4个参数指定新项目的信息
# archetype开头的3个参数指定模板的信息
 mvn archetype:generate -DgroupId=sss -DartifactId=ddd -Dversion=3 -Dpackage=fff -DarchetypeGroupId='cn.ikarosx' -DarchetypeArtifactId='ikarosx-template-archetype' -DarchetypeVersion='1.0-SNAPSHOT' -DinteractiveMode=false

配置文件

archetype插件还提供了配置文件的形式创建模板

# ./archetype.properties
# 模板配置
archetype.groupId=my.group.id
archetype.artifactId=my-archetype
archetype.version=1.0.3-SNAPSHOT

# 自定义变量
# 是否使用swagger
useSwagger=true

# 模板使用的语言
# archetype.languages have: java, groovy, csharp, aspectj.
archetype.languages=groovy

通过配置文件创建模板

mvn archetype:create-from-project 
-D'archetype.properties'=./archetype.properties

使用配置文件有几个好处

1. 配置模板信息无需手动填写
2. 可以自定义变量，实现动态模板
3. 修改一些插件提供的其他配置

通过变量动态化处理模板内容

先create-from-project后，进入archetype的文件内进行变量处理

// 如果useSwagger是true，就加入swagger的依赖
#if( $useSwagger && $useSwagger == "true" )
        <!-- swagger -->
        <dependency>
            <groupId>cn.ikarosx</groupId>
            <artifactId>commons-swagger3</artifactId>
            <version>1.0-SNAPSHOT</version>
        </dependency>
#end

处理完需要install，这部分和前面的一样

在通过模板创建项目的时候可以通过控制useSwagger变量控制是否显示内容

实际使用

落地使用时会发现这样的问题
上面的动态化处理模板会出现每次执行create-from-project都会重置文件
前面的动态化处理都会消失
这是因为每次都会清空target然后重新build，又是从源码里复制一份
导致我们写的条件判断语句是会清空的
所以正确的方式应该是把这个模板项目直接写成动态的
即将条件判断等操作直接写入源文件
可以考虑第一次先create-from-project
因为第一次会让插件自动处理我们生成的包路径之类
然后再以这个项目为基础直接改写我们需要的动态条件

总结

如果不需要动态变量那么复杂，那么直接用原本项目create-from-project即可
如果需要用到变量判断，那么直接将判断写在原项目比较好。