SpringBoot 读取配置文件的4种方式

devtools/2024/9/25 7:57:27/

文章目录

  • 1. @Value 注解读取单个属性
  • 2. 使用 @ConfigurationProperties 注解
  • 3. 通过 Environment 对象读取属性
  • 4. 使用 @PropertySource 注解加载额外的配置文件

在 Spring Boot 中,application.yml 文件用于配置应用程序的属性,Spring Boot 默认会从 src/main/resources 目录下的 application.propertiesapplication.yml 文件中读取配置。读取 application.yml 文件中的配置可以通过以下几种常用的方法进行:

  1. @Value: 适合读取简单的单一属性。
  2. @ConfigurationProperties: 适合读取复杂的配置集。
  3. Environment: 适合在运行时动态访问配置。
  4. @PropertySource: 加载 .properties 文件。

1. @Value 注解读取单个属性

@Value 注解用于读取单一简单的配置属性,该注解可以直接应用于字段、构造函数或方法参数上,不要求提供 Setter 方法。

  1. application.yml 配置文件中添加如下配置:

    app:name: MyAppkeys:- key1- key2
    
  2. 使用 @Value 注解从配置文件中读取单个属性值:

    1. 字段注入:将 @Value 注解应用于字段,Spring 将直接将配置值注入到字段中。

      java">@Component
      public class MyComponent {@Value("${app.name}")private String name;}
      
    2. 构造函数注入@Value 也可以用于构造函数参数。

      java">@Component
      public class MyComponent {private final String name;public MyComponent(@Value("${app.name}") String name) {this.name = name;}}
      
    3. 方法参数注入@Value 注解用于方法参数。

      java">@Component
      public class MyComponent {private String name;@Value("${app.name}")public void setKeys(String name) {this.name = name;}}
      

注意:@Value 注解无法处理复杂的配置,如集合,如下处理会在应用启动时抛出 IllegalArgumentException 异常:Could not resolve placeholder 'app.keys' in value "${app.keys}"

java">@Value("${app.keys}")
private List<String> keys;

2. 使用 @ConfigurationProperties 注解

@ConfigurationProperties 用于将配置文件中的属性绑定到 Java 对象中。适合处理结构化的配置,比如嵌套的属性或复杂的属性集合。

  1. application.yml 配置文件中添加如下配置:

    app:name: MyAppkeys:- key1- key2
    
  2. 在类上使用 @ConfigurationProperties 注解,并指定前缀,该类会直接映射配置文件中的属性名一致属性:

    java">@Component
    @ConfigurationProperties(prefix = "app")
    public class AppProperties {private List<String> keys;}
    

注意:@ConfigurationProperties 读取配置时需要确保配置文件中的属性名与 Java 类中的属性名匹配。

3. 通过 Environment 对象读取属性

Environment 是 Spring 中用于管理和访问配置属性、配置文件和环境变量的一个抽象接口,该对象提供了一种管理和访问配置属性、激活的配置文件和环境变量的统一方式。我们可以在任何 Spring 管理的 bean 中通过注入 Environment 对象来获取配置属性。

  1. application.yml 配置文件中添加如下配置:

    app:name: MyAppkeys:- key1- key2
    
  2. 在类中注入 Environment 对象,使用env.getProperty(String key)来检索属性的值。

    java">@Component
    public class MyComponent {@Autowiredprivate Environment env;public void printConfig() {String port = env.getProperty("server.port");System.out.println("Server Port: " + port);}
    }
    

注意:Environment 在加载 YML 配置文件时,会将每个元素视为单独的键。

application.yml 文件中的配置:

yamlCopy Codeapp:keys:- key1- key2- key3

Environment 中,将被处理为:

  • app.keys[0] 对应 key1
  • app.keys[1] 对应 key2
  • app.keys[2] 对应 key3

因此对于复杂配置需要特殊处理,例如获取集合元素需要使用类似数组索引的语法来访问 YAML 文件中的列表元素。

4. 使用 @PropertySource 注解加载额外的配置文件

@PropertySource 注解是 Spring Framework 提供的一个注解,用于加载额外 .properties 配置文件或其他资源文件中的属性到 Spring 的 Environment 中。

  1. src/main/resources 目录下创建 config.properties 的属性文件:

    app.name=MyApp
    app.version=1.0.0
    
  2. 在配置类上使用 @PropertySource 注解来加载配置文件:

    java">@Configuration
    @PropertySource("classpath:config.properties")
    //@PropertySource({"classpath:config.properties", "classpath:another-config.properties"})
    public class AppConfig {}
    
  3. 使用 @Value 注解或 Environment 对象获取属性:

    java">import org.springframework.beans.factory.annotation.Value;
    import org.springframework.stereotype.Component;@Component
    public class MyComponent {@Value("${app.name}")private String appName;@Autowiredprivate Environment env;public void printAppInfo() {System.out.println("App Name: " + appName);String appVersion = env.getProperty("app.version");System.out.println("App Version: " + appVersion);}
    }
    

