SpringCloud中集成Consul实现服务注册与发现

场景

SpringCloud中集成Eureka实现服务注册(单机Eureka构建)：

https://blog.csdn.net/BADAO_LIUMANG_QIZHI/article/details/124688609

SpringCloud中集成Eureka实现集群部署服务注册与服务提供者：

https://blog.csdn.net/BADAO_LIUMANG_QIZHI/article/details/124710576

SpringCloud中集成Eureka时通过Discovery实现服务发现：

https://blog.csdn.net/BADAO_LIUMANG_QIZHI/article/details/124725905

SpringCloud中集成Zookeeper实现服务注册与发现：

https://blog.csdn.net/BADAO_LIUMANG_QIZHI/article/details/124749801

上面分别集成了Eureka和Zookeeper实现服务注册与发现。下面集成

Consul实现服务注册与发现。

Consul

官网介绍

https://www.consul.io/docs/intro

功能

1、服务发现

提供HTTP和DNS两种发现方式

2、健康监测

支持多种方式，HTTP、TCP、Docker、Shell脚本定制化监控

3、KV存储

key、value的存储方式

4、多数据中心

Consul支持多数据中心

5、可视化Web界面

下载

https://www.consul.io/downloads.html

教程

https://www.springcloud.cc/spring-cloud-consul.html

注：

博客：
https://blog.csdn.net/badao_liumang_qizhi
关注公众号
霸道的程序猿
获取编程相关电子书、教程推送与免费下载。

实现

1、安装并运行Consul

其他安装方式可以参考其官网

https://learn.hashicorp.com/consul/getting-started/install.html

这里使用较为方便的Docker的安装方式。

2、Docker中安装启动Consul

拉取镜像

docker pull consul

启动容器

docker run --name consul1 -d -p 8500:8500 -p 8300:8300 -p 8301:8301 -p 8302:8302 -p 8600:8600 consul agent -server -bootstrap-expect=1 -ui -bind=0.0.0.0 -client=0.0.0.0

命令参数说明

-net=host docker参数, 使得docker容器越过了net namespace的隔离，免去手动指定端口映射的步骤

-server consul支持以server或client的模式运行, server是服务发现模块的核心, client主要用于转发请求

-advertise 将本机私有IP传递到consul

-retry-join 指定要加入的consul节点地址，失败后会重试, 可多次指定不同的地址

-client 指定consul绑定在哪个client地址上，这个地址可提供HTTP、DNS、RPC等服务，默认是>127.0.0.1

-bind 绑定服务器的ip地址；该地址用来在集群内部的通讯，集群内的所有节点到地址必须是可达的，>默认是0.0.0.0

allow_stale 设置为true则表明可从consul集群的任一server节点获取dns信息, false则表明每次请求都会>经过consul的server leader

-bootstrap-expect 数据中心中预期的服务器数。指定后，Consul将等待指定数量的服务器可用，然后>启动群集。允许自动选举leader，但不能与传统-bootstrap标志一起使用, 需要在server模式下运行。

-data-dir 数据存放的位置，用于持久化保存集群状态

-node 群集中此节点的名称，这在群集中必须是唯一的，默认情况下是节点的主机名。

-config-dir 指定配置文件，当这个目录下有 .json 结尾的文件就会被加载

-enable-script-checks 检查服务是否处于活动状态，类似开启心跳

-datacenter 数据中心名称

-ui 开启ui界面

-join 指定ip, 加入到已有的集群中

端口说明

8500 : http 端口，用于 http 接口和 web ui访问；

8300 : server rpc 端口，同一数据中心 consul server 之间通过该端口通信；

8301 : serf lan 端口，同一数据中心 consul client 通过该端口通信; 用于处理当前datacenter中LAN的gossip通信；

8302 : serf wan 端口，不同数据中心 consul server 通过该端口通信; agent Server使用，处理与其他datacenter的gossip通信；

8600 : dns 端口，用于已注册的服务发现；

容器启动成功

然后关闭服务器上的8500防火墙端口，然后浏览器中访问如下ip:8500

访问成功之后会在Services中只有一个consul服务，其他两个是后来注册的服务。

3、服务提供者注册进Consul

参考上面新建其他子模块的基础上，新建8006端口的服务提供者模块

修改其pom文件添加Consul依赖

        <!--SpringCloud consul-server -->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-consul-discovery</artifactId>
        </dependency>

完整pom依赖

