SpringBoot读取指定yaml文件内容

前言

在项目启动时，需要读取一些业务上大量的配置文件，用来初始化数据或者配置设定值等，我们都知道使用SpringBoot的@ConfigurationProperties注解 + application.yml配置可以很方便的读取这些配置，并且映射成对象很方便的使用，但是这些配置文件比较多的时候，而且不希望与application.yml放在一起，那么用SpringBoot如何实现呢。

my-config.yml

my-config:key1: hello

方法1 导入配置文件

application.yml中可以导入这些配置文件，然后继续使用@ConfigurationProperties注解，这样做的好处是最简单的，而且还可以增加my-conf-profile.yml的文件，以达到根据profile切换配置文件的目的

application.yml

spring:config:import: my-config.yml

MyConfig.java

@Data
@Configuration
@ConfigurationProperties(prefix="my-config")
public class MyConfig {private String key1;
}

方法2 使用@PropertySource注解加载配置文件

MyConfig.java

@Data
@Configuration
@ConfigurationProperties(prefix="my-config")
@PropertySource(value = "classpath:my-config.yml", factory = YamlPropertySourceFactory.class)
public class MyConfig {private String key1;
}

由于@PropertySource注解默认只支持properties格式的配置文件，所以要自定义yaml文件读取方式：

YamlPropertySourceFactory.java

import org.springframework.boot.env.YamlPropertySourceLoader;
import org.springframework.core.env.PropertySource;
import org.springframework.core.io.support.EncodedResource;
import org.springframework.core.io.support.PropertySourceFactory;public class YamlPropertySourceFactory implements PropertySourceFactory {@Overridepublic PropertySource<?> createPropertySource(String name, EncodedResource resource) throws IOException {return new YamlPropertySourceLoader().load(resource.getResource().getFilename(), resource.getResource()).get(0);}
}

方法3 使用YamlPropertySourceLoader + Binder进行手动绑定

以上方法都会将MyConfig对象注入到Spring容器中去，而且配置文件也会在上下文的环境中存在，如果不想放入容器或者想对绑定的过程做更定制化的处理（比如判断文件修改时间等），那么需要手动绑定，生成配置对象。

MyConfig.java

@Data
public class MyConfig {private String key1;
}

BindDemo.java

import org.springframework.boot.context.properties.bind.BindResult;
import org.springframework.boot.context.properties.bind.Binder;
import org.springframework.boot.context.properties.source.ConfigurationPropertySource;
import org.springframework.boot.env.YamlPropertySourceLoader;
import org.springframework.core.env.PropertySource;
import org.springframework.core.io.ClassPathResource;public class BindDemo {public MyConfig getMyConfig() throws IOException {Resource resource = new ClassPathResource("my-config.yml");// 查看文件最后修改时间FileTime lastModifiedTime = Files.getLastModifiedTime(resource.getFile().toPath());String format = lastModifiedTime.toInstant().atZone(ZoneId.systemDefault()).format(DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss"));System.out.println("system-dic.yml last modified time: " + format);List<PropertySource<?>> load = new YamlPropertySourceLoader().load(resource.getFilename(), resource);Binder binder = new Binder(ConfigurationPropertySource.from(load.get(0)));BindResult<DicProperties> bind = binder.bind("my-config", DicProperties.class);return bind.get();}
}