JAVA 在微服务环境中实现动态配置中心？Apollo 实战讲解 - 智猿学院-前后端，数据库，人工智能，云计算等领域前沿技术讲座

JAVA 微服务动态配置中心：Apollo 实战讲解

大家好！今天我们来聊聊在微服务环境中，如何使用 Apollo 构建动态配置中心。在微服务架构下，服务数量众多，配置复杂且频繁变更。传统的配置文件方式，例如 properties 文件，难以满足动态更新、版本控制、权限管理等需求。一个好的配置中心能够统一管理所有服务的配置，实现配置的动态更新，降低运维成本，提升系统稳定性。Apollo，作为一款优秀的开源配置管理平台，正为此而生。

1. 为什么需要动态配置中心？

在深入 Apollo 实战之前，我们先来明确一下动态配置中心解决的核心问题：

配置集中管理： 微服务数量庞大，每个服务都有自己的配置。统一配置中心可以避免配置分散在各个服务中，方便管理和维护。
配置动态更新： 当配置发生变更时，无需重启服务即可生效，避免服务中断，提升用户体验。
环境隔离： 支持不同环境（开发、测试、生产）使用不同的配置，避免配置混淆。
版本控制： 记录配置的修改历史，方便回滚到之前的版本。
权限控制： 限制对配置的访问和修改权限，保证配置安全。
灰度发布： 允许部分用户优先体验新配置，观察效果后再全面推广。

2. Apollo 架构简介

Apollo 的核心架构包含以下几个组件：

Config Service： 提供配置的获取、推送等服务。客户端从 Config Service 获取配置，并建立长连接，以便实时接收配置更新。
Admin Service： 提供配置的管理界面，包括配置发布、修改、删除等功能。
Meta Server： 提供 Config Service 和 Admin Service 的服务发现功能。客户端和 Admin Service 通过 Meta Server 找到可用的 Config Service 和 Admin Service。
Client SDK： 提供客户端 API，方便应用集成 Apollo。
Apollo Portal： 提供用户界面，方便用户管理配置。
Database： 用于存储配置信息。

可以用一张表格来概括这些组件：

组件名称	职责
Config Service	配置获取、推送，是客户端获取配置的入口。
Admin Service	配置管理界面，提供配置的发布、修改、删除等功能。
Meta Server	服务发现，帮助客户端和 Admin Service 找到可用的 Config Service 和 Admin Service。
Client SDK	客户端 API，方便应用集成 Apollo。
Apollo Portal	用户界面，方便用户管理配置。
Database	存储配置信息，包括配置项、namespace、应用信息等。

3. Apollo 实战：Spring Boot 集成

接下来，我们通过一个 Spring Boot 项目，演示如何集成 Apollo。

3.1 引入 Apollo 客户端依赖

在 pom.xml 文件中添加 Apollo 客户端依赖：

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

3.2 配置 Apollo 相关属性

在 application.yml 或 application.properties 文件中配置 Apollo 相关属性：

apollo:
  meta: http://apollo.example.com # Meta Server 地址
  app-id: SampleApp # 应用 ID
  bootstrap:
    enabled: true # 开启 Apollo Bootstrap
    namespaces: application,DBConfig # 指定需要加载的 namespace，多个 namespace 用逗号分隔
  cache-dir: apollo-cache # 本地缓存目录

注意替换 apollo.example.com 为你的 Meta Server 地址，SampleApp 为你在 Apollo Portal 创建的应用 ID。

3.3 使用 @ApolloConfig 和 @ApolloConfigChangeListener

@ApolloConfig: 用于注入指定 namespace 的配置。
@ApolloConfigChangeListener: 用于监听指定 namespace 的配置变更。

例如，我们创建一个配置类 AppConfig：

import com.ctrip.framework.apollo.Config;
import com.ctrip.framework.apollo.ConfigService;
import com.ctrip.framework.apollo.model.ConfigChangeEvent;
import com.ctrip.framework.apollo.spring.annotation.ApolloConfig;
import com.ctrip.framework.apollo.spring.annotation.ApolloConfigChangeListener;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;

@Component
public class AppConfig {

    @Value("${timeout:100}") // 默认值 100
    private int timeout;

    @ApolloConfig
    private Config config;

    @ApolloConfig("DBConfig") // 指定 namespace
    private Config dbConfig;

    public int getTimeout() {
        return timeout;
    }

