Serverless App Engine：使用Spring Cloud開發微服務應用並部署至SAE

為什麼使用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的應用nacos-service-consumer綁定公網CLB。配置公網 CLB 訪問時，網路通訊協定選擇HTTP，HTTP 連接埠設定為80，容器連接埠設定為18082。具體步驟，請參見為應用綁定CLB。

2. 在瀏覽器中輸入應用的公網訪問地址並斷行符號，格式為http://<公網訪問IP>/echo-rest/rest-rest或http://<公網訪問IP>/echo-feign/feign-rest。頁面上返迴響應結果，表示應用部署成功。

配置項參考

更多關於Spring Cloud Alibaba Nacos Discovery的資訊，請參見開源版本的Nacos Discovery。