springboot自定义加载yml实现，附源码解读

2019独角兽企业重金招聘Python工程师标准>>>

背景

昨天在对公司的微服务配置文件标准化的过程中&＃xff0c;发现将原来的properties文件转为yml文件之后&＃xff0c;微服务module中标记有&＃64;Configuration的配置类都不能正常工作了&＃xff0c;究其原因&＃xff0c;是由于&＃64;PropertySource属性默认只用于标记并告诉spring boot加载properties类型的文件&＃xff0c;spring boot 2.0.0.RELEASE版的文档解释如下&＃xff1a;

24.6.4 YAML ShortcomingsYAML files cannot be loaded by using the &＃64;PropertySource annotation. So, in the case that you need to load values that way, you need to use a properties file.

这段话的意思是说&＃xff1a;

24.6.4 YAML 缺点YAML 文件不能用 &＃64;PropertySource 注解来标记加载。因此&＃xff0c;在需要加载值的场景&＃xff0c;你需要使用属性文件。

解决方法

解决这个问题并不难&＃xff0c;我们只需要自定义一个yaml文件加载类&＃xff0c;并在&＃64;PropertySource注解的factory属性中声明就可以。scala版实现代码如下&＃xff0c;spring boot版本为2.0.0.RELEASE&＃xff1a;

1、自定义yaml文件资源加载类

import org.springframework.boot.env.YamlPropertySourceLoader import org.springframework.core.env.PropertySource import org.springframework.core.io.support.{DefaultPropertySourceFactory, EncodedResource}/*** yaml资源加载类*/ class YamlPropertyLoaderFactory extends DefaultPropertySourceFactory{override def createPropertySource(name: String, resource: EncodedResource): PropertySource[_] &＃61; {if (resource &＃61;&＃61; null) {super.createPropertySource(name, resource)}return new YamlPropertySourceLoader().load(resource.getResource.getFilename, resource.getResource, null)} }

这个类继承自DefaultPropertySourceFactory类&＃xff0c;并重写了createPropertySource方法。

2、引入&＃64;PropertySource注解并使用

import com.core.conf.YamlPropertyLoaderFactory import javax.persistence.EntityManagerFactory import javax.sql.DataSource import org.springframework.beans.factory.annotation.{Autowired, Qualifier} import org.springframework.boot.autoconfigure.jdbc.DataSourceBuilder import org.springframework.boot.context.properties.ConfigurationProperties import org.springframework.boot.orm.jpa.EntityManagerFactoryBuilder import org.springframework.context.annotation.{Bean, Configuration, PropertySource} import org.springframework.core.env.Environment import org.springframework.data.jpa.repository.config.EnableJpaRepositories import org.springframework.orm.jpa.{JpaTransactionManager, LocalContainerEntityManagerFactoryBean} import org.springframework.transaction.PlatformTransactionManager/*** JPA 数据源配置*/ &＃64;Configuration &＃64;PropertySource(value &＃61; Array("classpath:/bootstrap-report.yml"), factory &＃61; classOf[YamlPropertyLoaderFactory]) &＃64;EnableJpaRepositories(entityManagerFactoryRef &＃61; "reportEntityManager",transactionManagerRef &＃61; "reportTransactionManager",basePackages &＃61; Array("com.report.dao") ) class ReportDBConfig {&＃64;Autowiredprivate var env: Environment &＃61; _&＃64;Bean&＃64;ConfigurationProperties(prefix &＃61; "spring.datasource.report")def reportDataSource(): DataSource &＃61; DataSourceBuilder.create.build&＃64;Bean(name &＃61; Array("reportEntityManager"))def reportEntityManagerFactory(builder: EntityManagerFactoryBuilder): LocalContainerEntityManagerFactoryBean &＃61; {val entityManager &＃61; builder.dataSource(reportDataSource()).packages("com.report.model") //设置JPA实体包路径.persistenceUnit("reportPU").buildentityManager.setJpaProperties(additionalProperties())entityManager}&＃64;Bean(name &＃61; Array("reportTransactionManager"))def reportTransactionManager(&＃64;Qualifier("reportEntityManager")entityManagerFactory: EntityManagerFactory): PlatformTransactionManager &＃61; {new JpaTransactionManager(entityManagerFactory)}/*** 获取JPA配置** &＃64;return*/def additionalProperties(): Properties &＃61; {val properties &＃61; new Properties();properties.setProperty("hibernate.hbm2ddl.auto", env.getProperty("spring.jpa.report.hibernate.ddl-auto"))properties.setProperty("hibernate.show_sql", env.getProperty("spring.jpa.report.show-sql"))properties.setProperty("hibernate.dialect", env.getProperty("spring.jpa.report.database-platform"))properties} }

源码解读

实现该功能涉及两个地方&＃xff1a;

1、&＃64;PropertySource注解&＃xff1a;用于声明和配置自定义配置类需要加载的配置文件信息&＃xff0c;源码及属性解释如下&＃xff1a;

package org.springframework.context.annotation;import java.lang.annotation.Documented; import java.lang.annotation.ElementType; import java.lang.annotation.Repeatable; import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target;import org.springframework.core.io.support.PropertySourceFactory;&＃64;Target(ElementType.TYPE) &＃64;Retention(RetentionPolicy.RUNTIME) &＃64;Documented &＃64;Repeatable(PropertySources.class) public &＃64;interface PropertySource {// 用于声明属性源名称String name() default "";// 声明属性文件位置String[] value();// 是否忽略未找到的资源boolean ignoreResourceNotFound() default false;// 声明配置文件的编码String encoding() default "";// 声明解析配置文件的类Class factory() default PropertySourceFactory.class;}

2、spring boot配置文件解析类&＃xff1a;

在&＃64;PropertySource注解的定义中&＃xff0c;属性factory主要用来声明解析配置文件的类&＃xff0c;这个类必须是PropertySourceFactory接口的实现&＃xff0c;在我们自定义了yaml文件加载类之后&＃xff0c;它的实现关系如下&＃xff1a;

输入图片说明

从以上类图可以发现&＃xff0c;它的实现类主要有2个&＃xff1a;

DefaultPropertySourceFactory&＃xff1a;默认的配置文件解析类&＃xff0c;主要用于解析properties配置文件
YamlPropertyLoaderFactory&＃xff1a;自定义的yaml资源解析类&＃xff0c;主要用于解析yaml配置文件&＃xff0c;使用时需要在PropertySource注解的factory属性上声明

这两个类将配置文件解析后&＃xff0c;会将属性信息存入Spring的Environment对象中&＃xff0c;以供我们通过&＃64;Value注解等方式使用。

因此&＃xff0c;我们如果遇到spring boot不能加载并解析自定义配置的时候&＃xff0c;可以试试自定义配置文件解析类解决。