Consul是微服务架构中，解决服务发现、配置中心的分布式中间件。

consul是分布式、高可用的系统，下图是单数据中心的部署架构。

说明:

consul主要有server和client两种组件组成。

server负责核心数据的存储和处理请求，server可以部署多个实例(通常推荐3-5个)，server只有一个leader实例，就是主节点，主节点是通过选举产生的，主节点负责数据的写入处理，同时将数据同步至其他server节点

client负责跟server通信，处理转发服务注册、服务发现请求到server节点，client还负责服务的健康检查，client节点可以部署多个实例，甚至每个微服务节点都部署一个client实例。

多数据中心架构图看下面官网给出的截图。

Consul安装比较友好，安装包解压压缩后只有一个执行程序consul。

官网下载地址：

根据自己的操作系统选在对应安装包下载即可。

教程以linux为例

将下载的安装包，解压缩到自己喜欢的目录，例如：

为了方便搜索到命令，将/local/consul添加到PATH环境变量中。

打开终端输入下面命令，即可表示安装成功。

显示以下内容：

我们知道consul主要分为server和client两个组件，server负责核心数据的存储和处理数据的读写，通过client可操作server提供的接口。

consul将server和client两个组件的实现都融合在一个叫consul的命令程序中，所以我们安装consul后，只有一个consul命令

在consul中，无论server还是client都叫做agent，通过命令参数区分，我们运行的是server还是client

consul部署好后，默认对外提供的接口地址是：127.0.0.1:8500或者consul agent ip地址+8500端口

作为本地开发环境，我们没有必要部署consul集群，只要一条命令就可以，以开发模式启动consul服务

-dev参数的意思，就是以开发模式启动consul，同时具备server和client的功能，不需要单独部署server和client

查询集群节点

打印出集群中所有的节点信息，可以通过status状态查看节点是否正常运行

我们只是启动开发模式，只有一个节点。

重新加载配置文件

如果我们修改了配置文件，可以使用这个命令，前面是单机模式，我们什么配置也不需要，以默认参数启动了

优雅关闭节点

优雅的关闭当前机器上的节点，如果你有多个节点，需要每个节点都执行此命令，否则就是关闭机器中的一个节点。

查询所有注册的服务

生产环境节点配置，主要分server节点和client节点，至少部署一个server节点，为了高可用，通常建议部署3-5个server节点，client节点任意，client节点可以跟服务节点数量一致，每台服务的节点部署一个client。

下图是单数据中心的部署架构：

通过配置文件配置启动server节点。

配置文件内容:/etc/consul.d/server.hcl

参数说明:

启动server命令:

参数说明: -config-dir 指定配置文件所在目录

注意你安装的consul的目录，可能跟这里不一样，输入正确的安装路径。

client节点的配置，跟server节点类似，就是少了一些参数。

配置文件内容:/etc/consul.d/client.hcl

参数说明：

跟server的参数对比，主要就是少了server和bootstrap_expect参数。

启动client的命令跟server一模一样。

consul支持两种方式注册，通过配置文件形式或通过http接口进行注册

基于配置文件的服务注册方式，是官方推荐的方式，因为这种方式对我们的微服务应用无侵入，就是不需要写代码调用consul的接口去注册。

1.定义一个服务

首选定义一个存放consul配置文件的目录，例如/etc/consul.d

为方便管理，我们通常一个微服务定义一个配置文件，服务定义配置文件是json格式。

例如：定义一个名字叫web的服务。

文件：/etc/consul.d/web.json

服务配置文件名，可以随便取，通常以服务名命名。

配置文件参数说明：

2.注册服务

本地开发模式，启动consul的时候，通过config-dir参数指定配置文件目录，就会自动注册配置文件目录下的所有服务。

如果你的consul agent已经启动，并且启动的时候已经通过参数config-dir指定了同样的配置目录，只要执行下面命令，重新加载配置值文件即可注册服务。

