【Spring Cloud Alibaba】4 - 服务注册与发现 —— 服务消费者

温馨提示：全套教程请查看 教程总览

前提条件

需要先下载 Nacos 并启动 Nacos server。操作步骤参见 2 - 服务注册与发现组件 —— Nacos的安装

一、简介

Consumer 的应用可能还没像启动一个 Provider 应用那么简单。因为在 Consumer 端需要去调用 Provider 端提供的REST服务。本节中我们使用最原始的一种方式，即显示的使用 LoadBalanceClient 和 RestTemplate 结合的方式来访问。

二、搭建Consumer应用

1.创建项目

1.1 新建Module

1.2 引入依赖

pom.xml 内容如下：

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.ash</groupId>
        <artifactId>spring-cloud-alibaba-demo</artifactId>
        <version>${revision}</version>
    </parent>

    <artifactId>cloud-consumer</artifactId>
    <description>服务消费者</description>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-actuator</artifactId>
        </dependency>

        <!-- Nacos注册中心 -->
        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
        </dependency>

        <!-- loadbalancer负载均衡 -->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-loadbalancer</artifactId>
        </dependency>

        <!-- lombok -->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <!-- 打包插件 -->
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <executions>
                    <execution>
                        <goals>
                            <goal>repackage</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
        </plugins>
        <!-- 将源码中的xml文件打包到jar中 -->
        <resources>
            <resource>
                <directory>src/main/java</directory>
                <excludes>
                    <exclude>**/*.java</exclude>
                </excludes>
            </resource>
            <resource>
                <directory>src/main/resources</directory>
                <includes>
                    <include>**/*.*</include>
                </includes>
            </resource>
        </resources>
    </build>
</project>

2.添加配置文件

resources目录下新建 application.yml 配置文件，内容如下：

server:
  port: 9002

spring:
  application:
    # 服务名称
    name: cloud-consumer
  cloud:
    nacos:
      # nacos注册中心
      discovery:
        # 服务ip:port
        server-addr: 127.0.0.1:8848

management:
  endpoints:
    web:
      exposure:
        include: '*'

#消费者将要去访问的微服务名称(nacos微服务提供者服务名)
service-url:
  nacos-provider-service: http://cloud-provider

Note：如果不想使用 Nacos 作为你的服务注册与发现，可以将 spring.cloud.nacos.discovery.enabled 设置为 false

3.添加启动类

新建启动类 ConsumerApplication.java

内容如下：

package org.ash.consumer;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.client.discovery.EnableDiscoveryClient;

@SpringBootApplication
@EnableDiscoveryClient
public class ConsumerApplication {

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

4.配置RestTemplate

新建 RestTemplateConfig.java

内容如下：

package org.ash.consumer.config;

import org.springframework.cloud.client.loadbalancer.LoadBalanced;
import org.springframework.context.annotation.Bean;
import org.springframework.web.client.RestTemplate;

@Configuration
public class RestTemplateConfig {

    @Bean
    @LoadBalanced //赋予RestTemplate负载均衡的能力
    public RestTemplate restTemplate() {
        return new RestTemplate();
    }
}

5.添加API

新建 ConsumerController.java

提供一个API，内容如下：

package org.ash.consumer.controller;

import jakarta.annotation.Resource;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.client.RestTemplate;

@RestController
public class ConsumerController {
    @Resource
    private RestTemplate restTemplate;

    @Value("${service-url.nacos-provider-service}")
    private String serverURL;

    @GetMapping("/consumer/test/{message}")
    public String test(@PathVariable("message") String message)
    {
        String result = restTemplate.getForObject(serverURL + "/provider/test/" + message, String.class);
        return "服务消费者调用返回--" + result;
    }
}

三、运行测试

1.启动项目

1.1 启动服务提供者

1.2 启动服务消费者

注意：如果启动控制台报错，请检查 Nacos server 是否已启动

2.查看Nacos控制台

打开浏览器访问：http://localhost:8848/nacos ，并打开控制台 “服务管理” 下的 “服务列表” 页面，看到 cloud-provider 服务和 cloud-consumer 已经注册进Nacos，表示服务注册成功。

3.调用测试接口

打开浏览器调用我们之前写的测试接口 http://localhost:9002/consumer/test/cloud-provider ，成功返回消息，表示调用成功。

4.服务的 EndPoint

spring-cloud-starter-alibaba-nacos-discovery 在实现的时候提供了一个EndPoint，EndPoint的访问地址为 http://ip:port/actuator/nacosdiscovery。 EndPoint 的信息主要提供了两类:

1、subscribe: 显示了当前有哪些服务订阅者
2、NacosDiscoveryProperties: 显示了当前服务实例关于 Nacos 的基础配置

打开浏览器访问：http://localhost:9002/actuator/nacosdiscovery，成功返回EndPoint信息

注意：
这里有个坑需要注意一下，很多教程里面说 EndPoint 的访问地址为 http://ip:port/actuator/nacos-discovery，
包括Nacos官方Wiki 里面也是这样写的，但是实际调用的时候404，不确定是不是版本问题，我这边实际测试
访问地址是 http://localhost:9002/actuator/nacosdiscovery，没有中间的短横杠“-”，大家注意一下。

至此，服务注册与发现 —— 服务消费者搭建完成！！！

温馨提示：全套教程请查看 教程总览