Consul快速入门（三）：Spring Cloud Consul实现服务注册与发现

最新推荐文章于 2022-07-29 15:41:59 发布
最新推荐文章于 2022-07-29 15:41:59 发布
阅读量1.3k 收藏 5
点赞数
分类专栏： Consul 文章标签： consul spring cloud 注册中心
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/u014513883/article/details/104597546
版权

1、前言

本文通过创建provider-service、consumer-service两个微服务，并通过feign接口调用来演示Spring Cloud整合Consul。阅读本文需要前置知识：

  • Spring Boot
  • Spring Cloud
  • Spring Cloud Feign

2、搭建provider-service服务

2.1、创建maven模块

创建provider项目，添加provider-service、provider-service-remote-api两个maven模块：

provider-module.png

2.2、添加spring boot、spring cloud依赖

在父模块provider中添加spring boot、spring cloud依赖
，spring cloud使用截止当前最新版本Hoxton.SR1，关联spring boot版本2.2.2.RELEASE

<properties>
    <java.version>1.8</java.version>
    <spring-cloud.version>Hoxton.SR1</spring-cloud.version>
</properties>

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

<dependencyManagement>
    <dependencies>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-dependencies</artifactId>
            <version>${spring-cloud.version}</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>
    </dependencies>
</dependencyManagement>

注意：spring boot和spring cloud之间有版本依赖关系，如果想用其他版本，请自行查询对应的依赖版本，否则可能由于不兼容服务起不来

2.3、provider-service-remote-api模块编写feign接口

maven模块provider-service-remote-api引入spring cloud feign

<dependencies>
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-openfeign</artifactId>
    </dependency>
</dependencies>

代码编写，新建IProviderRemoteService接口

@FeignClient(name = "provider-service")
public interface IProviderRemoteService {

    @RequestMapping(value = "hello", method = RequestMethod.GET)
    String hello();
}

2.4、provider-service模块编写接口实现

maven依赖

<dependency>
    <groupId>com.example</groupId>
    <artifactId>provider-service-remote-api</artifactId>
    <version>0.0.1-SNAPSHOT</version>
</dependency>
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter</artifactId>
</dependency>
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>

接口实现类ProviderRemoteService

@RestController
public class ProviderRemoteService implements IProviderRemoteService {

    @Override
    public String hello() {
        return "hello world!";
    }
}

2.5、集成spring cloud consul

引入spring cloud consul模块

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

application.yml添加consul配置

server:
  port: 8080
spring:
  application:
    name: provider-service
  cloud:
    consul:
      host: 127.0.0.1
      port: 8500
      discovery:
        heartbeat:
          enabled: true

启动类添加@EnableDiscoveryClient注解，启用服务发现功能

@SpringBootApplication
@EnableDiscoveryClient
public class Application {

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

}

到此，provider-service服务已经全部搭建完毕，完整项目结构：

provider-service.png

3、搭建consumer-service服务

3.1、创建maven模块

创建consumer项目，添加consumer-service，因为该服务不需要对外提供接口，所以无需consumer-service-remote-api模块：
consumer-module.png

3.2、consumer-service编写接口调用provider-service服务

引用provider-service-remote-api

<dependency>
    <groupId>com.example</groupId>
    <artifactId>provider-service-remote-api</artifactId>
    <version>0.0.1-SNAPSHOT</version>
</dependency>

编写测试接口，通过feign调用provider-service服务

@RestController
public class ConsumerController {

    @Autowired
    private IProviderRemoteService providerRemoteService;

    @RequestMapping(value = "/test")
    public String test() {
        return providerRemoteService.hello();
    }
}

3.3、集成spring cloud consul

同provider-service服务一样，引入spring cloud consul模块

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

application.yml添加consul配置

server:
  port: 9090
spring:
  application:
    name: consumer-service
  cloud:
    consul:
      host: 127.0.0.1
      port: 8500
      discovery:
        heartbeat:
          enabled: true

启动类添加@EnableDiscoveryClient注解，启用服务发现功能，并添加@EnableFeignClients注解，启用feign功能

@SpringBootApplication
@EnableDiscoveryClient
@EnableFeignClients
public class Application {

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

}

到此，consumer-service服务也搭建完成，完整项目结构：

consumer-service.png

4、测试

4.1、启动consul服务

为了便于测试，笔者在本机以开发者模式起了一个consul服务

