為什么使用SAE服務注冊中心

SAE服務注冊中心提供了開源Nacos Server的商用版本，使用開源版本Spring Cloud Alibaba Nacos Discovery開發的應用可以直接使用SAE提供的商業版服務注冊中心。

SAE服務注冊中心與Nacos、Eureka和Consul相比，具有以下優勢：

• 共享組件，節省了部署、運維Nacos、Eureka或Consul的成本。

• 在服務注冊和發現的調用中都進行了鏈路加密，保護您的服務，無需再擔心服務被未授權的應用發現。

• SAE服務注冊中心與SAE其他組件緊密結合，為您提供一整套的微服務解決方案，包括環境隔離、灰度發布等。

您在SAE部署應用時，SAE服務注冊中心以高優先級自動設置Nacos Server服務端地址和服務端口，以及命名空間、AccessKey、Context-path等信息，無需進行任何額外的配置。

準備工作

• 下載Maven并設置環境變量。

• 啟動Nacos Server。

  1. 下載并解壓Nacos Server。

  2. 進入nacos/bin目錄，啟動Nacos Server。

     • Linux、Unix、macOS系統：執行命令sudo sh startup.sh -m standalone。

     • Windows系統：執行命令startup.cmd -m standalone。

     說明

     standalone表示單機模式運行，非集群模式。startup.cmd文件默認以集群模式啟動，因此您在使用Windows系統時，如果直接雙擊執行startup.cmd文件會導致啟動失敗，此時需要在startup.cmd文件內設置MODE="standalone"。 更多信息，請參見Nacos快速開始。

步驟一：創建服務提供者

在本地創建服務提供者應用工程，添加依賴，開啟服務注冊與發現功能，并將注冊中心指定為Nacos Server。

1. 創建命名為nacos-service-provider的Maven工程。

2. 在pom.xml文件中添加依賴。

   具體示例，請參見nacos-service-provider。本文以Spring Boot 2.1.4.RELEASE和Spring Cloud Greenwich.SR1為例，依賴如下：

   說明

   不支持Spring Boot 2.4及以上版本。支持Spring Cloud Alibaba2.2.6.RELEASE版本（1.4.2客戶端版本）。

   <parent>
       <groupId>org.springframework.boot</groupId>
       <artifactId>spring-boot-starter-parent</artifactId>
       <version>2.1.4.RELEASE</version>
       <relativePath/>
   </parent>
   
   <dependencies>
       <dependency>
           <groupId>com.alibaba.cloud</groupId>
           <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
           <version>2.1.0.RELEASE</version>
       </dependency>
       <dependency>
           <groupId>org.springframework.boot</groupId>
           <artifactId>spring-boot-starter-web</artifactId>
       </dependency>
   </dependencies>
   
   <dependencyManagement>
       <dependencies>
           <dependency>
               <groupId>org.springframework.cloud</groupId>
               <artifactId>spring-cloud-dependencies</artifactId>
               <version>Greenwich.SR1</version>
               <type>pom</type>
               <scope>import</scope>
           </dependency>
       </dependencies>
   </dependencyManagement>
   
   <build>
       <plugins>
           <plugin>
               <groupId>org.springframework.boot</groupId>
               <artifactId>spring-boot-maven-plugin</artifactId>
           </plugin>
       </plugins>
   </build>                  

   示例中使用的版本為Spring Cloud Greenwich，對應Spring Cloud Alibaba版本為2.1.1.RELEASE。

   • 如果使用Spring Cloud Finchley版本，對應Spring Cloud Alibaba版本為2.0.1.RELEASE。

   • 如果使用Spring Cloud Edgware版本，對應Spring Cloud Alibaba版本為1.5.1.RELEASE。

     說明

     Spring Cloud Edgware版本的生命周期已結束，不推薦使用該版本開發應用。

3. 在src\main\java下創建Packagecom.aliware.edas。

4. 在Packagecom.aliware.edas中創建服務提供者的啟動類ProviderApplication，并添加以下代碼。

   其中@EnableDiscoveryClient注解表明此應用需開啟服務注冊與發現功能。

       package com.aliware.edas;
   
       import org.springframework.boot.SpringApplication;
       import org.springframework.boot.autoconfigure.SpringBootApplication;
       import org.springframework.cloud.client.discovery.EnableDiscoveryClient;
   
       @SpringBootApplication
       @EnableDiscoveryClient
       public class ProviderApplication {
   
           public static void main(String[] args) {
               SpringApplication.run(ProviderApplication.class, args);
           }
       }             

