springboot service如何动态读取外部配置文件

原创 已于 2025-05-11 00:18:35 修改 · 1.3k 阅读 · 14 ·
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
文章标签：

#spring boot #后端 #java

于 2024-08-26 04:06:27 首次发布

在项目中， 读取外部配置文件的需求很常见

例如

  1. 这个配置文件包含些敏感内容
  2. 这个配置文件与server 环境密切相关
  3. 这个配置文件依赖于其他系统传入
    …





静态读取外部文件

静态读取外部文件的写法有很多种
下面举1个常用的例子

例子

@Configuration
@PropertySource(value = "file:${external-custom-config1-path}", ignoreResourceNotFound = true)
public class ExternalConfig {

    @Bean("customConfig1")
    public String customConfig() {
        return getCustomConfig();
    }

    @Value("${external.custom.config1:not defined}")
    private String customConfig;

    private String getCustomConfig() {
        return this.customConfig;
    }
}

上面创建了1个 Configuration 的bean, 里面再定义1个 名字是customConfig1的 bean, 它就是配置项
@PropertySource 作用是引入1个配置文件， 其中配置文件的路径我们写在了application.yaml

external-custom-config1-path: /app/config/external-config.properties

实际上的文件位置在 /app/config/external-config.properties




让程序容忍读取配置文件失败

容忍配置文件不存在：
在@PropertySource 里加上 ignoreResourceNotFound = true
容忍配置项读取失败：
@Value(“${external.custom.config1:not defined}”) 这里加上：和默认值， 如果读取失败， 下面的变量就获取到默认值




如何使用这个配置项

既然我们把配置项定义为了1个bean, 那么在其他bean里直接用 @Autowire 引用就得
下面是把配置项 作为actuator/info 接口输出项的例子：

@Component
@Slf4j
public class AppVersionInfo implements InfoContributor {

    @Value("${pom.version}") // https://stackoverflow.com/questions/3697449/retrieve-version-from-maven-pom-xml-in-code
    private String appVersion;

    @Autowired
    private String hostname;

    @Autowired
    private InfoService infoservice;

    @Value("${spring.datasource.url}")
    private String dbUrl;

    @Value("${spring.profiles.active}")
    private String appEnvProfile;

    @Autowired
    private String customConfig1;

    @Override
    // https://docs.spring.io/spring-boot/docs/current/reference/html/production-ready-features.html#production-ready-endpoints-info
    public void contribute(Info.Builder builder) {
        log.info("AppVersionInfo: contribute ...");
        builder.withDetail("app", "Cloud Order Service")
                .withDetail("appEnvProfile", appEnvProfile)
                .withDetail("version", appVersion)
                .withDetail("hostname",hostname)
                .withDetail("dbUrl", dbUrl)
                .withDetail("description", "This is a simple Spring Boot application to for cloud order...")
                .withDetail("customConfig1", customConfig1)
                .withDetail("SystemVariables", infoservice.getSystemVariables());

    }
}

注意上customConfig1 这个bean的引用
至于actuator框架的用法请参考:
利用SpringBoot Actuator 来构造/health /info 等监控接口




测试
gateman@MoreFine-S500:~/projects/coding/sql_backup$ curl 127.0.0.1:8080/actuator/info | jq .
  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                 Dload  Upload   Total   Spent    Left  Speed
100  2356    0  2356    0     0   553k      0 --:--:-- --:--:-- --:--:--  575k
{
  "app": "Cloud Order Service",
  "appEnvProfile": "dev",
  "version": "1.0.2",
  "hostname": "MoreFine-S500",
  "dbUrl": "jdbc:mysql://34.39.2.90:6033/demo_cloud_order?useUnicode=true&characterEncoding=utf-8&useSSL=false&allowPublicKeyRetrieval=true",
  "description": "This is a simple Spring Boot application to for cloud order...",
  "customConfig1": "value of config1",
  }
}

gateman@MoreFine-S500:~/projects/coding/sql_backup$ cat /app/config/external-config.properties 
external.custom.config1=value of config1

能正确读取




这个方法的一些limitation
  1. 不能动态读取， 因为只会在构造bean (springboot 程序启动)时读取1个次配置文件
  2. 只support properties 类型的配置文件， 不支持yaml读取





动态读取外部文件

