SpringBoot系列之@PropertySource读取yaml文件

SpringBoot系列之@PropertySource支持yaml文件读取

最近在做实验，想通过@PropertySource注解读取配置文件的属性，进行映射，习惯上用properties都是测试没问题的，偶然换成yaml文件，发现都读取不到属性值

因为yaml语法很简洁，比较喜欢写yaml配置文件，很显然，@PropertySource默认不支持yaml读取，我们改成@Value注解也是可以读取的，不过属性一堆的话，一个一个读取也是很繁琐的，通过网上找资料和自己实验验证，发现是可以实现对yaml支持

然后，为什么@PropertySource注解默认不支持？可以简单跟一下源码

@PropertySource源码：

在这里插入图片描述

根据注释，默认使用DefaultPropertySourceFactory类作为资源文件加载类

在这里插入图片描述

里面还是调用Spring框架底层的PropertiesLoaderUtils工具类进行读取的

在这里插入图片描述

PropertiesLoaderUtils.loadProperties

在这里插入图片描述

从源码可以看出也是支持xml文件读取的，能支持reader就获取reader对象，否则出件inputStream

在这里插入图片描述

在这里插入图片描述

load0方法是关键，这里加了同步锁

在这里插入图片描述

很重要的load0 方法抓取出来：

private void load0 (LineReader lr) throws IOException {
        char[] convtBuf = new char[1024];
        int limit;
        // 当前key所在位置
        int keyLen;
        // 当前value所在位置
        int valueStart;
        char c;//读取的字符
        boolean hasSep;
        boolean precedingBackslash;//是否转义字符，eg:/n etc.
        // 一行一行地读取
        while ((limit = lr.readLine()) >= 0) {
            c = 0;
            keyLen = 0;
            valueStart = limit;
            hasSep = false;

            //System.out.println("line=<" + new String(lineBuf, 0, limit) + ">");
            precedingBackslash = false;
            //key的长度小于总的字符长度，那么就进入循环
            while (keyLen < limit) {
                c = lr.lineBuf[keyLen];
                //need check if escaped.
                if ((c == '=' ||  c == ':') && !precedingBackslash) {
                    valueStart = keyLen + 1;
                    hasSep = true;
                    break;
                } else if ((c == ' ' || c == '\t' ||  c == '\f') && !precedingBackslash) {
                    valueStart = keyLen + 1;
                    break;
                }
                if (c == '\\') {
                    precedingBackslash = !precedingBackslash;
                } else {
                    precedingBackslash = false;
                }
                keyLen++;
            }
            //value的起始位置小于总的字符长度，那么就进入该循环
            while (valueStart < limit) {
                c = lr.lineBuf[valueStart];
                //当前字符是否非空格类字符
                if (c != ' ' && c != '\t' &&  c != '\f') {
                    if (!hasSep && (c == '=' ||  c == ':')) {
                        hasSep = true;
                    } else {
                        break;
                    }
                }
                valueStart++;
            }
            //读取key
            String key = loadConvert(lr.lineBuf, 0, keyLen, convtBuf);
            //读取value
            String value = loadConvert(lr.lineBuf, valueStart, limit - valueStart, convtBuf);
            put(key, value);
        }
    }

ok，从源码可以看出，这个方法是一行一行地读取，然后根据冒号、等于号、空格等进行校验，经过一系列遍历之后获取key和value，而yaml语法是以缩进来辨别的，经过自己调试，这个方法也是不支持yaml文件的读取的，properties源码是比较多的，具体的Properties源码实现的可以参考博客：https://www.cnblogs.com/liuming1992/p/4360310.html，这篇博客写的比较详细

ok，然后给个例子来实现对yaml配置文件的读取

# 测试ConfigurationProperties
user:
  userName: root
  isAdmin: true
  regTime: 2019/11/01
  isOnline: 1
  maps: {k1 : v1,k2: v2}
  lists:
   - list1
   - list2
  address:
    tel: 15899988899
    name: 上海市

模仿DefaultPropertySourceFactory写一个yaml资源文件读取的工厂类：

package com.example.springboot.properties.core.propertyResouceFactory;

import org.springframework.boot.env.YamlPropertySourceLoader;
import org.springframework.core.env.PropertiesPropertySource;
import org.springframework.core.env.PropertySource;
import org.springframework.core.io.support.EncodedResource;
import org.springframework.core.io.support.PropertySourceFactory;
import org.springframework.lang.Nullable;

import java.io.IOException;
import java.util.List;
import java.util.Optional;
import java.util.Properties;

/**
 * 
 *  YAML配置文件读取工厂类
 * 
 * 

 * 
 * @author nicky.ma
 * 修改记录
 *    修改后版本:     修改人：  修改日期: 2019/11/13 15:44  修改内容:
 * 
 */
public class YamlPropertyResourceFactory implements PropertySourceFactory {

    /**
     * Create a {@link PropertySource} that wraps the given resource.
     *
     * @param name     the name of the property source
     * @param encodedResource the resource (potentially encoded) to wrap
     * @return the new {@link PropertySource} (never {@code null})
     * @throws IOException if resource resolution failed
     */
    @Override
    public PropertySource createPropertySource(@Nullable String name, EncodedResource encodedResource) throws IOException {
        String resourceName = Optional.ofNullable(name).orElse(encodedResource.getResource().getFilename());
        if (resourceName.endsWith(".yml") || resourceName.endsWith(".yaml")) {//yaml资源文件
            List> yamlSources = new YamlPropertySourceLoader().load(resourceName, encodedResource.getResource());
            return yamlSources.get(0);
        } else {//返回空的Properties
            return new PropertiesPropertySource(resourceName, new Properties());
        }
    }
}

写个bean类进行属性映射，注意换一下factory参数，factory = YamlPropertyResourceFactory.class

package com.example.springboot.properties.bean;

import com.example.springboot.properties.core.propertyResouceFactory.CommPropertyResourceFactory;
import com.example.springboot.properties.core.propertyResouceFactory.YamlPropertyResourceFactory;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.PropertySource;
import org.springframework.core.io.support.DefaultPropertySourceFactory;
import org.springframework.stereotype.Component;

import java.util.Date;
import java.util.List;
import java.util.Map;

/**
 * 
 *
 * 
 *
 * @author nicky
 * 
 * 修改记录
 *    修改后版本:     修改人：  修改日期: 2019年11月03日  修改内容:
 * 
 */
@Component
@PropertySource(value = "classpath:user.yml",encoding = "utf-8",factory = YamlPropertyResourceFactory.class)
@ConfigurationProperties(prefix = "user")
public class User {

    private String userName;
    private boolean isAdmin;
    private Date regTime;
    private Long isOnline;
    private Map maps;
    private List