如何创建含自定义参数的Maven Archetype？解决参数传递失效问题

刚好我之前折腾过这个场景，给你一步步捋清楚怎么搞定自定义参数传递和模板文件的变量替换：

1. 先在Archetype的pom.xml里定义自定义属性（可选但推荐） #

在你的Archetype项目的pom.xml中，给自定义参数设置默认值，这样用户不传参数时也能有兜底值：

<properties>
  <param1>defaultValueForParam1</param1>
  <!-- 可以加更多自定义参数，比如param2之类的 -->
</properties>

2. 配置archetype-metadata.xml（核心步骤） #

这个文件是Archetype的配置核心，放在src/main/resources/META-INF/maven/目录下。你需要做两件事：注册自定义参数，以及配置需要替换变量的文件集合。

2.1 注册自定义参数 #

如果你的参数是必填项，就加到requiredProperties里；如果是可选的，就放在外层的properties标签中：

<?xml version="1.0" encoding="UTF-8"?>
<archetype-descriptor name="basic">
  <requiredProperties>
    <requiredProperty key="groupId"/>
    <requiredProperty key="artifactId"/>
    <requiredProperty key="version"/>
    <!-- 把自定义必填参数加在这里 -->
    <requiredProperty key="param1"/>
  </requiredProperties>

  <!-- 可选参数的话，用这个标签，还能设置默认值 -->
  <!--
  <properties>
    <property key="param2" defaultValue="defaultParam2"/>
  </properties>
  -->

2.2 配置需要替换变量的文件集合 #

要确保你的模板文件（比如pom.xml、src/main/someFile.txt）被Maven的资源过滤机制处理，也就是开启filtered="true"：

<fileSets>
    <!-- 处理根目录下的pom.xml -->
    <fileSet filtered="true" encoding="UTF-8">
      <directory>.</directory>
      <includes>
        <include>pom.xml</include>
      </includes>
    </fileSet>

    <!-- 处理src/main下的txt文件（可以根据需要调整路径和文件类型） -->
    <fileSet filtered="true" encoding="UTF-8">
      <directory>src/main</directory>
      <includes>
        <include>**/*.txt</include>
      </includes>
    </fileSet>
  </fileSets>
</archetype-descriptor>

3. 在模板文件中使用自定义参数占位符 #

在Archetype的模板目录（src/main/resources/archetype-resources/）下的文件里，用${param1}这样的占位符引用自定义参数：

3.1 模板pom.xml示例 #

<?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>${groupId}</groupId>
  <artifactId>${artifactId}</artifactId>
  <version>${version}</version>

  <!-- 把自定义参数放到生成项目的pom属性里 -->
  <properties>
    <custom.param>${param1}</custom.param>
  </properties>
</project>

3.2 src/main/someFile.txt示例 #

This is a custom parameter value passed from archetype: ${param1}

4. 安装Archetype到本地仓库 #

执行下面的命令，把你的Archetype安装到本地Maven仓库，这样才能用archetype:generate调用它：

mvn clean install

5. 测试自定义参数传递 #

现在执行生成命令，带上你的自定义参数：

mvn archetype:generate \
  -DarchetypeGroupId=你的Archetype的groupId \
  -DarchetypeArtifactId=你的Archetype的artifactId \
  -DarchetypeVersion=你的Archetype的版本 \
  -DgroupId=com.example \
  -DartifactId=demo-project \
  -Dversion=1.0.0-SNAPSHOT \
  -Dparam1=myCustomValue123

生成项目后，你可以检查：

• 生成的pom.xml里的custom.param是不是myCustomValue123
• src/main/someFile.txt里的内容是不是替换成了对应的参数值

常见坑提醒 #

• 确保archetype-metadata.xml的路径完全正确，必须在src/main/resources/META-INF/maven/下
• 所有需要替换变量的文件，一定要在fileSets里配置filtered="true"，否则Maven不会替换占位符
• 如果参数没生效，试试清理本地Maven仓库的Archetype缓存，重新安装一遍

内容的提问来源于stack exchange，提问作者ikos23