.NET Core + Spring Cloud：服務註冊與發現

毫無疑問，微服務架構是目前的主流，在微服務架構下，服務治理、負載均衡、服務熔斷、配置中心、API網關 等都是需要關注的問題，當然不是非要全部完善後才能進行微服務開發，在很多項目團隊中，初期可能會將某個服務部署成集羣，然後通過 Nginx 代理做到負載均衡提供服務，但隨着微服務體量逐漸龐大，以上提到需要關注的問題就越來越明顯。在 .NET Core 環境下，目前比較流行的微服務架構：Consul（服務治理、配置中心）+ Polly（服務熔斷）+ Ocelot（API網關），當然這只是一種組合方式。參考：NanoFabric

今天主要介紹一下如何通過 Spring Cloud 下的 Eureka 來實現服務註冊與發現，Spring Cloud 是 Java 平臺提供的一套解決方案，提供了微服務的基礎功能，包括 Eureka（服務治理）、Config（配置中心）、Hystrix（服務熔斷）、Zuul（API網關）等。

至於爲什麼要將 .NET Core 服務融合 Spring Cloud 來部署，毫無疑問，這只是一種結合方案，如果團隊是 Java + .NET， 如果恰好需要，嘗試一下也爲何不可。

Steeltoe

Steeltoe 是 .NET 與 Spring Cloud 結合的橋樑，Steeltoe 客戶端庫使 .NET Core 和 .NET Framework 應用程序能夠輕鬆利用 Spring Cloud 的 Eureka、Hystrix、Config Server、雲平臺服務 等核心組件。更多資料請參考官方文檔：http://steeltoe.io/docs/

搭建 Eureka Server

1. 在 IntelliJ IDEA 中新建項目，選 Spring Initializr 完成項目創建

2. 在 pom.xml 添加 eureka-server 的依賴

   <dependency>
       <groupId>org.springframework.cloud</groupId>
       <artifactId>spring-cloud-starter-netflix-eureka-server</artifactId>
   </dependency>
   

3. 在啓動類上添加 EnableEurekaServer 註解

   @EnableEurekaServer
   @SpringBootApplication
   public class EurekaServiceApplication {
       public static void main(String[] args) {
           SpringApplication.run(EurekaServiceApplication.class, args);
       }
   }
   

4. 修改配置文件，模擬搭建 Eureka Server 集羣

   application.yml

   spring:
     application:
       # 服務名
       name: eureka-service
     profiles:
       # 默認使用 server1 配置
       active: server1
   
   eureka:
     instance:
       # 超過這個時間沒收到心跳就剔除這個服務，這個配置一般爲服務刷新時間配置的三倍，默認90s
       lease-expiration-duration-in-seconds: 15
       # 服務刷新時間，默認30s
       lease-renewal-interval-in-seconds: 5
     client:
       # eureka client 刷新本地緩存時間，默認30s
       registry-fetch-interval-seconds: 5
     server:
       # eureka server 刷新 readCacheMap 的時間，client 讀取的是 readCacheMap，默認30s
       response-cache-update-interval-ms: 3000
       # 服務下線任務定時，默認60s
       eviction-interval-timer-in-ms: 3000
   

   application-server1.yml

   server:
     port: 8001
   
   eureka:
     instance:
       hostname: server1
     client:
       service-url:
         defaultZone: http://server2:8002/eureka/,http://server3:8003/eureka/
   

   application-server2.yml 和 application-server3.yml 與 server1 類似，只需 port、hostname、defaultZone 作調整。hostname 對應的名稱需要修改電腦的 C:\Windows\System32\drivers\etc\HOSTS 文件添加映射關係

   127.0.0.1 server1
   127.0.0.1 server2
   127.0.0.1 server3
   

5. 修改啓動配置

6. 啓動成功，訪問：http://server1:8001 (當前 Availability Zones 爲 3）

創建 .NET Core 基礎服務

