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 ファイルがクラスターモードではなくスタンドアロンモードで実行されることを示します。デフォルトでは、startup.cmd ファイルはクラスターモードで起動されます。Windows システムで startup.cmd ファイルをダブルクリックして実行すると、起動に失敗します。この場合、startup.cmd ファイルに MODE="standalone" を設定する必要があります。詳細については、「」Quick Start for Nacos をご参照ください。

ステップ 1：サービスプロバイダーの作成

ローカル環境でサービスプロバイダーアプリケーションプロジェクトを作成します。依存関係を追加し、サービス登録と検出を有効にし、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 Alibaba 2.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 に、com.aliware.edas パッケージを作成します。

4. com.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. com.aliware.edas パッケージに、EchoController を作成します。

   EchoController で、URL マッピングを /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 が表示され、[詳細] をクリックしてこのサービスの詳細を表示できます。

ステップ 2：サービス利用者の作成

このセクションでは、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 ディレクトリに、com.aliware.edas パッケージを作成します。

4. com.aliware.edas パッケージで RestTemplate と FeignClient を構成します。

   1. com.aliware.edas パッケージに、EchoService という名前のインターフェイスを作成し、@FeignClient アノテーションを追加して、対応する HTTP URL とメソッドを構成します。

      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. com.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. com.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 が表示され、[詳細] をクリックしてこのサービスの詳細を表示できます。

ステップ 3：ローカルテスト

ローカル環境で、利用者からプロバイダーへのサービス呼び出しをテストします。

• 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 を入力します。

ステップ 4：アプリケーションの SAE へのデプロイ

アプリケーションを SAE にデプロイすると、SAE サービスレジストリは Nacos Server のアドレス、サービスポート、名前空間、AccessKey、および Context-path 情報を高い優先度で自動的に設定します。追加の構成を行う必要はありません。元の構成を保持または削除できます。

ステップ 5：結果の検証

1. SAE にデプロイされた nacos-service-consumer アプリケーションにパブリック CLB をバインドします。CLB のパブリックアクセスを構成する際、[ネットワークプロトコル] に [HTTP] を選択し、[HTTP ポート] を 80 に、[コンテナポート] を 18082 に設定します。詳細については、「アプリケーションへの CLB のバインド」をご参照ください。

2. ブラウザのアドレスバーに、アプリケーションのパブリック IP アドレスを http://<Public IP address>/echo-rest/rest-rest または http://<Public IP address>/echo-feign/feign-rest の形式で入力し、Enter キーを押します。ページに応答が返された場合、アプリケーションは正常にデプロイされています。

設定項目

Spring Cloud Alibaba Nacos Discovery の詳細については、「Nacos Discovery」をご参照ください。