IDEA使用Maven-archetype构建模板工程

发表于 |

IDEA使用Maven-archetype构建模板工程

官方文档参考

官方文档

创建maven工程

如上图首先创建一个maven工程，然后开始进行工程配置，在resources目录下增加archetype-resources,用于放模板工程的相关资源,此外还要增加一个描述模板内容的xml文件archetype-metadata.xml，放在resources/META-INF/maven目录中，如下图所示。

配置模板工程

构建自己的模板工程结构：

archetype 默认提供 artifactId,groupId,version,package属性用于用户参数化模板中的值：例如模板工程的pom文件:

archetype-metadata.xml 配置

<fileSet filtered="true" encoding="UTF-8" packaged="true">
  <directory>src/main/java</directory>
  <includes>
    <include>**/*.**</include>
  </includes>
</fileSet>

<requiredProperties>
    <requiredProperty key="testKey">
    </requiredProperty>
</requiredProperties>

filtered=true时,模板开启参数替换功能，将src/main/java目录下满足include通配的所有文件中${key}替换为用户所设置的值。

packaged=”true”时，在src/main/java文件夹下创建${package}结构的目录，同时将include的所有文件放置${packag}下。

用户可使用requiredProperties自定义属性。

注意：工程模板建立空文件夹时，通过模板创建的工程会删除该文件夹，需特殊处理。

发布，并使用其创建工程

在模板工程所在maven工程进行mvn clean install 发布

如下图，创建新工程时，勾选create from archetype，并使用 add archetype 输入自己创建的模板工程groupId等信息，并选择自己的模板工程进行创建

如有自定义参数可在如下页面进行添加：

同样可以使用mvn archetype:generate 来创建新工程。

简单模板工程创建

如果模板工程简单，同样可以使用 mvn archetype:create-from-project 命令来通过maven工程创建模板，运行后进入 target/generated-sources/archetype 目录，运行mvn install 即可。

注意：使用此工程创建的模板,增加archetype时artifactId的值为原maven工程artifactId-archetype，例如：原工程artifactId为abc,现工程为abc-archetype

删除archetype

由于idea只提供了增加archetype的界面，没有删除功能，如果需要删除则要到.IntelliJIdea2018.1\system\Maven\Indices\UserArchetypes.xml 文件内删除自定义信息