apollo更改配置刷新@ConfigurationProperties配置类

最新推荐文章于 2025-06-15 18:11:35 发布

肥肥技术宅

最新推荐文章于 2025-06-15 18:11:35 发布

阅读量3.3k

点赞数 1

CC 4.0 BY-SA版权

分类专栏： java 文章标签： spring java spring boot

本文链接：https://blog.csdn.net/m0_71777195/article/details/129982737

前言

apollo配置经常使用的方式是@value，比较便捷，如果只出现在一个类中还行，但是如果多个类中并不是很方便，特别是如果出现配置值变化了之后需要触发相关变动也无法实现，因此就会考虑使用配置类@ConfigurationProperties，它能实现：

统一管理一组配置。
配置变化的时需要触发相关变动只涉及一个bean。

但是apollo配置变化时不会把@ConfigurationProperties的值进行更新，具体看官方文档，需要配合EnvironmentChangeEvent或RefreshScope使用。

可以大概看看：

package com.ctrip.framework.apollo.use.cases.spring.cloud.zuul;

import com.ctrip.framework.apollo.model.ConfigChangeEvent;
import com.ctrip.framework.apollo.spring.annotation.ApolloConfigChangeListener;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.BeansException;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.cloud.context.environment.EnvironmentChangeEvent;
import org.springframework.cloud.netflix.zuul.RoutesRefreshedEvent;
import org.springframework.cloud.netflix.zuul.filters.RouteLocator;
import org.springframework.context.ApplicationContext;
import org.springframework.context.ApplicationContextAware;
import org.springframework.stereotype.Component;

@Component
public class ZuulPropertiesRefresher implements ApplicationContextAware {

  private static final Logger logger = LoggerFactory.getLogger(ZuulPropertiesRefresher.class);

  private ApplicationContext applicationContext;

  @Autowired
  private RouteLocator routeLocator;

  @ApolloConfigChangeListener(interestedKeyPrefixes = "zuul.")
  public void onChange(ConfigChangeEvent changeEvent) {
    refreshZuulProperties(changeEvent);
  }

  private void refreshZuulProperties(ConfigChangeEvent changeEvent) {
    logger.info("Refreshing zuul properties!");

    /**
     * rebind configuration beans, e.g. ZuulProperties
     * @see org.springframework.cloud.context.properties.ConfigurationPropertiesRebinder#onApplicationEvent
     */
    this.applicationContext.publishEvent(new EnvironmentChangeEvent(changeEvent.changedKeys()));

    /**
     * refresh routes
     * @see org.springframework.cloud.netflix.zuul.ZuulServerAutoConfiguration.ZuulRefreshListener#onApplicationEvent
     */
    this.applicationContext.publishEvent(new RoutesRefreshedEvent(routeLocator));

    logger.info("Zuul properties refreshed!");
  }

  @Override
  public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
    this.applicationContext = applicationContext;
  }
}
复制代码

使用@ApolloConfigChangeListener注册了apollo配置变化监听器，内部使用了cloud发布EnvironmentChangeEvent事件进行更新。

/*
 * Copyright 2022 Apollo Authors
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless requir