超详细！Spring Boot项目结合Maven Profile实现多环境切换，轻松搞定开发部署难题

在当今的软件开发中，一个项目往往需要在不同的环境中运行，如开发、测试和生产环境。每个环境都有其独特的配置需求，如何高效地管理这些配置，让项目在不同环境中顺利运行，成为了开发者们必须面对的问题。Spring Boot 和 Maven 作为 Java 开发中非常流行的框架和构建工具，为我们提供了强大的解决方案，那就是 Spring Boot Profile 和 Maven Profile。本文将深入探讨如何将两者结合使用，实现多环境的灵活切换，极大地提升项目的可维护性和开发效率。

一、Spring Boot Profile：配置管理的利器

什么是springboot profile？

Spring Boot Profile 是一种配置机制，它允许我们在同一个应用程序中针对不同的环境（如开发、测试和生产环境）设置不同的配置。这意味着我们可以根据环境的需求，灵活地加载特定的配置，让应用程序在不同环境下都能完美运行。这些配置通常存储在以application-{profile}.yml或application-{profile}.properties命名的文件中，比如application-dev.yml就是专门用于开发环境的配置文件。

Spring Boot Profile 常见的使用场景

• 不同环境下的配置管理：在开发环境中，我们可能需要使用本地的数据库连接、设置较高的日志级别以便于调试，以及采用简单的缓存策略。而在测试环境中，会使用专门的测试数据库连接和模拟服务，保证测试的准确性和独立性。生产环境则更注重稳定性和性能，需要使用正式的数据库连接和优化后的配置。
• 条件性 Bean 注入：根据不同的环境条件注入不同的 Bean 实例。例如，在开发环境中，为了快速开发和测试，我们可以使用内存数据库 H2；而在生产环境中，为了保证数据的安全性和可靠性，需要切换到 MySQL 数据库。
• 资源和服务的差异化配置：不同环境下的资源和服务可能有所不同。比如邮件服务、消息队列等，在开发环境中可能使用免费的测试服务，而在生产环境中则需要使用正式的商业服务。
• 性能优化配置：生产环境通常对性能有更高的要求，可能会配置更优的缓存策略、调整线程池大小等。而在开发环境中，这些优化配置可能并不是必需的，更注重开发的便利性。
• 安全性和监控配置：生产环境需要更严格的安全配置，如 SSL/TLS 加密、访问控制等，以保护数据的安全。监控配置也会有所不同，例如在生产环境中设置更严格的日志级别和报警策略，及时发现和解决问题。

如何使用springboot profile

• 创建配置文件：为每个环境创建对应的配置文件，如application-dev.yml、application-prod.yml等。在这些文件中，定义该环境特有的配置信息。
• 激活特定profile：可以通过设置spring.profiles.active属性来激活一个特定的 profile。这个设置可以在命令行启动参数中完成，也可以在application.properties或application.yml主配置文件中预先设定。
• 在代码中使用：通过@Profile注解可以在类级别上指定这个 bean 只在某个 profile 被激活时才创建。

示例

• 配置文件示例 (application-dev.yml):

    spring:
      datasource:
        url: jdbc:mysql://localhost:3306/mydb_dev
    

• Java代码中使用特定profile创建bean

    @Profile("dev")
    @Bean
    public DataSource dataSource() {
        return new EmbeddedDatabaseBuilder()
            .setType(EmbeddedDatabaseType.H2)
            .addScript("schema.sql")
            .build();
    }
    

如何激活特定的profile

1、通过命令行参数

示例：

  java -jar myapp.jar --spring.profiles.active=dev
  

2、通过环境变量

示例：

  export SPRING_PROFILES_ACTIVE=prod
  

3、通过配置文件

示例：

  spring:
    profiles:
      active: test
  

二、Maven Profile：构建过程的魔法棒

Maven Profile 是一组预定义的配置集合，在构建过程中可以激活。这些配置涵盖了依赖项版本、插件配置、仓库位置等多个方面。通过激活不同的 Profile，我们可以在不同的构建环境下使用不同的配置，实现构建过程的灵活定制。

Maven Profile常见的使用场景

• 不同环境下的依赖管理：在开发环境中，为了获取最新的功能和修复，我们可以使用最新的依赖版本。而在生产环境中，为了保证稳定性，会使用经过充分测试的稳定版本。
• 构建过程的差异化配置：在不同的构建阶段，我们可能需要不同的插件配置。例如，在开发环境中，为了方便调试，我们可以使用更多的调试工具和插件；而在生产环境中，为了提高性能，会使用性能优化工具。
• 资源文件的差异化配置：不同环境下的资源文件（如配置文件、数据库脚本等）可能有不同的版本。比如，开发环境使用本地数据库配置，而生产环境使用远程数据库配置。
• 仓库管理：不同环境下的仓库配置也可能不同。开发环境可以使用本地仓库，加快依赖的下载速度；而生产环境为了保证安全性和稳定性，可能会使用私有仓库。
• 环境特定的构建目标：在不同的环境中执行不同的构建目标。例如，在开发环境中执行单元测试，快速验证代码的正确性；而在生产环境中执行集成测试和性能测试，确保系统在实际运行中的稳定性和性能。

