Apollo 配置中心

Apollo 是携程开源的分布式配置中心，支持配置的集中管理、灰度发布、版本管理等功能。

安装

dotnet add package Apq.Cfg.Apollo

默认层级

该配置源的默认层级为 CfgSourceLevels.Apollo (200)。

如果不指定 level 参数，将使用默认层级：

// 使用默认层级 200
.AddApollo(options => { ... })

// 指定自定义层级
.AddApollo(options => { ... }, level: 250)

快速开始

using Apq.Cfg;
using Apq.Cfg.Apollo;

var cfg = new CfgBuilder()
    .AddJson("config.json")
    .AddApollo(options =>
    {
        options.AppId = "my-app";
        options.MetaServer = "http://localhost:8080";
        options.Cluster = "default";
        options.Namespaces = new[] { "application" };
        options.EnableHotReload = true;
    })  // 使用默认层级 200
    .Build();

// 读取配置
var value = cfg["Database:Host"];

// 订阅配置变更
cfg.ConfigChanges.Subscribe(e =>
{
    foreach (var (key, change) in e.Changes)
    {
        Console.WriteLine($"配置变更: {key} = {change.NewValue}");
    }
});

配置选项

选项	类型	默认值	说明
`AppId`	string	`""`	Apollo 应用 ID
`MetaServer`	string	`http://localhost:8080`	Meta Server 地址
`Cluster`	string	`default`	集群名称
`Namespaces`	string[]	`["application"]`	命名空间列表
`Secret`	string?	null	访问密钥（可选）
`EnableHotReload`	bool	true	是否启用热重载
`ConnectTimeout`	TimeSpan	10 秒	连接超时时间
`LongPollingTimeout`	TimeSpan	90 秒	长轮询超时时间
`DataFormat`	ApolloDataFormat	Properties	配置数据格式

多命名空间

Apollo 支持从多个命名空间读取配置：

.AddApollo(options =>
{
    options.AppId = "my-app";
    options.MetaServer = "http://localhost:8080";
    options.Namespaces = new[] { "application", "common", "database" };
})

当配置多个命名空间时，非 application 命名空间的配置键会自动添加命名空间前缀：

// application 命名空间的配置
var appName = cfg["App:Name"];

// common 命名空间的配置
var logLevel = cfg["common:Logging:Level"];

// database 命名空间的配置
var connStr = cfg["database:ConnectionString"];

热重载

启用 EnableHotReload 后，配置源会使用 Apollo 的长轮询通知机制监听配置变更：

.AddApollo(options =>
{
    options.EnableHotReload = true;
    options.LongPollingTimeout = TimeSpan.FromSeconds(90);
})

认证

Secret 签名认证

.AddApollo(options =>
{
    options.AppId = "my-app";
    options.MetaServer = "http://localhost:8080";
    options.Secret = "your-app-secret";
})

多层级配置

Apollo 配置源可以与其他配置源组合使用：

var cfg = new CfgBuilder()
    .AddJson("config.json")                              // 基础配置
    .AddJson("config.local.json", level: 1)              // 本地覆盖
    .AddApollo(options =>                                // Apollo 远程配置（使用默认层级 200）
    {
        options.AppId = "my-app";
        options.MetaServer = "http://apollo:8080";
    })
    .Build();

简化用法

// 使用简化的扩展方法
var cfg = new CfgBuilder()
    .AddApollo("my-app", "http://localhost:8080",
        namespaces: new[] { "application", "common" })  // 使用默认层级 200
    .Build();

注意事项

注意：Apollo 配置源不支持通过 API 写入配置。如需修改配置，请通过 Apollo 管理界面操作。

// 以下代码会抛出 NotSupportedException
cfg["Key"] = "Value";
await cfg.SaveAsync();  // 抛出异常

与其他配置中心对比

特性	Apollo	Nacos	Consul	Etcd
写入支持	❌	✅	✅	✅
多命名空间	✅	❌	❌	❌
多集群	✅	❌	✅	❌
灰度发布	✅	✅	❌	❌
本地缓存	✅（内置）	❌	❌	❌

依赖

无外部依赖，使用 HTTP API 直接与 Apollo 通信。

下一步

Nacos - Nacos 配置中心
Consul - Consul 配置中心

apollo.md 4.3 KB Permalink History Raw