gpt4 book ai didi

解决SpringBoot使用yaml作为配置文件遇到的坑

转载 作者:qq735679552 更新时间:2022-09-27 22:32:09 26 4
gpt4 key购买 nike

CFSDN坚持开源创造价值,我们致力于搭建一个资源共享平台,让每一个IT人在这里找到属于你的精彩世界.

这篇CFSDN的博客文章解决SpringBoot使用yaml作为配置文件遇到的坑由作者收集整理,如果你对这篇文章有兴趣,记得点赞哟.

  。

SpringBoot yaml作为配置文件遇到的坑

  。

背景

最近搞新项目,重新搭建一套基于SpringBoot的开发框架.

问题的由来是我在进行一个dao单元测试时,一直失败,报错信息大概是“生成dataSource时maxActive属性不能为0”。基于以往的经验,应该是配置属性没有成功加载。排查由@ConfigurationProperties注解注释的配置属性类时,application.yml中的属性怎么注入不进来.

查看debug日志,发现很奇怪的一行日志 。

Skipped (empty) config file "file:/E:/workspace/union-service/union-service-dao/target/test-classes/application.yml" (classpath:/application.yml)

明明不是空的!怀疑文件名不对,确认并重试了几次,仍然不行,只能调试了.

调试到了PropertySourcesLoader这个类 。

public PropertySource<?> load(Resource resource, String group, String name,  String profile) throws IOException {if (isFile(resource)) {  String sourceName = generatePropertySourceName(name, profile);  for (PropertySourceLoader loader : this.loaders) {  if (canLoadFileExtension(loader, resource)) {    PropertySource<?> specific = loader.load(sourceName, resource,      profile);    addPropertySource(group, specific, profile);    return specific;  }  }}return null;}

YamlPropertySourceLoader类的load方法:

@Overridepublic PropertySource<?> load(String name, Resource resource, String profile)  throws IOException {if (ClassUtils.isPresent("org.yaml.snakeyaml.Yaml", null)) {  Processor processor = new Processor(resource, profile);  Map<String, Object> source = processor.process();  if (!source.isEmpty()) {  return new MapPropertySource(name, source);  }}return null;}

查找" org.yaml.snakeyaml.Yaml"类,如果不存在,就返回null。我的项目代码修改倒也简单,添加snakeyaml的依赖即可.

但是SpringBoot代码执行到这里,说明已经存在resource文件,因为没有解析yaml的类跳过去,再去找其他适合的配置文件,也说的过去,可是为啥不能打个日志提示一下粗心又顽强的码农们呢?

  。

感觉修改一下比较好,类似这样:

@Overridepublic PropertySource<?> load(String name, Resource resource, String profile)  throws IOException {if (ClassUtils.isPresent("org.yaml.snakeyaml.Yaml", null)) {  Processor processor = new Processor(resource, profile);  Map<String, Object> source = processor.process();  if (!source.isEmpty()) {  return new MapPropertySource(name, source);  }} else {  logger.warn("Found " + name + " while lacking of snakeyaml");}return null;}

相关issue已在github提交给spring boot.

  。

SpringBoot-yaml配置注入

  。

yaml基础语法

说明:语法要求严格! 。

1、空格不能省略 。

2、以缩进来控制层级关系,只要是左边对齐的一列数据都是同一个层级的.

3、属性和值的大小写都是十分敏感的.

  。

字面量:普通的值 [ 数字,布尔值,字符串 ]

字面量直接写在后面就可以 , 字符串默认不用加上双引号或者单引号; 。

k: v 。

注意:

“ ” 双引号,不会转义字符串里面的特殊字符 , 特殊字符会作为本身想表示的意思; 。

比如 :

yaml name: "kuang  shen"

输出 :

yaml kuang 换行 shen 。

""单引号,会转义特殊字符 , 特殊字符最终会变成和普通字符一样输出 。

比如 :

yaml name: ‘kuang  shen"

输出 :

yaml kuang shen 。

  。

对象、Map(键值对)

#对象、Map格式k:     v1:    v2:

在下一行来写对象的属性和值得关系,注意缩进;比如:

student:    name: qinjiang    age: 3

行内写法 。

student: {name: qinjiang,age: 3}

  。

数组( List、set )

用 - 值表示数组中的一个元素,比如:

pets: - cat - dog - pig