5. 在Packagecom.aliware.edas中創建EchoController。

   EchoController中，指定URL mapping為/echo/{string} ，指定HTTP方法為GET，從URL路徑中獲取方法參數，并回顯收到的參數。

       package com.aliware.edas;
   
       import org.springframework.web.bind.annotation.PathVariable;
       import org.springframework.web.bind.annotation.RequestMapping;
       import org.springframework.web.bind.annotation.RequestMethod;
       import org.springframework.web.bind.annotation.RestController;
   
       @RestController
       public class EchoController {
           @RequestMapping(value = "/echo/{string}", method = RequestMethod.GET)
           public String echo(@PathVariable String string) {
               return string;
           }
       }              

6. 在src\main\resources路徑下創建文件application.properties，在application.properties中添加如下配置，指定Nacos Server的地址。

       spring.application.name=service-provider
       server.port=18081
       spring.cloud.nacos.discovery.server-addr=127.0.0.1:8848               

   其中127.0.0.1為Nacos Server的地址。如果您的Nacos Server部署在另外一臺機器，則需要修改成對應的IP地址。如果有其它需求，可以在application.properties文件中增加配置。更多信息，請參見配置項參考。

7. 驗證結果。

   1. 執行nacos-service-provider中ProviderApplication的main函數，啟動應用。

   2. 登錄本地啟動的Nacos Server控制臺http://127.0.0.1:8848/nacos。

      本地Nacos控制臺的默認用戶名和密碼同為nacos。

   3. 在左側導航欄，選擇服務管理 > 服務列表。

      可以看到服務列表中已經包含了service-provider，且在詳情中可以查詢該服務的詳情。

步驟二：創建服務消費者

本節除介紹服務注冊的功能，還將介紹Nacos服務與RestTemplate和FeignClient兩個客戶端如何配合使用。

1. 創建命名為nacos-service-consumer的Maven工程。

2. 在pom.xml中添加依賴。

   具體示例，請參見nacos-service-consumer。

   <parent>
       <groupId>org.springframework.boot</groupId>
       <artifactId>spring-boot-starter-parent</artifactId>
       <version>2.1.4.RELEASE</version>
       <relativePath/>
   </parent>
   
   <dependencies>
       <dependency>
           <groupId>com.alibaba.cloud</groupId>
           <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
           <version>2.1.0.RELEASE</version>
       </dependency>
       <dependency>
           <groupId>org.springframework.boot</groupId>
           <artifactId>spring-boot-starter-web</artifactId>
       </dependency>
       <dependency>
           <groupId>org.springframework.cloud</groupId>
           <artifactId>spring-cloud-starter-openfeign</artifactId>
       </dependency>
   </dependencies>
   
   <dependencyManagement>
       <dependencies>
           <dependency>
               <groupId>org.springframework.cloud</groupId>
               <artifactId>spring-cloud-dependencies</artifactId>
               <version>Greenwich.SR1</version>
               <type>pom</type>
               <scope>import</scope>
           </dependency>
       </dependencies>
   </dependencyManagement>
   
   <build>
       <plugins>
           <plugin>
               <groupId>org.springframework.boot</groupId>
               <artifactId>spring-boot-maven-plugin</artifactId>
           </plugin>
       </plugins>
   </build>        

3. 在src\main\java下創建Packagecom.aliware.edas。

4. 在Packagecom.aliware.edas中配置RestTemplate和FeignClient。

   1. 在Packagecom.aliware.edas中創建一個接口類EchoService，添加@FeignClient注解，并配置對應的HTTP URL地址及HTTP方法。

      package com.aliware.edas;
      
      import org.springframework.cloud.openfeign.FeignClient;
      import org.springframework.web.bind.annotation.PathVariable;
      import org.springframework.web.bind.annotation.RequestMapping;
      import org.springframework.web.bind.annotation.RequestMethod;
      
      @FeignClient(name = "service-provider")
      public interface EchoService {
          @RequestMapping(value = "/echo/{str}", method = RequestMethod.GET)
          String echo(@PathVariable("str") String str);
      }                   

   2. 在Packagecom.aliware.edas中創建啟動類ConsumerApplication并添加相關配置。

      • 使用@EnableDiscoveryClient注解啟用服務注冊與發現。

      • 使用@EnableFeignClients注解激活FeignClient。

      • 添加@LoadBalanced注解將RestTemplate與服務發現集成。

      package com.aliware.edas;
      
      import org.springframework.boot.SpringApplication;
      import org.springframework.boot.autoconfigure.SpringBootApplication;
      import org.springframework.cloud.client.discovery.EnableDiscoveryClient;
      import org.springframework.cloud.client.loadbalancer.LoadBalanced;
      import org.springframework.cloud.openfeign.EnableFeignClients;
      import org.springframework.context.annotation.Bean;
      import org.springframework.web.client.RestTemplate;
      
      @SpringBootApplication
      @EnableDiscoveryClient
      @EnableFeignClients
      public class ConsumerApplication {
      
          @LoadBalanced
          @Bean
          public RestTemplate restTemplate() {
              return new RestTemplate();
          }
      
          public static void main(String[] args) {
              SpringApplication.run(ConsumerApplication.class, args);
          }
      }

