《SpringBoot系列一》:yaml配置文件各种数据类型使用姿势(含@EnableConfigurationProperties、@ConfigurationProperties)

本文主要是介绍《SpringBoot系列一》:yaml配置文件各种数据类型使用姿势(含@EnableConfigurationProperties、@ConfigurationProperties),希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

一、SpringBoot配置介绍

SpringBoot支持两种配置文件类型:

  • application.properties
  • applicatioin.yml

@ConfigurationProperties注解的作用是:把properties或者yml配置文件转化为bean来使用。
@EnableConfigurationProperties注解的作用是:使 使用 @ConfigurationProperties 注解的类生效。

如果只配置@ConfigurationProperties注解,在IOC容器中是获取不到properties配置文件转化的bean的,当然在@ConfigurationProperties加入注解的类上加@Component也可以使交于springboot管理。

所以也就有两种自定义配置的绑定方式:

  • @ConfigurationProperties + @Component
  • @ConfigurationProperties + @EnableConfigurationProperties

另外, @EnableConfigurationProperties 就相当于把使用 @ConfigurationProperties 注解的类(TestProp)进行了一次注入

二、yaml

1、基本语法

  1. 大小写敏感
  2. 使用缩进表示层级关系
  3. 缩进不允许使用tab,只允许空格
  4. 缩进的空格数不重要,只要相同层级的元素左对齐即可
  5. '#'表示注释

2、数据类型

  1. 对象:键值对数据,又称哈希(Hash)、映射(Mapping)、字典(Dict)。
  2. 数组:一组按次序排列的值,又称为序列(sequence)、列表(list)
  3. 常量(scalars):单个的、不可再分的值;比如:字符串(str)、布尔值(bool)、整数(int)、浮点数(float)、时间(time)、日期(date)、Null。
1)对象

对象键值对使用冒号结构表示 key: value,冒号后面需要加一个空格。另外key: value可以嵌套使用,例如:key: {key1: value1, key2: value2, ...}。此外还可以使用缩进表示层级关系。

key: child-key1: value1child-key2: value2

对应的JSON字符串:

key: {child-key1: value1, child-key2: value2}
2)数组

-开头的行表示构成一个数组:

ip: - 192.168.1.1- 192.168.1.2- 192.168.1.3- 192.168.1.4

YAML 支持多维数组,可以使用行内表示:

ip: ['192.168.1.1', '192.168.1.2', '192.168.1.3', '192.168.1.4']

对应的JSON字符串:

{ip: ['192.168.1.1', '192.168.1.2', '192.168.1.3', '192.168.1.4']}
3)复合(嵌套)结构
users:-id: 1name: Saint-id: 2name: Bob
address:city: nanjingstreet: shazhou

意思是 users属性是一个数组,每一个数组元素又是由 id、name、name两个属性构成;address是一个对象。

数组也可以使用流式的方式表示:

users: [{id: 1,name: Saint},{id: 2,name: Bob}]
address:cite: nanjingstreet: shazhou

对应的JSON字符串:

{users: [{id: 1,name: Saint},{id: 2,name: Bob}], address:{city: nanjing, street: shazhou}}
4)常量
boolean: - TRUE  #true,True都可以- FALSE  #false,False都可以
float:- 3.14- 6.8523015e+5  #可以使用科学计数法
int:- 123- 0b1010_0111_0100_1010_1110    #二进制表示
null:nodeName: 'node'parent: ~  #使用~表示null
string:- 哈哈- 'Hello world'  #可以使用双引号或者单引号包裹特殊字符- newlinenewline2    #字符串可以拆成多行,每一行会被转化成一个空格
date:- 2018/02/17    ##格式必须为yyyy/M/d 或 yyyy/MM/dd,否则无法在SpringBoot做映射
datetime: -  2018/02/17 15:02:31    #格式必须为yyyy/M/d HH:mm:ss
5)& 锚点、 * 别名、<< 表示合并到当前数据

& 用来建立锚点(default),<< 表示合并到当前数据,* 用来引用锚点。

& 锚点和 * 别名,可以用来引用:

