springboot取配置文件值|SpringBoot有几种读取配置的方式

Ⅰ SpringBoot有几种读取配置的方式

常见的读取配置的方式有三种:第一、@Value注解,比较常用的一种方式。也支持与@propertySource注解何用,指定使用的配置文件第二、@Configuration注解,读取配置到类中,批量注入配置属性第三、Environment对象,获取配置文件中所有的属性的对象如果你想掌握时下热门微服务技术栈,跟上时代技术步伐,就去黑马程序员官网视频库看免费视频。

Ⅱ springboot中获取apollo或者nacos里的配置文件

常规的,在springboot中一般只需要拿appolo或者nacos里配置的属性就够了。 但是也有一些很特殊的场景,要拿到appolo或者nacos里配置的文件,比如有个第三方jar包提供的方法中,要求把properties配置文件路径传进去来初始化第三方jar包里需要用到的东西,这时候一般是把properties文件配置到appolo或者nacos里,但是如何直接拿到这个properties文件而不是里面的属性值呢? apollo里直接提供了把配置的相应namespace直接转换成file的方法: 再把这个content转换成输入流就可以用了 如果只是想拿到里面某个namespace的属性,则可以: key为属性key名,c.getPropertyNames()方法能拿到该namespace下面的所有属性,返回一个Set<String>集合,再遍历这个集合就能拿到所有属性。 nacos跟apollo的处理思路有点不一样,找了很多资料,貌似没有找到nacos里直接获取整个获取配置文件的方法,后面如果有同学找到了这个方法记得留言提醒我。 nacos在springboot启动的时候已经把所有配置文件都注入到了spring里。 第一种:可以直接用注解 @Value("${key}")来获取配置好的属性值 第二种:在java里获取: 新建SpringContextUtil实现org.springframework.context.ApplicationContextAware这个接口: 在启动类用注解导入该类:@Import({SpringContextUtil.class}) 利用org.springframework.core.env.Environment类来直接获取属性: 如果有这样一个需求,有个第三方的jar包要求初始化配置好的properties文件,只给了properties文件的路径传参,只能用文件路径的方式初始化这个第三方jar包,那么我们就必须保证项目里或者其他文件夹有这个properties文件才可以,而这些配置如果经常要变的话,最好也是配置在nacos或者apollo,如此看来,apollo是可以直接把配置的相应namespace直接转换成file,而nacos大概只能把所有属性手工生成一个新的properties文件来保存到本地了。 这个生成文件的过程,要在springboot启动之后立即执行: 那我们就要建一个配置类实现org.springframework.beans.factory.InitializingBean这个接口,重写afterPropertiesSet()方法:把需要启动后执行的逻辑放在里面,下面是一个示例: 把这个类在启动类里注入: 如此,在启动的时候就可以在本地生成一个cssconfig.properties文件了。 于是乎就可以类似这样调用第三方接口(根据第三方jar包来定):

Ⅲ Springboot打成JAR包后读取外部配置文件

Springboot的application.properties配置文件的加载路径优先歼念蔽级(从高到低):

当Springboot打成JAR包(不包含配置文件),读取外部配高薯置文件application.properties时,氏州可以选择:

Ⅳ springboot配置文件总结

springboot 本身支持多种灵活的配置方式,为开发 springboot 程序带来了很大的灵活性和扩展性,但是同时由于太灵活,经常会导致明明配置了相关属性,却没有生效。 本文总结了 springboot 配置文件的原理以及多个配置文件生效的顺序。 springboot 配置文件支持灵活的路径,以及灵活的文件名,用一个变量表达式总结如下: 部分源码如下: 当满足上述变量表达式的配置文件有多个时,会有一个配置的优先级。假设 上面每个条件组合起来,则最多有配置文件如下,且顺序从上到下: 获取属性时,按从上到下的顺序遍历由上述文件生成的属性资源对象 PropertySource ,如果遇到匹配的key直接返回。 总结一下:就是如果同一个key的属性只出现一次,则直接取该值即可。如果同一个key的属性出现多次,则取顺序靠前的属性资源对象。另外其中每个文件都是可选的。 需要注意的一点是:如果在同一个 location 下配置了多个文件名一样的文件,则只会取一个,比如在 classpath:/ ,有如下两个文件 application.yml : 则只会根据 classloader 的 classpath 列表,选取第一个出现的文件。因为 springboot 加载配置文件时最底层是使用的下面的方法: 这两个方法只会获取 classloader 类的 ucp 属性里面第一个匹配到的值。如果对 springboot 自身的机制不满意,想获取所有的classpath:/路径下面的 applicaiton.yml 文件,可以使用下面的方法: 本文总结了 springboot 配置文件的原理以及多个配置文件生效的顺序。如果存在增加了配置文件或者在配置文件里面增加了属性却没有生效,可以参考上面的 springboot 配置文件表达式和配置文件生效顺序进行排查。 后面还会有一篇文章讨论基于 springboot 配置原理如何实现自定义的配置读取方式。

