Spring Cloud 接入服务注册与发现

本文介绍如何使用 ANS（Alibaba Naming Service，服务发现组件）将基于 Spring Cloud 开发的应用接入到 EDAS，并实现服务发现。

前提条件

• 注册阿里云账号

• 开通 EDAS 服务

创建服务提供者

1. 创建一个 Spring Cloud 工程，命名为 service-provider。这里我们以 Spring Boot 1.5.8 和 Spring Cloud Dalston.SR4 为例，在 pom.xml 中引入需要的依赖内容。

   其他版本如 Spring Boot 2 和 Spring Cloud Finchley 也同样支持，请您自行修改版本号和替换相应的组件依赖。

     <parent>
         <groupId>org.springframework.boot</groupId>
         <artifactId>spring-boot-starter-parent</artifactId>
         <version>1.5.8.RELEASE</version>
         <relativePath/>
     </parent>
     <dependencies>
         <dependency>
             <groupId>com.alibaba.cloud</groupId>
             <artifactId>spring-cloud-starter-ans</artifactId>
             <version>1.1.3</version>
         </dependency>
         <dependency>
             <groupId>com.alibaba.cloud</groupId>
             <artifactId>spring-cloud-alibaba-edas-starter</artifactId>
             <version>1.1.3</version>
         </dependency>
     </dependencies>
     <dependencyManagement>
         <dependencies>
             <dependency>
                 <groupId>org.springframework.cloud</groupId>
                 <artifactId>spring-cloud-dependencies</artifactId>
                 <version>Dalston.SR4</version>
                 <type>pom</type>
                 <scope>import</scope>
             </dependency>
         </dependencies>
     </dependencyManagement>

2. 编码服务提供端的启动类，其中 @EnableDiscoveryClient 注解表明此应用需开启服务注册与发现功能。

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

3. 创建一个简单的 controller，指定 url mapping 为 {/echo/{String}}，指定 http 方法为 GET，方法参数从 url 路径中获得，逻辑是将收到的参数回显。

    @RestController
     public class EchoController {
         @RequestMapping(value = "/echo/{string}", method = RequestMethod.GET)
        public String echo(@PathVariable String string) {
            return string;
        }
    }

4. 权限配置，配置阿里云账号的 AccessKey、SecretKey，以及 EDAS 的命名空间信息。

   1. 配置阿里云 AccessKey 和 SecretKey。

      1. 登录阿里云 AK 管理控制台。

      2. 在左侧导航栏单击安全信息管理。

      3. 在安全信息管理页面复制 AccessKey ID 和 Access Key Secret，分别对应配置项中的 alibaba.cloud.access-key 和 alibaba.cloud.secret-key。

         安全凭证信息格式如下：

         alibaba.cloud.access-key=xxxxxxxxxx
         alibaba.cloud.secret-key=xxxxxxxxxx

      4. 将安全凭证信息粘贴到您的配置文件中，如 application.properties。

   2. 配置 EDAS 的命名空间。

      1. 登录 EDAS 控制台。

      2. 在左侧导航栏中单击命名空间。

      3. 在命名空间列表页面选择地域，并找到您想发布到的命名空间，复制其命名空间 ID，对应配置项中的 alibaba.edas.namespace。

         alibaba.edas.namespace=xxxxxxxxxx

      4. 将命名空间信息粘贴到您的配置文件中，如 application.properties。

   3. 经过如上配置之后，我们的配置文件 application.properties 内容如下。

        spring.application.name=service-provider
        server.port=18081
        alibaba.cloud.access-key=xxxxxxxxxx
        alibaba.cloud.secret-key=xxxxxxxxxx
        alibaba.edas.namespace=cn-hangzhou

5. 登录 EDAS 控制台，进入服务管理 > 服务查询页面。选择地域和命名空间，在服务查询页面查看服务注册的信息。可以在服务名列表查看到创建的服务实例 service-provider，单击详情进入服务详情页，可以查看本机的IP地址和端口等信息。

创建服务消费者

该部分文档我们不仅演示了服务发现的功能，还说明了 ANS 服务发现与 RestTemplate、AsyncRestTemplate 和 FeignClient 这三个客户端是如何结合的。