3.查询注册的服务

通过下面命令查询，当前注册的所有服务，会发现web服务已经注册成功。

输出：

4.反注册

就是删除注册的服务，输入下面命令，会删除注册的服务信息，同时删掉本地的服务的配置文件。

参数说明：

通过http接口注册服务，一般不推荐，毕竟还需要在写代码实现注册服务的逻辑，还不如配置文件方便，如果你想通过api注册，可以参考官方服务注册api接口文档：www.consul.io/api/catalog…

3.服务查询

consul支持两种接口查询我们注册服务信息，http api或者DNS查询

1.查询指定的服务

api格式:

http://localhost:8500/v1/catalog/service/**服务名**

例子:

查询web服务的多有地址信息

返回:

上面例子返回的结果是没有健康检查的结果，不知道服务地址是否可用。

2.仅查询可用的服务地址

下面查询服务信息，仅返回可用的服务信息，这个需要配置健康检查功能使用，后续有专门的章节介绍健康检查。

api格式:

在url后面增加一个passing参数代表，查询可用的服务地址。

例子:

查询web服务，可用的服务信息。

返回结果:

3.查询注册中心的服务目录

通过这个接口，我们可以查询consul目前注册了那些服务。

api格式:

例子:

请求api后，返回当前注册中心，注册的所有服务清单。

目前注册中心，只有两个服务web和consul

consul支持通过dns查询服务信息，dns只能返回可用的服务地址

下面我们公通过dig命令，进行dns查询请求。

例子:

查询web服务的地址。

参数说明:

web.service.consul是需要查询的域名。

consul服务的域名规则:

consul默认会为服务配置本地域名。

下面是执行dig命令后输出的结果:

上面dig命令，默认查询的是DNS的A记录，只能查询到IP地址，查询不到端口号，我们可以通过查询DNS的SRV记录，获取完整的服务地址(ip和端口号)

例子:

命令，最后面多了一个SRV，代表查询DNS的SRV记录

输出:

查询结果跟之前的命令差不多，下面仅显示关键信息。

分布式环境下，微服务实例的重启、微服务异常等等，都会导致服务不可用，例如：我们向consul注册了一个web服务，web服务启动了10个实例，现在有3个实例不可用，consul怎么知道那些服务实例不可用？

consul健康检查机制，就是解决上述问题的方案，健康检查机制运行在consul client中，会定期的根据服务健康检查配置，去检测服务是否正常，如果服务异常，就将服务的实例标记为不用， 如果恢复了，就标记为可用。

健康检查基本配置格式，是在服务定义配置中，增加checks字段，配置健康检查。

consul健康检查有多种方式，具体的配置参考下面。

定时以GET请求方式，请求指定url，http请求返回状态码200表示正常，其他状态代表异常。

例子:

基于tcp请求方式，就是定时，想指定的地址，建立tcp链接，连接成功就代表服务正常，否则就代表异常。

例子:

如果微服务是基于grpc协议，可以使用grpc协议监测服务是否正常。

例子:

consul支持定期执行一个命令或脚本，来检测服务是否正常，consul通过监测命令退出状态判断服务是否正常，命令退出状态0代表正常，其他代表异常。

例如:

通过shell脚本检测服务

例子1：

例子2：

为了安全考虑，如果健康检查使用执行命令方式，在启动consul的时候支持下面两种参数:

建议生产环境使用-enable-local-script-checks参数启动consul agent。

例子：

本地测试，增加-dev参数，代表开发模式，生产环境，去掉-dev参数。

因为只有consul的client才会执行健康检查任务，可以在client设置这个参数就可以。

consul提供一个键值存储（k/v）数据库,我们使用这个特性，存储我们的应用配置、应用元数据和实现分布式锁

consul支持命令和http api的方式读写键值对

consul的键（key）是以目录树的形式组织的，例如：

