Apollo 配置中心:客户端接入

通过上篇文章 分布式部署 的介绍 ,接下来就可以在程序中接入 Apollo 客户端进行调用,这篇文章主要介绍在 Java 和 .NET Core 中如何接入,更多可参考 其它语言客户端接入指南

创建应用

在客户端接入 Apollo 之前,先在 Apollo 管理后台创建一个 demo-apollo 应用,并添加配置项,如下:

demo-apollo 配置信息

创建 Namespace

在 Apollo 中,还可以通过建 Namespace 供应用进行关联使用。比如:有 N 个服务,每个服务有自己的配置信息,那就需要在 Apollo 中建 N 个应用,每个服务引用对应的应用配置,但有的配置可能是所有或部分服务都需要的,这时候就可以考虑创建一个公共的 Namespace 配置,需要这些配置信息的应用引用此 Namespace 即可。

通过应用右侧的 添加 Namespace 或者顶部的 管理员工具 进行 Namespace 的创建,然后在 Namespace 中添加配置项。

namespace

nginx 代理 Meta Server

分布式部署 介绍中启动了两个 Meta Server 实例,为了接下来客户端配置 Meta Server 方便(测试下来 .NET 下并不支持逗号分隔的方式),通过 nginx 做一层代理(nginx 只是一种选择),后面可直接使用 http://apollo.beckjin.com:8888

upstream apollo-server{
  server 192.168.199.133:8080;
  server 192.168.199.133:8081;
}

server {
  listen       8888;
  # 已在本地 hosts 中添加: 127.0.0.1 apollo.beckjin.com
  server_name  apollo.beckjin.com;

  location / {
    proxy_pass http://apollo-server;
  }
}

Java

  1. 创建一个 Spring Boot 项目,添加 Spring Web Starter 依赖

  2. 添加 apollo-client 依赖

    <dependency>
      <groupId>com.ctrip.framework.apollo</groupId>
      <artifactId>apollo-client</artifactId>
      <version>1.4.0</version>
    </dependency>
    
  3. 基于前面创建好的应用 demo-apollo 和 Namespace TEST1.Common,在 application.properties 中添加 Apollo 相关配置。(如果不需要本应用外的 Namespace,只需要配置 app.id)

    # 对应 Apollo 中应用的 AppId
    app.id=demo-apollo
    apollo.bootstrap.enabled=true
    # 添加 application 本身 和 TEST1.Common Namespace 的配置
    apollo.bootstrap.namespaces=application,TEST1.Common
    

    注意:namespaces 中的顺序是有讲究的,如果 application 和 TEST1.Common 中有相同 key ,那么 application 会覆盖掉 TEST1.Common 中相同 key 的值。

  4. 将配置信息注入到 ConfigBean 的属性上

    @Getter
    @Setter
    @ToString
    public class ConfigBean {
    
      @Value("${name:name取不到时的默认值}")
      private String name;
    
      @Value("${company:name取不到时的默认值}")
      private String company;
    
      @Value("${url:url取不到时的默认值}")
      private String url;
    }
    
    @Configuration
    @EnableApolloConfig
    public class AppConfig {
    
      @Bean
      public ConfigBean getConfigBean() {
        return new ConfigBean();
      }
    }
    

    添加 @Configuration、@EnableApolloConfig,标记配置信息来源 Apollo,@Value 指定 Apollo 中对应 key 的值映射到什么属性。

    在 ConfigBean 中使用了 lombok,简化属性的 Get、Set 生成,使用 lombok 需要在 IDEA 中添加 Lombok plugin

  5. 添加获取配置信息接口

    @RestController
    @RequestMapping("/test")
    public class TestController {
    
      @Autowired
      private AppConfig appConfig;
    
      @GetMapping(value = "/get-config")
      public ConfigBean getConfig() {
        return appConfig.getConfigBean();
      }
    }
    

    在启动项目前需要设置 VM options,指定 env 和 appllo meta:

    wm options
  6. 启动并调用接口

    config data

.NET Core

Apollo .NET 客户端支持 .NET Framework 和 .NET Core ,这里以 .NET Core 为例来介绍,更多可参考:apollo.net 中的 Demo。

  1. 创建一个 .NET Core API 项目,添加 Com.Ctrip.Framework.Apollo.Configuration NuGet 包

  2. 在 appsettings.json 添加 Apollo 配置信息

    {
      "apollo": {
        "AppId": "demo-apollo", // 应用id
        "MetaServer": "http://apollo.beckjin.com:8888/", 
        "Env": "PRO" 
      }
    }
    
  3. 修改 Program.cs

    public static IWebHostBuilder CreateWebHostBuilder(string[] args) =>
      WebHost.CreateDefaultBuilder(args)
        .ConfigureAppConfiguration(builder => builder
          .AddApollo(builder.Build().GetSection("apollo"))
          .AddNamespace("TEST1.Common") // 引入 TEST1.Common 命名空间
          .AddDefault()) // 默认 namespace: application
          .UseStartup<Startup>();
    

    以上配置如果 Default 中具有 TEST1.Common 相同的 key,那么 Default 会覆盖掉 TEST1.Common 中相同 key 的值。

  4. 添加获取配置信息接口

    public class ValuesController : ControllerBase
    {
      private IConfiguration _configration;
    
      public ValuesController(IConfiguration configuration)
      {
        _configration = configuration;
      }
    
      [HttpGet]
      public async Task<object> Get()
      {
        await Task.CompletedTask;
    
        return new
        {
          Name = _configration["name"],
          Company = _configration["company"],
          Url = _configration["url"]
        };
      }
    }
    

    服务启动成功后,配置信息会注入到 IConfiguration 中,可以从容器中的 IConfiguration 对象获取具体配置。

  5. 启动并调用接口

    config data

在之前的介绍中提到了客户端拉取到配置信息之后,会在本地文件中进行缓存,目的是在遇到服务不可用,或网络不通的时候,依然能从本地恢复配置。经过以上测试,可以在以下目录进行查看缓存文件:

Mac/Linux: /opt/data/{appId}/config-cache
Windows: C:\opt\data\{appId}\config-cache

在缓存文件存的情况下,可以将 Apollo 服务全部 kill 进行测试,服务依然能拉起到配置信息。

Apollo 修改配置发布后是实时生效的,但有些情况下并不能反应出来,主要原因还是在代码的实现上,如果存在这样的情况,需要看看代码的具体实现。比如:配置信息赋给了静态变量、程序内部有自己的缓存策略等。

参考链接

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,921评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,635评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,393评论 0 338
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,836评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,833评论 5 368
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,685评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,043评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,694评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 42,671评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,670评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,779评论 1 332
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,424评论 4 321
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,027评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,984评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,214评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,108评论 2 351
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,517评论 2 343