解決SpringBoot使用yaml作為配置文件遇到的坑

Posted on by

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方法：

@Override
public 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的類跳過去，再去找其他適合的配置文件，也說的過去，可是為啥不能打個日志提示一下粗心又頑強的碼農們呢？

感覺修改一下比較好，類似這樣：

@Override
public 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 \n shen"

輸出 ：

yaml kuang 換行 shen

”單引號，會轉義特殊字符 ， 特殊字符最終會變成和普通字符一樣輸出

比如 ：

yaml name: ‘kuang \n shen'

輸出 ：

yaml kuang \n 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 //註冊bean
public class Dog {
    @Value("阿黃")
    private String name;
    @Value("18")
    private Integer age;
}

4、在SpringBoot的測試類下註入狗狗輸出一下；

@SpringBootTest
class DemoApplicationTests {
    @Autowired //將狗狗自動註入進來
    Dog dog;
    @Test
    public void contextLoads() {
        System.out.println(dog); //打印看下狗狗對象
    }
}

結果成功輸出，@Value註入成功，這是原來的辦法。

在這裡插入圖片描述

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;
}

確認以上配置之後，測試類中測試一下

@SpringBootTest
class DemoApplicationTests {
    @Autowired
    Person person; //將person自動註入進來
    @Test
    public void contextLoads() {
        System.out.println(person); //打印person信息
    }
}

結果：所有值全部註入成功

在這裡插入圖片描述

加載指定的配置文件

@PropertySource ：加載指定的配置文件；

@configurationProperties：默認從全局配置文件中獲取值；

@PropertySource的使用

1、在resources目錄下新建一個person.properties文件

name=kuangshen

2、然後在代碼中指定加載person.properties文件

@PropertySource(value = "classpath:person.properties")
@Component //註冊bean
public class Person {
    @Value("${name}")
    private String name;
    ......  
}

3、再次輸出測試一下：指定配置文件綁定成功

在這裡插入圖片描述

@configurationProperties的使用

配合yaml文件使用，具體看上邊的程序理解。

結論

配置yml和配置properties都可以獲取到值 ， 強烈推薦 yml；

如果我們在某個業務中，隻需要獲取配置文件中的某個值，可以使用一下 @value；

如果說，我們專門編寫瞭一個JavaBean來和配置文件進行一一映射，就直接@configurationProperties，不要猶豫！

以上為個人經驗，希望能給大傢一個參考，也希望大傢多多支持WalkonNet。

推薦閱讀：