Spring Cloud Alibaba 基础教程：使用 Nacos 实现服务注册与发现

[dyc87112]

自 Spring Cloud Alibaba 发布第一个 Release 以来，就备受国内开发者的高度关注。虽然 Spring Cloud Alibaba 还没能纳入 Spring Cloud 的主版本管理中，但是凭借阿里中间件团队的背景，还是得到不少团队的支持；同时，由于 Spring Cloud Alibaba 中的几项主要功能都直指 Netflix OSS 中的重要组件，而后者最近频繁宣布各组件不在更新新特性，这使得 Spring Cloud Alibaba 关注度不断飙升，不少开发者或团队也开始小范围试水。笔者对此也进行了一段时间的调研与试水，接下来计划以《 Spring Cloud Alibaba 基础教程》为主题，为大家完成一套快速入门的免费内容，以支持开源社区的发展！ ^_^

更多关于 Spring Cloud Alibaba 的介绍可见：《 Spring Cloud 加盟重量级成员 Spring Cloud Alibaba，打造更符合中国国情的微服务体系》

什么是 Nacos

Nacos 致力于帮助您发现、配置和管理微服务。Nacos 提供了一组简单易用的特性集，帮助您快速实现动态服务发现、服务配置、服务元数据及流量管理。Nacos 帮助您更敏捷和容易地构建、交付和管理微服务平台。Nacos 是构建以“服务”为中心的现代应用架构 (例如微服务范式、云原生范式) 的服务基础设施。

在接下里的教程中，将使用 Nacos 作为微服务架构中的注册中心（替代：eurekba、consul 等传统方案）以及配置中心（ spring cloud config ）来使用。

安装 Nacos

下载地址： https://github.com/alibaba/nacos/releases 本文版本：0.7.0

下载完成之后，解压。根据不同平台，执行不同命令，启动单机版 Nacos 服务：

• Linux/Unix/Mac：sh startup.sh -m standalone
• Windows：cmd startup.cmd -m standalone

startup.sh脚本位于 Nacos 解压后的 bin 目录下。这里主要介绍 Spring Cloud 与 Nacos 的集成使用，对于 Nacos 的高级配置，后续再补充。所以，持续关注我的博客或者公众号吧！

启动完成之后，访问：http://127.0.0.1:8848/nacos/，可以进入 Nacos 的服务管理页面，具体如下；

在完成了 Nacos 服务的安装和启动之后，下面我们就可以编写两个应用（服务提供者与服务消费者）来验证服务的注册与发现了。

服务提供者

第一步：创建一个 Spring Boot 应用，可以命名为：alibaba-nacos-discovery-server。如果您还不会或者不了解 Spring Boot 应用，建议先学习《 Spring Boot 基础教程》。

第二步：编辑pom.xml，加入必要的依赖配置，比如：

<parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>2.0.5.RELEASE</version>
    <relativePath/> <!-- lookup parent from repository -->
</parent>

<dependencyManagement>
    <dependencies>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-dependencies</artifactId>
            <version>Finchley.SR1</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-alibaba-dependencies</artifactId>
            <version>0.2.1.RELEASE</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>
    </dependencies>
</dependencyManagement>

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
    </dependency>
    <dependency>
        <groupId>org.projectlombok</groupId>
        <artifactId>lombok</artifactId>
        <version>1.18.2</version>
        <optional>true</optional>
    </dependency>
</dependencies>

上述内容主要三部分：

• parent：定义 spring boot 的版本
• dependencyManagement：spring cloud 的版本以及 spring cloud alibaba 的版本，由于 spring cloud alibaba 还未纳入 spring cloud 的主版本管理中，所以需要自己加入
• dependencies：当前应用要使用的依赖内容。这里主要新加入了 Nacos 的服务注册与发现模块：spring-cloud-starter-alibaba-nacos-discovery。由于在dependencyManagement中已经引入了版本，所以这里就不用指定具体版本了。

第三步：创建应用主类，并实现一个 HTTP 接口：

@EnableDiscoveryClient
@SpringBootApplication
public class TestApplication {

    public static void main(String[] args) {
        SpringApplication.run(TestApplication.class, args);
    }

    @Slf4j
    @RestController
    static class TestController {
        @GetMapping("/hello")
        public String hello(@RequestParam String name) {
            log.info("invoked name = " + name);
            return "hello " + name;
        }
    }
}