D:\consul>consul agent -dev
==> Starting Consul agent...
           Version: 'v1.7.0'
           Node ID: 'c43eedeb-f211-dbf2-e3fa-3caa64f86ddb'
         Node name: 'DESKTOP-77V3R9P'
        Datacenter: 'dc1' (Segment: '<all>')
            Server: true (Bootstrap: false)
       Client Addr: [127.0.0.1] (HTTP: 8500, HTTPS: -1, gRPC: 8502, DNS: 8600)
      Cluster Addr: 127.0.0.1 (LAN: 8301, WAN: 8302)
           Encrypt: Gossip: false, TLS-Outgoing: false, TLS-Incoming: false, Auto-Encrypt-TLS: false

==> Log data will now stream in as it occurs:

    2020-02-22T15:34:07.878+0800 [DEBUG] agent: Using random ID as node ID: id=c43eedeb-f211-dbf2-e3fa-3caa64f86ddb
    2020-02-22T15:34:07.900+0800 [DEBUG] agent.tlsutil: Update: version=1
    2020-02-22T15:34:07.914+0800 [DEBUG] agent.tlsutil: OutgoingRPCWrapper: version=1
    2020-02-22T15:34:07.916+0800 [INFO]  agent.server.raft: initial configuration: index=1 servers="[{Suffrage:Voter ID:c43eedeb-f211-dbf2-e3fa-3caa64f86ddb Address:127.0.0.1:8300}]"
    2020-02-22T15:34:07.916+0800 [INFO]  agent.server.raft: entering follower state: follower="Node at 127.0.0.1:8300 [Follower]" leader=
    2020-02-22T15:34:07.919+0800 [INFO]  agent.server.serf.wan: serf: EventMemberJoin: DESKTOP-77V3R9P.dc1 127.0.0.1
    2020-02-22T15:34:07.920+0800 [INFO]  agent.server.serf.lan: serf: EventMemberJoin: DESKTOP-77V3R9P 127.0.0.1
    2020-02-22T15:34:07.920+0800 [INFO]  agent.server: Adding LAN server: server="DESKTOP-77V3R9P (Addr: tcp/127.0.0.1:8300) (DC: dc1)"
    2020-02-22T15:34:07.921+0800 [INFO]  agent.server: Handled event for server in area: event=member-join server=DESKTOP-77V3R9P.dc1 area=wan
    2020-02-22T15:34:07.921+0800 [INFO]  agent: Started DNS server: address=127.0.0.1:8600 network=udp
    2020-02-22T15:34:07.923+0800 [INFO]  agent: Started DNS server: address=127.0.0.1:8600 network=tcp
    2020-02-22T15:34:07.926+0800 [INFO]  agent: Started HTTP server: address=127.0.0.1:8500 network=tcp
    2020-02-22T15:34:07.928+0800 [INFO]  agent: started state syncer
==> Consul agent running!
...

4.2、启动服务注册到consul

分别启动provider-service服务和consumer-service服务，访问consul的Web UI界面可以看到两个服务都注册上来了：

consul-services.png

consul-nodes.png

4.3、调用测试接口

调用consumer-service测试接口http://127.0.0.1:9090/test

invoke.png

现在尝试把provider服务停止，consul注册中心可以看到健康检查状态为Critical，服务已经下线