    public String getDbUrl() {
        return dbConfig.getProperty("db.url", "default_db_url");
    }

    @ApolloConfigChangeListener({"application", "DBConfig"}) // 监听多个namespace
    public void onChange(ConfigChangeEvent changeEvent) {
        if (changeEvent.isChanged("timeout")) {
            timeout = config.getIntProperty("timeout", 100);
            System.out.println("Timeout changed to: " + timeout);
        }

        if (changeEvent.isChanged("db.url")){
            System.out.println("DB URL changed to: "+ dbConfig.getProperty("db.url", "default_db_url"));
        }

        System.out.println("Changes for namespace " + changeEvent.getNamespace());
        for (String key : changeEvent.changedKeys()) {
            System.out.println("Change - key: " + key + ", oldValue: " + changeEvent.getChange(key).getOldValue() + ", newValue: " + changeEvent.getChange(key).getNewValue());
        }

    }
}

在这个例子中：

timeout 属性使用了 @Value 注解，并设置了默认值 100。如果 Apollo 中没有配置 timeout 属性，则使用默认值。
config 属性使用了 @ApolloConfig 注解，注入了默认 namespace（即 application）的配置。
dbConfig 属性使用了 @ApolloConfig("DBConfig") 注解，注入了 DBConfig namespace 的配置。
onChange 方法使用了 @ApolloConfigChangeListener 注解，监听了 application 和 DBConfig 两个 namespace 的配置变更。当配置发生变更时，该方法会被自动调用。

3.4 在 Controller 中使用配置

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class HelloController {

    @Autowired
    private AppConfig appConfig;

    @GetMapping("/hello")
    public String hello() {
        return "Hello, timeout is: " + appConfig.getTimeout() + ", DB URL is: " + appConfig.getDbUrl();
    }
}

在 Controller 中，我们可以直接注入 AppConfig，并使用其中的配置属性。

3.5 启动 Spring Boot 应用

启动 Spring Boot 应用后，访问 /hello 接口，可以看到输出结果。然后，在 Apollo Portal 中修改 application namespace 的 timeout 属性，并发布。再次访问 /hello 接口，可以看到 timeout 的值已经更新，而无需重启服务。

4. Apollo 的一些高级特性

除了基本的配置管理功能，Apollo 还提供了一些高级特性，例如：

Namespace 管理： 支持多个 Namespace，可以根据不同的业务场景或环境，将配置进行隔离。
配置继承： 支持配置继承，可以从父 Namespace 继承配置，减少重复配置。
灰度发布： 支持灰度发布，可以指定部分客户端优先体验新配置。
权限管理： 支持权限管理，可以限制对配置的访问和修改权限。
多环境支持： 支持多环境，可以为不同的环境（开发、测试、生产）设置不同的配置。

5. Namespace 的使用

Namespace 是 Apollo 中一个重要的概念，用于隔离配置。常见的 Namespace 类型包括：

application： 默认的 Namespace，用于存放通用的配置。
私有 Namespace： 自定义的 Namespace，用于存放特定业务或功能的配置。
公共 Namespace： 可以被多个应用共享的 Namespace，用于存放公共的配置。

使用 Namespace 可以更好地组织和管理配置，避免配置冲突。

6. 配置加密

对于敏感信息，例如数据库密码，可以使用 Apollo 的配置加密功能。Apollo 支持 AES 加密算法。

6.1 配置加密步骤

生成密钥： 使用 Apollo 提供的工具生成 AES 密钥。
加密配置： 使用生成的密钥对敏感配置进行加密。
配置解密： 在客户端配置解密器，用于解密加密的配置。

6.2 代码示例

假设我们有一个需要加密的配置项 db.password。

生成密钥：
```
java -jar apollo-portal.jar gen_key
```
执行该命令后，会生成一个 AES 密钥。
加密配置：

假设生成的密钥为 your_secret_key，密码为 your_password。使用密钥对密码进行加密。这部分需要你自己编写加密工具，可以使用任何你熟悉的 AES 加密库。加密后的密文为 encrypted_password。

配置解密：

在 Apollo Portal 中，将 db.password 的值设置为 {cipher} + encrypted_password。

在客户端，需要配置解密器：

import com.ctrip.framework.apollo.Config;
import com.ctrip.framework.apollo.ConfigService;
import com.ctrip.framework.apollo.CipherManager;
import org.springframework.stereotype.Component;