基礎服務只提供服務，不引用其他服務

1. 創建 .NET Core WebApi 項目

2. Nuget 添加 Steeltoe.Discovery.ClientCore 引用（目前版本 2.1.1）

3. 修改 Startup.cs 的 ConfigureServices 方法，添加 AddDiscoveryClient

   public void ConfigureServices(IServiceCollection services)
   {
       services.AddDiscoveryClient(Configuration);
       services.AddMvc().SetCompatibilityVersion(CompatibilityVersion.Version_2_1);
   }
   

4. 修改 Startup.cs 的 Configure 方法，添加 UseDiscoveryClient

   public void Configure(IApplicationBuilder app, IHostingEnvironment env)
   {
       if (env.IsDevelopment())
       {
           app.UseDeveloperExceptionPage();
       }
       app.UseMvc();
       app.UseDiscoveryClient();
   }
   

5. 修改配置文件 appsettings.json，更多配置請參考 eureka-client-settings

   {
     "spring": {
       "application": {
         "name": "base-service"
       }
     },
     "eureka": {
       "client": {
         "serviceUrl": "http://server1:8001/eureka/",
         "shouldRegisterWithEureka": true,
         "shouldFetchRegistry": false // 不需要獲取註冊信息，只提供服務
       },
       "instance": {
         "port": 5001
       }
     }
   }
   

6. 修改 program.cs，添加 UseUrls，端口與 appsettings.json port 一致

   public static IWebHostBuilder CreateWebHostBuilder(string[] args) =>
       WebHost.CreateDefaultBuilder(args)
       .UseUrls("http://*:5001")
       .UseStartup<Startup>();
   

7. 再新建一個項目，其他都一致，端口改成 5002

8. 啓動 2 個 base-service 成功後在 Eureka 中查看如下：

創建 .NET Core 客戶端服務

客戶端服務需要調用基礎服務

與基礎服務的主要不同如下：

1. appsettings.json，拉取註冊信息（shouldFetchRegistry=true），添加 base-service url

   {
     "spring": {
       "application": {
         "name": "client-service"
       }
     },
     "eureka": {
       "client": {
         "serviceUrl": "http://server1:8001/eureka/",
         "shouldRegisterWithEureka": true,
         "shouldFetchRegistry": true
       },
       "instance": {
         "port": 6001
       }
     },
     "services": {
       "base-service": {
         "url": "http://base-service/"
       }
     }
   }
   

2. 修改 Startup.cs 的 ConfigureServices 方法

   services.AddDiscoveryClient(Configuration);
   services.AddTransient<DiscoveryHttpMessageHandler>();
   
   // 指定 BaseService 內使用的 HttpClient 在發送請求前通過 DiscoveryHttpMessageHandler 解析 BaseAddress 爲已註冊服務的 host:port
   services.AddHttpClient("base-service", c =>
   {
       c.BaseAddress = new Uri(Configuration["services:base-service:url"]);
   })
   .AddHttpMessageHandler<DiscoveryHttpMessageHandler>()
   .AddTypedClient<IBaseService, BaseService>();
   

3. 添加 BaseService 的封裝

   public interface IBaseService
   {
       Task<string> GetValueAsync();
   }
   
   public class BaseService : IBaseService
   {
       private readonly HttpClient _httpClient;
   
       public BaseService(HttpClient httpClient)
       {
           _httpClient = httpClient;
       }
       public async Task<string> GetValueAsync()
       {
           var result = await _httpClient.GetStringAsync("api/values");
           return result;
       }
   }
   

4. 啓動 client-service 成功後在 Eureka 中查看如下：

5. 通過訪問 http://server1:6001/api/values 查看調用 base-service 返回結果，因爲 base-service 有 2 個服務，所以會自動做到負載均衡

參考鏈接

• Steeltoe
• Steeltoe Discovery 文檔
• SteeltoeSamples 源碼