草庐IT

你绝对不知道的 SpringBoot 的外部化配置特性!

了不起 2023-03-28 原文
作为 Java​ 程序员,相信大家都知道,我们日常的 SpringBoot​ 项目会有一个配置文件 application.properties 文件。

里面会配置很多参数,例如服务的端口等,这些都只是默认值,在不改变配置文件里面内容的情况下,我们可以通过在部署的时候,传递一个相应的参数来替换默认的参数。

那么问题来了,你有想过为什么可以这样吗?为什么 SpringBoot 部署时传递的启动配置会生效,而配置文件中的配置就不生效了呢?或者说这两者的优先级是什么样子的呢?

外部化配置

要解释上面的问题,我们就需要知道 SpringBoot 到底支持哪些配置形式,以及这些配置方式的优先级是什么样子的,只有搞清楚了这个,才能真正的解决配置的优先级问题。

在 SpringBoot 的官方文档中我们可以看到这么一段描述

用了不起我拙劣的英语翻译一下,大概的意思就是:Spring Boot​ 提供了将配置文件外部化的功能,这样您就可以在不同环境下使用相同的应用程序代码。您可以使用 properties​ 文件、YAML 文件、环境变量以及命令行参数来外部化配置文件。

通过 @Value​ 注解,属性值可以直接注入到 beans​ 中,通过 Environment abstraction​(环境映射)可以访问其他位置,或者使用 @ConfigurationProperties 绑定结构化对象。

有哪些外部配置

既然上面提到了 SpringBoot​ 提供了外部化配置,那么 SpringBoot 提供了哪些配置呢?依然是通过官方文档,我们可以看到有如下配置列表

从上图可以看到 SpringBoot 总共内置了 17 种外部化配置方法,而且这 17 种的优先级是从上到下依次优先的。这些方式中我们常用的有 4 命令行方法,9 Java 系统环境变量,10 操作系统环境变量,以及 12 到 15 到配置文件的形式。

通过上面的顺序我们就可以解释为什么我们通过命令行配置的参数会生效,而配置文件中的默认值就会忽略了,从而达到了覆盖配置的目的。

PropertySource

上面的文档中也提到了,SpringBoot​ 主要是通过 PropertySource​ 机制来实现多样属性源的,SpringBoot​ 的 PropertySource​ 是一种机制,用于加载和解析配置属性,可以从多种来源获取这些属性,例如文件、系统环境变量、JVM​ 系统属性和命令行参数等。PropertySource​ 是 Spring 框架中的一个抽象接口,它定义了如何读取属性源的方法。

通过 SpringBoot​ 的代码,我们可以看到,org.springframework.core.env.PropertySource​ 是一个抽象类,实现在子类有很多,我们上面提到的命令行 PropertySource​ 是 org.springframework.core.env.CommandLinePropertySource。整体的类图如下,涵盖的内容还是很多的,感兴趣的小伙伴可以好好研究一番。

另外在 SpringBoot​ 中,我们还可以使用 @PropertySource 注解来自定义指定要加载的属性文件。例如,可以在应用程序的主类上添加以下注解:

@SpringBootApplication
@PropertySource("classpath:customer.properties")
public class CustomerProperties {
// ...
}
这将告诉 SpringBoot​ 在 classpath​ 下查找名为 customer.properties​ 的文件,并将其加载为属性源。然后,可以使用 @Value​注解将属性值注入到 bean 中,如下所示:

@Service
public class MyService {
@Value("${my.property}")
private String myProperty;
// ...
}
这里的 ${my.property}​ 是从 customer.properties​ 文件中获取的属性值。如果找不到该属性,那么 SpringBoot 将使用默认值,这里因为是自定义的属性,是没有默认值的,就会报错,项目无法启动。

具体实现是,SpringBoot​ 在启动时会自动加载和解析所有的 PropertySource​,包括默认的 PropertySource​ 和自定义的PropertySource​。这些属性值被存储在 Spring​ 环境中,可以通过 Spring​ 的 Environment​ 对象访问。当属性被注入到 bean​ 中时, Spring​ 会查找 Environment 对象并尝试解析属性的值。

总之,SpringBoot​ 的 PropertySource​ 提供了一种简单的方法来加载和解析应用程序的配置属性,这些属性可以从多个来源获取。它通过将属性值存储在 Spring 环境中,使其易于在应用程序的不同部分中使用。

调试

为了验证上面说的命令行的参数配置要优先于配置文件,我们创建一个 SpringBoot 项目,并且在 application.properties​ 文件中配置一个参数 name=JavaGeekTech​,而在 IDEA 启动窗口中配置 name=JAVA_JIKEJUSHU,分别如下所示

在写一个简单的 HelloController​ 类,并且通过 @Value​ 注解注入 name​ 属性,接下来我们就需要调试看下,SpringBoot​是如何将 name​ 属性赋值的。通过验证 name​ 会被赋值成 JAVA_JIKEJISHU​ 而不是 JavaGeekTech。

