如何在Cucumber BDD框架中实现Maven Profiles多环境配置

一、补全pom.xml配置 #

你当前的Profile配置仅定义了基础激活规则，需要补充两处配置，打通Profile和运行时代码的参数传递：

1. 为每个Profile显式声明env属性值，避免参数传递时出现空值，调整后的profiles块如下：

<profiles>
    <profile>
        <id>dev</id>
        <activation>
            <activeByDefault>true</activeByDefault>
            <property>
                <name>env</name>
                <value>dev</value>
            </property>
        </activation>
        <properties>
            <env>dev</env>
        </properties>
    </profile>
    <profile>
        <id>stage</id>
        <activation>
            <property>
                <name>env</name>
                <value>stage</value>
            </property>
        </activation>
        <properties>
            <env>stage</env>
        </properties>
    </profile>
    <profile>
        <id>prod</id>
        <activation>
            <property>
                <name>env</name>
                <value>prod</value>
            </property>
        </activation>
        <properties>
            <env>prod</env>
        </properties>
    </profile>
</profiles>

2. 在build节点下配置maven-surefire-plugin（Cucumber测试默认通过该插件执行），将Profile对应的env变量注入为测试运行时的系统参数：

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-surefire-plugin</artifactId>
            <version>3.2.5</version>
            <configuration>
                <systemPropertyVariables>
                    <env>${env}</env>
                </systemPropertyVariables>
            </configuration>
        </plugin>
    </plugins>
</build>

配置说明：如果你的properties配置文件存放在src/test/resources目录下，不需要额外配置资源规则，Maven默认会将该目录下的文件加入测试类路径。

二、编写通用配置加载类 #

直接复用下面的PropertyReader实现，类加载时会自动识别当前激活的环境，加载对应properties文件，不需要手动调用初始化方法：

import java.io.IOException;
import java.io.InputStream;
import java.util.Properties;

public class PropertyReader {
    private static final Properties CONFIG_PROPS = new Properties();
    private static final String DEFAULT_ENV = "dev";

    static {
        // 读取运行时注入的env参数，取不到则默认加载dev环境
        String activeEnv = System.getProperty("env", DEFAULT_ENV);
        String configFile = activeEnv + ".properties";
        
        try (InputStream is = PropertyReader.class.getClassLoader().getResourceAsStream(configFile)) {
            if (is == null) {
                throw new RuntimeException("未找到对应环境配置文件：" + configFile + "，请检查文件是否放在resources根目录");
            }
            CONFIG_PROPS.load(is);
            System.out.printf("=== 当前激活环境：%s，已加载对应配置 ===%n", activeEnv);
        } catch (IOException e) {
            throw new RuntimeException("加载配置文件失败：" + configFile, e);
        }
    }

    /**
     * 读取字符串类型配置
     */
    public static String get(String key) {
        return CONFIG_PROPS.getProperty(key);
    }

    /**
     * 读取字符串类型配置，不存在时返回指定默认值
     */
    public static String get(String key, String defaultValue) {
        return CONFIG_PROPS.getProperty(key, defaultValue);
    }

    /**
     * 读取整数类型配置
     */
    public static Integer getInt(String key) {
        return Integer.parseInt(CONFIG_PROPS.getProperty(key));
    }

    /**
     * 读取布尔类型配置
     */
    public static Boolean getBool(String key) {
        return Boolean.parseBoolean(CONFIG_PROPS.getProperty(key));
    }
}

• 使用方式：在Cucumber的步骤定义、钩子类里直接调用PropertyReader.get("配置键名")即可拿到对应环境的配置值。
• 文件存放要求：将dev.properties、stage.properties、prod.properties三个文件直接放在src/test/resources根目录，不要嵌套多余文件夹，否则类加载器无法识别。

三、命令行指定环境运行方式 #

支持两种参数指定方式，效果完全一致：

• 通过Profile ID指定：使用-P参数加Profile ID，示例：
  mvn clean test -Pstage
  上述命令会激活stage环境的Profile，自动加载stage.properties配置执行测试
• 通过env参数直接指定：使用-D传入env参数，会自动匹配激活对应Profile，示例：
  mvn clean test -Denv=prod
  上述命令会激活prod环境的Profile，自动加载prod.properties配置执行测试
• 不传任何环境参数直接执行mvn clean test时，会默认激活dev环境，加载dev.properties配置。

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