行内写法 。

pets: [cat,dog,pig]

  。

修改SpringBoot的默认端口号

配置文件中添加,端口号的参数,就可以切换端口; 。

server:  port: 8082

  。

yaml注入配置文件

  。

原来的方法

1、在springboot项目中的resources目录下新建一个文件 application.yml 。

2、编写一个实体类 Dog; 。

package com.kuang.springboot.pojo;@Component  //注册bean到容器中public class Dog {    private String name;    private Integer age;        //有参无参构造、get、set方法、toString()方法  }

3、思考,我们原来是如何给bean注入属性值的!@Value,给狗狗类测试一下:

@Component //注册beanpublic class Dog {    @Value("阿黄")    private String name;    @Value("18")    private Integer age;}

4、在SpringBoot的测试类下注入狗狗输出一下; 。

@SpringBootTestclass DemoApplicationTests {    @Autowired //将狗狗自动注入进来    Dog dog;    @Test    public void contextLoads() {        System.out.println(dog); //打印看下狗狗对象    }}

结果成功输出,@Value注入成功,这是原来的办法.

解决SpringBoot使用yaml作为配置文件遇到的坑

  。

Yaml方法

我们在编写一个实体类:Person 类 。

@Component //注册bean到容器中public class Person {    private String name;    private Integer age;    private Boolean happy;    private Date birth;    private Map<String,Object> maps;    private List<Object> lists;    private Dog dog;        //有参无参构造、get、set方法、toString()方法  }

使用yaml配置的方式进行注入,写的时候注意区别和优势,我们编写一个yaml配置! 。

person:  name: qinjiang  age: 3  happy: false  birth: 2000/01/01  maps: {k1: v1,k2: v2}  lists:   - code   - girl   - music  dog:    name: 旺财    age: 1

把person这个对象的所有值都写好了,现在来注入到类中 。

/*@ConfigurationProperties作用:将配置文件中配置的每一个属性的值,映射到这个组件中;告诉SpringBoot将本类中的所有属性和配置文件中相关的配置进行绑定参数 prefix = “person” : 将配置文件中的person下面的所有属性一一对应*/@Component //注册bean@ConfigurationProperties(prefix = "person")public class Person {    private String name;    private Integer age;    private Boolean happy;    private Date birth;    private Map<String,Object> maps;    private List<Object> lists;    private Dog dog;}

确认以上配置之后,测试类中测试一下 。

@SpringBootTestclass DemoApplicationTests {    @Autowired    Person person; //将person自动注入进来    @Test    public void contextLoads() {        System.out.println(person); //打印person信息    }}

结果:所有值全部注入成功 。

解决SpringBoot使用yaml作为配置文件遇到的坑

加载指定的配置文件 。

@PropertySource :加载指定的配置文件; 。

@configurationProperties:默认从全局配置文件中获取值; 。

  。

@PropertySource的使用

1、在resources目录下新建一个person.properties文件 。

name=kuangshen

2、然后在代码中指定加载person.properties文件 。

@PropertySource(value = "classpath:person.properties")@Component //注册beanpublic class Person {    @Value("${name}")    private String name;    ......  }

3、再次输出测试一下:指定配置文件绑定成功 。

解决SpringBoot使用yaml作为配置文件遇到的坑

  。

@configurationProperties的使用

配合yaml文件使用,具体看上边的程序理解.

  。

结论

配置yml和配置properties都可以获取到值 , 强烈推荐 yml; 。

如果我们在某个业务中,只需要获取配置文件中的某个值,可以使用一下 @value; 。

如果说,我们专门编写了一个JavaBean来和配置文件进行一一映射,就直接@configurationProperties,不要犹豫! 。

以上为个人经验,希望能给大家一个参考,也希望大家多多支持我.

原文链接:https://my.oschina.net/bfleeee/blog/879209 。

最后此篇关于解决SpringBoot使用yaml作为配置文件遇到的坑的文章就讲到这里了,如果你想了解更多关于解决SpringBoot使用yaml作为配置文件遇到的坑的内容请搜索CFSDN的文章或继续浏览相关文章,希望大家以后支持我的博客! 。

26 4 0
Copyright 2021 - 2024 cfsdn All Rights Reserved 蜀ICP备2022000587号
广告合作:1813099741@qq.com 6ren.com