如何在运行时动态更新并持久化Spring应用配置属性？

1. 定义配置属性类 #

用@ConfigurationProperties绑定配置项，配合@RefreshScope实现运行时刷新，同时设置默认值：

@ConfigurationProperties(prefix = "app")
@RefreshScope
@Component
@Data // 用Lombok简化getter/setter，也可手动实现
public class AppConfigProperties {
    private double flagColorThreshold = 7.5;
    private int voteWeightUser = 1;
    private double voteWeightGuest = 0.75;
    private int voteTimeoutUser = 1800;
    private int voteTimeoutGuest = 3600;
}

2. 暴露管理员更新接口 #

创建REST接口供管理员修改配置，加入权限控制避免非法访问，同时处理参数校验和更新逻辑：

@RestController
@RequestMapping("/admin/config")
@PreAuthorize("hasRole('ADMIN')") // 需配合Spring Security实现权限控制
public class ConfigUpdateController {

    private final AppConfigProperties appConfig;
    private final ConfigFileUpdater configFileUpdater;
    private final RefreshScope refreshScope;

    public ConfigUpdateController(AppConfigProperties appConfig, 
                                  ConfigFileUpdater configFileUpdater,
                                  RefreshScope refreshScope) {
        this.appConfig = appConfig;
        this.configFileUpdater = configFileUpdater;
        this.refreshScope = refreshScope;
    }

    @PostMapping("/update")
    public ResponseEntity<Map<String, Object>> updateConfig(@RequestBody Map<String, Object> updates) {
        try {
            // 校验并更新内存配置
            updates.forEach((key, value) -> {
                switch (key) {
                    case "flagColorThreshold":
                        double threshold = Double.parseDouble(value.toString());
                        if (threshold < 0) throw new IllegalArgumentException("阈值不能为负数");
                        appConfig.setFlagColorThreshold(threshold);
                        break;
                    case "voteWeightUser":
                        int userWeight = Integer.parseInt(value.toString());
                        if (userWeight < 0) throw new IllegalArgumentException("用户投票权重不能为负数");
                        appConfig.setVoteWeightUser(userWeight);
                        break;
                    case "voteWeightGuest":
                        double guestWeight = Double.parseDouble(value.toString());
                        if (guestWeight < 0) throw new IllegalArgumentException("访客投票权重不能为负数");
                        appConfig.setVoteWeightGuest(guestWeight);
                        break;
                    case "voteTimeoutUser":
                        int userTimeout = Integer.parseInt(value.toString());
                        if (userTimeout <= 0) throw new IllegalArgumentException("用户超时时间必须大于0");
                        appConfig.setVoteTimeoutUser(userTimeout);
                        break;
                    case "voteTimeoutGuest":
                        int guestTimeout = Integer.parseInt(value.toString());
                        if (guestTimeout <= 0) throw new IllegalArgumentException("访客超时时间必须大于0");
                        appConfig.setVoteTimeoutGuest(guestTimeout);
                        break;
                    default:
                        throw new IllegalArgumentException("不支持的配置项: " + key);
                }
            });

            // 持久化到配置文件
            configFileUpdater.saveConfig(appConfig);

            // 触发配置刷新，确保所有依赖该配置的Bean立即生效
            refreshScope.refresh("appConfigProperties");

            // 返回更新后的配置
            Map<String, Object> result = new HashMap<>();
            result.put("flagColorThreshold", appConfig.getFlagColorThreshold());
            result.put("voteWeightUser", appConfig.getVoteWeightUser());
            result.put("voteWeightGuest", appConfig.getVoteWeightGuest());
            result.put("voteTimeoutUser", appConfig.getVoteTimeoutUser());
            result.put("voteTimeoutGuest", appConfig.getVoteTimeoutGuest());
            return ResponseEntity.ok(result);
        } catch (IllegalArgumentException e) {
            return ResponseEntity.badRequest().body(Map.of("error", e.getMessage()));
        } catch (Exception e) {
            return ResponseEntity.internalServerError().body(Map.of("error", "配置更新失败: " + e.getMessage()));
        }
    }
}

3. 实现配置持久化 #

要让配置重启后保留，需将更新后的内容写入配置文件（这里以application.yml为例，生产环境建议用外部挂载的配置文件）：

@Component
public class ConfigFileUpdater {

    // 配置文件路径，生产环境可改为外部路径，比如"/opt/config/application.yml"
    private static final String CONFIG_FILE_PATH = "src/main/resources/application.yml";

    public void saveConfig(AppConfigProperties config) throws IOException {
        File configFile = new File(CONFIG_FILE_PATH);
        Yaml yaml = new Yaml();
        
        // 读取现有配置
        Map<String, Object> configMap = yaml.load(new FileInputStream(configFile));
        if (configMap == null) configMap = new HashMap<>();

        // 更新app前缀下的配置项
        Map<String, Object> appSection = (Map<String, Object>) configMap.getOrDefault("app", new HashMap<>());
        appSection.put("flag-color-threshold", config.getFlagColorThreshold());
        appSection.put("vote-weight-user", config.getVoteWeightUser());
        appSection.put("vote-weight-guest", config.getVoteWeightGuest());
        appSection.put("vote-timeout-user", config.getVoteTimeoutUser());
        appSection.put("vote-timeout-guest", config.getVoteTimeoutGuest());
        configMap.put("app", appSection);

        // 写回配置文件
        try (FileWriter writer = new FileWriter(configFile)) {
            yaml.dump(configMap, writer);
        }
    }
}

4. 关键注意事项 #

• 权限控制：必须给更新接口添加管理员权限校验，可通过Spring Security实现角色或权限验证
• 参数校验：对输入的数值做合法性校验（比如不能为负、超时时间大于0），避免非法配置
• 生产环境适配：容器部署时，不要使用项目内的配置文件，改用外部挂载的配置文件（比如通过spring.config.location指定）
• 依赖引入：需要引入Lombok（简化代码）、SnakeYAML（处理YAML文件）、Spring Security（权限控制）等依赖，根据实际需求添加到pom.xml或build.gradle
• 刷新机制：调用refreshScope.refresh()会重新创建AppConfigProperties实例，确保所有依赖该配置的Bean获取到最新值

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