SpringBoot如何启动自动加载自定义模块yml文件(PropertySourceFactory)

 更新时间:2024年07月10日 09:00:27   作者:君哥聊编程  
这篇文章主要介绍了SpringBoot如何启动自动加载自定义模块yml文件(PropertySourceFactory),具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教

参考:https://deinum.biz/2018-07-04-PropertySource-with-yaml-files/

背景

自定义模块时经常会编写当前模块的一些核心yml配置,如果要被Spring容器加载到通常的做法是将自定义模块的yml命名为application-模块名.yml,比如db模块命名为application-db.yml,然后再在spring.profiles.include中引入该db,即可加载到子模块配置(前提是maven构建时能够将resources资源目录编译进去)。

上面说的这种限制有很多,子模块对于父模块是黑箱操作,我们无法得知有多少个子模块要被include进来,而且前缀必须以application开头。

今天我们来看另外一种更加灵活的方式,自定义名称的yml直接在子模块中加载,各位朋友继续往下看PropertySourceFactory如何实现。

总结3步走

定义一个YamlPropertySourceFactory,实现PropertySourceFactory,重写createPropertySource方法

将接口给过来的资源流文件使用加载到spring提供的YmlPropertiesFactorBean中,由该工厂Bean产出一个Properties对象

将生成的Properties对象传入PropertiesPropertySource中产出一个PropertySource对象

import lombok.AllArgsConstructor;
import org.springframework.beans.factory.config.YamlPropertiesFactoryBean;
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 java.io.FileNotFoundException;
import java.io.IOException;
import java.util.Properties;

/**
 * @description:
 * @author: jianjun.ren
 * @date: Created in 2020/9/24 12:05
 */
@AllArgsConstructor
public class YamlPropertySourceFactory implements PropertySourceFactory {
	//这个方法有2个入参,分别为资源名称和资源对象,这是第一步
    public PropertySource< ? > createPropertySource(String name, EncodedResource resource) throws IOException {
    
    	//这是第二步,根据流对象产出Properties对象
        Properties propertiesFromYaml = loadYamlIntoProperties(resource);
        String sourceName = name != null ? name : resource.getResource().getFilename();
        assert sourceName != null;
        
        //这是第三部,根据Properties对象,产出PropertySource对象,放入到Spring中
        return new PropertiesPropertySource(sourceName, propertiesFromYaml);
    }

    private Properties loadYamlIntoProperties(EncodedResource resource) throws FileNotFoundException {
        try {
            YamlPropertiesFactoryBean factory = new YamlPropertiesFactoryBean();
            factory.setResources(resource.getResource());
            factory.afterPropertiesSet();
            return factory.getObject();
        } catch (IllegalStateException e) {
            Throwable cause = e.getCause();
            if (cause instanceof FileNotFoundException) {
                throw (FileNotFoundException) e.getCause();
            }
            throw e;
        }
    }
}

创建咱们是说完了,小伙伴有很多问号,怎么去使用呢?

接下来我们再看康康:

在任意一个@Configuration类中,你自己写一个也可以,反正能够被Spring所扫描的

加入下面这段代码,其实就一行:

@Configuration
//这个地方的YamlPropertySourceFactory就是上面编写的代码类
@PropertySource(factory = YamlPropertySourceFactory.class, value = "classpath:xxx-xxx.yml")
public class XXXXConfiguration {
		
}

最后

好了到这里就结束了,去使用看看效果吧~

以上为个人经验,希望能给大家一个参考,也希望大家多多支持脚本之家。

相关文章

  • Spring Cloud 通过 Gateway webflux实现网关异常处理

    Spring Cloud 通过 Gateway webflux实现网关异常处理

    在某一个服务中出现异常,通过@ControllerAdvice + @ExceptionHandler 统一异常处理,即使在微服务架构中,也可以将上述统一异常处理放入到公共的微服务中,这样哪一个微服务需要,直接引入模块,本文重点介绍Spring Cloud 通过 Gateway webflux实现网关异常处理,一起看看吧
    2023-11-11
  • 关于List、Map、Stream初始化方式

    关于List、Map、Stream初始化方式

    这篇文章主要介绍了关于List、Map、Stream初始化方式,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-08-08
  • java web中使用cookie记住用户的账号和密码

    java web中使用cookie记住用户的账号和密码

    这篇文章主要介绍了java web中使用cookie记住用户的账号和密码的相关资料,需要的朋友可以参考下
    2017-01-01
  • Java Eclipse进行断点调试的方法

    Java Eclipse进行断点调试的方法

    本篇文章主要介绍了Java Eclipse进行断点调试的方法,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2017-11-11
  • SpringBoot2.3.0配置JPA的实现示例

    SpringBoot2.3.0配置JPA的实现示例

    这篇文章主要介绍了SpringBoot2.3.0配置JPA的实现示例,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2020-08-08
  • Java 8新增的方法参数反射实例分析

    Java 8新增的方法参数反射实例分析

    这篇文章主要介绍了Java 8新增的方法参数反射,结合实例形式分析了java8新增api方法参数反射相关操作技巧,需要的朋友可以参考下
    2019-07-07
  • 解决idea配置Tomcat Deployment没有artifact选项的问题

    解决idea配置Tomcat Deployment没有artifact选项的问题

    今天在配置的时候tomcat deployment中却找不到artifact,没有artifact就不能打成war包上传到服务器了,那么怎么解决没有artifact选项的问题呢,今天通过本文给大家分享idea配置Tomcat Deployment没有artifact选项的解决方案,一起看看吧
    2023-10-10
  • java list去重操作实现方式

    java list去重操作实现方式

    Java中的List是可以包含重复元素的(hash code 和equals),接下来将介绍两种方式实现java list去重操作,感兴趣的朋友可以参考下
    2012-12-12
  • hashtable桶数通常会取一个素数分析

    hashtable桶数通常会取一个素数分析

    这篇文章主要介绍了hashtable桶数通常会取一个素数分析的相关资料,需要的朋友可以参考下
    2016-12-12
  • java.lang.OutOfMemoryError: Java heap space错误的问题解决

    java.lang.OutOfMemoryError: Java heap space错误

    本文主要介绍了java.lang.OutOfMemoryError: Java heap space错误的问题解决,包括内存泄漏、数据过大和JVM堆大小配置不足,提供了解决方法,具有一定的参考价值,感兴趣的可以了解一下
    2025-03-03

最新评论