『壹』 SpringBoot配置文件存放位置以及读取顺序
默认情况下,我们可以将application.properties或者application.yaml(为了方便演示,本文以下均以application.properties介绍)放置在如下四处: 1.1、idea中,为了我们本地方便开发测试,我们在此处创建一个config目录,然后把application.properties放进去,项目正常运行。jar包会自动生成在target目录下。 我们将生成的jar包,复制出来,到另外文件夹进行运行,比如,我现在该jar包复制到test目录下,但是这个时候是起不来,因为没有配置文件,虽然我们在idea里面是有config目录的,但是它并不没有被打包进去。我们要把config目录也复制过来,跟该jar包放在同一个目录下。 在此处,我们可以使用java -jar demo-0.01-SNAPSHOT来运行项目。 正常运行。 当我们将其打成jar包时,application.properties同样不会被打包进jar包中。需要另外复制出来和jar包放在才能正常运行。 推荐以上两种方式来放置配置文件,如果不写开发,测试,和生产好几套环境配置文件的话,就可以直接打开配置文件,改成自己需要的配置即可。 以下两种方式是将该配置文件打包在jar包里面了,即便只改一个端口号,开发人员先改配置文件,再打包,再运行。此处也记录下,并解开jar包,看下该配置文件被打包后,放置的位置。 打包后,如下图,jar包再target里面,我们寻找下application.properties文件。为了方便演示,我们将target目录下的demo-0.0.1-SNAPSHOT.jar放到一个新目录给它解压开,找下该配置文件,我放置到了一个test目录下。 解压后:如下图,我们进入目录 发现config目录被放置在classes目录下。然后这也就让我们明白了,什么是classpath?classpath的路径到底指的是哪里,在idea中我们就把它放置在resource目录,该目录就是表示classpath。而被打成jar包后classes目录就是所谓的classpath。 所有的yaml文件,同理。
『贰』 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有几种读取配置的方式
常见的读取配置的方式有三种:第一、@Value注解,比较常用的一种方式。也支持与@propertySource注解何用,指定使用的配置文件第二、@Configuration注解,读取配置到类中,批量注入配置属性第三、Environment对象,获取配置文件中所有的属性的对象如果你想掌握时下热门微服务技术栈,跟上时代技术步伐,就去黑马程序员官网视频库看免费视频。
『肆』 二、springboot配置文件
1. 配置文件 Spring Boot使用一个全局的配置文件 application.properties application.yml 配置文件的作用:修改Spring Boot自动配置的默认值,SpringBoot在底层都给我们自动 配置好。有什么配置项,可以移步官方文档 配置文件一般放在src/main/resources目录或者类路径/confifig下,当然还有很多位置可 以放,它们会有不同优先级,后面会讲到。 YAML (YAML Ain't Markup Language) 简单介绍 <!–绑定配置文件处理器,配置文件进行绑定的时候就会有提示–> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-configuration-processor</artifactId> <optional>true</optional> </dependency> <!– 将应用打包成一个可执行Jar包,直接使用java -jar xxxx的命令来执行 –> <build> <plugins> <plugin> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-maven-plugin</artifactId> </plugin> </plugins> </build>以前的配置文件:大多是xml .yml是YAML语言的文件,以数据为中 心,比json、xml等更适合做配置文件 全局配置文件的可以对一些默认配置值进行修改 配置实例 xml: yml: 2. YAML语法 基本语法 K:(空格)V 标识一对键值对 以空格的缩进来控制层级关系 只要是左对齐的一列数据,都是同一层级的 属性和值也是大小写敏感 实例: 值的写法 普通的值 k: v 字面量直接来写,字符串默认不用添加单引号 " " 双引号 不会转义字符串里面的特殊字符; <server> <port>8081</port> </server> server: port: 8081 server: port: 8081 path: /hello // 冒号后面的空格不要拉下' ' 单引号 会转义字符,特殊字符最终是一个普通的字符串 对象 普通写法: 行内写法 frends:{ lastName: zhang,age: 18 } Map 示例: maps: {k1: v1,k2: v2} 数组 普通写法: pets: // var onj = {pets: ['cat','pig','dog']} – cat – pig – dog 行内写法 pets:[cat, pig, dog] 配置文件获取 将配置文件中的每一个值映射到此组件中 1. Persion name: "wang \n qian" // 输出:wang 换行 qian frends: lastName: zhang age: 20package com.wrq.boot.bean; @Component @ConfigurationProperties(prefix = "persion") public class Persion { private String name; private int age; private double weight; private boolean boss; private Date birth; private Map<String,Object> maps; private List<Object> list; private Dog dog; 此处,这个bean的getter、setter和tostring方法已经省略,千万不能忽略! } @ConfifigurationProperties 意思是:我们类里面的属性和配置文件中的属性做绑定 不使用此注解,可以在bean的属性添加@value()注解,如下: @Component // @ConfigurationProperties(prefix = "persion") public class Persion { @value("${persion.name}") // $()读取配置文件、环境变量中的值 private String name; @value("#{11*2}") // #{SpEL} 采用表达式 private int age; @value("true") // 直接赋值 private boolean boos; } 此处采用@ConfifigurationProperties的方式,@value()和@ConfifigurationProperties的 区别见下方表格。prefifix = "persion" 配置文件中那个下面的属性来一一映射 @Component 如果想要这个注解起作用,必须放到容器里面 2. Dog package com.wrq.boot.bean; public class Dog { // 用作Persion中的属性 private String name; private int age; 此处,这个bean的getter、setter和tostring方法已经省略,千万不能忽略! } 3. 配置文件 方式一: application.yml persion: name: 王大锤 age: 18 weight: 125 boss: false birth: 2018/5/5 maps: {k1: v1,k2: v2} list: – wangli – wang dog: name: xiaogou age: 2方式二: application.propertiespersion.name = 王大锤 persion.age = 18 persion.weight = 125 persion.boss = false persion.birth = 2018/5/5 persion.maps.k1 = v1 persion.maps.k2 = v2 persion.dog.name = xiaogou persion.dog.age = 15 4. 测试类:BootApplicationTests package com.wrq.boot; @RunWith(SpringRunner.class) @SpringBootTest public class BootApplicationTests { @Autowired Persion persion; @Test public void contextLoads() { System.out.print(persion); } } 5. 运行 BootApplicationTests方法 控制台打印: application.yml的结果: Persion{name='王大锤', age=18, weight=125.0, boss=false, birth=Sat May 05 00:00:00 CST 2018, maps={k1=v1, k2=v2}, list=[wangli, wang], dog=Dog{name='xiaogou', age=2}} application.properties的结果: Persion{name='��Ǭ', age=18, weight=125.0, boss=false, birth=Sat May 05 00:00:00 CST 2018, maps={k2=v2, k1=v1}, list=[wangli, wang], dog=Dog{name='xiaogou', age=15}} 把Bean中的属性和配置文件绑定,通过yml文件和properties都可以做到,但是properties 文件出现乱码。 properties中文读取乱码:File->Settings->File Encodings最底部选utf-8、Tranparent打 上勾 注解比较 @value和@ConfifigurationProperties获取值比较名词解释: 松散绑定 last-name和lastName都可以获取导致,则代表支持松散绑定 [email protected] @ConfigurationProperties(prefix = "persion") // 如果使用的是@value注入值 时,无法使用校验 @Validated // 添加此注解 public class Persion { @Email // 配置文件书写的属性必须是邮箱格式,不符合报错! private String name; } 复杂类型封装 如果获取配置文件中map的值时,@value是获取不到值的 @value("${persion.maps}") // 由于使用的是@value,无法获取配置文件中的map private Map<String,Object> maps; @PropertySource @PropertySource:加载指定配置文件 @ConfifigurationProperties()默认是从全局配置文件中获取值,也就是 application.properties这个文件中获取值。 如果做的配置很多,全局的配置文件就会特别大,为了方便管理。我会创建不同的配置文 件定向管理不同的配置。 如创建persion.properties文件单独存放persion需要的配置 @PropertySource就是用来导入创建的配置文件 示例: 1. persion.properties 同时把两个全局的配置中关于Persion的配置都注释掉persion.name = 王弟弟 persion.age = 18 persion.weight = 125 persion.boss = false persion.birth = 2018/5/5 persion.maps.k1 = v1 persion.maps.k2 = v2 persion.dog.name = xiaogou persion.dog.age = 15 2. Persion package com.wrq.boot.bean; @Component @PropertySource(value = {"classpath:persion.properties"}) @ConfigurationProperties(prefix = "persion") public class Persion { private String name; private int age; private double weight; private boolean boss; private Date birth; private Map<String,Object> maps; private List<Object> list; private Dog dog; 此处,这个bean的getter、setter和tostring方法已经省略,千万不能忽略! } 这样运行测试类,控制台就可以打印persion.properties中的数据。 通过下面的注解,把类路径下的persion.properties加载进来。并且把persion开头的数 据进行绑定。 @PropertySource(value = {"classpath:persion.properties"})@ConfifigurationProperties(prefifix = "persion") @ImportResource @ImportResource:导入Spring的配置文件,让配置文件生效。 示例: 1. com.wrq.boot.service package com.wrq.boot.service; /** * Created by wangqian on 2019/1/12. */ public class HelloService { } 2. resources目录手动建立bean.xml <?xml version="1.0" encoding="UTF-8"?> <beans xmlns="http://www.springframework.org/schema/beans" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd"> <bean id="helloService" class="com.wrq.boot.service.HelloService"> </bean> </beans> 3. 测试类 package com.wrq.boot; @RunWith(SpringRunner.class) @SpringBootTest public class BootApplicationTests { @Autowired ApplicationContext ioc;@Test public void testConfig() { boolean b = ioc.containsBean("helloService"); System.out.print(b); } } 试图通过添加一个Spring的配置文件bean.xml来把HelloService注入进去。 运行测试类结果:false 结果表明IoC容器中并不包含HelloService,即:配置文件bean.xml没有生效 解决方式 方式一: 主程序中进行配置@ImportResouece注解 package com.wrq.boot; @ImportResource(locations = {"classpath:bean.xml"}) // 通过此配置是 bean.xml生效 @SpringBootApplication public class BootApplication { public static void main(String[] args) { //应用启动起来 SpringApplication.run(BootApplication.class, args); } } 方法二:通过配置类实现,这种方式也是Spring Boot推荐的 1. com.wrq.boot.confifigpackage com.wrq.boot.config; /** * Created by wangqian on 2019/1/12. */ @Configuration public class MyConfig { // 将方法的返回值添加到容器之中,并且容器中这个组件的id就是方法名 @Bean public HelloService helloService(){ System.out.print("通过@Bean给容器添加组件了.."); return new HelloService(); } } @Confifiguration标注这是一个配置类 通过@Bean注解,将方法的返回值添加到容器之中,并且容器中这个组件的id就是方 法名 2. 把主程序类中@ImportResource()配置注释掉 3. 测试成功,添加了HelloService()组件 3. 配置文件占位符 随机数 RandomValuePropertySource:配置文件中可以使用随机数 ${random.value} ${random.int} ${random.long} ${random.uuid} ${random.int(10)} ${random.int[1024,65536]} 属性配置占位符可以在配置文件中引用前面配置过的属性(优先级前面配置过的这里都能用) ${app.name:默认值}来指定找不到属性时的默认值 persion.name = 王弟弟${random.uuid} persion.age = ${random.int} persion.dog.name = ${persion.name}_dog 4. Profifile 多环境支持 Profifile是Spring对不同环境提供不同配置功能的支持,可以通过激活、 指定参数等方式 快速切换环境 1. 多Profifile的方式 格式:application-{profifile}.properties/yml application-dev.properties application-prod.properties 默认采用application.properties配置文件,如果使用别的,需要激活: 1. application.properties中配置: # 激活application-dev.properties配置文件 spring.profiles.active=dev 2. application-dev.properties: server.port=8082 3. 运行BootApplication主程序: 2019-01-12 20:46:09.345 INFO 14404 — [main] s.b.c.e.t. : Tomcat started on port(s): 8082 (http) 2. 多文档块的方式 除了上方多Profifile的方式来切换环境,也可以通过YAML多文档块的方式。示例: application.yml: server: port: 8081 spring: profiles: active: dev — spring: profiles: dev server: port: 8083 — spring: profiles: prod server: port: 8084 3. 激活指定Profifile 1. application.properties中配置: # 激活application-dev.properties配置文件 spring.profiles.active=dev 2. application.yml中配置 server: port: 8081 spring: profiles: active: dev — spring: profiles: dev server: port: 80833. 启动配置-参数 在IDE中,类似于配置tomcat的地方,按下方配置: Program arguments:–spring.profiles.active=dev 4. 启动配置-虚拟机 在IDE中,类似于配置tomcat的地方,按下方配置: VM options:-Dspring-profiles-active=dev 5. 命令行 使用Maven的package命令打包,移动到jar的目录。 java -jar spring-boot-project-config.jar –spring.profiles.active=dev 5. 配置文件优先级 GitHub对应项目:boot-confifig-position 优先级 Spring Boot 启动会扫描以下位置的application.properties或者 application.yml文件作 为Spring boot的默认配置文件 fifile:./confifig/ (项目根目录confifig文件夹下的配置文件) fifile:./ (项目根目下的配置文件) classpath:/confifig/ (resources目录confifig文件夹下的配置文件) classpath:/ (resources目下的配置文件) 以上是按照优先级从高到低的顺序,所有位置的文件都会被加载,高优先级配置内容会覆 盖低优先级配置内容,形成互补配置。 默认配置 我们也可以通过配置spring.confifig.location来改变默认配置。 项目打包后以后,我们可以使用命令行参数的形式,启动项目的时候来指定配置文件的新 位置;指定配置文件和默认加载的这些配置文件共同起作用,形成互补配置。 1. Maven->package对项目打包2. 把待使用的配置文件放在本地文件夹中,如:D:/application.properties 3. 命令行执行命令 java -jar boot-config-position-xxxxxx.jar — spring.config.location=D:/application.properties 这样即使项目上线了,我们也可以通过修改本地的配置文件,使用一行命令即可,极大方 便了运维人员。 6. 外部配置加载顺序 Spring Boot 支持多种外部配置方式 可以从以下位置加载配置,优先级从高到低,高优先级配置覆盖低优先级的,所以配置形 成互补配置。 1. 命令行参数 java -jar boot-config-position-xxxxxx.jar –server.port // 多个配置用空格 隔开 2. 来自java:comp/env的JNDI属性 3. Java系统属性(System.getProperties()) 4. 操作系统环境变量 5. RandomValuePropertySource配置的random.*属性值 6. jar包外部的application-{profifile}.properties或application.yml(带spring.profifile)配 置文件 7. jar包内部的application-{profifile}.properties或application.yml(带spring.profifile)配 置文件 8. jar包外部的application.properties或application.yml(不带spring.profifile)配置文件 9. jar包内部的application.properties或application.yml(不带spring.profifile)配置文件 10. @Confifiguration注解类上的@PropertySource 11. 通过SpringApplication.setDefaultProperties指定的默认属性 注意:从jar包外向jar包内寻找,优先加载profifile最后加载不带profifile,更多参考官方文 档 7. 自动配置原理GitHub对应项目:boot-confifig-autoconfifig 1. 配置文件写什么? 配置文件可配置属性查阅 2. 什么是注解,如何实现一个注解? 关于注解的机制和相关原理可以移步此篇博客 3. 配置原理解析 我们运行Spring Boot应用是从main方法启动,在主程序类上有一个 @SpringBootApplication注解。 @SpringBootApplication是一个复合注解,包括@ComponentScan,和 @SpringBootConfifiguration,@EnableAutoConfifiguration。 @SpringBootConfifiguration继承自@Confifiguration,二者功能也一致,标注当前类 是配置类,并会将当前类内声明的一个或多个以@Bean注解标记的方法的实例纳入到 srping容器中,并且实例名就是方法名。 @EnableAutoConfifiguration的作用启动自动的配置,@EnableAutoConfifiguration注 解的意思就是SpringBoot根据你添加的jar包来配置你项目的默认配置,比如根据 spring-boot-starter-web ,来判断你的项目是否需要添加了webmvc和tomcat,就 会自动的帮你配置web项目中所需要的默认配置 @ComponentScan,扫描当前包及其子包下被@Component,@Controller, @Service,@Repository注解标记的类并纳入到spring容器中进行管理。是以前的co ntext:component-scan(以前使用在xml中使用的标签,用来扫描包配置的平行支 持)。 @SpringBootApplication注解分析 配置原理视频讲解 4. 自动配置类判断 在配置文件properties中设置:debug=true 来让控制台打印自动配置报告,方便的得知 那些配置类生效。 ========================= AUTO-CONFIGURATION REPORT =========================Positive matches: —————– matched: – @ConditionalOnClass found required class 'org.springframework.web.servlet.DispatcherServlet'; @ConditionalOnMissingClass did not find unwanted class (OnClassCondition) – @ConditionalOnWebApplication (required) found 'session' scope (OnWebApplicationCondition) Negative matches: —————– ActiveMQAutoConfiguration: Did not match: – @ConditionalOnClass did not find required classes 'javax.jms.ConnectionFactory', 'org.apache.activemq.ActiveMQConnectionFactory' (OnClassCondition)
『伍』 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 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 读取配置文件原理
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人解决一切问题的不变的方法论。