如何在SpringBoot应用中读取K8s挂载卷Secret文件并自动刷新配置

你当前使用的spring.config.import=configtree:是Spring Boot 2.4+引入的本地配置树功能，要实现挂载卷Secret文件变更时自动重载配置，完全不需要依赖Actuator的/refresh端点，以下是可行的实现方案：

1. 基于@ConfigurationProperties的自动刷新 #

这是最直接的方案，利用Spring Boot原生的配置绑定与自动刷新机制：

• 编写配置类，用@ConfigurationProperties绑定需要的凭证属性，避免使用@Value（@Value默认不支持自动刷新）：

@ConfigurationProperties(prefix = "db") // 假设你的凭证配置前缀是db
public class DbCredentials {
    private String username;
    private String password;

    // 生成getter、setter方法
}

• 在启动类或配置类上启用该配置绑定：

@SpringBootApplication
@EnableConfigurationProperties(DbCredentials.class)
public class YourApplication {
    public static void main(String[] args) {
        SpringApplication.run(YourApplication.class, args);
    }
}

• 开启自动刷新配置：在application.properties或application.yml中添加：

spring.config.refresh.enabled=true

当挂载卷的Secret文件发生变更时，Spring Boot会自动监听文件变化，刷新@ConfigurationProperties绑定的Bean实例，无需手动触发任何端点。

2. 配合Spring Cloud Context的自动刷新配置 #

如果需要更精细地控制刷新范围，可以添加以下配置：

spring.cloud.refresh.enabled=true
spring.cloud.refresh.refreshable=com.yourpackage.DbCredentials # 指定需要刷新的配置类全路径

这个配置会让Spring Cloud Context主动监听ConfigTree的文件变化，仅刷新指定的配置类，避免不必要的Bean刷新。

验证自动刷新效果 #

修改挂载卷中的Secret文件后，查看应用日志，若出现类似Reloading PropertySource for config tree at 'file:/path/to/your/configtree'的日志，说明配置已自动重载。你也可以在业务代码中注入DbCredentials，打印属性值来验证是否更新。

注意事项 #

• 确保Spring Boot与Spring Cloud版本兼容：你使用的spring-cloud-starter-config 3.1.5对应Spring Boot 2.6.x版本，完全支持上述自动刷新特性。
• 不要给配置类添加@RefreshScope注解，该注解是用于手动触发刷新场景的，会干扰自动刷新逻辑。

内容的提问来源于stack exchange，提问作者Deshan