使用配置中心 Apollo 实现实时配置更新

站长

2024年07月16日 05:30 · 阅读数 103

在 Java 项目中，使用配置中心 Apollo 实现实时配置更新的过程可以分为以下几个步骤：

引入 Apollo 依赖：在项目的 pom.xml 或 build.gradle 文件中添加 Apollo 客户端的依赖。

<dependency>
    <groupId>com.ctrip.framework.apollo</groupId>
    <artifactId>apollo-client</artifactId>
    <version>1.8.0</version>
</dependency>

配置 Apollo：在项目的资源文件夹中创建 application.properties 或 application.yml 文件，并添加 Apollo 的基本配置，例如 Apollo 的 Meta Server 地址和应用 ID。
```
app.id=your-app-id
apollo.meta=http://apollo-config-server-url
```

初始化 Apollo 客户端：在项目启动时初始化 Apollo 客户端。Apollo 客户端会在启动时从配置中心获取配置，并定期轮询配置更新。

import com.ctrip.framework.apollo.Config;
import com.ctrip.framework.apollo.ConfigService;
import com.ctrip.framework.apollo.model.ConfigChangeEvent;

public class ApolloConfigExample {
    public static void main(String[] args) {
        // 获取默认命名空间的配置
        Config config = ConfigService.getAppConfig();

        // 添加配置变更监听器
        config.addChangeListener((ConfigChangeEvent changeEvent) -> {
            changeEvent.changedKeys().forEach(key -> {
                System.out.println("Change - key: " + key + ", oldValue: " + changeEvent.getChange(key).getOldValue() + ", newValue: " + changeEvent.getChange(key).getNewValue());
                // 在这里可以处理配置更新的逻辑
            });
        });

        // 获取配置值
        String someKey = "someKey";
        String someValue = config.getProperty(someKey, "defaultValue");
        System.out.println("someKey: " + someValue);
    }
}

处理实时配置更新：在上面的代码中，config.addChangeListener 方法用于添加配置变更监听器。当 Apollo 配置中心的配置发生变更时，监听器会被触发，并在回调方法中处理配置更新逻辑。

自动更新 Spring 配置：如果使用 Spring 框架，可以通过 @Value 注解和 Apollo 的 @ApolloConfigChangeListener 注解实现配置的自动更新。

import com.ctrip.framework.apollo.spring.annotation.ApolloConfigChangeListener;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;

@Component
public class ConfigBean {
    @Value("${someKey:defaultValue}")
    private String someKey;

    @ApolloConfigChangeListener
    private void onChange(ConfigChangeEvent changeEvent) {
        if (changeEvent.isChanged("someKey")) {
            // 处理配置更新逻辑
            System.out.println("someKey updated: " + someKey);
        }
    }
}

通过上述步骤，Java 项目可以使用 Apollo 实现实时配置更新，确保配置的变更能够及时应用到项目中，提升项目的灵活性和可维护性。

配置实时更新是如何实现的

Apollo 配置中心实现实时配置更新的原理可以分为客户端和服务端两个部分来解释。

服务端

配置管理：
- Apollo 配置中心提供了一个统一的平台，允许开发人员通过 Web 界面或者 API 管理应用的配置。
- 配置存储在 MySQL 等持久化存储中，并且支持多环境（如开发、测试、生产）和多集群的配置管理。
版本控制和发布：
- 每次修改和发布配置时，Apollo 会生成一个新的配置版本，并将变更内容记录下来。
- 配置发布时，Apollo 会将最新的配置数据广播给所有监听该配置的客户端。

客户端

配置加载：
- 在客户端启动时，Apollo 客户端会从服务端拉取最新的配置，并将这些配置缓存到本地内存中。
- 客户端使用定时任务机制（通常每 5 分钟一次）向 Apollo 服务端发送 HTTP 请求，检查是否有新的配置版本。
长连接机制：
- 为了实现配置的实时更新，Apollo 客户端会与服务端建立一个长连接（通常是使用 HTTP 长轮询）。
- 长连接允许服务端在配置发生变更时，立即通知客户端，而不是依赖客户端定时轮询。
配置更新通知：
- 当服务端检测到有新的配置发布时，会通过长连接向客户端发送通知。
- 客户端接收到通知后，会立即从服务端拉取最新的配置，并更新本地缓存。
配置变更监听：
- 客户端提供了配置变更监听器机制，允许开发人员注册监听器，当配置变更时执行相应的回调逻辑。
- 这通常通过订阅 ConfigChangeEvent 事件来实现。

流程图解

配置发布：
- 开发人员通过 Apollo Web 界面修改配置并发布。
- Apollo 服务端记录变更并生成新版本，同时将变更通知广播给所有相关客户端。
长连接通知：
- 客户端与服务端保持一个 HTTP 长连接（长轮询）。
- 当服务端检测到有配置变更时，通过长连接立即通知客户端。
配置拉取：
- 客户端接收到变更通知后，立即向服务端发送请求，拉取最新的配置数据。
- 客户端更新本地缓存，并触发变更监听器执行相应的回调逻辑。

示例代码

import com.ctrip.framework.apollo.Config;
import com.ctrip.framework.apollo.ConfigService;
import com.ctrip.framework.apollo.model.ConfigChangeEvent;

public class ApolloConfigExample {
    public static void main(String[] args) {
        // 获取默认命名空间的配置
        Config config = ConfigService.getAppConfig();

        // 添加配置变更监听器
        config.addChangeListener((ConfigChangeEvent changeEvent) -> {
            changeEvent.changedKeys().forEach(key -> {
                System.out.println("Change - key: " + key + ", oldValue: " + changeEvent.getChange(key).getOldValue() + ", newValue: " + changeEvent.getChange(key).getNewValue());
                // 在这里可以处理配置更新的逻辑
            });
        });

        // 获取配置值
        String someKey = "someKey";
        String someValue = config.getProperty(someKey, "defaultValue");
        System.out.println("someKey: " + someValue);
    }
}

通过上述流程，Apollo 能够实现配置的实时更新，确保客户端在配置变更后能够立即感知并应用最新的配置。

转载自:https://juejin.cn/post/7386485874300895258