key以这种目录树结构组织，方便我们实现前缀搜索，例如 查询/tizi为前缀的键值数据。

主要通过consul kv的子命令读写数据。

下面介绍通过命令方式读写键值数据

1.更新/创建

如果key不存在则创建一个新的，存在则更新数据。

api语法：

my-key就是我们的key，更新key的值需要发送PUT请求

例子：

key = tizi365/domain，value = tizi365.com

2.读取

api语法：

查询指定key的值，发送get请求即可。

输出:

value的值是base64编码的，读取的时候需要编码处理。

3.删除

api语法：

删除指定的key，需要发送DELETE请求。

例子：

4.查询前缀相同的key有哪些

例子: 查询key前缀为/web/的所有key，不返回值。

返回：

5.批量查询前缀相同的key值

例子:

一次返回，key前缀等于tizi365的所有键值。

返回：

Consul自带了一个可视化的后台，我们可以再后台查看注册服务、修改一些配置等等。

启动UI很简单，只要在启动consul agent的时候加上一个参数即可，但是不需要每个Consul agent节点都需要启动UI，只要一个consul agent启动ui即可

consul agent启动ui后 ，默认地址是:http://localhost:8500/ui/

只要在启动Consul agent的时候，加上-ui参数即可。

例如：

启动开发模式的agent

只要在consul配置文件中添加 ui=true配置，重启consul agent即可。

可以查看当前注册了什么服务、服务的健康状态等等。

查看consul机器节点的情况

支持查看、创建、编辑键值数据

当consul中注册的服务信息发生变化的时候，我们除了定时通过接口去查询最新的服务信息之外，consul还提供了watch机制，通过监控consul数据的变化，主动通知。

目前consul watch支持两种通知方式：可执行程序和http接口。

consul watch支持监控的数据类型：

也就是说，consul支持监控服务、键值数据、节点信息、只要发生变化，就通知我们。

我们以监控键值数据的变化为例子，介绍watch机制的用法。

watch监控的配置信息是跟consul的配置文件放在一起的，通过配置文件中的watches字段，设置监控信息。

当我们监控的数据发生变化，consul agent会调用我们配置的可执行程序（命令、脚本等等），并且通过标准输入，以Json格式传入通知的参数， 我们只要在程序中根据参数处理业务即可。

例子：

下面是我们consul agent的配置，文件保存在/etc/consul.d/server.json

参数说明：

上面这些都是consul的基本配置，具体可以参考安装与部署章节，里面生产环境部署。

watches参数说明：

例子的watches配置的意思就是：

监控key=foo/bar/baz的键值数据，如果数据发生变化，就调用/usr/bin/my-service-handler.sh -redis 命令， 这个命令可以通过标准输入，接收变化的数据。

启动consul，就会加载watches配置。

例如：以开发模式启动

通过http接口通知数据变化，大体上配置跟上面一样，区别是多了一些http接口的配置参数。

例子:

我们关注watches字段的配置信息，下面是参数说明：

http_handler_config参数说明：

这个例子的意思，就是当key=foo/bar/baz的键值数据发生变化，就通过https://localhost:8000/watch 通知我们。

上面介绍了watch的基本用法，我们也可以监控服务信息的变化，例如当有人注册新的服务或者服务不可用的时候，通知我们。

我们忽略掉，consul agent的配置，单独看watches的配置。

监控所有的服务的配置

监控单个服务的配置

前面介绍过基本Key的监控，其实我们还可以通过key的前缀，批量监控一批key，只要key的前缀相同，这些Key下面的数据发生变化，都会发送通知。

监控类型为：keyprefix

通过prefix字段，配置key的前缀。

这个配置的意思就是：以foo/开头的Key, 数据发生变化，都会执行args参数，配置的命令。

我们也可以监控consul集群节点的变化信息。

没有其他额外的参数，type=nodes即可，当节点信息发生变化，会根据配置的方式通知。