default: &default # 定义锚点adapter:  postgreshost:     localhostdevelopment:database: myapp_development<<: *default # 引用锚点  并合并到当前数据test:database: myapp_test<<: *default

相当于:

defaults:adapter:  postgreshost:     localhostdevelopment:database: myapp_developmentadapter:  postgreshost:     localhosttest:database: myapp_testadapter:  postgreshost:     localhost

再来看一种使用方式:

- &showell Steve 
- Saint
- Oren 
- *showell 

相当于:

[ 'Steve', 'Saint', 'Oren', 'Steve' ]

三、Spring+yaml结合使用案例

首先要在maven依赖中添加:

<dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-configuration-processor</artifactId><optional>true</optional>
</dependency>

否则TestProp类上会有一行红色的异常信息,具体如下:

Spring Boot Configuration Annotation Processor not found in classpath

并且在pom中加上spring-boot-configuration-processor依赖之后,我们使用@ConfigurationProperties注解注释的配置类中的字段,可以在yaml文件中通过.的方式自动带出提示。
在这里插入图片描述

1、TestController类(@EnableConfigurationProperties):

@EnableConfigurationProperties(TestProp.class)
@RestController
public class TestController {@Autowiredprivate TestProp testProp;@GetMapping("/test")public String test() {return JSONObject.toJSONString(testProp);}
}

2、TestProp类(@ConfigurationProperties):

package com.saint.config;import lombok.Data;
import lombok.ToString;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;import java.util.Date;
import java.util.List;
import java.util.Map;
import java.util.Set;/*** @Component注解,使得该类自动注入到Spring.* 也可以按需在第一次使用TestProp的类上添加@EnableConfigurationProperties(TestProp.class)注解,将其注入。* @author 周鑫(玖枭)*/
//@Component
@ConfigurationProperties(prefix = "user")
@Data
@ToString
public class TestProp {/*** 姓名*/private String name;/*** 性别*/private Boolean sex;/*** 出生日期*/private Date birth;/*** 年龄*/private Integer age;/*** 地址*/private Address address;/****/private String[] interests;/*** 朋友*/private List<String> friends;/*** 技能分数*/private Map<String, Double> score;/*** 拥有的工具*/private Set<Double> tools;/*** 所有朋友的地址*/private Map<String, List<Address>> allFriendAddress;}

3、application.yml文件:

user:name: Saintsex: truebirth: 2020/2/2 12:00:00 #格式必须为yyyy/M/d HH:mm:ss 或 yyyy/MM/ddage: 18address:city: nanjingstreet: shazhouinterests:- football- swimmingfriends:- Bob- rupaliscore: {math: 100, ehglish: 8}tools: [12.3, 13.4, 14.5]allFriendAddress:bestFriend:- {city: shanghai, street: nanjinglu}- city: beijingstreet: xierqicommoneFriend:- { city: hainan, street: dao }- city: jiangsustreet: sheng

4、两种注入TestProp类的方式样例

1)@Component + @ConfigurationProperties()

在需要使用到TestProp的地方直接使用@Autowired注入即可。

样例如下:
在这里插入图片描述
在这里插入图片描述

2)@EnableConfigurationProperties(xxx.class) + @ConfigurationProperties()

在需要使用到TestProp的地方(或者在一个@Configuration注解注释的配置类中),使用@EnableConfigurationProperties(xxx.class)让@ConfigurationProperties注解生效,@ConfigurationProperties注解会把properties或者yml配置文件转化为bean;再使用@Autowired注入TestProp即可。
在这里插入图片描述
在这里插入图片描述
有强迫症的老哥可以使用下面方式移除报红,@Autowired(required = false)表示自动注入的时候Bean可以不存在:
在这里插入图片描述

这种方式在Spring源码中被广泛使用:

比如:Spring MVC的配置类(WebMvcProperties)
在这里插入图片描述
其在WebMvcAutoConfiguration类的静态内部类WebMvcAutoConfigurationAdapter上被通过@Configuration + @EnableConfigurationProperties的方式被注入到Spring IOC容器中。
在这里插入图片描述

