走进SpringBoot之配置文件与多环境详解

配置文件的使用

Spring Boot支持多种类型的配置文件，包括：

• 属性文件（.properties）
• YAML文件（.yml或.yaml）
• JSON文件（.json）

在Spring Boot中，我们可以通过在配置文件中定义属性来配置应用程序的行为。配置文件中的属性可以被注入到Spring Bean中，以及在代码中使用。

Spring Boot默认会查找以下位置的配置文件：

1. 当前目录下的config文件夹
2. 当前目录
3. classpath下的config文件夹
4. classpath根目录

使用属性文件

属性文件是一种基于键值对的配置文件格式，每一行包含一个键值对，键和值之间用等号（=）或冒号（:）分隔。例如：

# application.properties

# 数据库连接配置
spring.datasource.url=jdbc:mysql://localhost:3306/mydb
spring.datasource.username=root
spring.datasource.password=123456

我们可以通过在代码中使用@Value注解获取属性值：

@Component
public class DataSourceConfig {
    @Value("${spring.datasource.username}")
    private String username;

    @Value("${spring.datasource.password}")
    private String password;

    //...
}

使用YAML文件

YAML是一种友好的、易读的、基于缩进的数据序列化格式。Spring Boot支持使用YAML格式的配置文件，以.yml或.yaml为扩展名。

下面是一个使用YAML文件的示例：

# application.yml

# 数据库连接配置
spring:
  datasource:
    url: jdbc:mysql://localhost:3306/mydb
    username: root
    password: 123456

YAML文件可以使用缩进表示嵌套关系，它比属性文件更加易读。

我们可在代码中使用@Value注解和ConfigurationProperties注解获取属性值：

@Component
@ConfigurationProperties(prefix = "spring.datasource")
public class DataSourceConfig {
    private String url;
    private String username;
    private String password;

    //...
}

使用JSON文件

Spring Boot也支持使用JSON格式的配置文件，以.json为扩展名。

下面是一个使用JSON文件的示例：

// application.json

{
  "spring": {
    "datasource": {
      "url": "jdbc:mysql://localhost:3306/mydb",
      "username": "root",
      "password": "123456"
    }
  }
}

我们可在代码中使用@Value注解和ConfigurationProperties注解获取属性值：

@Component
@ConfigurationProperties(prefix = "spring.datasource")
public class DataSourceConfig {
    private String url;
    private String username;
    private String password;

    //...
}

多环境配置

在实际应用程序中，经常需要在不同的环境中使用不同的配置。例如，开发环境使用一个数据库，生产环境使用另一个数据库。

Spring Boot支持在不同的环境中使用不同的配置文件。例如，我们可以定义一个名为application-dev.yml的配置文件，它将应用于开发环境。

使用命令行参数指定环境

通过在命令行运行应用程序时使用--spring.profiles.active参数来指定要使用的配置文件。例如，--spring.profiles.active=dev表示使用名为application-dev.yml的配置文件。

我们也可以在application.properties或application.yml文件中指定默认的环境：

spring.profiles.active=dev

按环境分开配置文件

我们可以按照以下方式来分开配置文件：

1. 在application.properties或application.yml文件中指定spring.profiles.active属性的值。

2. 在与配置文件同级的目录下创建以application-{profile}.properties或application-{profile}.yml命名的文件，其中{profile}是要使用的环境名称。

例如，我们可以在开发环境中使用以下配置文件：

# application-dev.yml

spring:
  datasource:
    url: jdbc:mysql://localhost:3306/devdb
    username: devuser
    password: devpwd

同时，我们可以在生产环境中使用以下配置文件：

# application-prod.yml

spring:
  datasource:
    url: jdbc:mysql://localhost:3306/proddb
    username: produser
    password: prodpwd

我们可以通过--spring.profiles.active参数来指定要使用的环境。例如，--spring.profiles.active=dev表示使用开发环境的配置。

示例说明

下面是一个Spring Boot应用程序的示例配置文件：

# application.properties

# 默认环境为dev
spring.profiles.active=dev

# 数据库连接配置
spring.datasource.url=jdbc:mysql://localhost:3306/devdb
spring.datasource.username=devuser
spring.datasource.password=devpwd

开发环境配置：

# application-dev.yml

# 数据库连接配置
spring:
  datasource:
    url: jdbc:mysql://localhost:3306/devdb
    username: devuser
    password: devpwd

生产环境配置：

# application-prod.yml

# 数据库连接配置
spring:
  datasource:
    url: jdbc:mysql://localhost:3306/proddb
    username: produser
    password: prodpwd

在代码中，我们可以使用以下方式来获取配置文件中的属性：

@Component
@ConfigurationProperties(prefix = "spring.datasource")
public class DataSourceConfig {
    private String url;
    private String username;
    private String password;

    //...
}

使用@Value注解：

@Component
public class MyComponent {
    @Value("${spring.datasource.url}")
    private String url;

    //...
}

在命令行中，我们可以使用以下命令启动应用程序，来指定要使用的配置文件：

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