此版本仍在开发中，尚未被视为稳定版本。对于最新的稳定版本，请使用 Spring Cloud Consul 4.1.3！spring-doc.cn

使用 Consul 进行服务发现

服务发现是基于微服务的架构的关键原则之一。尝试手动配置每个客户端或某种形式的约定可能非常困难，并且可能非常脆弱。Consul 通过 HTTP API 和 DNS 提供服务发现服务。Spring Cloud Consul 利用 HTTP API 进行服务注册和发现。这不会阻止非 Spring Cloud 应用程序利用 DNS 接口。Consul Agents 服务器运行在通过 gossip 协议通信并使用 Raft 共识协议的集群中。spring-doc.cn

如何激活

要激活 Consul Service Discovery，请使用 starter 和 group 和 artifact id 。有关使用当前 Spring Cloud Release Train 设置构建系统的详细信息，请参阅 Spring Cloud 项目页面。org.springframework.cloudspring-cloud-starter-consul-discoveryspring-doc.cn

向 Consul 注册

当客户端向 Consul 注册时，它会提供有关自身的元数据，例如主机和端口、ID、名称和标签。默认情况下，会创建一个 HTTP 检查，Consul 每 10 秒命中一次终端节点。如果运行状况检查失败，则服务实例将标记为 critical。/actuator/healthspring-doc.cn

Consul 客户端示例：spring-doc.cn

@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:8500spring-doc.cn

application.yml
spring:
  cloud:
    consul:
      host: localhost
      port: 8500
如果您使用 Spring Cloud Consul Config，并且您已经设置了 or or use ，则需要将上述值放在 中，而不是 。spring.cloud.bootstrap.enabled=truespring.config.use-legacy-processing=truespring-cloud-starter-bootstrapbootstrap.ymlapplication.yml

默认服务名称、实例 ID 和端口（取自 、 分别是 Spring 上下文 ID 和 。Environment${spring.application.name}${server.port}spring-doc.cn

要禁用 Consul Discovery Client，您可以设置为 。当 Consul Discovery Client 设置为 时，也会被禁用。spring.cloud.consul.discovery.enabledfalsespring.cloud.discovery.enabledfalsespring-doc.cn

要禁用服务注册，您可以设置为 。spring.cloud.consul.discovery.registerfalsespring-doc.cn

将 Management 注册为单独的服务

当管理服务器端口设置为与应用程序端口不同的端口时，通过设置属性，管理服务将被添加为与应用程序服务不同的服务。例如：management.server.portspring-doc.cn

application.yml
spring:
  application:
    name: myApp
management:
  server:
    port: 4452

上述配置将注册以下 2 个服务：spring-doc.cn

ID: myApp
Name: myApp
ID: myApp-management
Name: myApp-management

管理服务将从应用程序服务继承其 and。例如：instanceIdserviceNamespring-doc.cn

application.yml
spring:
  application:
    name: myApp
management:
  server:
    port: 4452
spring:
  cloud:
    consul:
      discovery:
        instance-id: custom-service-id
        serviceName: myprefix-${spring.application.name}

上述配置将注册以下 2 个服务：spring-doc.cn

ID: custom-service-id
Name: myprefix-myApp
ID: custom-service-id-management
Name: myprefix-myApp-management

可以通过以下属性进行进一步自定义：spring-doc.cn

