百度360必应搜狗淘宝本站头条
当前位置:网站首页 > IT知识 > 正文

Spring Boot中通过@PropertySource注解读取yaml或yml配置文件

liuian 2025-02-09 13:14 17 浏览

一、@PropertySource注解

@PropertySource加载指定的配置文件。

将一切配置全部写在全局配置文件中,是不可想象的。项目中不可避免存在多个配置文件。

@PropertySource 可以根据需要加载指定的配置文件,将配置文件中的属性注入到系统环境中。@ConfigurationProperties 默认从全局配置文件获取配置。

这里将person的属性配置单独写在person.yml文件中,并从全局配置文件中注释掉person的属性配置。

因为yaml语法很简洁,写yaml配置文件也比较方便。

通过@PropertySource注解读取配置文件的属性,进行映射,习惯上用properties配置文件是没问题的。但是,换成yaml文件,发现都读取不到属性值。

这是因为@PropertySource默认不支持yaml读取,我们改成@Value注解也是可以读取的,不过属性一堆的话,一个一个读取也是很繁琐的。不过,可以通过自定义开发来实现对yaml配置文件的支持。



二、为什么@PropertySource 注解默认不支持yaml配置文件?

下面简单分析一下源码。

1. @PropertySource 源码

根据上面的注释,默认使用
DefaultPropertySourceFactory类作为资源文件加载类。

进一步调用Spring框架底层的PropertiesLoaderUtils工具类进行读取资源文件。

然后调用
DefaultPropertiesPersister的load方法:


最终加载配置文件的方法,就是下面的load0()方法。

从源码可以看出,这个方法是一行一行地读取,然后根据冒号、等于号、空格等进行校验,经过一系列遍历之后获取key和value,而yaml语法是以缩进来辨别的,这个方法不支持yaml文件的读取。


三、自定义yaml配置文件读取的工厂类

模仿
DefaultPropertySourceFactory写一个yaml配置文件读取的工厂类。

完整代码如下所示:

package com.rickie.springboot.core;


import org.springframework.boot.env.YamlPropertySourceLoader;

import org.springframework.core.env.PropertiesPropertySource;

import org.springframework.core.env.PropertySource;

import org.springframework.core.io.support.EncodedResource;

import org.springframework.core.io.support.PropertySourceFactory;


import java.io.IOException;

import java.util.List;

import java.util.Optional;

import java.util.Properties;


public class YmlPropertyResourceFactory implements PropertySourceFactory {


@Override

public PropertySource createPropertySource(String name, EncodedResource encodedResource) throws IOException {

String resourceName = Optional.ofNullable(name).orElse(encodedResource.getResource().getFilename());


if(resourceName.endsWith(".yml") || resourceName.endsWith(".yaml")) {

List> yamlSources = new YamlPropertySourceLoader().load(resourceName, encodedResource.getResource());

return yamlSources.get(0);

} else {

return new PropertiesPropertySource(resourceName, new Properties());

}

}

}



四、编写Person类和person.yml 配置文件

写个bean类进行属性映射,注意替换一下默认的factory参数,factory =
YmlPropertyResourceFactory.class。


@Component组件

注入Spring容器,只有Spring容器中的组件才能使用@ConfigurationProperties功能;


@PropertySource(value = "classpath:person.yml",encoding = "utf-8",factory = YmlPropertyResourceFactory.class)

加载指定的配置文件;获取的是person.properties 这个配置文件下的配置信息;

factory =
YmlPropertyResourceFactory.class 设置使用自定义的配置文件读取的工厂类;


@ConfigurationProperties(prefix = "person")

告诉SpringBoot将本类中的相关配置与yml文件中的配置绑定,并获取配置前缀person下的配置项。


下面是person.yml 配置文件,同时将application.yml 中的person配置项注释掉。



五、测试验证

编写单元测试类,进行测试验证。

测试结果如下所示 :



六、扩展PropertyResourceFactory 工厂类

如果既要支持原来的yml,又要支持properties,就可以将PropertyResourceFactory类进行改写一下。

package com.rickie.springboot.core;


import org.springframework.boot.env.YamlPropertySourceLoader;

import org.springframework.core.env.PropertySource;

import org.springframework.core.io.support.DefaultPropertySourceFactory;

import org.springframework.core.io.support.EncodedResource;

import org.springframework.core.io.support.PropertySourceFactory;

import org.springframework.lang.Nullable;


import java.io.IOException;

import java.util.List;

import java.util.Optional;


public class CommonPropertyResourceFactory implements PropertySourceFactory {

/**

* Create a {@link PropertySource} that wraps the given resource.

*

* @param name the name of the property source

* @param resource the resource (potentially encoded) to wrap

* @return the new {@link PropertySource} (never {@code null})

* @throws IOException if resource resolution failed

*/

@Override

public PropertySource createPropertySource(@Nullable String name, EncodedResource resource) throws IOException {

String resourceName = Optional.ofNullable(name).orElse(resource.getResource().getFilename());

if (resourceName.endsWith(".yml") || resourceName.endsWith(".yaml")) {

List> yamlSources = new YamlPropertySourceLoader().load(resourceName, resource.getResource());

return yamlSources.get(0);

} else {

return new DefaultPropertySourceFactory().createPropertySource(name, resource);

}

}

}