`critical.png

此时，再次调用consumer-service测试接口，会报找不到服务

service not found.ong

5、Spring Cloud Consul应用配置

NameDefaultDescription
spring.cloud.consul.config.acl-token
spring.cloud.consul.config.data-keydataIf format is Format.PROPERTIES or Format.YAML then the following field is used as key to look up consul for configuration.
spring.cloud.consul.config.default-contextapplication
spring.cloud.consul.config.enabledTRUE
spring.cloud.consul.config.fail-fastTRUEThrow exceptions during config lookup if true, otherwise, log warnings.
spring.cloud.consul.config.format
spring.cloud.consul.config.nameAlternative to spring.application.name to use in looking up values in consul KV.
spring.cloud.consul.config.prefixconfig
spring.cloud.consul.config.profile-separator,
spring.cloud.consul.config.watch.delay1000The value of the fixed delay for the watch in millis. Defaults to 1000.
spring.cloud.consul.config.watch.enabledTRUEIf the watch is enabled. Defaults to true.
spring.cloud.consul.config.watch.wait-time55The number of seconds to wait (or block) for watch query, defaults to 55. Needs to be less than default ConsulClient (defaults to 60). To increase ConsulClient timeout create a ConsulClient bean with a custom ConsulRawClient with a custom HttpClient.
spring.cloud.consul.discovery.acl-token
spring.cloud.consul.discovery.catalog-services-watch-delay1000The delay between calls to watch consul catalog in millis, default is 1000.
spring.cloud.consul.discovery.catalog-services-watch-timeout2The number of seconds to block while watching consul catalog, default is 2.
spring.cloud.consul.discovery.consistency-modeConsistency mode for health service request.
spring.cloud.consul.discovery.datacentersMap of serviceId’s → datacenter to query for in server list. This allows looking up services in another datacenters.
spring.cloud.consul.discovery.default-query-tagTag to query for in service list if one is not listed in serverListQueryTags.
spring.cloud.consul.discovery.default-zone-metadata-namezoneService instance zone comes from metadata. This allows changing the metadata tag name.
spring.cloud.consul.discovery.deregisterTRUEDisable automatic de-registration of service in consul.
spring.cloud.consul.discovery.enabledTRUEIs service discovery enabled?
spring.cloud.consul.discovery.fail-fastTRUEThrow exceptions during service registration if true, otherwise, log warnings (defaults to true).
spring.cloud.consul.discovery.health-check-critical-timeoutTimeout to deregister services critical for longer than timeout (e.g. 30m). Requires consul version 7.x or higher.
spring.cloud.consul.discovery.health-check-headersHeaders to be applied to the Health Check calls.
spring.cloud.consul.discovery.health-check-interval10sHow often to perform the health check (e.g. 10s), defaults to 10s.
spring.cloud.consul.discovery.health-check-path/actuator/healthAlternate server path to invoke for health checking.
spring.cloud.consul.discovery.health-check-timeoutTimeout for health check (e.g. 10s).
spring.cloud.consul.discovery.health-check-tls-skip-verifySkips certificate verification during service checks if true, otherwise runs certificate verification.
spring.cloud.consul.discovery.health-check-urlCustom health check url to override default.
spring.cloud.consul.discovery.heartbeat.enabledFALSE
spring.cloud.consul.discovery.heartbeat.interval-ratio
spring.cloud.consul.discovery.heartbeat.ttl30s
spring.cloud.consul.discovery.hostnameHostname to use when accessing server.
spring.cloud.consul.discovery.include-hostname-in-instance-idFALSEWhether hostname is included into the default instance id when registering service.
spring.cloud.consul.discovery.instance-groupService instance group.
spring.cloud.consul.discovery.instance-idUnique service instance id.
spring.cloud.consul.discovery.instance-zoneService instance zone.
spring.cloud.consul.discovery.ip-addressIP address to use when accessing service (must also set preferIpAddress to use).
spring.cloud.consul.discovery.lifecycle.enabledTRUE
spring.cloud.consul.discovery.management-portPort to register the management service under (defaults to management port).
spring.cloud.consul.discovery.management-suffixmanagementSuffix to use when registering management service.
spring.cloud.consul.discovery.management-tagsTags to use when registering management service.
spring.cloud.consul.discovery.order0Order of the discovery client used by?CompositeDiscoveryClient?for sorting available clients.
spring.cloud.consul.discovery.portPort to register the service under (defaults to listening port).
spring.cloud.consul.discovery.prefer-agent-addressFALSESource of how we will determine the address to use.
spring.cloud.consul.discovery.prefer-ip-addressFALSEUse ip address rather than hostname during registration.
spring.cloud.consul.discovery.query-passingFALSEAdd the 'passing` parameter to /v1/health/service/serviceName. This pushes health check passing to the server.
spring.cloud.consul.discovery.registerTRUERegister as a service in consul.
spring.cloud.consul.discovery.register-health-checkTRUERegister health check in consul. Useful during development of a service.
spring.cloud.consul.discovery.schemehttpWhether to register an http or https service.
spring.cloud.consul.discovery.server-list-query-tagsMap of serviceId’s → tag to query for in server list. This allows filtering services by a single tag.
spring.cloud.consul.discovery.service-nameService name.
spring.cloud.consul.discovery.tagsTags to use when registering service.
spring.cloud.consul.enabledTRUEIs spring cloud consul enabled.
spring.cloud.consul.hostlocalhostConsul agent hostname. Defaults to ‘localhost’.
spring.cloud.consul.port8500Consul agent port. Defaults to ‘8500’.
spring.cloud.consul.retry.initial-interval1000Initial retry interval in milliseconds.
spring.cloud.consul.retry.max-attempts6Maximum number of attempts.
spring.cloud.consul.retry.max-interval2000Maximum interval for backoff.
spring.cloud.consul.retry.multiplier1.1Multiplier for next interval.
spring.cloud.consul.schemeConsul agent scheme (HTTP/HTTPS). If there is no scheme in address - client will use HTTP.
spring.cloud.consul.tls.certificate-passwordPassword to open the certificate.
spring.cloud.consul.tls.certificate-pathFile path to the certificate.
spring.cloud.consul.tls.key-store-instance-typeType of key framework to use.
spring.cloud.consul.tls.key-store-passwordPassword to an external keystore.
spring.cloud.consul.tls.key-store-pathPath to an external keystore.