/** 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 路径（例如 ）或 Management 端点路径（例如 ），则需要更改此设置，即使对于 Actuator 应用程序也是如此。server.servletPath=/foomanagement.server.servlet.context-path=/adminspring-doc.cn

还可以配置 Consul 用于检查运行状况端点的间隔。“10s” 和 “1m” 分别代表 10 秒和 1 分钟。spring-doc.cn

此示例说明了上述内容（有关更多选项，请参阅附录页中的属性）。spring.cloud.consul.discovery.health-check-*spring-doc.cn

application.yml
spring:
  cloud:
    consul:
      discovery:
        healthCheckPath: ${management.server.servlet.context-path}/actuator/health
        healthCheckInterval: 15s

您可以通过设置 来完全禁用 HTTP 运行状况检查。spring.cloud.consul.discovery.register-health-check=falsespring-doc.cn

应用标头

标头可应用于运行状况检查请求。例如，如果您尝试注册使用 Vault 后端的 Spring Cloud Config 服务器：spring-doc.cn

application.yml
spring:
  cloud:
    consul:
      discovery:
        health-check-headers:
          X-Config-Token: 6442e58b-d1ea-182e-cfa5-cf9cddef0722

根据 HTTP 标准，每个标头可以有多个值，在这种情况下，可以提供一个数组：spring-doc.cn

application.yml
spring:
  cloud:
    consul:
      discovery:
        health-check-headers:
          X-Config-Token:
            - "6442e58b-d1ea-182e-cfa5-cf9cddef0722"
            - "Some other value"

TTL 运行状况检查

可以使用 Consul TTL 检查来代替默认配置的 HTTP 检查。 主要区别在于，应用程序向 Consul 代理发送检测信号，而不是 Consul 代理向应用程序发送请求。spring-doc.cn

还可以配置应用程序用于发送 ping 的间隔。“10s” 和 “1m” 分别代表 10 秒和 1 分钟。 默认值为 30 秒。spring-doc.cn

此示例说明了上述内容（有关更多选项，请参阅附录页中的属性）。spring.cloud.consul.discovery.heartbeat.*spring-doc.cn

application.yml
spring:
  cloud:
    consul:
      discovery:
        heartbeat:
          enabled: true
          ttl: 10s

TTL 应用程序状态

对于 Spring Boot Actuator 应用程序，状态是根据其可用的运行状况端点确定的。 当运行状况端点不可用（禁用或不是 Spring Boot Actuator 应用程序）时，它会假定应用程序处于良好状态。spring-doc.cn

查询运行状况终端节点时，默认情况下使用根运行状况组。 通过设置以下属性，可以使用其他运行状况组：spring-doc.cn

application.yml
spring:
  cloud:
    consul:
      discovery:
        heartbeat:
          actuator-health-group: <your-custom-group-goes-here>

您可以通过设置以下属性来完全禁用运行状况终端节点的使用：spring-doc.cn

application.yml
spring:
  cloud:
    consul:
      discovery:
        heartbeat:
          use-actuator-health: false
自定义 TTL 应用程序状态

如果您想配置自己的应用程序状态机制，只需实现ApplicationStatusProviderspring-doc.cn

MyCustomApplicationStatusProvider.java
@Bean
public class MyCustomApplicationStatusProvider implements ApplicationStatusProvider {
	public CheckStatus currentStatus() {
        return yourMethodToDetermineAppStatusGoesHere();
    }
}

并使其可用于应用程序上下文：spring-doc.cn

@Bean
public CustomApplicationStatusProvider customAppStatusProvider() {
     return new MyCustomApplicationStatusProvider();
}

执行器健康指示器

如果服务实例是 Spring Boot Actuator 应用程序，则可以为其提供以下 Actuator 运行状况指示器。spring-doc.cn

DiscoveryClientHealthIndicator

当 Consul 服务发现处于活动状态时，将配置一个 DiscoverClientHealthIndicator 并使其可用于 Actuator health 端点。 有关配置选项，请参阅此处。spring-doc.cn

ConsulHealthIndicator

配置了一个指示器，用于验证 .ConsulClientspring-doc.cn

默认情况下，它会检索 Consul 领导节点状态和所有已注册的服务。 在具有许多已注册服务的部署中，在每次运行状况检查时检索所有服务的成本可能很高。 要跳过服务检索，只检查领导节点状态，请设置 。spring.cloud.consul.health-indicator.include-services-query=falsespring-doc.cn

要禁用指示器集 .management.health.consul.enabled=falsespring-doc.cn

当应用程序在 bootstrap 上下文模式（默认）下运行时， 此指示器被加载到引导上下文中，并且不可用于 Actuator health 端点。

元数据

Consul 支持服务上的元数据。Spring Cloud 有一个字段，该字段是从 services 字段填充的。要填充字段，请将值设置为 on 或 properties。ServiceInstanceMap<String, String> metadatametametaspring.cloud.consul.discovery.metadataspring.cloud.consul.discovery.management-metadataspring-doc.cn

application.yml
spring:
  cloud:
    consul:
      discovery:
        metadata:
          myfield: myvalue
          anotherfield: anothervalue

上述配置将导致服务的 meta 字段包含 和 。myfield→myvalueanotherfield→anothervaluespring-doc.cn

生成的元数据

Consul 自动注册将自动生成一些条目。spring-doc.cn

表 1.自动生成的元数据
钥匙 值

'组'spring-doc.cn

财产。仅当 is 不为空时，才会生成此值。spring.cloud.consul.discovery.instance-groupinstance-groupspring-doc.cn

“安全”spring-doc.cn

如果 property 等于 'https'，则为 True，否则为 false。spring.cloud.consul.discovery.schemespring-doc.cn

Property ，默认为 'zone'spring.cloud.consul.discovery.default-zone-metadata-namespring-doc.cn

财产。仅当 is 不为空时，才会生成此值。spring.cloud.consul.discovery.instance-zoneinstance-zonespring-doc.cn
旧版本的 Spring Cloud Consul 通过解析属性从 Spring Cloud Commons 填充方法。这不再受支持，请迁移到使用地图。ServiceInstance.getMetadata()spring.cloud.consul.discovery.tagsspring.cloud.consul.discovery.metadata

使 Consul 实例 ID 唯一

默认情况下，consul 实例注册的 ID 等于其 Spring Application Context ID。默认情况下，Spring 应用程序上下文 ID 为 。在大多数情况下，这将允许一个服务的多个实例在一台计算机上运行。如果需要进一步的唯一性，请使用 Spring Cloud，您可以通过在 中提供唯一标识符来覆盖它。例如：${spring.application.name}:comma,separated,profiles:${server.port}spring.cloud.consul.discovery.instanceIdspring-doc.cn

application.yml
spring:
  cloud:
    consul:
      discovery:
        instanceId: ${spring.application.name}:${vcap.application.instance_id:${spring.application.instance_id:${random.value}}}

有了这个元数据，以及 localhost 上部署的多个服务实例，随机值将在那里启动，使实例唯一。在 Cloudfoundry 中，它将自动填充到 Spring Boot 应用程序中，因此不需要 random 值。vcap.application.instance_idspring-doc.cn

查找服务

使用 Load-balancer

Spring Cloud 支持 Feign（一个 REST 客户端构建器）和 Spring RestTemplate，用于使用逻辑服务名称/ID 而不是物理 URL 来查找服务。Feign 和发现感知的RestTemplate都利用 Spring Cloud LoadBalancer 进行客户端负载平衡。spring-doc.cn

如果你想使用 RestTemplate 访问 service STORES，只需声明：spring-doc.cn

@LoadBalanced
@Bean
public RestTemplate loadbalancedRestTemplate() {
     return new RestTemplate();
}

并像这样使用它（注意我们如何使用 Consul 的 STORES 服务名称/ID 而不是完全限定的域名）：spring-doc.cn

@Autowired
RestTemplate restTemplate;

public String getFirstProduct() {
   return this.restTemplate.getForObject("https://STORES/products/1", String.class);
}

如果您在多个数据中心拥有 Consul 集群，并且想要访问另一个数据中心中的服务，则仅提供服务名称/ID 是不够的。在那种情况下 您使用属性 where 是服务名称/ID，是数据中心 STORES 服务所在的位置。spring.cloud.consul.discovery.datacenters.STORES=dc-westSTORESdc-westspring-doc.cn

Spring Cloud 现在还提供对 Spring Cloud LoadBalancer 的支持。

使用 DiscoveryClient

您还可以使用 ，它为发现客户端提供了一个简单的 API，它不是特定于 Netflix 的，例如org.springframework.cloud.client.discovery.DiscoveryClientspring-doc.cn

@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。spring-doc.cn

要更改调用 Config Watch 的频率，请更改 。默认值为 1000，以毫秒为单位。延迟是上一个调用结束和下一个调用开始之后的时间量。spring.cloud.consul.config.discovery.catalog-services-watch-delayspring-doc.cn

要禁用 Catalog Watch set 。spring.cloud.consul.discovery.catalogServicesWatch.enabled=falsespring-doc.cn

手表使用 Spring 来安排对 consul 的调用。默认情况下，它是 a 为 1 的 a。要更改 ，请创建一个以 constant 命名的 Bean。TaskSchedulerThreadPoolTaskSchedulerpoolSizeTaskSchedulerTaskSchedulerConsulDiscoveryClientConfiguration.CATALOG_WATCH_TASK_SCHEDULER_NAMEspring-doc.cn