02 SpringBoot配置文件之统一配置管理文件+配置属性批量注入+多环境配置

1.1 统一配置管理概述

• SpringBoot工程下，进行统一的配置管理，你想设置的任何参数（端口号、项目根路径、数据库连接信息等等)都集中到一个固定位置和命名的配置文件（application.properties或application.yml）中！
• 配置文件应该放置在Spring
  Boot工程的src/main/resources目录下。这是因为src/main/resources目录是Spring
  Boot默认的类路径（classpath），配置文件会被自动加载并可供应用程序访问。
• 大部分参数都有默认值 , 不想修改可以不建application.properties/yml

1.2 properties属性配置文件的使用

这是一个application.properties的示例:

# application.properties 为统一配置文件
# 内部包含: 固定功能的key,自定义的key
# 此处的配置信息,我们都可以在程序中@Value等注解读取

# 固定的key
# 启动端口号
server.port=80 

# 自定义
spring.jdbc.datasource.driverClassName=com.mysql.cj.jdbc.driver
spring.jdbc.datasource.url=jdbc:mysql:///springboot_01
spring.jdbc.datasource.username=root
spring.jdbc.datasource.password=root

读取配置文件:

package com.atguigu.properties;

import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;

@Component
public class DataSourceProperties {

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

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

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

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

1.3 YAML配置文件的使用

YAML文件和properties有什么区别?

本质就是键值对 , 但键和值的类型的都是任意的.

1. 层次结构：YAML文件使用缩进和冒号来表示层次结构，使得数据之间的关系更加清晰和直观。
2. 自我描述性：YAML文件具有自我描述性，字段和值之间使用冒号分隔，并使用缩进表示层级关系。
3. 注释支持：YAML格式支持注释，可以在配置文件中添加说明性的注释，使配置更具可读性和可维护性。相比之下，`.properties`文件不支持注释，无法提供类似的解释和说明。
4. 多行文本：YAML格式支持多行文本的表示，可以更方便地表示长文本或数据块。相比之下，`.properties`文件需要使用转义符或将长文本拆分为多行。
5. 类型支持：YAML格式天然支持复杂的数据类型，如列表、映射等。这使得在配置文件中表示嵌套结构或数据集合更加容易，而不需要进行额外的解析或转换。

2. yaml语法说明
   1. 数据结构用树形结构呈现，通过缩进来表示层级
   2. 连续的项目（集合）通过减号 ” - ” 来表示
   3. 键值结构里面的key/value对用冒号 ” : ” 来分隔,且冒号后必须有空格.
   4. YAML配置文件的扩展名是yaml 或 yml

# YAML配置文件示例
app_name: 我的应用程序
version: 1.0.0
author: 张三

spring:
  jdbc:
    datasource:
      driverClassName: com.mysql.jdbc.Driver
      url: jdbc:mysql:///springboot_02
      username: root
      password: root

#对比properties
#spring.jdbc.datasource.driverClassName=com.mysql.cj.jdbc.driver
#spring.jdbc.datasource.url=jdbc:mysql:///springboot_01
#spring.jdbc.datasource.username=root
#spring.jdbc.datasource.password=root

#三个属性都属于features
features:
  - 登录
  - 注册
  - 仪表盘

3. 配置文件

spring:
  jdbc:
    datasource:
      driverClassName: com.mysql.jdbc.Driver
      url: jdbc:mysql:///springboot_02
      username: root
      password: root
      
server:
  port: 80

4. 读取配置文件的方式和properties一致

package com.sunsplanter.properties;

import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;

@Component
public class DataSourceProperties {

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

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

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

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

1.4 @ConfigurationProperties批量注入配置属性

1. 创建类，添加属性和注解

   在类上通过@ConfigurationProperties注解声明该类要读取属性配置

   prefix=“spring.jdbc.datasource” 读取属性文件中前缀为spring.jdbc.datasource的值。前缀和属性名称和配置文件中的key必须要保持一致才可以注入成功

package com.sunsplanter.properties;

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;

@Component
@ConfigurationProperties(prefix = "spring.jdbc.datasource")
public class DataSourceConfigurationProperties {
    //只要键名 = 属性名 , 就可以自动匹配注入
    private String driverClassName;
    private String url;
    private String username;
    private String password;

1.5 多环境配置和使用

什么是多环境配置?
在开发 , 测试 , 生产中各种配置参数可能不同(数据库/日志级别),就需要多个application.yaml

以下是实现Spring Boot多环境配置的常见方法：

1. YAML配置文件：与属性文件类似，可以将配置参数分离到不同的YAML文件中，每个环境对应一个文件。例如，可以创建application-dev.yml、application-prod.yml和application-test.yml等文件。在这些文件中，可以使用YAML语法定义各自环境的配置参数。同样，通过spring.profiles.active属性指定当前的环境，Spring Boot会加载相应的YAML文件。

#同时激活两个配置文件
spring: 
	profiles: 
		active: dev,prod

2. 命令行参数(动态)：可以通过命令行参数来指定当前的环境。例如，可以使用--spring.profiles.active=dev来指定使用开发环境的配置。

注意 :

如果设置了spring.profiles.active，且激活的子配置文件和父配置文件application有重叠属性，以active设置优先。

如果设置了spring.profiles.active，且激活的子配置文件和父配置文件application无重叠属性，application设置依然生效！