1. 创建一个 Spring Cloud 工程，命名为 service-consumer。在 pom.xml 中引入需要的依赖内容：

    <parent>
         <groupId>org.springframework.boot</groupId>
         <artifactId>spring-boot-starter-parent</artifactId>
         <version>1.5.8.RELEASE</version>
         <relativePath/>
    </parent>
    <dependencies>
         <dependency>
             <groupId>com.alibaba.cloud</groupId>
             <artifactId>spring-cloud-starter-ans</artifactId>
             <version>1.1.3</version>
         </dependency>
         <dependency>
             <groupId>com.alibaba.cloud</groupId>
             <artifactId>spring-cloud-alibaba-edas-starter</artifactId>
             <version>1.1.3</version>
         </dependency>
    </dependencies>
    <dependencyManagement>
         <dependencies>
             <dependency>
                 <groupId>org.springframework.cloud</groupId>
                 <artifactId>spring-cloud-dependencies</artifactId>
                 <version>Dalston.SR4</version>
                 <type>pom</type>
                 <scope>import</scope>
             </dependency>
         </dependencies>
    </dependencyManagement>

   注意：与 service-provider 相比，service-consumer 要演示 FeignClient 的使用，故 pom.xml 文件中增加了一个 spring-cloud-starter-feign 的依赖。

2. 配置 RestTemplate、AsyncRestTemplate 和 FeignClient。

   1. FeignClient 是一个将HTTP 转为 RPC 格式调用的客户端。在使用他之前，我们需完成两项配置：

      1. @EnableFeignClient注解。

      2. 配置对应的 HTTP URL 地址及 HTTP 方法。

         @FeignClient(name = "service-provider")
         public interface EchoService{
            @RequestMapping(value = "/echo/{str}", method = RequestMethod.GET)
            String echo(@PathVariable("str") String str);
         }

   2. 在启动类中：

      1. 使用 @EnableDiscoveryClient 注解启用服务注册与发现；

      2. 使用 @EnableFeignClients 注解激活 FeignClient；

      3. 添加 @LoadBalanced 注解将 RestTemplate 与 AsyncRestTemplate 与服务发现结合。

         @SpringBootApplication
         @EnableDiscoveryClient
         @EnableFeignClients
         public class ConsumerApplication {
            @LoadBalanced
            @Bean
             public RestTemplate restTemplate() {
                return new RestTemplate();
            }
            @LoadBalanced
            @Bean
            public AsyncRestTemplate asyncRestTemplate(){
                 return new AsyncRestTemplate();
            }
            public static void main(String[] args) {
                 SpringApplication.run(ConsumerApplication.class, args);
            }
         }

3. 创建 Controller 以演示和验证服务发现功能。

   @RestController
   public class TestController {
        @Autowired
        private RestTemplate restTemplate;
        @Autowired
        private AsyncRestTemplate asyncRestTemplate;
        @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-async-rest/{str}", method = RequestMethod.GET)
        public String asyncRest(@PathVariable String str) throws Exception{
            ListenableFuture<ResponseEntity<String>> future = asyncRestTemplate.
            getForEntity("http://service-provider/echo/"+str, String.class);
            return future.get().getBody();
        }
        @RequestMapping(value = "/echo-feign/{str}", method = RequestMethod.GET)
        public String feign(@PathVariable String str) {
            return echoService.echo(str);
        }
   }

4. 添加应用基本配置和阿里云 AK、SK 以及 EDAS 的命名空间。

   spring.application.name=service-consumer
   server.port=18082
   alibaba.cloud.access-key=xxxxxxxxxx
   alibaba.cloud.secret-key=xxxxxxxxxx
   alibaba.edas.namespace=cn-hangzhou

5. 登录 EDAS 控制台，进入服务管理 > 服务查询页面。选择地域和命名空间，在服务查询页面查看服务注册的信息。可以在服务名列表查看到创建的服务实例 service-consumer。

6. 分别调用我们的演示 API，可以看到调用成功的结果。

   

Demo 下载

• service-provider

• service-consumer

更多配置项

FAQ

1. 我看到我的服务注册成功了，如何调用呢？

   答：spring-cloud-starter-ans 默认支持集成了 Ribbon，您可以使用 RestTemplate 和 FeignClient 调用。

2. 为什么我的服务注册总是失败？

   答：如果您在确认账号信息都准确无误的情况下，但是运行此文档中的 Demo 却注册失败了。有可能是由于您本机的时间不准确，从而导致验签鉴权失败。此时您需要校正本机的时间，建议打开时间自动同步功能。

参考

更多详情请参考 ANS 使用指南。