关于 Consul 中 Blocking Queries 阻止查询详解

小渣渣

需求：Consul 一些接口支持“阻止查询”功能，通过此功能可以防止频繁拉取 Consul 中的数据，如果数据没有发生变化，会一直阻塞到指定时间才会响应，如果数据发生变化，会立马响应请求。

Consul 中的许多端点都支持一项称为“阻塞查询”的功能。阻塞查询用于使用长轮询等待潜在更改。并非所有端点都支持阻塞，但每个端点都会在文档中唯一地记录其对阻塞查询的支持。

文档：https://developer.hashicorp.com/consul/api-docs/features/blocking

支持 Blocking Queries 阻止查询的接口

响应头会返回：X-Consul-Index，请求查询参数携带：index（上一次响应头的 X-Consul-Index 内容）

本文以 KV 存储查询接口为例，文档：https://developer.hashicorp.com/consul/api-docs/kv，如下图：



第一次不携带请求参数（或携带默认值0）

可以看到响应立马返回，响应头中包含 x-consul-index 信息，如下图：



再次请求接口

携带 index 请求参数，可以看到请求被阻塞（默认为 5 分钟），然后到了默认等待时间才会响应，如下图：



再请求过程中修改 KV 的值

如果在请求过程中，触发了阻止查询功能等待，这时，如果修改 KV 的值，请求会立马响应，如下图：



对 .NET/C# 代码调用，参考如下：

登录可见。

参考：https://github.com/G-Research/consuldotnet/blob/master/Consul/Client_GetRequests.cs

（完）