SpringBoot加载多个配置文件实现dev、product多环境切换的方法

下面我将详细讲解“SpringBoot加载多个配置文件实现dev、product多环境切换的方法”的完整攻略。

为什么需要多环境切换

在我们开发一个由多人参与的项目时，由于开发环境、测试环境、生产环境等不同的环境下，配置文件的不同，我们需要动态地切换配置环境，才可以顺利进行开发、测试以及发布等操作。而使用SpringBoot可以灵活地预先加载配置，实现多环境切换。

加载多个配置文件

在SpringBoot代码中，我们可以通过@PropertySource注解在配置类中加载多个配置文件。

@Configuration
@PropertySource("classpath:config-${spring.profiles.active}.properties")
@PropertySource("classpath:config-db.properties")
public class AppConfig {
  // ...
}

上述 @PropertySource 注解中的 ${spring.profiles.active} 是SpringBoot提供的一个参数配置，根据参数的值自动加载不同的配置文件。

配置不同环境下的配置文件

有几种不同的方式可以配置不同环境下的配置文件，下面介绍两种：

命名规范

我们可以根据约定的命名规范来对不同环境的配置文件进行命名，比如：

application.properties // 默认配置文件
application-dev.properties // dev 环境配置文件
application-prod.properties // prod 环境配置文件

当SpringBoot启动时，会优先加载默认配置文件 application.properties，当设置 active 环境为 dev 时，会覆盖 application.properties 中的相同配置。

yml 配置

我们也可以在 application.yml 全局配置文件中开启多环境配置。

server:
  port: 8080

spring:
  profiles:
    active: dev

---

spring:
  profiles: dev
  datasource:
    url: jdbc:mysql://localhost:3306/dev_db
    username: root
    password: dev_password

---

spring:
  profiles: prod
  datasource:
    url: jdbc:mysql://localhost:3306/prod_db
    username: root
    password: prod_password

上述配置中，在全局配置中设置参数 spring.profiles.active 的值为 dev，这时候SpringBoot会自动加载 application-dev.properties 配置文件，并将其中的配置覆盖掉 application.properties 中的同名配置。

示例说明

下面我会举两个简单的例子来说明 SpringBoot 加载多个配置文件实现多环境切换的方法。

示例一：DataSource 配置

首先编写 application.properties 配置文件，内容如下：

spring.datasource.url=jdbc:mysql://localhost:3306/demo
spring.datasource.username=root
spring.datasource.password=admin

接着我们再编写 application-dev.properties 配置文件，内容如下：

spring.datasource.url=jdbc:mysql://localhost:3306/dev
spring.datasource.username=dev
spring.datasource.password=dev_password

然后我们新建一个 DemoController 类，代码如下：

@RestController
public class DemoController {

    @Autowired
    private DataSource dataSource;

    @GetMapping("/info")
    public String getInfo() throws SQLException {
        return "URL: " + dataSource.getConnection().getMetaData().getURL();
    }

}

这里注入了 DataSource 数据源，最后启动程序时，我们可以设置环境为 dev ，这时候就可以访问到 application-dev.properties 中的配置了。

示例二：日志输出配置

我们可以在 application-prod.properties 配置文件中设置日志新的输出路径，代码如下：

logging.file.path=/var/log/mysite

具体地，在代码中这样使用：

@Log4j2
@RestController
public class DemoController {

  @GetMapping("/info")
  public String getInfo() {
    log.info("hello");
    return "info";
  }
}

在 dev 环境中，日志会输出在 console 中，而在 prod 环境中日志会输出在 /var/log/mysite/myapp.log 下。

总结

本篇文章详细介绍了 SpringBoot 加载多个配置文件实现多环境切换的方法，包括命名规范和 yml 配置两种方式。并通过两个示例说明了这种方法的具体应用。