springboot多模块多环境配置文件问题(动态配置生产和开发环境)

下面我将详细讲解一下如何在SpringBoot中实现多模块多环境配置文件的动态配置，让你可以快速切换生产和开发环境。

首先，需要明确一下我们要解决的问题：在实际开发中，我们可能会有多个环境（如dev、test、prod等），而且每个环境都有自己对应的配置文件，比如application-dev.properties、application-test.properties、application-prod.properties等。此时，我们的问题是如何在不同的环境中动态切换配置文件。

以下是具体实现步骤：

步骤一：创建多模块项目

多模块项目可以更好地组织项目，提高代码的可维护性和可扩展性。我们可以在主项目下创建多个子模块，每个子模块都有自己的配置文件。

$ mkdir -p myproject/{myproject-service,myproject-web}/src/main/resources

如上，我们在myproject目录下创建了两个子模块myproject-service和myproject-web，每个子模块下都有自己的src/main/resources目录。

步骤二：配置主项目的pom.xml文件

1. 在myproject的pom.xml文件中添加多模块配置：

<modules>
  <module>myproject-service</module>
  <module>myproject-web</module>
</modules>

1. 在pom.xml文件中添加maven-resources-plugin插件，用于复制各子模块下的配置文件：

<plugin>
  <groupId>org.apache.maven.plugins</groupId>
  <artifactId>maven-resources-plugin</artifactId>
  <version>3.2.0</version>
  <executions>
    <execution>
      <phase>process-resources</phase>
      <goals>
        <goal>copy-resources</goal>
      </goals>
      <configuration>
        <outputDirectory>${project.build.outputDirectory}</outputDirectory>
        <resources>
          <resource>
            <directory>${basedir}/myproject-service/src/main/resources</directory>
            <filtering>true</filtering>
          </resource>
          <resource>
            <directory>${basedir}/myproject-web/src/main/resources</directory>
            <filtering>true</filtering>
          </resource>
        </resources>
      </configuration>
    </execution>
  </executions>
</plugin>

1. 在pom.xml文件中添加代码生成插件mapstruct-maven-plugin，用于在子模块代码生成过程中自动生成对应的Mapper接口。

<plugin>
  <groupId>org.mapstruct</groupId>
  <artifactId>mapstruct-maven-plugin</artifactId>
  <version>${mapstruct.version}</version>
  <executions>
    <execution>
      <phase>generate-sources</phase>
      <goals>
        <goal>compile</goal>
      </goals>
    </execution>
  </executions>
  <configuration>
    <sourceDirectory>src/main/java</sourceDirectory>
    <targetDirectory>target/generated-sources</targetDirectory>
    <processors>
      <processor>org.mapstruct.ap.MappingProcessor</processor>
    </processors>
  </configuration>
</plugin>

步骤三：在子模块中添加配置文件

在每个子模块的src/main/resources目录下添加对应的配置文件，比如：

myproject-service/src/main/resources/application-dev.properties

spring.profiles.active=dev
server.port=8081

myproject-service/src/main/resources/application-prod.properties

spring.profiles.active=prod
server.port=8082

同理，myproject-web也需要添加对应的配置文件。

步骤四：在主项目中添加Controller

在主项目中编写Controller，用于测试不同环境中的配置文件是否生效。

@RestController
public class ConfigController {

  @Value("${server.port}")
  private String port;

  @GetMapping("/config")
  public String getConfig() {
    return "当前端口：" + port;
  }

}

步骤五：启动程序

在IDEA中打开myproject，点击Run按钮启动程序。在浏览器中访问http://localhost:8081/config（或者http://localhost:8082/config），查看当前程序的端口号是否和配置文件中配置一致。如果一致，说明配置文件已经生效。

到此为止，我们已经成功实现了多模块多环境配置文件的动态配置。

示例一：

让我们来看一个比较复杂的场景。假设我们有多个模块，每个模块都有自己的配置文件，而且每个模块都可以单独部署到不同的服务器上。这时候，我们需要在配置文件中指定当前模块运行的环境和端口号。

假设我们的项目有两个模块：myproject-service和myproject-web。我们需要在不同的环境中运行这两个模块，比如：

• myproject-service在开发环境中运行在8081端口，在生产环境中运行在8082端口；
• myproject-web在开发环境中运行在8083端口，在生产环境中运行在8084端口。

此时，我们需要在配置文件中指定每个模块的环境以及端口号。

首先，在每个模块的配置文件中添加如下内容：

# myproject-service/src/main/resources/application-dev.properties
service.env=dev
service.port=8081

# myproject-service/src/main/resources/application-prod.properties
service.env=prod
service.port=8082

# myproject-web/src/main/resources/application-dev.properties
web.env=dev
web.port=8083

# myproject-web/src/main/resources/application-prod.properties
web.env=prod
web.port=8084

然后，在代码中引用这些配置文件的值：

@Component
@ConfigurationProperties(prefix = "service")
public class ServiceConfig {

  private String env;
  private int port;

  // getter、setter方法省略
}

@Component
@ConfigurationProperties(prefix = "web")
public class WebConfig {

  private String env;
  private int port;

  // getter、setter方法省略
}

以上是常见场景，具体实现方式还需根据具体情况调整。

示例二：

还有一种场景是需要在不同的环境中使用不同的配置文件，比如在开发环境中使用H2数据库，在生产环境中使用MySQL数据库。此时，我们需要在应用启动之前指定不同的配置文件。

在实现时，需要在启动类中指定环境变量，如下：

@SpringBootApplication
public class MyApplication {

  public static void main(String[] args) {
    SpringApplication application = new SpringApplication(MyApplication.class);

    // 设置环境变量
    String env = "test"; // test、dev、prod等
    String[] profiles = {"prod"};
    application.setAdditionalProfiles(profiles);
    application.setEnvironment(new StandardEnvironment() {{
      setActiveProfiles(env);
    }});

    // 启动应用
    application.run(args);
  }

}

以上就是SpringBoot多模块多环境配置文件问题（动态配置生产和开发环境）的完整攻略，希望可以帮助到大家。