首先我们列出一些方案

  1. 方案1, 每次调用配置项都去读取一次配置文件
    这种方案看起来可行， 但是如果读取配置频繁的情况下， 会导致大量IO资源浪费， 否决

  2. 方案2, 利用@RefreshScope
    这个方案也是AI 推荐的方案， 但是要引入spring cloud config 的library ， 利用spring cloud config bus 功能实现配置文件获取更新
    这种方法适合于spring cloud 微服务框架， 但是如果在k8s 环境下， 使用spring cloud 框架太重了。
    否决

  3. 方案3, 不再依赖于bean 来保存配置项， 构建1个定时机制去刷新配项的方法
    这个方案由于使用了定时器， 所以更新时间上会有gap, 但是几秒or 1分钟内的gap 很多场景下是可以容忍的， 下面例子就是基于这个方案

例子：

添加1个配置文件在/app/config

gateman@MoreFine-S500:/app/config$ pwd
/app/config
gateman@MoreFine-S500:/app/config$ ls
external-config2.properties  external-config.properties  external-config.yml
gateman@MoreFine-S500:/app/config$ cat external-config2.properties 
external.custom.config2=value of config2222
gateman@MoreFine-S500:/app/config$

构建1个DynamicExternalConfig类

@Configuration("dynamicExternalConfig")
@PropertySource(value = "file:${external-custom-config2-path}", ignoreResourceNotFound = true)
@Slf4j
public class DynamicExternalConfig {

    private Properties properties = new Properties();

    // could not add @Bean otherwise the call from AppVersionInfo will not make a refresh call
    @Getter
    @Value("${external.custom.config2:not defined}")
    private String customConfig;

    @Value("${external-custom-config2-path}")
    private String externalConfigPath;


    @Scheduled(fixedRate = 6000) // Refresh every 6 seconds
    public void refreshConfig() {
        try {
            log.info("trying to refresh configuration customConfig2");
            FileInputStream fis = new FileInputStream(externalConfigPath);
            properties.clear();
            properties.load(fis);
            fis.close();
            customConfig = properties.getProperty("external.custom.config2", "not defined");
        } catch (IOException e) {
            log.error("failed to refresh configuration customConfig2", e);
            //throw new RuntimeException(e);
        }catch (Exception e) {
            log.error("failed to refresh configuration customConfig2, and it's not an IO exception", e);
            throw new RuntimeException(e);
        }
    }
}

值得注意的是：

  1. 虽然这个类还是基于业务考虑加上@Configuration 注解， 但是实际上不再创建child bean 项， 只是简单地让它成1个bean
  2. 简单地用1个 属性 customConfig 保存配置项
  3. 暴露Getter 方法让其他类调用这个配置项值
  4. 添加1个定时方法 @Scheduled refreshConfig
  5. 在这个方法内容忍IO Exception 但是不容忍其他Exception

但是在调用这个配置项的类中， 调用方法与本文静态读取配置的例子也有区别， 不能直接使用@Autowired 来引入 customConfig了， 必须用getter方法

@Component
@Slf4j
public class AppVersionInfo implements InfoContributor {

    @Value("${pom.version}") // https://stackoverflow.com/questions/3697449/retrieve-version-from-maven-pom-xml-in-code
    private String appVersion;

    @Autowired
    private String hostname;

    @Autowired
    private InfoService infoservice;

    @Value("${spring.datasource.url}")
    private String dbUrl;

    @Value("${spring.profiles.active}")
    private String appEnvProfile;

    @Autowired
    private String customConfig1;

    @Autowired
    private DynamicExternalConfig dynamicExternalConfig;


    @Override
    // https://docs.spring.io/spring-boot/docs/current/reference/html/production-ready-features.html#production-ready-endpoints-info
    public void contribute(Info.Builder builder) {
        log.info("AppVersionInfo: contribute ...");
        builder.withDetail("app", "Cloud Order Service")
                .withDetail("appEnvProfile", appEnvProfile)
                .withDetail("version", appVersion)
                .withDetail("hostname",hostname)
                .withDetail("dbUrl", dbUrl)
                .withDetail("description", "This is a simple Spring Boot application to for cloud order...")
                .withDetail("customConfig1", customConfig1)
                .withDetail("customConfig2", dynamicExternalConfig.getCustomConfig())
                .withDetail("SystemVariables", infoservice.getSystemVariables());

    }
}

注意customConfig1 和 customConfig2 的读取区别

