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

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

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

一、@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信息如下所示:

相关推荐

教你把多个视频合并成一个视频的方法

一.情况介绍当你有一个m3u8文件和一个目录,目录中有连续的视频片段,这些片段可以连成一段完整的视频。m3u8文件打开后像这样:m3u8文件,可以理解为播放列表,里面是播放视频片段的顺序。视频片段像这...

零代码编程:用kimichat合并一个文件夹下的多个文件

一个文件夹里面有很多个srt字幕文件,如何借助kimichat来自动批量合并呢?在kimichat对话框中输入提示词:你是一个Python编程专家,完成如下的编程任务:这个文件夹:D:\downloa...

Java APT_java APT 生成代码

JavaAPT(AnnotationProcessingTool)是一种在Java编译阶段处理注解的工具。APT会在编译阶段扫描源代码中的注解,并根据这些注解生成代码、资源文件或其他输出,...

Unit Runtime:一键运行 AI 生成的代码,或许将成为你的复制 + 粘贴神器

在我们构建了UnitMesh架构之后,以及对应的demo之后,便着手于实现UnitMesh架构。于是,我们就继续开始UnitRuntime,以用于直接运行AI生成的代码。PS:...

挣脱臃肿的枷锁:为什么说Vert.x是Java开发者手中的一柄利剑?

如果你是一名Java开发者,那么你的职业生涯几乎无法避开Spring。它如同一位德高望重的老国王,统治着企业级应用开发的大片疆土。SpringBoot的约定大于配置、SpringCloud的微服务...

五年后,谷歌还在全力以赴发展 Kotlin

作者|FredericLardinois译者|Sambodhi策划|Tina自2017年谷歌I/O全球开发者大会上,谷歌首次宣布将Kotlin(JetBrains开发的Ja...

kotlin和java开发哪个好,优缺点对比

Kotlin和Java都是常见的编程语言,它们有各自的优缺点。Kotlin的优点:简洁:Kotlin程序相对于Java程序更简洁,可以减少代码量。安全:Kotlin在类型系统和空值安全...

移动端架构模式全景解析:从MVC到MVVM,如何选择最佳设计方案?

掌握不同架构模式的精髓,是构建可维护、可测试且高效移动应用的关键。在移动应用开发中,选择合适的软件架构模式对项目的可维护性、可测试性和团队协作效率至关重要。随着应用复杂度的增加,一个良好的架构能够帮助...

颜值非常高的XShell替代工具Termora,不一样的使用体验!

Termora是一款面向开发者和运维人员的跨平台SSH终端与文件管理工具,支持Windows、macOS及Linux系统,通过一体化界面简化远程服务器管理流程。其核心定位是解决多平台环境下远程连接、文...

预处理的底层原理和预处理编译运行异常的解决方案

若文章对您有帮助,欢迎关注程序员小迷。助您在编程路上越走越好![Mac-10.7.1LionIntel-based]Q:预处理到底干了什么事情?A:预处理,顾名思义,预先做的处理。源代码中...

为“架构”再建个模:如何用代码描述软件架构?

在架构治理平台ArchGuard中,为了实现对架构的治理,我们需要代码+模型描述所要处理的内容和数据。所以,在ArchGuard中,我们有了代码的模型、依赖的模型、变更的模型等,剩下的两个...

深度解析:Google Gemma 3n —— 移动优先的轻量多模态大模型

2025年6月,Google正式发布了Gemma3n,这是一款能够在2GB内存环境下运行的轻量级多模态大模型。它延续了Gemma家族的开源基因,同时在架构设计上大幅优化,目标是让...

比分网开发技术栈与功能详解_比分网有哪些

一、核心功能模块一个基本的比分网通常包含以下模块:首页/总览实时比分看板:滚动展示所有正在进行的比赛,包含比分、比赛时间、红黄牌等关键信息。热门赛事/焦点战:突出显示重要的、关注度高的比赛。赛事导航...

设计模式之-生成器_一键生成设计

一、【概念定义】——“分步构建复杂对象,隐藏创建细节”生成器模式(BuilderPattern):一种“分步构建型”创建型设计模式,它将一个复杂对象的构建与其表示分离,使得同样的构建过程可以创建...

构建第一个 Kotlin Android 应用_kotlin简介

第一步:安装AndroidStudio(推荐IDE)AndroidStudio是官方推荐的Android开发集成开发环境(IDE),内置对Kotlin的完整支持。1.下载And...