package com.example.demo.controller;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class HelloController {

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

@GetMapping(value = "/hello")
public String hello() {
return helloService.sayHello(name);
}

}
接着我们启动 debug​,因为我们是基于 SpringBoot​ 的,属性的赋值是在创建 bean​ 的时候,从 createBean​,到 doCreateBean​,再到 org.springframework.beans.factory.support.AbstractAutowireCapableBeanFactory#populateBean​,因为每个 bean​ 都会经过很多 PostProcessor​ 的处理,属性赋值的 PostProcessor​ 是 org.springframework.beans.factory.annotation.AutowiredAnnotationBeanPostProcessor#postProcessProperties

里面的 metadata.inject​ 会调用到 org.springframework.beans.factory.annotation.AutowiredAnnotationBeanPostProcessor.AutowiredFieldElement#inject​,再到 org.springframework.beans.factory.annotation.AutowiredAnnotationBeanPostProcessor.AutowiredFieldElement#resolveFieldValue,

org.springframework.beans.factory.support.DefaultListableBeanFactory#resolveDependency,

org.springframework.beans.factory.support.DefaultListableBeanFactory#doResolveDependency,

org.springframework.beans.factory.support.AbstractBeanFactory#resolveEmbeddedValue,

org.springframework.core.env.AbstractPropertyResolver#resolveRequiredPlaceholders,

org.springframework.core.env.PropertySourcesPropertyResolver#getPropertyAsRawString,

org.springframework.core.env.PropertySourcesPropertyResolver#getProperty(java.lang.String, java.lang.Class<T>, boolean)

整体调用链还是挺长的,不过只要跟着思路,在配合断点,还是可以看看看出来的。

在 getProperty​ 方法中,我们可以看到如下的逻辑,根据 key​ 获取到的 value​ 值为JAVA_JIKEJISHU。

继续跟踪 getProperty​ 方法,我们可以看到这个方法 org.springframework.boot.context.properties.source.ConfigurationPropertySourcesPropertySource#findConfigurationProperty(org.springframework.boot.context.properties.source.ConfigurationPropertyName),

其中的 getSource() 中就有我们配置的两个属性源的数据,如下所示

根据代码逻辑,我们也可以看到,在迭代的时候,如果找到了一个就直接返回了,所以得到的结果是JAVA_JIKEJISHU。

总结

今天了不起带大家研究了一个 SpringBoot​ 的外部化配置,并且通过实际的一个 case 跟踪代码的调用链来给大家测试了一下,虽然说这个知识点我们经常都在使用,但是没看到底层源码的时候我们并不知道这样的一个功能底层是怎样的复杂的。

这里还是要敬佩一下 SpringBoot 的开发者,同时也建议大家,在日常的开发中我们需要多看看底层的源码,通过不断的看源码,我们能更好的理解特性的实现原理,从而加强我们自身的能力。


