如何在Maven插件中通过属性文件注入参数默认值？

核心思路 #

将默认值存放在插件自身的属性文件中，在插件初始化阶段加载这些值，为未被用户配置的参数自动赋值，无需在pom.xml中定义全局变量。

具体实现步骤 #

1. 创建默认属性文件
   在插件项目的src/main/resources目录下新建属性文件（比如plugin-defaults.properties），写入参数默认值：

param1Name=param1Value
param2Name=42

2. 在Mojo类中加载属性文件并设置默认值
   利用@PostConstruct注解在Mojo初始化时加载属性文件，然后为未配置的参数赋值：

import org.apache.maven.plugin.AbstractMojo;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugin.MojoFailureException;
import org.apache.maven.plugins.annotations.Mojo;
import org.apache.maven.plugins.annotations.Parameter;

import javax.annotation.PostConstruct;
import java.io.IOException;
import java.io.InputStream;
import java.util.Properties;

@Mojo(name = "your-plugin-goal")
public class YourPluginMojo extends AbstractMojo {

    @Parameter(name = "param1Name")
    private String param1;

    @Parameter(name = "param2Name")
    private Integer param2;

    private Properties defaultProps;

    @PostConstruct
    public void loadDefaultValues() throws IOException {
        defaultProps = new Properties();
        // 加载插件内置的属性文件
        try (InputStream is = getClass().getResourceAsStream("/plugin-defaults.properties")) {
            if (is != null) {
                defaultProps.load(is);
            } else {
                getLog().warn("未找到默认属性文件plugin-defaults.properties");
            }
        }

        // 为未配置的参数赋值默认值
        if (param1 == null) {
            param1 = defaultProps.getProperty("param1Name");
        }
        if (param2 == null) {
            String param2Str = defaultProps.getProperty("param2Name");
            if (param2Str != null) {
                try {
                    param2 = Integer.parseInt(param2Str);
                } catch (NumberFormatException e) {
                    getLog().error("默认参数param2Name不是有效的整数", e);
                    throw new IOException("无效的默认参数值", e);
                }
            }
        }
    }

    @Override
    public void execute() throws MojoExecutionException, MojoFailureException {
        // 插件业务逻辑
        getLog().info("param1: " + param1);
        getLog().info("param2: " + param2);
    }
}

3. 确保属性文件被打包进插件JAR
   Maven默认会将src/main/resources下的文件打包到JAR中，无需额外配置。如果有特殊需求，可以在插件的pom.xml中添加resources配置：

<build>
    <resources>
        <resource>
            <directory>src/main/resources</directory>
            <includes>
                <include>plugin-defaults.properties</include>
            </includes>
        </resource>
    </resources>
</build>

优势说明 #

• 默认值集中管理，便于维护和修改
• 用户仍可通过pom.xml配置参数覆盖默认值
• 无需在pom.xml中定义全局变量，避免污染项目配置

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