@Component
public class MyCipherManager implements CipherManager {

    @Override
    public String decrypt(String ciphertext) {
        // 使用你的密钥解密
        // 请勿在代码中硬编码密钥，建议从安全的地方获取
        String secretKey = "your_secret_key"; // Replace with your actual secret key
        try {
            // AES 解密逻辑，这里只是一个示例，你需要根据你的加密方式进行调整
            // ... 解密逻辑 ...
            //这里是AES解密的伪代码示例
            //return AESUtil.decrypt(ciphertext, secretKey);
            return "your_password"; // Replace with decrypted password
        } catch (Exception e) {
            throw new RuntimeException("Failed to decrypt password", e);
        }
    }
}

需要在 Spring Boot 启动类中注册这个 CipherManager：

import com.ctrip.framework.apollo.spring.annotation.EnableApolloConfig;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.Bean;

@SpringBootApplication
@EnableApolloConfig
public class MyApplication {

    public static void main(String[] args) {
        SpringApplication.run(MyApplication.class, args);
    }

    @Bean
    public MyCipherManager myCipherManager() {
        return new MyCipherManager();
    }
}

现在，当你的应用读取 db.password 配置时，Apollo 客户端会自动调用 MyCipherManager 的 decrypt 方法进行解密。

7. 权限管理

Apollo 提供了完善的权限管理功能，可以控制用户对配置的访问和修改权限。

应用管理员： 可以管理应用的所有配置。
Namespace 管理员： 可以管理指定 Namespace 的配置。
只读用户： 只能查看配置，不能修改。

可以在 Apollo Portal 中配置权限。

8. 最佳实践

合理规划 Namespace： 根据业务场景和环境，合理规划 Namespace，避免配置冲突。
使用默认值： 为每个配置项设置默认值，避免因配置缺失导致程序出错。
配置加密： 对于敏感信息，使用配置加密功能，保证配置安全。
定期清理配置： 定期清理不再使用的配置，保持配置的整洁。
监控配置变更： 监控配置变更，及时发现和处理配置问题。

9. 常见问题

配置不生效： 检查 Apollo 客户端是否正确配置，Meta Server 地址是否正确，App ID 是否正确。
配置冲突： 检查是否存在多个 Namespace 包含相同的配置项，导致配置冲突。
配置丢失： 检查 Apollo Portal 是否正常运行，数据库连接是否正常。

10. 代码示例：灰度发布

import com.ctrip.framework.apollo.Config;
import com.ctrip.framework.apollo.ConfigService;
import org.springframework.stereotype.Component;

@Component
public class GrayReleaseConfig {

    private static final String GRAY_RELEASE_KEY = "gray.release.enabled";

    public boolean isGrayReleaseEnabled() {
        Config config = ConfigService.getAppConfig(); //or ConfigService.getConfig(namespace)
        return config.getBooleanProperty(GRAY_RELEASE_KEY, false);
    }
}

然后在代码中使用：

@Autowired
private GrayReleaseConfig grayReleaseConfig;

public void doSomething() {
    if (grayReleaseConfig.isGrayReleaseEnabled()) {
        // 执行灰度发布逻辑
        System.out.println("灰度发布逻辑");
    } else {
        // 执行正常逻辑
        System.out.println("正常逻辑");
    }
}

在 Apollo Portal 中，你可以为特定的客户端（例如，指定 IP 地址或用户 ID）设置 gray.release.enabled 为 true，从而实现灰度发布。这需要你在客户端代码中加入获取客户端标识的逻辑，并通过配置指定哪些客户端启用灰度版本。Apollo 本身不直接提供客户端标识的管理，这部分需要你自己实现。

总结：配置管理，动态更新，微服务利器

我们了解了微服务环境下配置管理的重要性，学习了 Apollo 的架构和核心概念，并通过 Spring Boot 集成演示了如何使用 Apollo 实现动态配置。希望大家能够掌握 Apollo 的使用方法，并在实际项目中灵活应用。

最后，再强调几个关键点：

选择合适的 Namespace 策略： 不同的业务场景需要不同的 Namespace 划分策略。
重视配置的安全性： 对于敏感信息，一定要进行加密处理。
做好配置变更的监控： 及时发现和处理配置问题，避免影响系统稳定性。

感谢大家的聆听！

JAVA 微服务动态配置中心：Apollo 实战讲解

发表回复 取消回复

发表回复取消回复