这个类就可以支持原来的properties文件,也可以支持yml文件。

调用的时候,要改一下factory参数:

@PropertySource(value = "classpath:person.yml",encoding = "utf-8",factory = CommonPropertyResourceFactory.class)


还可以编写Rest方法进行验证,如下所示:

运行时返回JSON信息如下所示:

相关推荐

总结下SpringData JPA 的常用语法

SpringDataJPA常用有两种写法,一个是用Jpa自带方法进行CRUD,适合简单查询场景、例如查询全部数据、根据某个字段查询,根据某字段排序等等。另一种是使用注解方式,@Query、@Modi...

解决JPA在多线程中事务无法生效的问题

在使用SpringBoot2.x和JPA的过程中,如果在多线程环境下发现查询方法(如@Query或findAll)以及事务(如@Transactional)无法生效,通常是由于S...

PostgreSQL系列(一):数据类型和基本类型转换

自从厂子里出来后,数据库的主力就从Oracle变成MySQL了。有一说一哈,贵确实是有贵的道理,不是开源能比的。后面的工作里面基本上就是主MySQL,辅MongoDB、ES等NoSQL。最近想写一点跟...

基于MCP实现text2sql

目的:基于MCP实现text2sql能力参考:https://blog.csdn.net/hacker_Lees/article/details/146426392服务端#选用开源的MySQLMCP...

ORACLE 错误代码及解决办法

ORA-00001:违反唯一约束条件(.)错误说明:当在唯一索引所对应的列上键入重复值时,会触发此异常。ORA-00017:请求会话以设置跟踪事件ORA-00018:超出最大会话数ORA-00...

从 SQLite 到 DuckDB:查询快 5 倍,存储减少 80%

作者丨Trace译者丨明知山策划丨李冬梅Trace从一开始就使用SQLite将所有数据存储在用户设备上。这是一个非常不错的选择——SQLite高度可靠,并且多种编程语言都提供了广泛支持...

010:通过 MCP PostgreSQL 安全访问数据

项目简介提供对PostgreSQL数据库的只读访问功能。该服务器允许大型语言模型(LLMs)检查数据库的模式结构,并执行只读查询操作。核心功能提供对PostgreSQL数据库的只读访问允许L...

发现了一个好用且免费的SQL数据库工具(DBeaver)

缘起最近Ai不是大火么,想着自己也弄一些开源的框架来捣腾一下。手上用着Mac,但Mac都没有显卡的,对于学习Ai训练模型不方便,所以最近新购入了一台4090的拯救者,打算用来好好学习一下Ai(呸,以上...

微软发布.NET 10首个预览版:JIT编译器再进化、跨平台开发更流畅

IT之家2月26日消息,微软.NET团队昨日(2月25日)发布博文,宣布推出.NET10首个预览版更新,重点改进.NETRuntime、SDK、libraries、C#、AS...

数据库管理工具Navicat Premium最新版发布啦

管理多个数据库要么需要使用多个客户端应用程序,要么找到一个可以容纳你使用的所有数据库的应用程序。其中一个工具是NavicatPremium。它不仅支持大多数主要的数据库管理系统(DBMS),而且它...

50+AI新品齐发,微软Build放大招:拥抱Agent胜算几何?

北京时间5月20日凌晨,如果你打开微软Build2025开发者大会的直播,最先吸引你的可能不是一场原本属于AI和开发者的技术盛会,而是开场不久后的尴尬一幕:一边是几位微软员工在台下大...

揭秘:一条SQL语句的执行过程是怎么样的?

数据库系统能够接受SQL语句,并返回数据查询的结果,或者对数据库中的数据进行修改,可以说几乎每个程序员都使用过它。而MySQL又是目前使用最广泛的数据库。所以,解析一下MySQL编译并执行...

各家sql工具,都闹过哪些乐子?

相信这些sql工具,大家都不陌生吧,它们在业内绝对算得上第一梯队的产品了,但是你知道,他们都闹过什么乐子吗?首先登场的是Navicat,这款强大的数据库管理工具,曾经让一位程序员朋友“火”了一把。Na...

详解PG数据库管理工具--pgadmin工具、安装部署及相关功能

概述今天主要介绍一下PG数据库管理工具--pgadmin,一起来看看吧~一、介绍pgAdmin4是一款为PostgreSQL设计的可靠和全面的数据库设计和管理软件,它允许连接到特定的数据库,创建表和...

Enpass for Mac(跨平台密码管理软件)

还在寻找密码管理软件吗?密码管理软件有很多,但是综合素质相当优秀且完全免费的密码管理软件却并不常见,EnpassMac版是一款免费跨平台密码管理软件,可以通过这款软件高效安全的保护密码文件,而且可以...