注意: 如果需要加载多个属性文件,可以在 @PropertySource 注解中使用 value 属性指定多个文件路径:

java">@PropertySource({"classpath:config.properties", "classpath:another-config.properties"})
  1. 路径classpath: 前缀表示文件在类路径中。如果文件位于文件系统的其他位置,你可以使用文件系统路径,例如 file:/path/to/config.properties
  2. 覆盖@PropertySource 加载的属性文件中的属性会覆盖同名的系统属性,但不会覆盖由 Spring Boot 的 application.propertiesapplication.yml 文件中定义的属性。
  3. 顺序:如果多个属性文件定义了同一个属性,后加载的文件中的属性值会覆盖先加载的文件中的值。

http://www.ppmy.cn/devtools/111390.html

相关文章

智能赋能,Vatee万腾平台助力企业升级新高度

在当今这个日新月异的数字时代&#xff0c;智能技术的飞速发展正以前所未有的力量重塑着各行各业的面貌。作为这一变革浪潮中的佼佼者&#xff0c;Vatee万腾平台凭借其卓越的智能赋能能力&#xff0c;正引领众多企业迈向转型升级的新高度&#xff0c;开启了智能化发展的新篇章。…

Vue3+TS项目给el-button统一封装一个点击后转圈效果的钩子函数按钮防抖

前言 每个按钮都要单独定义一个loading变量&#xff0c;并且在接口请求前修改为true&#xff0c;接口响应后再修改为false&#xff0c;封装后这段重复的逻辑就可以统一管理不用每次都写一遍了。 效果 新建一个公共的src\common.ts import { ref } from "vue"expor…

【即时通讯】轮询方式实现

技术栈 LayUI、jQuery实现前端效果。django4.2、django-ninja实现后端接口。 代码仓 - 后端 代码仓 - 前端 实现功能 首次访问页面并发送消息时需要设置昵称发送内容为空时要提示用户不能发送空消息前端定时获取消息&#xff0c;然后展示在页面上。 效果展示 首次发送需要…

手机玩机常识-------谷歌系列机型解锁bl详细步骤 其他机型可以借鉴参考

谷歌公司自从在2005年收购了Android公司之后一直在开发一款手机操作系统&#xff0c;谷歌的这一举动正是为了推出自己的手机而作准备.目前。谷歌Pixel 系列为很多玩家所持有。其独特的安装原生系统为很多粉丝所青睐。今天我们来看看谷歌Pixel 系列机型解锁bl的相关常识 谷歌Pi…

【nginx】Nginx 缓存的工作原理

Nginx 的缓存功能可以显著提高网站的性能和用户体验&#xff0c;它通过缓存静态资源&#xff08;如图片、CSS、JavaScript 等&#xff09;来减少服务器的负载&#xff0c;并加快网页的加载速度。 Nginx 缓存的工作原理&#xff1a; 请求到达 Nginx&#xff1a; 当用户请求一个…

哨兵机制Sentinel

哨兵机制Sentinel 主从复制&#xff1a;读写分离&#xff0c;多读少写&#xff0c;单点故障&#xff08;主机宕机&#xff0c;从机不能自动切换&#xff09;&#xff0c;负载压力&#xff08;客户端请求&#xff0c;并发&#xff09;&#xff0c;数据集中存储&#xff08;主从…

【机器学习】高斯过程的基本概念和应用领域以及在python中的实例

引言 高斯过程&#xff08;Gaussian Process&#xff0c;简称GP&#xff09;是一种概率模型&#xff0c;用于描述一组随机变量的联合概率分布&#xff0c;其中任何一个有限维度的子集都具有高斯分布 文章目录 引言一、高斯过程1.1 基本定义1.1.1 随机过程1.1.2 高斯分布 1.2 高…

第二章算法设计题

1设线性表存放在向量A[arrsize]的前elenum个分量中&#xff0c;且递增有序。试写一算法&#xff0c;将x插入到线性表的适当位置上&#xff0c;以保持线性表的有序性&#xff0c;并且分析算法的时间复杂度。 【提示】直接用题目中所给定的数据结构&#xff08;顺序存储的思想是…