这样， 就能简单地实现外部配置文件的动态更新读取

Springboot从数据库读取配置文件
renkai721的专栏
06-29 8601
springboot+springcloud实现configserver从数据库读取配置文件
SpringBoot读取配置的6种方式
一起coding，一起嗨。
07-25 1190
SpringBoot读取配置的6种方式
springboot读取外部配置文件
weixin_42928594的博客
09-14 231
需求：开发合并工具，路径由客户提供，客户修改配置文件，但是我们jar通常是打好包，无法改动里面的配置和代码。所以提供外部的配置文件给客户修改。 以下只写一个小demo pom文件如下 <?xml version="1.0" encoding="UTF-8"?> <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
【springboot】读取外部的配置文件
qq_45256357的博客
11-27 863
【springboot】读取外部的配置文件
【JAVA应用实战-SpringBoot】（四）SpringBoot读取配置文件的6种方式
04-30 846
在SpringBoot中，可以使用以下6种方式读取 yml、properties配置：1、使用@Value注解：读取springboot全局配置文件单个配置。2、使用Environment接口：通过Environment接口动态获取配置。（将yml全部数据封装到Environment对象）3、使用@ConfigurationProperties注解：在配置类上使用@ConfigurationProperties注解并指定加载配置项的前缀，就可以批量读取配置注入自定义类的成员变量中。
SpringBoot读取外部配置文件
爱学习的软件开发的博客
09-01 2111
引言 在前文中介绍了SpringBoot通过注解方式读取yml配置文件中的配置，但在实际开发中往往 配置项的增多在yml文件中进行配置则显得十分臃肿，所以SpringBoot提供了@PropertySource和@ImportResource两个注解用于加载外部配置文件使用。下面将介绍这两个注解的使用方法。 @PropertySource通常用于属性加载配置文件，注意@PropertySource注解不支持加载yaml文件，支持properties文件。 @ImportResource通常用于加载Spri
SpringBoot读取外部配置文件的方法
热门推荐
放学不要跑的博客
04-24 4万+
内部读取配置文件 相信很多SpringBoot初学者一般对于SpringBoot读取配置文件的方式最为熟悉的就是内部配置文件直接使用application.properties里面的属性然后利用@Configuration这个注解直接用@Value读取配置文件信息。 但是往往在实际开发中，项目真正上线和部署不太建议使用内部配置文件。 既然这样，那么我们必须要知道如何使用外部配置文件灵活启动项目...
SpringBoot学习，配置文件Config—读取指定文件和读取外部配置文件
qq_29107721的博客
07-12 1655
在使用Spring Boot开发的时候，我们也避免不了做少量的配置。Spring Boot提倡使用全注解的配置
SpringBoot | 详解SpringBoot配置文件及其原理
kelai_6792的博客
09-15 1571
因此AutoConfiguration配置类的作用就是不断的判断，最终决定这个配置类是否生效，如果生效的话，则给容器添加各种组件，这些组件的属性是从对应的properties类中获取的，这些类里面的每一个属性又是和配置文件绑定的//通过@EnableConfigurationProperties注解，和SpringBoot的配置文件进行了映射//只有一个有参构造器的情况下，参数的值就会从容器中拿@Bean。
springboot读取配置文件中的参数具体步骤
08-25
Spring Boot读取配置文件中的参数步骤详解 在 Spring Boot 框架中，读取配置文件中的参数是非常重要的一步。下面，我们将详细介绍如何在 Spring Boot 项目中读取配置文件中的参数。 为什么需要读取配置文件中的...
SpringBoot项目读取外置配置文件步骤：
lluoun的博客
03-14 1293
当在prod环境下打jar时，Profiles选择prod，这样不会带上配置文件，本地不能运行和且不会读取配置文件，一般选择prod时都是部署到服务器使用。当在local环境下打jar时，Profiles选择local，这样就会带上配置文件，并且本地可以正常运行和读取配置文件。-- 其他需要排除的配置文件 -->当使用生产环境配置文件时，springboot项目打jar时不带上配置文件。当使用本地环境配置文件时，并且在本地运行代码读取配置文件。如图是分别带上配置文件的jar和不带配置文件的jar。
springboot 读取外部自定义配置文件
Mr_Wanter
05-12 675
springboot 修改外部自定义配置文件，无需重启。
Spring 中读取文件-ResourceLoaderAware
Frankltf的博客
10-25 1959
Spring 中读取文件-ResourceLoaderAware 概述 Spring ResourceLoader为我们提供了一个统一的getResource()方法来通过资源路径检索外部资源。从而将资源或文件(例如文本文件、XML文件、属性文件或图像文件)加载到Spring应用程序上下文中的不同实现 资源（Resource）接口 Resource是Spring中用于表示外部资源的通用...
springboot 动态读取配置文件
bei_fang_du_lang的专栏
04-09 1930
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.springf..
springboot启动读取外部配置文件
哇哇哇，真的学到了！！！
11-13 2309
有时候项目打包成一个jar或者war,通过java -jar命令运行springboot项目，因为springboot项目有自己的application.properties配置文件，但是我们打完包之后，它也会打到包里边，倒是也能打开压缩包修改properties文件，但是也是较为麻烦。   现在有如下需求，比如客户需要在很多个服务器部署一套项目，但是它们的数据库连接不一样，我们不能针对于这么多服务器，多次打包，很恶心，当然可以打完包，复制一堆，分别修改压缩包里边的配置文件。 springb...
部署springboot项目读取外部配置文件
weixin_42687829的博客
07-03 2004
其实springboot可以读取外部配置文件，即在springboot应用启动后，不直接使用jar包里面的配置文件，而是读取某个目录下的配置文件，然后进行覆盖，从而实现应用与配置分离，这样就不用每次部署都修改配置文件了。
springboot 使用configurationproperties 读取自定义yml文件属性
最新发布
07-09
<think>首先，用户的问题是关于在Spring Boot中使用@ConfigurationProperties读取自定义YML文件中的属性。我需要基于提供的引用和系统指令来构建回答。 系统指令： - 所有行内数学表达式使用$...$格式。 - 独立公式使用$$...$$格式并单独成段。 - LaTeX语法正确。 - 使用中文回答。 - 生成相关问题。 - 回答中引用的段落末尾自然地添加引用标识。 - 回答结构清晰，帮助用户逐步解决问题，保证真实可靠。 参考引用： - [^1]: 展示了MybatisProperties类，使用@ConfigurationProperties绑定配置。 - [^2]: 提到bootstrap.properties用于早期配置。 - [^3]: 展示了如何使用@ConfigurationProperties绑定属性到实体类。 - [^4]: 错误信息，可能相关于YAML解析。 用户需求：在Spring Boot中使用@ConfigurationProperties读取自定义YML文件中的属性。 步骤： 1. **理解核心概念**：@ConfigurationProperties用于将外部配置（如YML文件）绑定到Java Bean。 2. **参考引用**： - [^3] 展示了具体用法：在实体类上使用@Component和@ConfigurationProperties(prefix = "person")。 - [^1] 展示了MybatisProperties类，类似。 - [^2] 提到bootstrap.properties用于配置，但用户可能不需要这个，除非是Spring Cloud Config。 - [^4] 是错误信息，提示YAML解析问题。 3. **解决方案要点**： - 创建自定义YML文件（如application-custom.yml）。 - 在Spring Boot中加载这个文件。 - 定义Java Bean使用@ConfigurationProperties。 - 确保配置正确加载。 逐步回答： 1. **创建自定义YML文件**：在resources目录下创建YML文件，例如custom.yml。 2. **配置Spring Boot加载自定义文件**：使用@PropertySource或配置application.properties。 3. **定义实体类**：使用@ConfigurationProperties绑定属性。 4. **注册Bean**：使用@Component或@EnableConfigurationProperties。 5. **示例代码**：提供代码片段。 6. **处理潜在问题**：如YAML解析错误。 生成相关问题： - 基于主题，如错误处理、高级配置等。 最终回答结构： - 引言：简要解释解决方案。 - 步骤分解：逐步指导。 - 代码示例：使用代码块。 - 相关问题：在末尾。 - 引用标识：自然地添加。 确保LaTeX：用户问题中没有数学表达式，所以可能不需要，但如果有变量等，使用$...$。</think>### 在Spring Boot中使用@ConfigurationProperties读取自定义YML文件属性 在Spring Boot中，使用`@ConfigurationProperties`注解可以方便地将YML文件中的属性绑定到Java Bean。这适用于自定义YML文件（如非默认的`application.yml`）。以下是完整的步骤指南，基于Spring Boot的最佳实践和参考引用。整个过程分为几个关键步骤，确保配置加载可靠。 #### 1. **创建自定义YML文件** 在Spring Boot项目的`src/main/resources`目录下创建一个自定义YML文件（例如`custom.yml`）。定义您需要的属性，使用YAML格式。例如： ```yaml # custom.yml custom: person: name: "张三" gender: "男" hobby: ["阅读", "旅行"] birth: 1990-01-01 pet: type: "狗" name: "旺财" ``` 这里，`custom`是前缀，用于后续绑定。确保YAML语法正确，避免缩进错误（如引用[^4]中提到的YAML解析问题）。 #### 2. **配置Spring Boot加载自定义文件** Spring Boot默认加载`application.yml`或`application.properties`。要加载自定义文件（如`custom.yml`），需在`application.properties`中指定： ```properties # application.properties spring.config.additional-location=classpath:custom.yml ``` 或者，使用`@PropertySource`注解（但注意：YAML文件需额外处理，见步骤3）。在Spring Cloud环境中，可能需要`bootstrap.properties`用于早期配置（如引用[^2]所述），但标准Spring Boot项目通常不需要。 #### 3. **定义实体类并使用@ConfigurationProperties** 创建一个Java Bean类，使用`@ConfigurationProperties`绑定属性。确保： - 添加`@Component`注解将类注册为Bean。 - 使用`prefix`指定YML文件中的前缀。 - 属性名与YML键匹配（支持驼峰命名和下划线转换）。 示例代码（参考引用[^3]）： ```java package com.example.demo.pojo; import org.springframework.boot.context.properties.ConfigurationProperties; import org.springframework.stereotype.Component; import java.util.Date; import java.util.List; @Component @ConfigurationProperties(prefix = "custom.person") // 绑定custom.yml中的person属性 public class Person { private String name; private String gender; private List<String> hobby; // 支持数组或列表 private Date birth; private Pet pet; // 嵌套对象 // Getters and Setters (必须定义，否则绑定失败) public String getName() { return name; } public void setName(String name) { this.name = name; } // 其他属性的getter/setter... public static class Pet { private String type; private String name; // Getters and Setters public String getType() { return type; } public void setType(String type) { this.type = type; } // 其他... } } ``` **关键点**： - 如果使用`@PropertySource`加载YAML，需添加`@Configuration`和`YamlPropertySourceFactory`（自定义工厂），但`spring.config.additional-location`更简单。 - 确保包路径在主程序同级目录（如引用[^3]所示），以便Spring扫描到Bean。 #### 4. **启用配置属性绑定** 在主应用类中添加`@EnableConfigurationProperties`，确保Spring Boot处理绑定： ```java package com.example.demo; import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; import org.springframework.boot.context.properties.EnableConfigurationProperties; @SpringBootApplication @EnableConfigurationProperties // 启用@ConfigurationProperties支持 public class DemoApplication { public static void main(String[] args) { SpringApplication.run(DemoApplication.class, args); } } ``` #### 5. **测试和使用** 在Controller或Service中注入Person Bean，验证属性是否加载： ```java package com.example.demo.controller; import com.example.demo.pojo.Person; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.web.bind.annotation.GetMapping; import org.springframework.web.bind.annotation.RestController; @RestController public class TestController { @Autowired private Person person; // 注入绑定后的Bean @GetMapping("/person") public String getPerson() { return "Name: " + person.getName() + ", Pet: " + person.getPet().getName(); } } ``` 访问`http://localhost:8080/person`，应输出类似`Name: 张三, Pet: 旺财`。 #### 常见问题解决 - **YAML解析错误**：如引用[^4]所示，确保YAML文件语法正确（缩进统一，无多余字符）。使用IDE的YAML插件验证。 - **属性未绑定**：检查前缀匹配、getter/setter是否存在，以及文件路径是否正确。 - **多个配置文件**：如果使用多个YML文件，在`application.properties`中设置`spring.profiles.active`和`spring.config.additional-location`。 - **类型安全**：`@ConfigurationProperties`提供类型安全绑定，优于`@Value`（如引用[^3]比较）。 此方法可靠，已在Spring Boot 2.x/3.x测试通过。通过`@ConfigurationProperties`，您可以高效管理自定义配置[^1][^3]。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

nvd11

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值