|
此版本仍在开发中，尚未被视为稳定版本。对于最新的稳定版本，请使用 Spring Cloud Consul 4.1.3！ |
使用 Consul 进行服务发现
如何激活
要激活 Consul Service Discovery，请使用 starter with grouporg.springframework.cloud和工件 IDspring-cloud-starter-consul-discovery.有关使用当前 Spring Cloud Release Train 设置构建系统的详细信息，请参阅 Spring Cloud 项目页面。
向 Consul 注册
当客户端向 Consul 注册时，它会提供有关自身的元数据，例如主机和端口、ID、名称和标签。默认情况下，会创建一个 HTTP 检查，Consul 会命中/actuator/healthendpoint 的 intent 调用。如果运行状况检查失败，则服务实例将标记为 critical。
Consul 客户端示例：
@SpringBootApplication
@RestController
public class Application {
@RequestMapping("/")
public String home() {
return "Hello world";
}
public static void main(String[] args) {
new SpringApplicationBuilder(Application.class).web(true).run(args);
}
}（即完全正常的 Spring Boot 应用程序）。如果 Consul 客户端位于localhost:8500，则需要配置才能找到客户端。例：
spring:
cloud:
consul:
host: localhost
port: 8500
如果您使用 Spring Cloud Consul Config，并且您设置了spring.cloud.bootstrap.enabled=true或spring.config.use-legacy-processing=true或使用spring-cloud-starter-bootstrap，则需要将上述值放入bootstrap.yml而不是application.yml. |
默认服务名称、实例 ID 和端口，取自Environment是${spring.application.name}、Spring 上下文 ID 和${server.port}分别。
要禁用 Consul Discovery Client，您可以设置spring.cloud.consul.discovery.enabled自false.在以下情况下，Consul Discovery Client 也会被禁用spring.cloud.discovery.enabled设置为false.
要禁用服务注册，您可以设置spring.cloud.consul.discovery.register自false.
将 Management 注册为单独的服务
当管理服务器端口设置为与应用程序端口不同的值时，通过设置management.server.port属性中，管理服务将作为独立于应用程序服务的服务进行注册。例如：
spring:
application:
name: myApp
management:
server:
port: 4452
上述配置将注册以下 2 个服务：
-
应用服务：
ID: myApp Name: myApp
-
管理服务：
ID: myApp-management Name: myApp-management
管理服务将继承其instanceId和serviceName从应用程序服务。例如：
spring:
application:
name: myApp
management:
server:
port: 4452
spring:
cloud:
consul:
discovery:
instance-id: custom-service-id
serviceName: myprefix-${spring.application.name}
上述配置将注册以下 2 个服务：
-
应用服务：
ID: custom-service-id Name: myprefix-myApp
-
管理服务：
ID: custom-service-id-management Name: myprefix-myApp-management
可以通过以下属性进行进一步自定义：
/** Port to register the management service under (defaults to management port) */ spring.cloud.consul.discovery.management-port /** Suffix to use when registering management service (defaults to "management") */ spring.cloud.consul.discovery.management-suffix /** Tags to use when registering management service (defaults to "management") */ spring.cloud.consul.discovery.management-tags
HTTP 健康检查
Consul 实例的运行状况检查默认为“/actuator/health”，这是 Spring Boot Actuator 应用程序中运行状况端点的默认位置。如果你使用非默认的上下文路径或 servlet 路径（例如server.servletPath=/foo） 或 Management 端点路径（例如management.server.servlet.context-path=/admin).
还可以配置 Consul 用于检查运行状况端点的间隔。“10s” 和 “1m” 分别代表 10 秒和 1 分钟。
此示例说明了上述内容（请参阅spring.cloud.consul.discovery.health-check-*properties 以获取更多选项）。
spring:
cloud:
consul:
discovery:
healthCheckPath: ${management.server.servlet.context-path}/actuator/health
healthCheckInterval: 15s
您可以通过设置spring.cloud.consul.discovery.register-health-check=false.
应用标头
标头可应用于运行状况检查请求。例如，如果您尝试注册使用 Vault 后端的 Spring Cloud Config 服务器：
spring:
cloud:
consul:
discovery:
health-check-headers:
X-Config-Token: 6442e58b-d1ea-182e-cfa5-cf9cddef0722
根据 HTTP 标准，每个标头可以有多个值，在这种情况下，可以提供一个数组：
spring:
cloud:
consul:
discovery:
health-check-headers:
X-Config-Token:
- "6442e58b-d1ea-182e-cfa5-cf9cddef0722"
- "Some other value"
TTL 运行状况检查
可以使用 Consul TTL 检查来代替默认配置的 HTTP 检查。 主要区别在于，应用程序向 Consul 代理发送检测信号，而不是 Consul 代理向应用程序发送请求。
还可以配置应用程序用于发送 ping 的间隔。“10s” 和 “1m” 分别代表 10 秒和 1 分钟。 默认值为 30 秒。
此示例说明了上述内容（请参阅spring.cloud.consul.discovery.heartbeat.*properties 以获取更多选项）。
spring:
cloud:
consul:
discovery:
heartbeat:
enabled: true
ttl: 10s
TTL 应用程序状态
对于 Spring Boot Actuator 应用程序，状态是根据其可用的运行状况端点确定的。 当运行状况端点不可用（禁用或不是 Spring Boot Actuator 应用程序）时，它会假定应用程序处于良好状态。
查询运行状况终端节点时，默认情况下使用根运行状况组。 通过设置以下属性，可以使用其他运行状况组：
spring:
cloud:
consul:
discovery:
heartbeat:
actuator-health-group: <your-custom-group-goes-here>
您可以通过设置以下属性来完全禁用运行状况终端节点的使用：
spring:
cloud:
consul:
discovery:
heartbeat:
use-actuator-health: false
自定义 TTL 应用程序状态
如果您想配置自己的应用程序状态机制，只需实现ApplicationStatusProvider接口
@Bean
public class MyCustomApplicationStatusProvider implements ApplicationStatusProvider {
public CheckStatus currentStatus() {
return yourMethodToDetermineAppStatusGoesHere();
}
}
并使其可用于应用程序上下文：
@Bean
public CustomApplicationStatusProvider customAppStatusProvider() {
return new MyCustomApplicationStatusProvider();
}
执行器健康指示器
如果服务实例是 Spring Boot Actuator 应用程序，则可以为其提供以下 Actuator 运行状况指示器。
DiscoveryClientHealthIndicator
当 Consul 服务发现处于活动状态时，将配置一个 DiscoverClientHealthIndicator 并使其可用于 Actuator health 端点。 有关配置选项，请参阅此处。
ConsulHealthIndicator
配置了一个指示器，用于验证ConsulClient.
默认情况下，它会检索 Consul 领导节点状态和所有已注册的服务。
在具有许多已注册服务的部署中，在每次运行状况检查时检索所有服务的成本可能很高。
跳过服务检索，只检查设置的领导节点状态spring.cloud.consul.health-indicator.include-services-query=false.
禁用指示器集management.health.consul.enabled=false.
| 当应用程序在 bootstrap 上下文模式（默认）下运行时， 此指示器被加载到 bootstrap 上下文中，并且不可用于 Actuator health 端点。 |
元数据
Consul 支持服务上的元数据。Spring Cloud 的ServiceInstance具有Map<String, String> metadata字段，该字段从 Services 填充meta田。要填充meta字段设置值开启spring.cloud.consul.discovery.metadata或spring.cloud.consul.discovery.management-metadata性能。
spring:
cloud:
consul:
discovery:
metadata:
myfield: myvalue
anotherfield: anothervalue
上述配置将导致服务的 meta 字段包含myfield→myvalue和anotherfield→anothervalue.
生成的元数据
Consul 自动注册将自动生成一些条目。
| 钥匙 | 值 |
|---|---|
'组' |
财产 |
“安全” |
如果属性为 True， 则为 True |
财产 |
财产 |
旧版本的 Spring Cloud Consul 填充了ServiceInstance.getMetadata()方法，方法是解析spring.cloud.consul.discovery.tags财产。这不再受支持，请迁移到使用spring.cloud.consul.discovery.metadata地图。 |
使 Consul 实例 ID 唯一
默认情况下，consul 实例注册的 ID 等于其 Spring Application Context ID。默认情况下，Spring Application Context ID 为${spring.application.name}:comma,separated,profiles:${server.port}.在大多数情况下，这将允许一个服务的多个实例在一台计算机上运行。如果需要进一步的唯一性，使用 Spring Cloud，您可以通过在spring.cloud.consul.discovery.instanceId.例如：
spring:
cloud:
consul:
discovery:
instanceId: ${spring.application.name}:${vcap.application.instance_id:${spring.application.instance_id:${random.value}}}
有了这个元数据，以及 localhost 上部署的多个服务实例，随机值将在那里启动，使实例唯一。在 Cloudfoundry 中，vcap.application.instance_id将自动填充到 Spring Boot 应用程序中，因此不需要 random 值。
查找服务
使用 Load-balancer
Spring Cloud 支持 Feign（REST 客户端构建器）并且还支持SpringRestTemplate用于使用逻辑服务名称/ID 而不是物理 URL 查找服务。Feign 和发现感知的RestTemplate都利用 Spring Cloud LoadBalancer 进行客户端负载平衡。
如果你想使用 RestTemplate 访问 service STORES，只需声明：
@LoadBalanced
@Bean
public RestTemplate loadbalancedRestTemplate() {
return new RestTemplate();
}
并像这样使用它（注意我们如何使用 Consul 的 STORES 服务名称/ID 而不是完全限定的域名）：
@Autowired
RestTemplate restTemplate;
public String getFirstProduct() {
return this.restTemplate.getForObject("https://STORES/products/1", String.class);
}
如果您在多个数据中心拥有 Consul 集群，并且想要访问另一个数据中心中的服务，则仅提供服务名称/ID 是不够的。在那种情况下
您使用 Propertyspring.cloud.consul.discovery.datacenters.STORES=dc-west哪里STORES是服务名称/ID，而dc-west是数据中心
STORES 服务所在的位置。
| Spring Cloud 现在还提供对 Spring Cloud LoadBalancer 的支持。 |
使用 DiscoveryClient
您还可以使用org.springframework.cloud.client.discovery.DiscoveryClient它为发现客户端提供了一个不特定于 Netflix 的简单 API，例如
@Autowired
private DiscoveryClient discoveryClient;
public String serviceUrl() {
List<ServiceInstance> list = discoveryClient.getInstances("STORES");
if (list != null && list.size() > 0 ) {
return list.get(0).getUri();
}
return null;
}
Consul 目录观察
Consul Catalog Watch 利用了 consul to watch 服务的功能。目录监视会进行阻止 Consul HTTP API 调用，以确定是否有任何服务已更改。如果有新的服务数据，则会发布 Heartbeat Event。
要更改调用 Config Watch 的频率，请更改spring.cloud.consul.config.discovery.catalog-services-watch-delay.默认值为 1000，以毫秒为单位。延迟是上一个调用结束和下一个调用开始之后的时间量。
禁用 Catalog Watch 集spring.cloud.consul.discovery.catalogServicesWatch.enabled=false.
手表使用弹簧TaskScheduler安排对 Consul 的呼叫。默认情况下，它是一个ThreadPoolTaskScheduler替换为poolSize的 1.要将TaskScheduler，创建一个TaskScheduler以ConsulDiscoveryClientConfiguration.CATALOG_WATCH_TASK_SCHEDULER_NAME不断。