百度360必应搜狗淘宝本站头条
当前位置:网站首页 > 技术分析 > 正文

详细介绍一下在Spring Boot中有几种读取配置文件的方式?

liebian365 2025-01-16 20:06 18 浏览 0 评论

Spring Boot中提供了很多的配置文件读取操作,可以通过不同的方式读取到放在不同的位置的配置文件,方便了在不同环境中进行定制化的配置操作,下面我们就来详细介绍一下在Spring Boot中常用的一些配置文件读取方式并且讨论一下这些实现方式的优缺点。

Spring Boot 配置文件概述

在Spring Boot中的配置文件主要支持了如下的两种格式。

  • application.properties:传统的键值对配置文件,适用于简单的配置。
  • application.yml:基于 YAML 的配置文件,层次结构清晰,适合复杂配置。

在默认情况下,SpringBoot项目启动的时候,会在项目的src/main/resources目录下去查找这个两个后缀的文件,如果项目中同时存在了application.properties 和 application.yml,那么默认清理下Spring Boot会优先读取application.yml配置文件。

读取配置文件的方式

使用@Value注解读取配置

@Value注解是由Spring框架提供的一种简单的配置文件读取配置方式,我们可以通过这个注解将配置文件中配置的数据值存储到类对象属性中,如下所示。

# application.yml
app:
  name: My Spring Boot App
  version: 1.0.0

配置类文件如下所示。

import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;

@Component
public class AppConfig {

    @Value("${app.name}")
    private String appName;

    @Value("${app.version}")
    private String appVersion;

    public String getAppName() {
        return appName;
    }

    public String getAppVersion() {
        return appVersion;
    }
}

这种方式适合一些小型应用的配置文件的读取,通过${} 语法可以轻松实现配置文件与配置类属性的绑定操作,但是这种方式不适合一些复杂对象的配置,例如配置对象、配置数组等,如果需要多个配置项进行选择的话这种方式就不适用了。

使用@ConfigurationProperties注解读取配置

@ConfigurationProperties注解是一个比较灵活且好用的配置方式读取注解,通过这个注解可以直接与将配置文件与Java的配置类属性进行映射,方便读取。如下所示。

# application.yml
app:
  name: My Spring Boot App
  version: 1.0.0
  owner:
    name: John Doe
    email: john.doe@example.com

对应的配置类文件如下所示。

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;

@Component
@ConfigurationProperties(prefix = "app")
public class AppConfig {

    private String name;
    private String version;
    private Owner owner;

    public static class Owner {
        private String name;
        private String email;

        // Getters and setters
    }

    // Getters and setters for name, version, and owner
}

通过上面的操作可以看出,这种方式适合一些层次化的配置操作,可以支持多值绑定,通过与Java类的映射可以提供灵活方便的配置使用,相比于@Value注解的话这种方式可能更复杂一些,需要手动完成类对象和配置文件的映射操作,所以比较繁琐。

使用Environment对象读取配置

当然除了上面的方式之外,Spring 提供的Environment对象也可以用来进行配置信息的读取操作,我们可以通过Environment来获取到任意的配置属性操作,适合于需要进行动态配置的场景中进行使用,如下所示。

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.EnvironmentAware;
import org.springframework.core.env.Environment;
import org.springframework.stereotype.Component;

@Component
public class AppConfig implements EnvironmentAware {

    private Environment environment;

    @Autowired
    public void setEnvironment(Environment environment) {
        this.environment = environment;
    }

    public String getAppName() {
        return environment.getProperty("app.name");
    }

    public String getAppVersion() {
        return environment.getProperty("app.version");
    }
}

这种方式通过动态灵活访问的配置,可以在代码运行时根据环境变量来读取配置,这种方式要比@Value注解更加灵活通过动态的逻辑代码来调整配置文件的读取。相比于@Value 注解和 @ConfigurationProperties 来说Environment方式的代码更加的复杂,如果配置项太多的话这个代码就显的冗余很多。

通过 ConfigFileApplicationListener 读取外部配置文件

Spring Boot中还支持了通过
ConfigFileApplicationListener监听的方式来读取外部的配置文件,它允许我们在命令行启动项目的时候指定配置文件的位置,--spring.config.location参数来指定配置文件来进行读取。

java -jar myapp.jar --spring.config.location=file:/path/to/external/application.yml

这种方式允许了动态指定配置文件操作,支持了多环境的配置部署,另外配置文件可以放在远程的路径上增加了配置读取的灵活性,但是这种方式需要手动指定配置,增加了运维的难度,也需要保证配置文件的安全性。

通过@PropertySource注解读取额外的配置文件

