.NET Core 下使用 Apollo 配置中心

阿星Plus發表於2020-09-11

Apollo（阿波羅）是攜程框架部門研發的分散式配置中心，能夠集中化管理應用不同環境、不同叢集的配置，配置修改後能夠實時推送到應用端，並且具備規範的許可權、流程治理等特性，適用於微服務配置管理場景。服務端基於Spring Boot和Spring Cloud開發，打包後可以直接執行，不需要額外安裝Tomcat等應用容器。

Apollo開源地址：https://github.com/ctripcorp/apollo

更多產品介紹可以檢視Apollo配置中心介紹，本篇主要介紹在 .NET 環境下如何使用 Apollo 配置中心。

Quick Start

為了方便，本次我選擇使用Docker部署，快速運用。

另外需要說明的是，不管是Docker方式部署Quick Start還是常規方式部署的，Quick Start只是用來快速入門、瞭解Apollo。如果部署Apollo在公司中使用，請參考分散式部署。

請確保開發環境有docker環境，然後下載docker-compose.yml和所需的sql檔案，然後在根目錄執行docker-compose up，一次執行會觸發下載映象等操作，需要耐心等待一些時間。

version: '2'

services:
  apollo-quick-start:
    image: nobodyiam/apollo-quick-start
    container_name: apollo-quick-start
    depends_on:
      - apollo-db
    ports:
      - "8080:8080"
      - "8070:8070"
    links:
      - apollo-db

  apollo-db:
    image: mysql:5.7
    container_name: apollo-db
    environment:
      TZ: Asia/Shanghai
      MYSQL_ALLOW_EMPTY_PASSWORD: 'yes'
    depends_on:
      - apollo-dbdata
    ports:
      - "13306:3306"
    volumes:
      - ./sql:/docker-entrypoint-initdb.d
    volumes_from:
      - apollo-dbdata

  apollo-dbdata:
    image: alpine:latest
    container_name: apollo-dbdata
    volumes:
      - /var/lib/mysql

搜尋所有apollo-quick-start開頭的日誌，看到以下日誌說明啟動成功：

apollo-quick-start    | Waiting for config service startup.....
apollo-quick-start    | Config service started. You may visit http://localhost:8080 for service status now!
apollo-quick-start    | Waiting for admin service startup.
apollo-quick-start    | Admin service started
apollo-quick-start    | ==== starting portal ====
apollo-quick-start    | Portal logging file is ./portal/apollo-portal.log
apollo-quick-start    | Started [239]
apollo-quick-start    | Waiting for portal startup....
apollo-quick-start    | Portal started. You can visit http://localhost:8070 now!

資料庫的埠對映為13306，所以如果希望在宿主機上訪問資料庫，可以通過localhost:13306，使用者名稱是root，密碼留空。如要檢視更多服務的日誌，可以通過docker exec -it apollo-quick-start bash登入， 然後到/apollo-quick-start/service和/apollo-quick-start/portal下檢視日誌資訊。

訪問http://localhost:8070，可以看到ApolloUI介面，預設賬號密碼為：apollo/admin

.NET Core 接入

新建一個 ASP.NET Core API專案，ApolloDemo，新增元件Com.Ctrip.Framework.Apollo.Configuration。

Install-Package Com.Ctrip.Framework.Apollo.Configuration

Apollo配置中心的 .NET 整合包開源地址：https://github.com/ctripcorp/apollo.net/tree/dotnet-core

接入也比較簡單，在appsettings.json中配置Apollo服務地址。

{
  "Apollo": {
    "AppId": "ApolloDemo",
    "Env": "DEV",
    "MetaServer": "http://localhost:8080",
    "ConfigServer": [ "http://localhost:8080" ]
  }
}

關於配置可以檢視文件：https://github.com/ctripcorp/apollo.net/tree/dotnet-core/Apollo.Configuration

為什麼地址埠是8080而不是8070？

因為在docker-compose.yml中我們暴露兩個埠：8080個8070，8070是我們的Apollo配置中心管理介面，而8080埠是Spring Eureka服務註冊中心。所以配置的應該是服務端的地址。

緊接著在Program.cs應用配置，程式碼如下：

using Com.Ctrip.Framework.Apollo;
using Com.Ctrip.Framework.Apollo.Logging;
using Microsoft.AspNetCore.Hosting;
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.Hosting;

namespace ApolloDemo
{
    public class Program
    {
        public static void Main(string[] args)
        {
            CreateHostBuilder(args).Build().Run();
        }

        public static IHostBuilder CreateHostBuilder(string[] args) =>
            Host.CreateDefaultBuilder(args)
                .ConfigureAppConfiguration((hostingContext, builder) =>
                {
                    LogManager.UseConsoleLogging(LogLevel.Trace);

                    builder.AddApollo(builder.Build().GetSection("Apollo")).AddDefault();
                })
                .ConfigureWebHostDefaults(webBuilder =>
                {
                    webBuilder.UseStartup<Startup>();
                });
    }
}

然後我們在Apollo管理介面新建一個與配置在appsettings.json中AppId同名的專案ApolloDemo。

Apollo有一個核心的概念：Namespace。

  • Namespace是配置項的集合，類似於一個配置檔案的概念。
  • Namespace型別有三種：私有型別、公共型別、關聯型別（繼承型別）。
  • Namespace的獲取許可權分為兩種：private （私有的）、public （公共的），這裡的獲取許可權是相對於Apollo客戶端來說的。

配置檔案有多種格式，例如：properties、xml、yml、yaml、json等。同樣Namespace也具有這些格式。在Portal UI中可以看到“application”的Namespace上有一個“properties”標籤，表明“application”是properties格式的。

非properties格式的namespace，在客戶端使用時需要呼叫ConfigService.getConfigFile(String namespace, ConfigFileFormat configFileFormat)來獲取，如果使用Http介面直接呼叫時，對應的namespace引數需要傳入namespace的名字加上字尾名，如datasources.json。
apollo-client 1.3.0版本開始對yaml/yml做了更好的支援，使用起來和properties格式一致：Config config = ConfigService.getConfig("application.yml");，Spring的注入方式也和properties一致。

關於Namespace`的文件：https://github.com/ctripcorp/apollo/wiki/Apollo核心概念之“Namespace”

接下來去新增幾個配置屬性，然後釋出。


現在去寫一個介面，來實時讀取Apollo中的配置。

using Microsoft.AspNetCore.Mvc;
using Microsoft.Extensions.Configuration;

namespace ApolloDemo.Controllers
{
    [Route("api/[controller]")]
    [ApiController]
    public class ValuesController : ControllerBase
    {
        [HttpGet]
        [Route("Apollo")]
        public IActionResult ApolloTest([FromServices] IConfiguration configuration, string key)
        {
            return Content(configuration.GetValue<string>(key));
        }
    }
}

使用起來也非常簡單，這裡根據傳入的key值不同，獲取到我們配置在Apollo中的value，並且是具有熱更新，實時動態改變的。

然後修改name和age的值，在呼叫介面看看。注意在Apollo中修改後，需要釋出才會生效。


簡單介紹了 .NET Core 下使用Apollo配置中心，Apollo的功能遠不止於此，根據需要可以去Github檢視官網Wiki介紹，有詳細的使用說明文件。

相關文章