5. 在Packagecom.aliware.edas中創建類TestController以演示和驗證服務發現功能。

       package com.aliware.edas;
   
       import org.springframework.beans.factory.annotation.Autowired;
       import org.springframework.web.bind.annotation.PathVariable;
       import org.springframework.web.bind.annotation.RequestMapping;
       import org.springframework.web.bind.annotation.RequestMethod;
       import org.springframework.web.bind.annotation.RestController;
       import org.springframework.web.client.RestTemplate;
   
       @RestController
       public class TestController {
   
           @Autowired
           private RestTemplate restTemplate;
           @Autowired
           private EchoService echoService;
   
           @RequestMapping(value = "/echo-rest/{str}", method = RequestMethod.GET)
           public String rest(@PathVariable String str) {
               return restTemplate.getForObject("http://service-provider/echo/" + str,
                       String.class);
           }
   
           @RequestMapping(value = "/echo-feign/{str}", method = RequestMethod.GET)
           public String feign(@PathVariable String str) {
               return echoService.echo(str);
           }
   
       }           

6. 在src\main\resources路徑下創建文件application.properties，在application.properties中添加以下配置，指定Nacos Server的地址。

       spring.application.name=service-consumer
       server.port=18082
       spring.cloud.nacos.discovery.server-addr=127.0.0.1:8848

   其中127.0.0.1為Nacos Server的地址。如果您的Nacos Server部署在另外一臺機器，則需要修改成對應的IP地址。如果有其它需求，可以在application.properties文件中增加配置。更多信息，請參見配置項參考。

7. 驗證結果。

   1. 執行nacos-service-consumer中ConsumerApplication的main函數，啟動應用。

   2. 登錄本地啟動的Nacos Server控制臺http://127.0.0.1:8848/nacos。

      本地Nacos控制臺的默認用戶名和密碼同為nacos。

   3. 在左側導航欄，選擇服務管理 > 服務列表，可以看到服務列表中已經包含了service-consumer，且在詳情中可以查詢該服務的詳情。

步驟三：本地測試

在本地測試消費者對提供者的服務調用結果。

• Linux、Unix、macOS系統：運行以下命令。

  curl http://127.0.0.1:18082/echo-rest/rest-rest
  curl http://127.0.0.1:18082/echo-feign/feign-rest

• Windows系統：在瀏覽器中輸入http://127.0.0.1:18082/echo-rest/rest-rest和http://127.0.0.1:18082/echo-feign/feign-rest。

步驟四：將應用部署到SAE

當您將應用部署到SAE時，SAE服務注冊中心會以更高優先級去設置Nacos Server服務端地址和服務端口，以及命名空間、AccessKey、Context-path信息。您無需進行任何額外的配置，原有的配置內容可以選擇保留或刪除。

步驟五：結果驗證

1. 為部署到SAE的應用綁定SLB。具體步驟，請參見為應用綁定CLB。

2. 在瀏覽器輸入配置好的公網訪問地址，并在應用首頁發起調用請求。

3. 在SAE控制臺查看服務調用數據。

   1. 登錄SAE控制臺。

   2. 在左側導航欄，選擇應用管理 > 應用列表，在頂部菜單欄選擇地域，然后單擊具體應用名稱。

   3. 在消費者應用基本信息頁面的左側導航欄，選擇應用監控 > 應用總覽，查看服務調用數據總覽。

   如果能夠監測到調用數據，說明服務調用成功。

配置項參考

更多關于Spring Cloud Alibaba Nacos Discovery的信息，請參見開源版本的Nacos Discovery。