如何使用自定义Maven原型自动创建文本文件并配置archetype-metadata.xml

我来一步步帮你搞定这两个问题，都是Maven Archetype开发里的核心配置点～

一、自动创建文本文件的完整流程 #

要让原型自动生成带变量替换的文本文件，核心是开启文件过滤+配置文件路径，步骤如下：

1. 准备原型的模板文件
   在你的原型项目里，找到src/main/resources/archetype-resources目录（如果没有就新建），然后按照目标项目的目录结构创建文件。比如你想在生成的项目的src/main/resources下有个greeting.txt，那就在原型里建src/main/resources/archetype-resources/src/main/resources/greeting.txt，文件内容可以用${属性名}做占位符，比如：

   Hello ${username}! Welcome to ${appName}
   

2. 配置archetype-metadata.xml的fileSet
   在原型的src/main/resources/META-INF/maven/archetype-metadata.xml里，添加你提供的fileSet配置，关键要开启filtered="true"——这个开关会让Maven自动替换文件里的${...}占位符：

   <fileSet filtered="true">
     <directory>src/main/resources</directory>
     <includes>
       <include>*.txt</include>
       <include>*.properties</include>
     </includes>
     <excludes>
       <exclude>**/*.xml</exclude>
     </excludes>
   </fileSet>
   

   这里的directory是相对于archetype-resources的路径，对应生成项目里的目录；includes指定要处理的文件类型，excludes排除不需要替换的文件。

3. 安装原型到本地仓库
   在原型项目根目录执行命令：

   mvn clean install archetype:update-local-catalog
   

   这样本地Maven仓库就会注册这个原型，方便后续生成项目。

4. 用原型生成新项目
   执行生成命令（替换成你的原型坐标）：

   mvn archetype:generate -DarchetypeGroupId=com.yourcompany -DarchetypeArtifactId=your-archetype -DarchetypeVersion=1.0-SNAPSHOT
   

   这时Maven会提示你输入属性值，输入后生成的greeting.txt就会自动替换占位符啦～

二、配置requiredProperties和文件的键值映射 #

你提供的requiredProperties片段里的??需要替换成你要定义的属性键名，这些键名就是你在文本文件里用的${键名}的来源，具体配置如下：

1. 定义必填属性 #

在archetype-metadata.xml里的requiredProperties节点中，添加你需要用户输入的属性键，还可以设置默认值（可选）：

<requiredProperties>
  <requiredProperty key="username" /> <!-- 必填，无默认值 -->
  <requiredProperty key="appName" defaultValue="MyAwesomeApp" /> <!-- 可选，有默认值 -->
</requiredProperties>

• key就是你要在文本文件中使用的变量名，比如${username}
• 添加defaultValue后，用户如果不输入该属性，就会用默认值填充

2. 关联fileSet和属性 #

只要你开启了fileSet的filtered="true"，Maven就会自动把requiredProperties里的键值，替换到对应目录下的文件占位符里。比如之前的greeting.txt里的${username}就会被用户输入的值替换，${appName}如果用户没输入就用默认的MyAwesomeApp。

注意事项 #

• 确保archetype-metadata.xml放在src/main/resources/META-INF/maven/目录下，这是Maven Archetype的约定路径，否则配置不会生效。
• 如果不需要过滤某个文件或目录，把filtered设为false即可。

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