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

最后

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

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

相关文章

  • 详解JavaSE实现IoC

    详解JavaSE实现IoC

    简单地说,IoC 是反转控制,类似于好莱坞原则,主要有依赖查找和依赖注入实现。依赖查找是主动或手动的依赖查找方式,通常需要依赖容器或标准API实现。 而依赖注入则是手动或自动依赖绑定的方式,无需依赖特定的容器和API。本文将详细介绍JavaSE实现IoC。
    2021-06-06
  • java IO流之转换流的具体使用

    java IO流之转换流的具体使用

    转换流可以将一个字节流包装成字符流,或者将一个字符流包装成字节流,本文主要介绍了java IO流之转换流的具体使用,具有一定的参考价值,感兴趣的可以了解一下
    2024-01-01
  • Spring Boot通过Junit实现单元测试过程解析

    Spring Boot通过Junit实现单元测试过程解析

    这篇文章主要介绍了Spring Boot通过Junit实现单元测试过程解析,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-01-01
  • C# TreeNode案例详解

    C# TreeNode案例详解

    这篇文章主要介绍了C# TreeNode案例详解,本篇文章通过简要的案例,讲解了该项技术的了解与使用,以下就是详细内容,需要的朋友可以参考下
    2021-08-08
  • Mybatis中 SQL语句复用

    Mybatis中 SQL语句复用

    这篇文章主要介绍了Mybatis中 SQL语句复用,需要的朋友可以参考下
    2017-03-03
  • SpringBoot(十)之邮件服务

    SpringBoot(十)之邮件服务

    这篇文章给大家介绍了SpringBoot邮件服务的相关知识,此文是使用springboot最新版本1.5.3进行开发的。本文给大家介绍的非常详细,具有参考借鉴价值,需要的的朋友参考下吧
    2017-05-05
  • Java类加载器ClassLoader的使用详解

    Java类加载器ClassLoader的使用详解

    类加载器负责读取Java字节代码,并转换成java.lang.Class类的一个实例的代码模块。本文主要和大家聊聊JVM类加载器ClassLoader的使用,需要的可以了解一下
    2022-12-12
  • 深入理解Spring Boot属性配置文件

    深入理解Spring Boot属性配置文件

    这篇文章主要给大家深入的介绍了关于Spring Boot属性配置文件的相关资料,文中介绍的很详细,相信对大家具有一定的参考借鉴价值,需要的朋友们下面来一起看看吧。
    2017-02-02
  • Spring Boot配置读取实现方法解析

    Spring Boot配置读取实现方法解析

    这篇文章主要介绍了Spring Boot配置读取实现方法解析,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-08-08
  • github上的java项目怎么运行(面向小白)

    github上的java项目怎么运行(面向小白)

    这篇文章主要介绍了github上的java项目怎么运行(面向小白),今天从github把我以前写的一个小demo下载下来了,第一次下载项目,摸索了一个多小时,才运行起来,需要的朋友可以参考下
    2019-06-06

最新评论