内容非常简单，@SpringBootApplication定义是个 Spring Boot 应用；@EnableDiscoveryClient开启 Spring Cloud 的服务注册与发现，由于这里引入了spring-cloud-starter-alibaba-nacos-discovery模块，所以 Spring Cloud Common 中定义的那些与服务治理相关的接口将使用 Nacos 的实现。这点不论我们使用 Eureka、Consul 还是其他 Spring Cloud 整合的注册中心都一样，这也是 Spring Cloud 做了封装的好处所在，如果对 Eureka、Consul 这些注册中心的整合还不熟悉的可以看看以前的这篇：Spring Cloud 构建微服务架构：服务注册与发现（ Eureka、Consul ）。

第四步：配置服务名称和 Nacos 地址

spring.application.name=alibaba-nacos-discovery-server
server.port=8001

spring.cloud.nacos.discovery.server-addr=127.0.0.1:8848

第五步：启动上面创建的应用。可以在启动时候增加-Dserver.port=8001的形式在本机的不同端口上启动多个实例。

在应用启动好之后，我们可以在控制台或日志中看到如下内容，代表已经注册成功：

INFO 10476 --- [           main] o.s.c.a.n.registry.NacosServiceRegistry  : nacos registry, alibaba-nacos-discovery-server 10.123.18.216:8001 register finished

在启动都 ok 之后，我们可以访问 Nacos 的管理页面http://127.0.0.1:8848/nacos/来查看服务列表，此时可以看到如下内容：

这里会显示当前注册的所有服务，以及每个服务的集群数目、实例数、健康实例数。点击详情，我们还能看到每个服务具体的实例信息，如下图所示：

服务消费者

接下来，实现一个应用来消费上面已经注册到 Nacos 的服务。

第一步：创建一个 Spring Boot 应用，命名为：alibaba-nacos-discovery-client-common。

第二步：编辑 pom.xml 中的依赖内容，与上面服务提供者的一样即可。

第三步：创建应用主类，并实现一个 HTTP 接口，在该接口中调用服务提供方的接口。

@EnableDiscoveryClient
@SpringBootApplication
public class TestApplication {

    public static void main(String[] args) {
        SpringApplication.run(TestApplication.class, args);
    }

    @Slf4j
    @RestController
    static class TestController {

        @Autowired
        LoadBalancerClient loadBalancerClient;

        @GetMapping("/test")
        public String test() {
            // 通过 spring cloud common 中的负载均衡接口选取服务提供节点实现接口调用
            ServiceInstance serviceInstance = loadBalancerClient.choose("alibaba-nacos-discovery-server");
            String url = serviceInstance.getUri() + "/hello?name=" + "didi";
            RestTemplate restTemplate = new RestTemplate();
            String result = restTemplate.getForObject(url, String.class);
            return "Invoke : " + url + ", return : " + result;
        }
    }
}

这里使用了 Spring Cloud Common 中的LoadBalancerClient接口来挑选服务实例信息。然后从挑选出的实例信息中获取可访问的 URI，拼接上服务提供方的接口规则来发起调用。

第四步：配置服务名称和 Nacos 地址，让服务消费者可以发现上面已经注册到 Nacos 的服务。

spring.application.name=alibaba-nacos-discovery-client-common
server.port=9000

spring.cloud.nacos.discovery.server-addr=127.0.0.1:8848

第五步：启动服务消费者，然后通过 curl 或者 postman 等工具发起访问，下面以 curl 为例：

$ curl localhost:9000/test
Invoke : http://10.123.18.216:8001/hello?name=didi, return : hello didi
$ curl localhost:9000/test
Invoke : http://10.123.18.216:8002/hello?name=didi, return : hello didi

可以看到，两次不同请求的时候，真正实际调用的服务提供者实例是不同的，也就是说，通过LoadBalancerClient接口在获取服务实例的时候，已经实现了对服务提供方实例的负载均衡。但是很明显，这样的实现还是比较繁琐，预告下后面的几篇，关于服务消费的几种不同姿势。

代码示例

本文示例读者可以通过查看下面仓库的中的alibaba-nacos-discovery-server和alibaba-nacos-discovery-client-common项目：

• Github
• Gitee

如果您对这些感兴趣，欢迎 star、follow、收藏、转发给予支持！

以下专题教程也许您会有兴趣

• Spring Boot 基础教程
• Spring Cloud 基础教程