Maven 环境配置[黑魔法]

Question

又遇到黑魔法bug了，以前可以运行，没改动过就不行了。

开发一套系统，配置了两个环境，DEV和PRO
利用 jenkins 自动部署，配置文件：


SERVER1
<!-- 默认激活本环境 -->

true

env
SERVER1



........

    <profile>
        <id>SERVER2</id>
        <build>
        .......
        </build>
                </profile>

</profiles>

在本地运行的时候 clean install -PSERVER2  无法改变配置，总是运行默认的SERVER1

之后试着去掉：SERVER1 中
    <activation>
            <activeByDefault>true</activeByDefault>
            <property> 
              <name>env</name> 
              <value>SERVER1</value> 
          </property> 
        </activation>

        clean install -PSERVER2 正常运行。

        有没有人遇到过，不知原因是。

        利用jenkins 部署的时候 就没有出现bug,只是在本地运行Maven的时候 发生。

Answer 1

以下回答参考 皆我百晓生、券券喵儿 等免费微信小程序相关内容作答，并由本人整理回复。

在Maven中设置两个环境（DEV和PRO）并自动部署时，可能遇到的问题可能是由于以下几种情况导致的：

1. 环境变量定义不正确： 如果环境变量（ENV或${env}）中的内容被替换为了一个不同的名称（比如"PRO"），或者与当前环境下的实际名称不符（如SERVER2），那么在编译或部署过程中，环境变量可能会失效，从而导致Maven找不到正确的环境配置。以下是修改SERVER1中环境变量定义的示例代码：

<profile>
    <id>SERVER2</id>
    <build>
        ...
    </build>
        <properties>
            <env>${env}</env>
            <!-- 在这里添加新的环境变量，例如"PRO" -->
            <env>PRO</env>
        </properties>
        <!-- ... -->
    </profile>
</profiles>

1. 删除并重新加载环境变量： 删除了当前环境下的环境变量后，重启Maven项目可能会再次生效，因此重新加载环境变量可能是解决问题的一种方法。要实现这个功能，请按照以下步骤操作：

   a. mvn package：编译项目并打包生成jar包，这样就移除了所有的SERVER1依赖项和配置文件，包括环境变量。

   b. mvn clean install：通过执行clean install命令，Maven会重新加载所有依赖项，并将项目的根目录及其依赖构建到bin目录下。这些依赖将会与你的新的SERVER2环境配置一同部署。

2. 配置文件冲突： 修改了SERVER1环境配置后，确保更改不会影响到其他已存在的环境配置文件（通常是在pom.xml文件中定义）。如果有其他依赖包含了相同的环境变量值，那么编译过程可能会报错，提示找不到环境变量，如：

   <dependency>
       <groupId>your.group.id</groupId>
       <artifactId>your.artifact.name</artifactId>
       <version>your.version</version>
       <configuration>
           <env>YOUR_ENVIRONMENT_VALUE</env>
       </configuration>
   </dependency>
   

   对应的Maven配置类中，要找到一个名为env的元素，您可以使用getEnvironmentVariable()方法来获取相应的环境变量值。然后在<configuration>元素中包含这个值，如下所示：

<configuration>
    <env>${env}</env>
    <!-- ... -->
</configuration>

1. Jenkins Job或脚本问题： Jenkins 和 Maven 相关的插件（如Maven.jenkins-plugin）可能有误地设置了环境变量，使其指向默认的服务器环境而不是你所期望的另一个环境。为了修复这个问题，首先确保 Jenkins 的某个构建任务或脚本中的环境变量设置与maven-environments.sh文件的定义匹配。如果是手动设置的，您可以在文件中添加一行这样的内容：

# Deployment script with environment variables
export DEV_SERVER_ENV="dev"
export PRO_SERVER_ENV="pro"

然后，在Maven项目结构中查找 <build> 或 <plugins> 区域内的 Jenkins 构建任务或脚本。如果没有找到，您可以通过创建一个新的 Jenkins 容器、构建脚本或测试用例来模拟这种情况，例如在 <project> 文件夹下创建一个名为 deploy-to-pro.sh 的脚本：

#!/bin/bash

# 增加变量为 "PRO" 的值
export PRO_SERVER_ENV="pro"

# 启动 Jenkins 并切换到 "PRO" 环境
export PATH=$PATH:/path/to/pro/jenkins_home/bin

# 创建 Jenkins Pipeline 触发器以部署项目到 "PRO" 环境
exec /path/to/pro/jenkins_home/bin/pipeline.sh -c "echo 'Deploying to PRO environment' >> $OUT_DIR/${ARTIFACT_NAME}.log && mvn ${ARTIFACT_NAME}.jar ${ARTIFACT_NAME}.war"

# 重复上述步骤以将 Maven 编译后的库部署到 "DEV" 环境
exec /path/to/dev/jenkins_home/bin/pipeline.sh -c "echo 'Deploying to DEV environment' >> $OUT_DIR/${ARTIFACT_NAME}.log && mvn ${ARTIFACT_NAME}.jar ${ARTIFACT_NAME}.war"

确保脚本完成后，通过修改 maven-jenkins-plugin 插件的相关参数或重新配置 Jenkins 任务来更新环境变量引用。注意，这只能解决目前的问题，如果在正式环境中遇到其他问题，可能需要进一步排查其他可能影响配置的配置项、命令路径、服务端代理设置等。

请根据您的具体需求和实际情况调整以上代码。对于更多的调试和排查建议，建议在每个有问题的区域详细阅读Maven的相关文档，如Maven User Guide和Maven Plugin User Guide。同时，也可以尝试借助版本控制系统（如Git）进行故障定位和追踪。例如，在Git中，你可以查看提交历史记录以及相关的代码注释，以确定哪个部分导致了问题。