来源官网：https://cloud.spring.io/spring-cloud-consul/reference/html/appendix.html

风树种子
关注
专栏目录
Consul作为SpringCloud配置中心
希望我的博客，能解决你工作中的问题
08-26 6430
一、背景介绍 在分布式系统中动态配置中，可以避免重复重启服务，动态更改服务参数等。一句话非常重要。 另外一篇文章也是这样说的，哈哈。 Consul 作为Spring 推荐的分布式调度系统其也具备配置中心的功能， 我们也可以利用其作为配置中心，其client端主动定时发起与配置中心同步机制，实现动态配置的的更新。 环境依赖： 名称 值 备注 JDK 1.8 Consul 1.5...
跟大家介绍一下关于Spring Cloud Consul
qq_40354025的博客
11-13 710
Spring Cloud Consul项目是针对Consul的服务治理实现。Consul是一个分布式高可用的系统，它包含多个组件，但是作为一个整体，在微服务架构中为我们的基础设施提供服务发现和服务配置的工具...
Spring Cloud Consul
个人学习笔记库，一篇一篇记录成长的足迹
07-29 588
Consul 是一套开源的分布式服务发现和配置管理系统，由 HashiCorp 公司用 Go 语言开发。提供了微服务系统中的服务治理、配置中心、控制总线等功能。这些功能中的每一个都可以根据需要单独使用，也可以一起使用以构建全方位的服务网格，Consul提供了一种完整的服务网格解决方案。 它同时具有很多优点。包括： 基于 raft 协议，比较简洁； 支持健康检查, 同时支持 HTTP 和 DNS 协议 支持跨数据中心的 WAN 集群 提供图形界面 跨平台等。...
consul java 服务发现_java相关：详解使用Spring Cloud Consul实现服务的注册和发现
weixin_32546235的博客
03-03 366
java相关：详解使用Spring Cloud Consul实现服务的注册和发现发布于 2020-5-30|复制链接摘记: 项目规划，2个服务端，1个客户端首先来看服务端，一：服务端1：项目依赖```xml..项目规划，2个服务端，1个客户端首先来看服务端，一：服务端1：项目依赖```xmlorg.springframework.cloudspring-cloud-consul-dependenc...
【微服务SpringCloud】：Consul 注册中心
悦.L的博客
10-27 692
文章目录1、什么是 Consul ？2、安装 Consul 1、什么是 Consul ？ Consul 是由 HashiCorp 公司推出的开源工具，用于实现分布式的、高可用的用于实现分布式系统的服务发现与配置。 Consul是分布式的、高可用的、 可横向扩展的用于实现分布式系统的服务发现与配置。 Consul 使用 Go 语言编写，安装包仅包含一个可执行文件，方便部署，与 Docker 等轻量级容器可无缝配合。Consul 的特点如下： 服务发现（Service Discovery）：Consul提
Cloud整合Consul
weixin_45877245的博客
07-17 109
Cloud整合Consul服务注册
详解使用Spring Cloud Consul实现服务的注册和发现
08-27
Spring Cloud Consul 是一个优秀的服务注册和发现工具，能够帮助我们快速实现服务注册和发现功能。 知识点： 1. 服务注册和发现的重要性 服务注册和发现是微服务架构中的一个关键组件，能够帮助我们更好地管理和...
spring cloud consul注册的服务报错critical的解决
08-26
在使用Spring Cloud Consul作为服务发现机制时，可能会遇到服务注册后被标记为"critical"状态的问题。这通常意味着Consul无法正确地进行健康检查，从而导致服务被认为不健康。解决此类问题的关键在于理解Consul如何...
spring-cloud-consul：Spring Cloud领事
01-30
《Spring Cloud Consul：构建微服务的利器》 在当今的云计算时代，微服务架构已经成为了软件开发领域的重要趋势。Spring Cloud作为一个强大的框架，为构建、配置和管理微服务提供了全面的支持。其中，Spring Cloud ...
10Spring Cloud Consul：服务治理与配置中心1
08-04
Spring Cloud Consul：服务治理与配置中心 Spring Cloud Consul 是 Spring Boot 应用提供了 Consul 的支持，Consul 既可以作为注册中心使用，也可以作为配置中心使用。Consul 是 HashiCorp 公司推出的开源软件，...
6.Cloud Consul服务注册与发现
自能生羽翼，何必仰云梯
05-21 221
1、 什么是Consul Consul是一套开源的分布式服务发现和配置管理系统，有HashiCorp公司用Go语言开发。提供了微服务系统中的服务治理、配置中心、控制总线等功能。这些功能中的每一个都可以根据单独需要使用，也可以一起使用以构建全方位的服务网络，总之Consul提供了一种完整的服务网络解决方案。其官方介绍见Consul官网。 它具有很多优点。包括：基于raft协议，比较简洁；支持健康检查，同时支持HTTP和DNS协议，支持跨数据中心的WAN集群，提供图形界面，跨平台，支持Linux/M...
SpringCloud系列教程03-服务注册之Consul
空夜's Blog
08-31 319
本篇文章介绍了通过consul进行服务注册与发现，替代eureka。 consul的使用更加简单、方便，支持服务注册、Ribbon、负载均衡、Zuul、分布式配置、控制总线。
[Spring Cloud系列]Consul实验篇
WN-YoungKun的博客
12-19 2082
猿Why为什么会想着写这样一篇文章？请先阅览先序篇。 先序篇，对Consul服务的服务特性、Spring Cloud Consul模块服务注册与服务发现原理进行了了解。但是感觉还是不够，在与同事“抬扛”的时候，明显的底气不足，特别是和“云端的架构师”聊服务治理的时候。所以，猿Why打算针对Consul的一些服务特性做几个验证性试验。 问题一：Consul服务重启，应用服务是否需要重新注册？ 实验步骤： 启动Consul服务 启动应用服务，注册到Consul Consul服务关闭 Consul服务重新启动
cloud使用consul作配置中心
面朝大海，春暖花开
04-07 695
cloud - 使用consul作配置中心 引入依赖 <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-consul-config</artifactId> </dependency&g...
Consul第二篇（Spring cloud整合consul）
qq_45078781的博客
07-14 126
（Consul第二篇）Spring cloud整合consul 一、创建cloud-provider-payment8006工程 二、修改pom.xml文件 添加cloud依赖以及其他必要依赖 <!-- SpringBoot整合consul客户端--> <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-st
【Spring Cloud 之 Consul】2019-01-27 SpringCloud使用Consul作为服务注册和发现中心
【程序员不弃】的博客
01-28 2442
【Spring Cloud 之 Consul】2019-01-27 SpringCloud使用Consul作为服务注册和发现中心 文章目录【Spring Cloud 之 Consul】2019-01-27 SpringCloud使用Consul作为服务注册和发现中心1. consul 的安装2. 搭建 consul 服务端(SpringCloud 往 consul 注册服务)2.1 父工程 spr...
【Spring Cloud】Consul注册中心实现服务发现
Dream it Possible
02-02 1008
【学习背景】 除了前面两篇博客中学习到的Eureka和Zookeeper可以实现服务的发布与调用，本篇博客要总结的Consul同样也可做服务的注册中心。 【学习内容】 1. Consul是什么？ Consul 是一个支持多数据中心分布式高可用的服务发现和配置共享的服务软件,由 HashiCorp 公司用 Go 语言开发, 基于 Mozilla Public License 2.0 的协议进行开源....
Consul开启ACL控制
qq_42489223的博客
03-30 4671
记录一下Consul开启 ACL方法和遇到的小坑 一、Consul的ACL是什么 ACL：访问策略控制 Consul的ACL用来控制访问API和Key/Value文档，做到访问控制。 二、达成目标 启动Consul ACL后，可以对服务注册和调用、Key/Value文档的访问控制，进行授权访问。 三、使用方法 一、开启ACL 1、添加consul配置文件，开启ACL。 创建config-dir目录，将以下配置文件放在此目录下，命名为acl.json { "acl": { "enabl
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值