使用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的应用绑定SLB。具体步骤，请参见为应用绑定CLB。

2. 在浏览器输入配置好的公网访问地址，并在应用首页发起调用请求。

3. 在SAE控制台查看服务调用数据。

   1. 登录SAE控制台。

   2. 在左侧导航栏，选择应用管理 > 应用列表，在顶部菜单栏选择地域，然后单击具体应用名称。

   3. 在消费者应用基本信息页面的左侧导航栏，选择应用监控 > 应用总览，查看服务调用数据总览。

   如果能够监测到调用数据，说明服务调用成功。

配置项参考

更多关于Spring Cloud Alibaba Nacos Discovery的信息，请参见开源版本的Nacos Discovery。