02 SpringBoot配置文件之统一配置管理文件+yaml配置属性注入的三种方式+多配置文件组织+多环境配置文件的配置

SunsPlanter

已于 2024-01-29 17:39:03 修改

阅读量1.2k

点赞数 24

分类专栏： SpringBoot 文章标签： spring boot 后端 java

于 2024-01-17 17:54:40 首次发布

本文链接：https://blog.csdn.net/m0_46671240/article/details/135653167

版权

SpringBoot 专栏收录该内容

13 篇文章 0 订阅

订阅专栏

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格式天然支持复杂的数据类型，如列表、映射等。这使得在配置文件中表示嵌套结构或数据集合更加容易，而不需要进行额外的解析或转换。

1.3.1 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:
  - 登录
  - 注册
  - 仪表盘

1.3.2 Map，List , array在yaml中的写法

step1：创建保存数据的 Bean

public class User {
private String name;
private String sex;
private Integer age;
//set | get ,toString
}
public class MyServer {
private String title;
private String ip;
//set | get ,toString
}
@ConfigurationProperties
public class CollectionConfig {
private List<MyServer> servers;
private Map<String,User> users;
private String [] names;
//set | get ,toString
}

step2: application.yml, 配置数据

#集合以及数组
#List<String> names
names:
  - lisi
  - zhangsan


#List<MyServer> servers
servers:
  - title: 华北服务器
    ip: 202.12.39.1
  - title: 西南服务器
    ip: 106.90.23.229


#Map<String,User> users
users:
	user1:
		name: 张三
		sex: 男
		age: 22
	user2:
		name: 李四
		sex: 男
		age: 26

“-”表示集合一个成员，因为成员是对象，需要属性名称指定属性值。
List 与数组前面加入“-”表示一个成员。
Map 直接指定 key 和 value，无需“-”

1.3.3 配置属性注入实例

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

读取配置文件的方式和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批量注入配置属性

创建类，添加属性和注解

在类上通过@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.4.1 @ConfigurationProperties注入嵌套Bean

什么是嵌套注入?
在上例中, 不存在一个链接中间层和最底层同时出现配置属性情况, 以下的例子出现了, prefix必须写到含有配置属性的最上层

yaml文件如下, 其中security是第二层, 第一和第二层同时出现了配置属性

app:
  name: Lession07-yml
  owner: bjpowernode
  port: 8002
  security:
    username: root
    password: 123456

编写嵌套实体类

import lombok.Data;
import org.springframework.context.annotation.Configuration;

@Configuration
@Data
public class Security {

    private String username;
    private String password;

}

import lombok.Data;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.Configuration;

@Configuration(proxyBeanMethods = false)
@ConfigurationProperties(prefix = "app")
@Data
public class NestAppBean {

    private String name;
    private String owner;
    private Integer  port;
    private Security security;

}

测试代码:

    @Test
    void contextLoads() {
        System.out.println(nestAppBean);
    }

1.5 Enviroment对象读取配置属性

Environment 是外部化的抽象，是多种数据源的集合。从中可以读取 application 配置文件，环境变量，系统属性。使用方式: 在 Bean 中注入 Environment。调用它的 getProperty(key)方法
step0: yaml配置文件不变
step1:创建 ReadConfig 类，注入 Enviroment, 即可调用其方法

@Service
public class ReadConfig {

@Autowired
private Environment environment;

public void print(){

//key 是否存在
if (environment.containsProperty("app.owner")) {
System.out.println(environment.getProperty("app.name"));
	}
}

step2:单元测试

@SpringBootTest
class ReadConfigTest {

@Autowired
private ReadConfig readConfig;

@Test
void test01() {
readConfig.print();
	}
}

1.5 import关键字组织多文件

什么是多环境配置?
大型集成的第三方框架，中间件比较多。每个框架的配置细节相对复杂。如果都将配置集中到一个 application文件，导致文件内容多，不易于阅读。我们将每个框架独立一个配置文件，最后将多个文件集中到 application。

需求：项目集成 redis，数据库 mysql。将 redis，数据库单独放到独立的配置文件
在这里插入图片描述 step2: application.yml 导入多个配置文件

step3：创建类，读取两个文件的配置属性

@Service
public class MultiConfigService {

@Value("${spring.redis.host}")
private String redisHost;

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

public void printConfig(){
System.out.println("redis 的 ip："+redisHost+"，数据库 url；"+dbUrl);
	}
}

step4: 单元测试

@SpringBootTest
class MultiConfigServiceTest {

@Autowired
private MultiConfigService multiConfigService;

@Test
void test01() {
multiConfigService.printConfig();
	}
}

1.6 import+active关键字配置和使用多环境

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

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

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

需求：项目使用多环境配置，准备一个开发环境，一个测试环境
step1：在 resources 创建环境配置文
在这里插入图片描述

step2: 激活环境

spring:
config:
#导入多个配置文件，“，”作为分隔符
import: conf/db.yml,conf/redis.yml
#激活环境，与 on-profile 名称保持一致
profiles:
active: dev

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

注意 :

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

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

SunsPlanter

关注

24
点赞
踩
16

收藏

觉得还不错? 一键收藏
0
评论
复制链接

分享到 QQ

分享到新浪微博

扫一扫

专栏目录