在Spring中还提供了@PropertySource注解来加载非默认路径下的配置文件,一般情况下可以与@Configuration配合使用增加了配置的灵活性还可以读取外部的 .properties文件,使得配置操作更加灵活。

import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.PropertySource;

@Configuration
@PropertySource("classpath:external-config.properties")
public class AppConfig {
    // 这里可以使用 @Value 来读取 external-config.properties 中的属性
}

通过这种方式我们可以指定外部路径中的配置文件,整合@Configuration可以提供更多的灵活的配置。但是这种方式仅支持了.properties 文件,而且需要手动进行配置文件的操作,增加了运维的复杂度。

总结

在Spring Boot中,读取配置文件的方式有很多种,每种方式适用于不同的场景和需求。选择合适的方式可以提高代码的可读性和维护性。根据项目的复杂度、配置项的层次结构以及是否需要动态读取配置,选择最合适的方式来管理Spring Boot应用的配置文件。

相关推荐

4万多吨豪华游轮遇险 竟是因为这个原因……

(观察者网讯)4.7万吨豪华游轮搁浅,竟是因为油量太低?据观察者网此前报道,挪威游轮“维京天空”号上周六(23日)在挪威近海发生引擎故障搁浅。船上载有1300多人,其中28人受伤住院。经过数天的调...

“菜鸟黑客”必用兵器之“渗透测试篇二”

"菜鸟黑客"必用兵器之"渗透测试篇二"上篇文章主要针对伙伴们对"渗透测试"应该如何学习?"渗透测试"的基本流程?本篇文章继续上次的分享,接着介绍一下黑客们常用的渗透测试工具有哪些?以及用实验环境让大家...

科幻春晚丨《震动羽翼说“Hello”》两万年星间飞行,探测器对地球的最终告白

作者|藤井太洋译者|祝力新【编者按】2021年科幻春晚的最后一篇小说,来自大家喜爱的日本科幻作家藤井太洋。小说将视角放在一颗太空探测器上,延续了他一贯的浪漫风格。...

麦子陪你做作业(二):KEGG通路数据库的正确打开姿势

作者:麦子KEGG是通路数据库中最庞大的,涵盖基因组网络信息,主要注释基因的功能和调控关系。当我们选到了合适的候选分子,单变量研究也已做完,接着研究机制的时便可使用到它。你需要了解你的分子目前已有哪些...

知存科技王绍迪:突破存储墙瓶颈,详解存算一体架构优势

智东西(公众号:zhidxcom)编辑|韦世玮智东西6月5日消息,近日,在落幕不久的GTIC2021嵌入式AI创新峰会上,知存科技CEO王绍迪博士以《存算一体AI芯片:AIoT设备的算力新选择》...

每日新闻播报(September 14)_每日新闻播报英文

AnOscarstatuestandscoveredwithplasticduringpreparationsleadinguptothe87thAcademyAward...

香港新巴城巴开放实时到站数据 供科技界研发使用

中新网3月22日电据香港《明报》报道,香港特区政府致力推动智慧城市,鼓励公私营机构开放数据,以便科技界研发使用。香港运输署21日与新巴及城巴(两巴)公司签署谅解备忘录,两巴将于2019年第3季度,开...

5款不容错过的APP: Red Bull Alert,Flipagram,WifiMapper

本周有不少非常出色的app推出,鸵鸟电台做了一个小合集。亮相本周榜单的有WifiMapper's安卓版的app,其中包含了RedBull的一款新型闹钟,还有一款可爱的怪物主题益智游戏。一起来看看我...

Qt动画效果展示_qt显示图片

今天在这篇博文中,主要实践Qt动画,做一个实例来讲解Qt动画使用,其界面如下图所示(由于没有录制为gif动画图片,所以请各位下载查看效果):该程序使用应用程序单窗口,主窗口继承于QMainWindow...

如何从0到1设计实现一门自己的脚本语言

作者:dong...

三年级语文上册 仿写句子 需要的直接下载打印吧

描写秋天的好句好段1.秋天来了,山野变成了美丽的图画。苹果露出红红的脸庞,梨树挂起金黄的灯笼,高粱举起了燃烧的火把。大雁在天空一会儿写“人”字,一会儿写“一”字。2.花园里,菊花争奇斗艳,红的似火,粉...

C++|那些一看就很简洁、优雅、经典的小代码段

目录0等概率随机洗牌:1大小写转换2字符串复制...

二年级上册语文必考句子仿写,家长打印,孩子照着练

二年级上册语文必考句子仿写,家长打印,孩子照着练。具体如下:...

一年级语文上 句子专项练习(可打印)

...

亲自上阵!C++ 大佬深度“剧透”:C++26 将如何在代码生成上对抗 Rust?

...

取消回复欢迎 发表评论: