Spring Cloud Consul-运行Consul客户端

谁践踏了优雅 2022-09-02 03:56 212阅读 0赞

> **关键词：**Spring Cloud    Consul    服务注册    服务发现    分布式配置

在使用**Spring Cloud Consul**的必要前提，是运行**Consul**服务，这样才能够使用Spring Cloud Consul提供的相关功能。

**（1）**下载软件包

Consul软件包是一个zip压缩二进制文件，我们需要根据自己使用的操作系统下载对应的软件包文件。可以从[Consul官网][Consul]下载合适的软件包。官网提供了如下几种操作系统下的软件包：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl81MDUxODI3MQ_size_16_color_FFFFFF_t_70][]

我使用的是64位的Windows操作系统，因此下载的版本是64-bit。点击链接可直接下载。

**（2）**运行Consul

从官网下载下来的zip文件，如：**consul\_1.10.1\_windows\_amd64.zip**。解压zip，得到**consul.exe**，其是Windows系统的可执行文件。

当我们双击consul.exe运行该可执行文件的时候，会看见有个黑窗口一闪而过。此时不要慌，执行consul.exe是需要在命令行运行的。

**①**打开cmd命令行窗口

**WIN + R**，然后输入**cmd**回车：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl81MDUxODI3MQ_size_16_color_FFFFFF_t_70 1][]

**②**进入到consul.exe所在的目录，我的是放在了D盘的consul文件夹下的。

使用命令：***consul***，该命令相当于***consul --help***。可以查看consul支持的命令行功能。*（如果运行consul无法出现如图所示的列表内容，请检查软件包是否有问题）*

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl81MDUxODI3MQ_size_16_color_FFFFFF_t_70 2][]

**③**启动Consul服务

使用命令：***consul agent -dev***，以dev环境启动Consul客户端

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl81MDUxODI3MQ_size_16_color_FFFFFF_t_70 3][]

从上面控制台输出的日志可以得到，Consul服务使用的通信协议是**http**，端口号默认为**8500**，访问地址为：**127.0.0.1:8500**，也就是**localhost:8500**。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl81MDUxODI3MQ_size_16_color_FFFFFF_t_70 4][]

既然Consul服务使用的是http协议，并且知道了服务地址为localhost:8500，在浏览器访问localhost:8500：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl81MDUxODI3MQ_size_16_color_FFFFFF_t_70 5][]

经过上面几个步骤，至此Consul服务启动成功。为了方便使用Consul提供的相关命令行命令，可以将Consul配置到环境变量中。

**（3）**查看consul服务列表

**①**使用命令：***consul members***，查看Consul数据中心的consul服务列表：

![20210729205149576.png][]

Node：节点名称，即服务名称。

Address：服务地址

Status：服务的健康状态

Type：服务的角色

因为我本地只启动了一个Consul服务，因此列表中就只有一条记录

**②**使用HTTP请求：[http://localhost:8500**/v1/agent/members**][http_localhost_8500_v1_agent_members]，查看consul服务列表：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl81MDUxODI3MQ_size_16_color_FFFFFF_t_70 6][]

Consul提供的所有http接口都是**/v1/**xxxxx格式的。关于更多的http接口信息，可以戳[Consul官网][Consul 1]浏览。

**（4）**注册服务到consul（服务注册）

<table> 
 <tbody> 
  <tr> 
   <td> <p>请求方式</p> </td> 
   <td> <p>接口地址</p> </td> 
   <td> <p>请求体格式</p> </td> 
   <td> <p>响应格式</p> </td> 
  </tr> 
  <tr> 
   <td> <p>PUT</p> </td> 
   <td> <p>/v1/agent/service/register</p> </td> 
   <td> <p>json</p> </td> 
   <td> <p>application/json</p> </td> 
  </tr> 
 </tbody> 
</table>

请求体示例：

{
      // 服务id  
      "ID": "myServerId",
      // 服务名称
      "Name": "myserverName",
      "Tags": ["primary", "v1"],
      // 服务地址
      "Address": "127.0.0.1",
      // 服务端口
      "Port": 8888,
      "Meta": {
        "myServer_version": "4.0"
      },
      "EnableTagOverride": false,
      "Weights": {
        "Passing": 10,
        "Warning": 1
      }
    }

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl81MDUxODI3MQ_size_16_color_FFFFFF_t_70 7][]

**（5）**获取注册到consul中的服务列表（服务发现）

**①**获取服务列表

<table> 
 <tbody> 
  <tr> 
   <td> <p>请求方式</p> </td> 
   <td> <p>接口地址</p> </td> 
   <td> <p>响应格式</p> </td> 
  </tr> 
  <tr> 
   <td> <p>GET</p> </td> 
   <td> <p>/v1/agent/services</p> </td> 
   <td> <p>application/json</p> </td> 
  </tr> 
 </tbody> 
</table>

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl81MDUxODI3MQ_size_16_color_FFFFFF_t_70 8][]

**②**获取某个服务的信息

<table> 
 <tbody> 
  <tr> 
   <td> <p>请求方式</p> </td> 
   <td> <p>接口地址</p> </td> 
   <td> <p>响应格式</p> </td> 
  </tr> 
  <tr> 
   <td> <p>GET</p> </td> 
   <td> <p>/v1/agent/service/{service_id}</p> </td> 
   <td> <p>application/json</p> </td> 
  </tr> 
 </tbody> 
</table>

service\_id为服务的id。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl81MDUxODI3MQ_size_16_color_FFFFFF_t_70 9][]

**③**获取某个服务的健康状态

<table> 
 <tbody> 
  <tr> 
   <td> <p>请求方式</p> </td> 
   <td> <p>接口地址</p> </td> 
   <td> <p>响应格式</p> </td> 
  </tr> 
  <tr> 
   <td> <p>GET</p> </td> 
   <td> <p>/v1/agent/health/service/name/{service_name}</p> </td> 
   <td> <p>application/json</p> </td> 
  </tr> 
 </tbody> 
</table>

service\_name为服务的名称。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl81MDUxODI3MQ_size_16_color_FFFFFF_t_70 10][]

（6）停止Consul

使用命令：***consul leave***

![20210729205611381.png][]

Consul服务输出的日志：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl81MDUxODI3MQ_size_16_color_FFFFFF_t_70 11][]

在Spring Cloud Consul中与Consul服务进行通信使用的是http请求，因此在学习Consul时，我们主要要学习Consul提供的http接口，这样利用Consul提供的http接口进行服务注册、服务发现等功能。

现在consul服务启动完成了，接下来我们就可以学习Spring Cloud Consul。

*（更多的Consul使用感兴趣的同学可以戳官网查看）*

[Consul]: https://www.consul.io/downloads
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl81MDUxODI3MQ_size_16_color_FFFFFF_t_70]: /images/20220829/14e93e9714c64bbd869946debdd50350.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl81MDUxODI3MQ_size_16_color_FFFFFF_t_70 1]: /images/20220829/346e9dc605474ea8b763fde38f885d22.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl81MDUxODI3MQ_size_16_color_FFFFFF_t_70 2]: /images/20220829/eef60810dd0c448f91d5502aac417c33.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl81MDUxODI3MQ_size_16_color_FFFFFF_t_70 3]: /images/20220829/0a825c617e024eec8cb8e5daf8ac956c.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl81MDUxODI3MQ_size_16_color_FFFFFF_t_70 4]: /images/20220829/fe46536ae214444f9d4fdd4d7f14e156.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl81MDUxODI3MQ_size_16_color_FFFFFF_t_70 5]: /images/20220829/e7f347a6fc034a98ae32b53761a054ae.png
[20210729205149576.png]: /images/20220829/efb868d5f090451eabac374e44abeb5d.png
[http_localhost_8500_v1_agent_members]: http://localhost:8500/v1/agent/members
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl81MDUxODI3MQ_size_16_color_FFFFFF_t_70 6]: /images/20220829/ad63af5b7ff24c33869914260b2a0499.png
[Consul 1]: https://www.consul.io/api-docs/agent/service#register-service
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl81MDUxODI3MQ_size_16_color_FFFFFF_t_70 7]: /images/20220829/82609726e9fa49cbaf98e73e4c5ca9af.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl81MDUxODI3MQ_size_16_color_FFFFFF_t_70 8]: /images/20220829/643e40cacb884bf5a22bebba91ea330c.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl81MDUxODI3MQ_size_16_color_FFFFFF_t_70 9]: /images/20220829/a369d09c550c4da7a8d6c3d0aadef424.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl81MDUxODI3MQ_size_16_color_FFFFFF_t_70 10]: /images/20220829/38ef3065111548b6876e10dadf3da64f.png
[20210729205611381.png]: /images/20220829/28594cae19d7471babcbde3717f7640d.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl81MDUxODI3MQ_size_16_color_FFFFFF_t_70 11]: /images/20220829/358c2795e0a24a9fae8e5449b47a9d52.png