1. 程式人生 > 其它 >SpringCloud中整合Consul實現服務註冊與發現

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