<?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">
    <parent>
        <artifactId>SpringCloudDemo</artifactId>
        <groupId>com.badao</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>cloud-providerconsul-payment8006</artifactId>

    <properties>
        <maven.compiler.source>8</maven.compiler.source>
        <maven.compiler.target>8</maven.compiler.target>
    </properties>

    <dependencies>
        <dependency><!-- 引入自己定义的api通用包，可以使用Payment支付Entity -->
            <groupId>com.badao</groupId>
            <artifactId>cloud-api-commons</artifactId>
            <version>${project.version}</version>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-actuator</artifactId>
        </dependency>
        <!--SpringCloud consul-server -->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-consul-discovery</artifactId>
        </dependency>
    </dependencies>

</project>

新建并修改application.yml的内容

###consul服务端口号
server:
  port: 8006

spring:
  application:
    name: consul-provider-payment
####consul注册中心地址
  cloud:
    consul:
      host: Consul的服务器ip
      port: 8500
      discovery:
        #hostname: 127.0.0.1
        service-name: ${spring.application.name}
        heartbeat:
          enabled: true

这里修改为上面安装的Consul的地址

然后新建主启动类并添加@EnableDiscoveryClient注解

package com.badao.springclouddemo;

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


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

新建一个controller

package com.badao.springclouddemo.controller;


import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import java.util.UUID;

@RestController
@Slf4j
public class PaymentController {
    @Value("${server.port}")
    private String serverPort;

    @RequestMapping(value = "/payment/consul")
    public String paymentConsul()
    {
        return "springcloud with consul: "+serverPort+"\t   "+ UUID.randomUUID().toString();
    }
}

让接口返回一个UUID。

然后启动该服务提供者，就可以在Consul上面的Services中发现该服务提供者了

4、服务消费者注册进Consul

参考上面新建子模块，这里新建88子模块

 修改其pom文件，如上面一样，添加依赖

<?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">
    <parent>
        <artifactId>SpringCloudDemo</artifactId>
        <groupId>com.badao</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>cloud-consumerconsul-order88</artifactId>

    <properties>
        <maven.compiler.source>8</maven.compiler.source>
        <maven.compiler.target>8</maven.compiler.target>
    </properties>

    <dependencies>
        <dependency><!-- 引入自己定义的api通用包，可以使用Payment支付Entity -->
            <groupId>com.badao</groupId>
            <artifactId>cloud-api-commons</artifactId>
            <version>${project.version}</version>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-actuator</artifactId>
        </dependency>
        <!--SpringCloud consul-server -->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-consul-discovery</artifactId>
        </dependency>
    </dependencies>

</project>

修改其pom文件

###consul服务端口号
server:
  port: 88

spring:
  application:
    name: cloud-consumer-order
####consul注册中心地址
  cloud:
    consul:
      host: Consul的服务器ip
      port: 8500
      discovery:
        #hostname: 127.0.0.1
        service-name: ${spring.application.name}
        heartbeat:
          enabled: true

新建其启动类

package com.badao.springclouddemo;

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


@SpringBootApplication
@EnableDiscoveryClient //该注解用于向使用consul或者zookeeper作为注册中心时注册服务
public class OrderConsulMain88
{
    public static void main(String[] args) {
            SpringApplication.run(OrderConsulMain88.class, args);
    }
}

为了实现服务调用，新增RestTemplate的配置类

package com.badao.springclouddemo.config;

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


@Configuration
public class ApplicationContextConfig
{
    @Bean
    @LoadBalanced
    public RestTemplate getRestTemplate()
    {
        return new RestTemplate();
    }
}

新建Controller并实现服务调用

package com.badao.springclouddemo.controller;

import lombok.extern.slf4j.Slf4j;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.client.RestTemplate;

import javax.annotation.Resource;


@RestController
@Slf4j
public class OrderConsulController
{
    public static final String INVOKE_URL = "http://consul-provider-payment";

    @Resource
    private RestTemplate restTemplate;

    @GetMapping(value = "/consumer/payment/consul")
    public String paymentInfo()
    {
        String result = restTemplate.getForObject(INVOKE_URL+"/payment/consul",String.class);
        return result;
    }
}

然后启动服务消费者，注册进Consul。

5、上面成功注册进Consul之后，就可以在Consul的界面中看到如上的Services了。

访问接口进行服务调用测试

6、注意事项

在消费者进行服务调用时提示：

No instances available for consul-....的提示，那是因为没有在pom依赖中添加actuator依赖

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

如果注册进Consul之后，界面上显示服务都是红色叉号，需要在yml配置文件中打开心跳检测

将spring.cloud.consul.discovery.heartbeart.enabled设置为true