构建与依赖 / 系统课时

配置多环境打包与运行

配置多环境打包与运行

这一实践把开发与生产环境的差异收敛到 Maven Profile:同一份源码通过资源过滤写入环境参数,再由打包插件生成可直接运行的 JAR。完成后,你可以用 -Pdev、-Pprod 明确选择环境,并从产物名称和运行输出双重确认没有打错包。

学习目标

  • 用 Profile 管理环境名和非敏感配置,并理解 activeByDefault 的实际行为。
  • 用资源过滤把 Profile 属性写入配置文件,再生成带 Main-Class 的可运行 JAR。
  • 分别构建并验证 dev、prod 产物,避免把密码等秘密固化进包内。

把环境差异收敛到 Profile 属性

示例使用 Java 17 和 Maven 3.9.x 的常见项目布局。准备 pom.xml、src/main/resources/application.properties、src/main/java/com/example/App.java 三个文件。开发环境默认激活;显式传入 -Pprod 后,同一 POM 中的 prod Profile 会提供另一组属性。

下面是完整 pom.xml。maven-shade-plugin 3.6.0 是真实可用版本;finalName 直接引用 Profile 中的 env.name,因此两个环境会得到不同文件名。

xml
<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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>

  <groupId>com.example</groupId>
  <artifactId>profile-demo</artifactId>
  <version>1.0.0</version>

  <properties>
    <maven.compiler.release>17</maven.compiler.release>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  </properties>

  <build>
    <finalName>profile-demo-${env.name}</finalName>
    <resources>
      <resource>
        <directory>src/main/resources</directory>
        <filtering>true</filtering>
      </resource>
    </resources>
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-shade-plugin</artifactId>
        <version>3.6.0</version>
        <executions>
          <execution>
            <phase>package</phase>
            <goals>
              <goal>shade</goal>
            </goals>
            <configuration>
              <createDependencyReducedPom>false</createDependencyReducedPom>
              <transformers>
                <transformer implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer">
                  <mainClass>com.example.App</mainClass>
                </transformer>
              </transformers>
            </configuration>
          </execution>
        </executions>
      </plugin>
    </plugins>
  </build>

  <profiles>
    <profile>
      <id>dev</id>
      <activation>
        <activeByDefault>true</activeByDefault>
      </activation>
      <properties>
        <env.name>dev</env.name>
        <service.url>http://localhost:8080/api</service.url>
      </properties>
    </profile>
    <profile>
      <id>prod</id>
      <properties>
        <env.name>prod</env.name>
        <service.url>https://api.example.com</service.url>
      </properties>
    </profile>
  </profiles>
</project>

这是配置文件 src/main/resources/application.properties。Maven 在 process-resources 阶段处理 ${...} 占位符,过滤后的文件进入 target/classes,随后被打进 JAR。

text
app.env=${env.name}
service.url=${service.url}

生效结果:dev 构建中会得到 app.env=dev,prod 构建中会得到 app.env=prod;service.url 也随 Profile 改变。

Profile 到可运行 JAR 的配置流

让应用读取过滤后的资源

主程序只读取类路径中的 application.properties,这样验证的是“打进 JAR 的最终配置”,而不是当前 Shell 临时变量。代码可直接放到 src/main/java/com/example/App.java。

java
package com.example;

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

public class App {
    public static void main(String[] args) throws IOException {
        Properties props = new Properties();

        // 从最终 JAR 的类路径读取经过 Maven 过滤的资源。
        try (InputStream in = App.class.getClassLoader()
                .getResourceAsStream("application.properties")) {
            if (in == null) {
                throw new IllegalStateException("application.properties not found");
            }
            props.load(in);
        }

        System.out.println("env=" + props.getProperty("app.env"));
        System.out.println("serviceUrl=" + props.getProperty("service.url"));
    }
}

预期结果:在 dev Profile 生成的类路径资源下运行时,程序应打印以下两行;切换 Profile 后,两行中的值应随过滤结果改变。

text
env=dev
serviceUrl=http://localhost:8080/api

先只构建开发环境,确认 POM、资源过滤和 Shade 配置能够共同完成一次完整打包。

bash
mvn -Pdev clean package

预期输出的关键结果如下;下载日志与耗时会因本机缓存和网络不同而变化。

text
[INFO] BUILD SUCCESS

连续生成并运行两个环境产物

如果要让 dev、prod 两个 JAR 同时留在 target,第二次打包不要再执行 clean。先清理并打 dev,再直接打 prod;因为 finalName 不同,第二次不会覆盖第一个环境的最终 JAR。

bash
mvn -Pdev clean package
mvn -Pprod package
java -jar target/profile-demo-dev.jar
java -jar target/profile-demo-prod.jar

预期输出的关键内容如下。两次 Maven 构建都应成功,两个 JAR 的运行结果必须分别对应自己的环境。

text
[INFO] BUILD SUCCESS
[INFO] BUILD SUCCESS
env=dev
serviceUrl=http://localhost:8080/api
env=prod
serviceUrl=https://api.example.com

如果执行 mvn package 而不写 -P,本例会使用 dev,因为它配置了 activeByDefault=true。生产流水线更稳妥的做法是始终显式执行 mvn -Pprod clean package,不要依赖默认 Profile。

检查错误配置和敏感信息

最常见的错误是让两个 Profile 同时提供互相冲突的同名属性,或把数据库密码、访问令牌直接写进 Profile,再通过过滤打入 JAR。环境名、服务地址这类非敏感值适合进入产物;秘密应由部署平台、环境变量或外部配置在运行时提供。

验证时至少检查三件事:产物名是否带正确环境后缀、应用打印出的 env 是否匹配、关键服务地址是否属于目标环境。三项中任何一项不一致,都不要发布该包,先回到有效 Profile 和过滤后的 target/classes/application.properties 定位。

按自己的节奏,确认真正理解。

目录与阅读设置

阅读设置

17

记录一个想法

配置多环境打包与运行

0 / 10000 · 笔记保存到账号。未提交的修改会在关闭、离开或刷新后丢失。

登录哪都通