Ⅳ springboot读取.properties配置文件中的map和list类型配置参数

#map 第一种方式 data.person.name=zhangsan data.person.sex=man data.person.age=11 data.person.url=xxxxxxxx #map 第二种方式 data.person[name]=zhangsan data.person[sex]=man data.person[age]=11 data.person[url]=xxxxxxxx #list 第一种方式 data.list[0]=apple0 data.list[1]=apple1 data.list[2]=apple2 #list 第态毕缓二种方帆模式数搭 data.list=apple0,apple1,apple2

Ⅵ SpringBoot 如何优雅读取配置文件10分钟教你搞定

很多时候我们需要将一些常用的配置信息比如阿里云 oss 配置、发送短信的相关信息配置等等放到配置文件中。 下面我们来看一下 Spring 为我们提供了哪些方式帮助我们从配置文件中读取这些配置信息。 application.yml 内容如下: wuhan2020: 2020年初武汉爆发了新型冠状病毒,疫情严重,但是,我相信一切都会过去!武汉加油!中国加油!my-profile:name: Guide哥email: [email protected]:location: 湖北武汉加油中国加油books:    -name: 天才基本法description: 二十二岁的林朝夕在父亲确诊阿尔茨海默病这天,得知自己暗恋多年的校园男神裴之即将出国深造的消息——对方考取的学校,恰是父亲当年为她放弃的那所。    -name: 时间的秩序description: 为什么我们记得过去,而非未来?时间“流逝”意味着什么?是我们存在于时间之内,还是时间存在于我们之中?卡洛·罗韦利用诗意的文字,邀请我们思考这一亘古难题——时间的本质。    -name: 了不起的我description: 如何养成一个新习惯?如何让心智变得更成熟?如何拥有高质量的关系? 如何走出人生的艰难时刻? 1.通过 @value 读取比较简单的配置信息 使用 @Value("${property}") 读取比较简单的配置信息: @Value("${wuhan2020}")String wuhan2020; 需要注意的是 @value这种方式是不被推荐的,Spring 比较建议的是下面几种读取配置信息的方式。 2.通过@ConfigurationProperties读取并与 bean 绑定 LibraryProperties 类上加了 @Component 注解,我们可以像使用普通 bean 一样将其注入到类中使用。 importlombok.Getter;importlombok.Setter;importlombok.ToString;importorg.springframework.boot.context.properties.ConfigurationProperties;importorg.springframework.context.annotation.Configuration;importorg.springframework.stereotype.Component;importjava.util.List;@[email protected](prefix ="library")@[email protected]@{privateString location;privateList books;@[email protected]@ToStringstaticclassBook{        String name;        String description;    }} 这个时候你就可以像使用普通 bean 一样,将其注入到类中使用: packagecn.javaguide.readconfigproperties;importorg.springframework.beans.factory.InitializingBean;importorg.springframework.boot.SpringApplication;importorg.springframework.boot.autoconfigure.SpringBootApplication;/** *@authorshuang.kou */@ntsInitializingBean{privatefinalLibraryProperties library;(LibraryProperties library){this.library = library;    }publicstaticvoidmain(String[] args){        SpringApplication.run(.class,args);    }@(){        System.out.println(library.getLocation());        System.out.println(library.getBooks());    }} 控制台输出: 湖北武汉加油中国加油[LibraryProperties.Book(name=天才基本法, description……..] 3.通过@ConfigurationProperties读取并校验 我们先将application.yml修改为如下内容,明显看出这不是一个正确的 email 格式: my-profile:name: Guide哥email: [email protected] ProfileProperties 类没有加 @Component 注解。我们在我们要使用ProfileProperties 的地方使用@ EnableConfigurationProperties注册我们的配置 bean: importlombok.Getter;importlombok.Setter;importlombok.ToString;importorg.springframework.boot.context.properties.ConfigurationProperties;importorg.springframework.stereotype.Component;importorg.springframework.validation.annotation.Validated;importjavax.validation.constraints.Email;importjavax.validation.constraints.NotEmpty;/***@authorshuang.kou*/@[email protected]@[email protected]("my-profile")@{@NotEmptyprivateString name;@[email protected] email;//配置文件中没有读取到的话就用默认值privateBooleanhandsome =Boolean.TRUE;} 具体使用: packagecn.javaguide.readconfigproperties;importorg.springframework.beans.factory.InitializingBean;importorg.springframework.beans.factory.annotation.Value;importorg.springframework.boot.SpringApplication;importorg.springframework.boot.autoconfigure.SpringBootApplication;importorg.springframework.boot.context.properties.EnableConfigurationProperties;/** *@authorshuang.kou */@[email protected](ProfileProperties.class){privatefinalProfileProperties profileProperties;(ProfileProperties profileProperties){this.profileProperties = profileProperties;    }publicstaticvoidmain(String[] args){        SpringApplication.run(.class,args);    }@(){        System.out.println(profileProperties.toString());    }} 因为我们的邮箱格式不正确,所以程序运行的时候就报错,根本运行不起来,保证了数据类型的安全性: Binding to target org.springframework.boot.context.properties.bind.BindException:Failedtobindpropertiesunder'my-profile'to cn.javaguide.readconfigproperties.ProfileProperties failed:Property:my-profile.emailValue:[email protected]:classpathresource[application.yml]:5:10Reason:mustbeawell-formedemailaddress 我们把邮箱测试改为正确的之后再运行,控制台就能成功打印出读取到的信息: ProfileProperties(name=Guide哥, email=koushuang[email protected], handsome=true) [email protected]读取指定 properties 文件 importlombok.Getter;importlombok.Setter;importorg.springframework.beans.factory.annotation.Value;importorg.springframework.context.annotation.PropertySource;importorg.springframework.stereotype.Component;@[email protected]("classpath:website.properties")@[email protected]{@Value("${url}")privateString url;} 使用: @Autowiredprivate WebSite webSite;System.out.println(webSite.getUrl());//https://javaguide.cn/ 5.题外话:Spring 加载配置文件的优先级 Spring 读取配置文件也是有优先级的,直接上图:原文链接:https://www.toutiao.com/a6791445278911103500/?log_from=7f5fb8f9b4b47_1640606437752

Ⅶ SpringBoot 配置文件详解(告别XML)

快速学会和掌握 SpringBoot 的 核心配置文件的使用。

SpringBoot 提供了丰富的 外部配置 ,常见的有:

其中核心配置文件我们并不陌生,主要以Key-Value的形式进行配置,其中属性Key主要分为两种:

在 application.properties 添加配置如下:

① 添加数据源信息

在 application.propertis 添加配置如下:

① 添加认证信息,其中 socks.indentity.* 是自定义的属性前缀。

② 添加随机值,其中spring.test.* 是自定义的属性前缀。

使用方法: @ConfigurationProperties(prefix = “spring.datasource”)

使用说明:提供 Setter方法 和 标记组件 Component

如何验证是否成功读取配置?答:这里可以简单做个验证,注入 MyDataSource ,使用 Debug 模式可以看到如下信息:

使用方法: @Value(“spring.datasource.*”)

使用说明:提供 Setter方法 和 标记组件 Component

注意事项:@Value不支持注入静态变量,可间接通过Setter注入来实现。

关于两者的简单功能对比:

显然,前者支持松绑定的特性更强大,所以在实际开发中建议使用@ConfigurationProperties来读取自定义属性。

SpringBoot 默认会加载这些路径加载核心配置文件,按优先级从高到低进行排列:具体规则详见 ConfigFileApplicationListener

如果存在多个配置文件,则严格按照优先级进行覆盖,最高者胜出:

举个简单的例子,例如再上述位置都有一个application.properties ,并且每个文件都写入了server.port=xx (xx分别是9001,9002,9003,9004),在启动成功之后,最终应用的端口为:9004。图例:

如果想修改默认的加载路径 或者 调改默认的配置文件名,我们可以借助命令行参数进行指定,例如:

YAML是JSON的一个超集,是一种可轻松定义层次结构的数据格式。

答: 因为配置文件这东西,结构化越早接触越规范越好。这里推荐阅读阮一峰老师写的 YAML语言教程 ,写的很简单明了。

引入依赖: 在POM文件引入 snakeyaml 的依赖。

使用说明: 直接在类路径添加 application.yml 即可。

例如下面这两段配置是完全等价的:

① 在 application.yml 配置数据源:

② 在 application.properties 配置数据源:

在项目的实际开发中,我们往往需要根据不同的环境来加载不同的配置文件。例如生产环境,测试环境和开发环境等。此时,我们可以借助 Profiles 来指定加载哪些配置文件。例如:

温馨提示:如果spring.profiles.active指定了多个配置文件,则按顺序加载,其中最后的优先级最高,也就是最后的会覆盖前者。

使用方法: 使用Maven插件打包好项目,然后在当前路径,执行DOS命令: java -jar demo.jar –server.port=8081 ,在控制台可看到应用端口变成了8081。

实现原理: 默认情况下,SpringBoot会将这些命令行参数转化成一个 Property ,并将其添加到 Environment 上下文。

温馨提示: 由于命令行参数优先级非常之高,基本高于所有常见的外部配置,所以使用的时候要谨慎。详见 PropertySource 执行顺序 。

关闭方法: 如果想禁用命令行属性,可以设置如下操作:springApplication.setAddCommandLineProperties(false)

Ⅷ Kotlin + Spring Boot 使用@Value读取配置文件

TL;DR 在做的一个项目遇到这个问题凳掘,需要把server.host存在application.properties里面,但是在取value 的时候遇到了问题,总是提示 ”lateinit property *** has not been initialized“,找遍了和so 都没有太好的答案,多方参考以后终于才解决这个小问题。 这个问题猜返的存在是因为在spring 跑到@service class的时候,我们还没有取到配置文件里面的value, 所以导致了穗粗饥spring 认为这个value variable没有initialize。 解决方案就是把你要取的value放到class的constructor里面去,下面提供一个简单的example。 -application.properties -Service.kt Reference: Kotlin Doc – Constructor Another code example

Ⅸ Springboot 读取配置文件原理

Springboot 读取配置文件(application.yaml, application.properties)的过程发生在SpringApplication#prepareEnvironment() 阶段,而prepareEnvironment又属于整个Springboot 应用启动的非常前置阶段,因为Environment的准备是后续bean创建的基础。让我们来一探启动是的详细code。除去StopWatch这些code,可以发现prepareEnvironment 发生在SpringApplication#run 这在整个应用启动的多步实质性操作中几乎是第一步。

而prepareEnvironment中最重要的是通过触发listener(EventPublishingRunListener)来通过#multicastEvent发出。

而#multicastEvent的实现其实也很简单,找到相关的监听的listener,然后一个个的调用他们的Listener#onApplicationEvent(event)方法,而这其中就包括了处理configuration文件的listener。 在Springboot 2.4.0 之前这个处理configuration 文件的lister是ConfigFileApplicationListener,在2.4.0之后,处理configuration 文件的lister是,并且对configuration文件的加载做了较大的改变,导致一些行为可能出现了变化,这也就是下面要详细讲的内容。

Springboot 2.4.0之后,configuration 文件的load顺序按照优先级是如下顺序(序号大的会被小的覆盖):

和之前版本比较,整体的属性加载顺序并无调整,只有Application properties(14,15)这里有顺序的调整,具体调整为:

如果存在多个active的profiles,例如[Test, Dev], 那么对于同时存在两个profile 配置文件中的配置,后面的profile里的配置(Dev)会覆盖前面profile(Test)里配置的值。

前面讲了这么多,终于要引出Springboot 2.4之后配置文件加载的行为变化了。

考虑这样的情况,如果我想在跑Springboot test的时候指定特定的profile,那么可以在Test class中加入@ActiveProfile(“Test”)。 如果我的应用中存在的某个自定义listener中,会根据当前environment 设置profile,如env.addActiveProfile(“Dev”)。 当前就会有两个active profile,由于springboot-test会在调用application#run 前利用DefaultActiveProfilesResolver把@ActiveProfile注解定义的profile(Test)先加入了active的profile,等test run的时候 env.addActiveProfile(“Dev”) 又会把”Dev”也作为active profile 加入,这时候当前的active profile便为[“Test”, “Dev”]。

据上面介绍,后面的profile(Dev)对应的configuration 会覆盖前面的(Test)。可Springboot 2.4.0之前的版本为我们做了调整,让Test class中@ActiveProfile内定义的profile所对应的配置文件成为最高优先级。

刚才提到在Springboot 2.4.0 之前这个处理configuration 文件的lister是ConfigFileApplicationListener,我们 来看看ConfigFileApplicationListener的相关code。

查看initializeProfiles(),发现此时对profile的顺序做了调整,将activatedViaProperty (Test) 放在最后add,于是profile的顺序就变成了[Dev, Test]。

在profiles.poll()时原本profile的顺序已经倒了过来,已经变为[Dev, Test], 在load()方法中由于后置的Test profile,application-Test.yaml中的值最终生效了。

可是到了Springboot2.4.0之后,ConfigFileApplicationListener被deprecated了,取而代之的是,通过调用来完成configuration加载。 .java

.java

只是老老实实的set了active profile,并没有调换profile的顺序。最后调用定义在spring.factories中的resource loader class来load 配置文件。

YamlPropertySourceLoader.java

插一句,Springboot为我们提供了很好的yaml文件parse的code,当你需要解析yaml文件时不妨直接参考Springboot的YamlPropertySourceLoader

这样一旦应用升级到Springboot 2.4.0之后相同的test code会使用application-Dev.yaml中配置的值,造成了test结果的改变。 如果要解决这个问题,根据上面介绍的配置文件优先级顺序,可以在@SpringbootTest中设置properties 来作为最终的配置覆盖当前profile对应的配置。

了解一个框架很不容易,一个小小的变化都有可能造成应用的行为变化,唯有刨根问底,不断总结才是framework人解决一切问题的不变的方法论。


赞 (0)