这篇关于《SpringBoot系列一》:yaml配置文件各种数据类型使用姿势(含@EnableConfigurationProperties、@ConfigurationProperties)的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/285239

相关文章

一文详解SpringBoot中控制器的动态注册与卸载

《一文详解SpringBoot中控制器的动态注册与卸载》在项目开发中,通过动态注册和卸载控制器功能,可以根据业务场景和项目需要实现功能的动态增加、删除,提高系统的灵活性和可扩展性,下面我们就来看看Sp... 目录项目结构1. 创建 Spring Boot 启动类2. 创建一个测试控制器3. 创建动态控制器注

使用Docker构建Python Flask程序的详细教程

《使用Docker构建PythonFlask程序的详细教程》在当今的软件开发领域,容器化技术正变得越来越流行,而Docker无疑是其中的佼佼者,本文我们就来聊聊如何使用Docker构建一个简单的Py... 目录引言一、准备工作二、创建 Flask 应用程序三、创建 dockerfile四、构建 Docker

Python使用vllm处理多模态数据的预处理技巧

《Python使用vllm处理多模态数据的预处理技巧》本文深入探讨了在Python环境下使用vLLM处理多模态数据的预处理技巧,我们将从基础概念出发,详细讲解文本、图像、音频等多模态数据的预处理方法,... 目录1. 背景介绍1.1 目的和范围1.2 预期读者1.3 文档结构概述1.4 术语表1.4.1 核

Java操作Word文档的全面指南

《Java操作Word文档的全面指南》在Java开发中,操作Word文档是常见的业务需求,广泛应用于合同生成、报表输出、通知发布、法律文书生成、病历模板填写等场景,本文将全面介绍Java操作Word文... 目录简介段落页头与页脚页码表格图片批注文本框目录图表简介Word编程最重要的类是org.apach

Python使用pip工具实现包自动更新的多种方法

《Python使用pip工具实现包自动更新的多种方法》本文深入探讨了使用Python的pip工具实现包自动更新的各种方法和技术,我们将从基础概念开始,逐步介绍手动更新方法、自动化脚本编写、结合CI/C... 目录1. 背景介绍1.1 目的和范围1.2 预期读者1.3 文档结构概述1.4 术语表1.4.1 核

Conda与Python venv虚拟环境的区别与使用方法详解

《Conda与Pythonvenv虚拟环境的区别与使用方法详解》随着Python社区的成长,虚拟环境的概念和技术也在不断发展,:本文主要介绍Conda与Pythonvenv虚拟环境的区别与使用... 目录前言一、Conda 与 python venv 的核心区别1. Conda 的特点2. Python v

Spring Boot中WebSocket常用使用方法详解

《SpringBoot中WebSocket常用使用方法详解》本文从WebSocket的基础概念出发,详细介绍了SpringBoot集成WebSocket的步骤,并重点讲解了常用的使用方法,包括简单消... 目录一、WebSocket基础概念1.1 什么是WebSocket1.2 WebSocket与HTTP

C#中Guid类使用小结

《C#中Guid类使用小结》本文主要介绍了C#中Guid类用于生成和操作128位的唯一标识符,用于数据库主键及分布式系统,支持通过NewGuid、Parse等方法生成,感兴趣的可以了解一下... 目录前言一、什么是 Guid二、生成 Guid1. 使用 Guid.NewGuid() 方法2. 从字符串创建

SpringBoot+Docker+Graylog 如何让错误自动报警

《SpringBoot+Docker+Graylog如何让错误自动报警》SpringBoot默认使用SLF4J与Logback,支持多日志级别和配置方式,可输出到控制台、文件及远程服务器,集成ELK... 目录01 Spring Boot 默认日志框架解析02 Spring Boot 日志级别详解03 Sp

Python使用python-can实现合并BLF文件

《Python使用python-can实现合并BLF文件》python-can库是Python生态中专注于CAN总线通信与数据处理的强大工具,本文将使用python-can为BLF文件合并提供高效灵活... 目录一、python-can 库:CAN 数据处理的利器二、BLF 文件合并核心代码解析1. 基础合