有关你绝对不知道的 SpringBoot 的外部化配置特性!的更多相关文章

  1. ruby-on-rails - 独立 ruby​​ 脚本的配置文件 - 2

    我有一个在Linux服务器上运行的ruby​​脚本。它不使用rails或任何东西。它基本上是一个命令行ruby​​脚本,可以像这样传递参数:./ruby_script.rbarg1arg2如何将参数抽象到配置文件(例如yaml文件或其他文件)中?您能否举例说明如何做到这一点?提前谢谢你。 最佳答案 首先,您可以运行一个写入YAML配置文件的独立脚本:require"yaml"File.write("path_to_yaml_file",[arg1,arg2].to_yaml)然后,在您的应用中阅读它:require"yaml"arg

  2. Ruby Sinatra 配置用于生产和开发 - 2

    我已经在Sinatra上创建了应用程序,它代表了一个简单的API。我想在生产和开发上进行部署。我想在部署时选择,是开发还是生产,一些方法的逻辑应该改变,这取决于部署类型。是否有任何想法,如何完成以及解决此问题的一些示例。例子:我有代码get'/api/test'doreturn"Itisdev"end但是在部署到生产环境之后我想在运行/api/test之后看到ItisPROD如何实现? 最佳答案 根据SinatraDocumentation:EnvironmentscanbesetthroughtheRACK_ENVenvironm

  3. Vscode+Cmake配置并运行opencv环境(Windows和Ubuntu大同小异) - 2

    之前在培训新生的时候,windows环境下配置opencv环境一直教的都是网上主流的vsstudio配置属性表,但是这个似乎对新生来说难度略高(虽然个人觉得完全是他们自己的问题),加之暑假之后对cmake实在是爱不释手,且这样配置确实十分简单(其实都不需要配置),故斗胆妄言vscode下配置CV之法。其实极为简单,图比较多所以很长。如果你看此文还配不好,你应该思考一下是不是自己的问题。闲话少说,直接开始。0.CMkae简介有的人到大二了都不知道cmake是什么,我不说是谁。CMake是一个开源免费并且跨平台的构建工具,可以用简单的语句来描述所有平台的编译过程。它能够根据当前所在平台输出对应的m

  4. 神州数码无线产品(AC+AP)配置 - 2

    注意:本文主要掌握DCN自研无线产品的基本配置方法和注意事项,能够进行一般的项目实施、调试与运维AP基本配置命令AP登录用户名和密码均为:adminAP默认IP地址为:192.168.1.10AP默认情况下DHCP开启AP静态地址配置:setmanagementstatic-ip192.168.10.1AP开启/关闭DHCP功能:setmanagementdhcp-statusup/downAP设置默认网关:setstatic-ip-routegeteway192.168.10.254查看AP基本信息:getsystemgetmanagementgetmanaged-apgetrouteAP配

  5. hadoop安装之保姆级教程(二)之YARN的配置 - 2

    1.1.1 YARN的介绍 为克服Hadoop1.0中HDFS和MapReduce存在的各种问题⽽提出的,针对Hadoop1.0中的MapReduce在扩展性和多框架⽀持⽅⾯的不⾜,提出了全新的资源管理框架YARN. ApacheYARN(YetanotherResourceNegotiator的缩写)是Hadoop集群的资源管理系统,负责为计算程序提供服务器计算资源,相当于⼀个分布式的操作系统平台,⽽MapReduce等计算程序则相当于运⾏于操作系统之上的应⽤程序。 YARN被引⼊Hadoop2,最初是为了改善MapReduce的实现,但是因为具有⾜够的通⽤性,同样可以⽀持其他的分布式计算模

  6. Ruby 默认将 IRB 配置为 Pretty_Inspect - 2

    我是ruby​​的新手,正在配置IRB。我喜欢pretty-print(需要'pp'),但总是输入pp来漂亮地打印它似乎很麻烦。我想做的是默认情况下让它漂亮地打印出来,所以如果我有一个var,比如说,'myvar',然后键入myvar,它会自动调用pretty_inspect而不是常规检查。我从哪里开始?理想情况下,我将能够向我的.irbrc文件添加一个自动调用的方法。有什么想法吗?谢谢! 最佳答案 irb中默认pretty-print对象正是hirb被迫去做。Theseposts解释hirb如何将几乎所有内容转换为ascii表。虽

  7. ruby - 从外部访问类的实例变量 - 2

    我理解(我认为)Ruby中类变量和类的实例变量之间的区别。我想知道如何从该类外部访问该类的实例变量。从内部(即在类方法中而不是实例方法中),它可以直接访问,但是从外部,有没有办法做MyClass.class.[@$#]variablename?我没有任何具体原因要这样做,只是学习Ruby并想知道是否可行。 最佳答案 classMyClass@my_class_instance_var="foo"class上述yield:>>foo我相信Arkku演示了如何从类外部访问类变量(@@),而不是类实例变量(@)。我从这篇文章中提取了上述内

  8. ruby - EventMachine - 你怎么知道你是否落后了? - 2

    我正在研究使用EventMachine支持的twitter-streamruby​​gem来跟踪和捕获推文。我对整个事件编程有点陌生。我如何判断我在事件循环中所做的任何处理是否导致我落后?有没有简单的检查方法? 最佳答案 您可以通过使用周期性计时器并打印出耗时来确定延迟。如果您使用的是1秒的计时器,您应该已经过了大约1秒,如果它更长,您就知道您正在减慢react器的速度。@last=Time.now.to_fEM.add_periodic_timer(1)doputs"LATENCY:#{Time.now.to_f-@last}"@

  9. ruby - 是否可以将 IRB 提示配置为动态更改? - 2

    我想在IRB中浏览文件系统并让提示更改以反射(reflect)当前工作目录,但我不知道如何在每个命令后进行提示更新。最终,我想在日常工作中更多地使用IRB,让bash溜走。我在我的.irbrc中试过这个:require'fileutils'includeFileUtilsIRB.conf[:PROMPT][:CUSTOM]={:PROMPT_N=>"\e[1m:\e[m",:PROMPT_I=>"\e[1m#{pwd}>\e[m",:PROMPT_S=>"FOO",:PROMPT_C=>"\e[1m#{pwd}>\e[m",:RETURN=>""}IRB.conf[:PROMPT_MO

  10. ruby - 如何配置 Ruby Mechanize 代理以通过 Charles Web 代理工作? - 2

    我正在使用Ruby/Mechanize编写一个“自动填写表格”应用程序。它几乎可以工作。我可以使用精彩CharlesWeb代理以查看服务器和我的Firefox浏览器之间的交换。现在我想使用Charles查看服务器和我的应用程序之间的交换。Charles在端口8888上代理。假设服务器位于https://my.host.com。.一件不起作用的事情是:@agent||=Mechanize.newdo|agent|agent.set_proxy("my.host.com",8888)end这会导致Net::HTTP::Persistent::Error:...lib/net/http/pe

随机推荐