SpringBoot读取外部的配置文件的代码实现

 更新时间:2024年11月28日 09:11:01   作者:墨momo  
这篇文章主要介绍了SpringBoot读取外部的配置文件的代码实现,文中通过代码示例给大家讲解的非常详细,对大家的学习或工作有一定的帮助,需要的朋友可以参考下

一、使用场景

假设有一个买卖商品的系统,客户希望能灵活修改首页推荐商品的个数 num。

如果 num 是写在代码里的固定值,每次修改,开发人员就得重新将系统打包部署上线,费时费力。

但如果 num 是写在 jar 包的外部配置文件中,开发人员只需要修改该外部配置文件,然后重启已经部署上线的系统,就可以达到灵活修改 num 的效果啦。

二、代码实现

(一)application.yml 的配置

配置外部文件的路径,这里是 customer.yml,和 src 文件夹同级,如图。

customer:
  path: customer.yml

(二)编辑 customer.yml

这里配置了一个 num,值是 5

num: 5

(三)自定义方法读取外部配置文件

import org.springframework.beans.factory.config.YamlPropertiesFactoryBean;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.env.EnvironmentPostProcessor;
import org.springframework.core.env.ConfigurableEnvironment;
import org.springframework.core.env.PropertiesPropertySource;
import org.springframework.core.env.PropertySource;
import org.springframework.core.io.FileSystemResource;
import org.springframework.core.io.Resource;

import java.io.File;
import java.util.Properties;

public class MyEnvironmentPostProcessor implements EnvironmentPostProcessor {

    @Override
    public void postProcessEnvironment(ConfigurableEnvironment environment, SpringApplication application) {
        //自定义配置文件,对应 application.yml 里的前缀
        String profiles = environment.getProperty("customer.path");
        //加载成PropertySource对象,并添加到Environment环境中
        File file = new File(profiles);
        Resource resource = new FileSystemResource(file);
        environment.getPropertySources().addLast(loadProfiles(resource));

    }

    /**
     * 加载单个配置文件
     * @param resource
     * @return
     */
    private PropertySource<?> loadProfiles(Resource resource) {
        // 判断资源是否存在
        if (!resource.exists()) {
            throw new IllegalArgumentException("资源" + resource + "不存在");
        }
        // 判断后缀名,兼容 .yml 文件和 .properties 文件
        if (resource.getFilename().contains(".yml")) {
            return loadYaml(resource);
        } else {
            return loadProperty(resource);
        }
    }

    /**
     * 加载properties格式的配置文件
     *
     * @param resource
     * @return
     */
    private PropertySource loadProperty(Resource resource) {
        try {
            //从输入流中加载一个Properties对象
            Properties properties = new Properties();
            properties.load(resource.getInputStream());
            return new PropertiesPropertySource(resource.getFilename(), properties);
        } catch (Exception ex) {
            throw new IllegalStateException("加载配置文件失败" + resource, ex);
        }
    }

    /**
     * 加载yml格式的配置文件
     *
     * @param resource
     * @return
     */
    private PropertySource loadYaml(Resource resource) {
        try {
            YamlPropertiesFactoryBean factory = new YamlPropertiesFactoryBean();
            factory.setResources(resource);
            //从输入流中加载一个Properties对象
            Properties properties = factory.getObject();
            return new PropertiesPropertySource(resource.getFilename(), properties);
        } catch (Exception ex) {
            throw new IllegalStateException("加载配置文件失败" + resource, ex);
        }
    }
}

(四)使用外部配置文件的配置

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.core.env.Environment;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class TestController {
    @Autowired
    private Environment environment;

    @GetMapping("/test")
    public void test() {
        // 读取 num 配置值,不为空则输出
        String num = environment.getProperty("num");
        if (num != null && !num.equals("")) {
            System.out.println("num = " + num);
        } else {
            System.out.println("num is null or ''");
        }
    }
}

到此这篇关于SpringBoot读取外部的配置文件的代码实现的文章就介绍到这了,更多相关SpringBoot读取外部配置文件内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • 单例模式的反射漏洞和反序列化漏洞代码实例

    单例模式的反射漏洞和反序列化漏洞代码实例

    这篇文章主要介绍了单例模式的反射漏洞和反序列化漏洞,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2019-04-04
  • jsp如何获取Session中的值

    jsp如何获取Session中的值

    这篇文章主要介绍了jsp如何获取Session中的值,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2019-10-10
  • 阅读EnumSet抽象类源码

    阅读EnumSet抽象类源码

    这篇文章主要介绍了阅读EnumSet抽象类源码,具有一定参考价值,需要的朋友可以了解下。
    2017-12-12
  • SpringBoot接口实现百万并发的代码示例

    SpringBoot接口实现百万并发的代码示例

    随着互联网的发展,越来越多的应用需要支持高并发,在这种情况下,如何实现高并发成为了一个重要的问题,Spring Boot是一个非常流行的Java框架,它提供了很多方便的功能来支持高并发,本文将介绍如何使用Spring Boot来实现百万并发
    2023-10-10
  • 一文带你掌握Java8中函数式接口的使用和自定义

    一文带你掌握Java8中函数式接口的使用和自定义

    函数式接口是 Java 8 引入的一种接口,用于支持函数式编程,下面我们就来深入探讨函数式接口的概念、用途以及如何创建和使用函数式接口吧
    2023-08-08
  • Java服务刚启动时接口超时排查全过程

    Java服务刚启动时接口超时排查全过程

    这篇文章主要为大家介绍了Java服务刚启动时,一小波接口超时排查全过程,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2023-07-07
  • Java 实现协同过滤算法推荐算法的示例代码

    Java 实现协同过滤算法推荐算法的示例代码

    本文介绍了协同过滤算法的概念,包括基于用户的协同过滤和基于物品的协同过滤,文章详细解释了数据准备、相似度计算以及如何在Java中实现这些算法,通过一个简单的用户-物品评分矩阵示例,展示了如何计算用户和物品之间的相似度,并推荐未评分的物品,感兴趣的朋友一起看看吧
    2025-02-02
  • Java使用位运算实现加减乘除详解

    Java使用位运算实现加减乘除详解

    这篇文章主要为大家详细介绍了Java如何使用位运算实现加减乘除,文中的示例代码讲解详细,对我们深入了解Java有一定的帮助,感兴趣的可以了解一下
    2023-05-05
  • Java中ThreadLocal的用法和原理详解

    Java中ThreadLocal的用法和原理详解

    这篇文章主要为大家详细介绍了Java中ThreadLocal的用法和原理,文中的示例代码讲解详细,具有一定的学习价值,感兴趣的可以了解一下
    2023-04-04
  • 这一次搞懂Spring事务注解的解析方式

    这一次搞懂Spring事务注解的解析方式

    这篇文章主要介绍了这一次搞懂Spring事务注解的解析方式,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2020-08-08

最新评论