Maven Profile 可以在哪些文件进行配置

• 全局配置文件：~/.m2/settings.xml
• 项目级别的配置文件：pom.xml
• 用户级别的配置文件：~/.m2/settings.xml

如何使用Maven Profile

示例

假设我们有一个 Maven 项目，需要在开发环境和生产环境中使用不同的配置

1、pom.xml 中的 Profile 配置

   <project>
     ...
     <profiles>
       <profile>
         <id>dev</id>
         <activation>
           <activeByDefault>false</activeByDefault>
         </activation>
         <properties>
           <env>development</env>
           <database.url>jdbc:mysql://localhost:3306/mydb_dev</database.url>
         </properties>
         <dependencies>
           <dependency>
             <groupId>org.springframework.boot</groupId>
             <artifactId>spring-boot-starter-test</artifactId>
             <scope>test</scope>
           </dependency>
         </dependencies>
       </profile>

       <profile>
         <id>prod</id>
         <activation>
           <activeByDefault>false</activation>
         </activation>
         <properties>
           <env>production</env>
           <database.url>jdbc:mysql://localhost:3306/mydb_prod</database.url>
         </properties>
         <dependencies>
           <dependency>
             <groupId>com.somecompany</groupId>
             <artifactId>performance-optimizer</artifactId>
             <version>1.0.0</version>
           </dependency>
         </dependencies>
       </profile>
     </profiles>
     ...
   </project>
   

2、激活特定 Profile

示例： 激活开发环境配置

mvn clean install -Pdev

综上可以发现Spring Boot和maven可以根据当前激活的profile选择合适的配置，从而简化了多环境部署的复杂度。

通过大篇幅springboot profile以及maven profile前置介绍，我们现在来聊聊如何将 Spring Boot 的 profile 与 Maven 的 profile 结合使用，可以进一步增强项目的灵活性和可维护性

三、Spring Boot Profile 与 Maven Profile 的完美结合

通过将 Spring Boot Profile 与 Maven Profile 结合使用，我们可以进一步增强项目的灵活性和可维护性。下面通过具体示例来详细说明。

假设我们有三个环境：开发环境（dev）、测试环境（test）和生产环境（prod）

1、Spring Boot Profile 配置

application-dev.yml配置如下

  spring:
    datasource:
      url: jdbc:mysql://localhost:3306/mydb_dev
      username: user
      password: pass
    logging:
      level: debug
  

application-test.yml配置如下

  spring:
    datasource:
      url: jdbc:mysql://localhost:3306/mydb_test
      username: user
      password: pass
    logging:
      level: info
  

application-prod.yml配置如下

  spring:
    datasource:
      url: jdbc:mysql://localhost:3306/mydb_prod
      username: user
      password: pass
    logging:
      level: warn
  

2、Maven Profile 配置

在项目的pom做如下配置

<project>
  ...
  <profiles>
    <profile>
      <id>dev</id>
      <activation>
        <activeByDefault>true</activation>
      </activation>
      <properties>
        <spring.profiles.active>dev</spring.profiles.active>
      </properties>
    </profile>

    <profile>
      <id>test</id>
      <properties>
        <spring.profiles.active>test</spring.profiles.active>
      </properties>
    </profile>

    <profile>
      <id>prod</id>
      <properties>
        <spring.profiles.active>prod</spring.profiles.active>
      </properties>
    </profile>
  </profiles>
  ...
</project>

3、在springboot的application.yml做如下配置

  spring:
    profiles:
      active: @spring.profiles.active@
  

通过配置@spring.profiles.active@和maven的profile配置产生联动

注： 用@@，是因为springboot为了避免和spring内置的“dollar符”产生冲突，因此springboot将maven-resources-plugin默认的分割符“dollar符”改成@。

其次spring.profiles.active要和maven profile配置properties的标签一模一样

4、激活 Maven Profile

可以通过以下方式激活 Maven profile，从而间接激活相应的 Spring Boot profile

mvn clean install -Pdev

注： 如果我们平时开发调试时，可以直接利用idea的面板进行激活。如下图

不过可能出现 @spring.profiles.active@识别不了，导致项目启动不起来，此时可以通过maven reimport来解决

总结

通过根据不同的构建环境激活不同的 Maven profile，进而激活相应的 Spring Boot profile，我们能够轻松地实现项目在不同环境下的灵活配置和部署。这种方式极大地增强了项目的灵活性和可维护性，让开发和运维工作变得更加高效。如果你想深入了解本文的具体示例，可以参考

https://github.com/lyb-geek/springboot-learning/blob/master/springboot-db-readwrite-splitting/springboot-db-readwrite-test/pom.xml

希望本文能帮助你更好地掌握 Spring Boot 和 Maven 的多环境配置技巧，让你的开发工作更加顺利！