常用应用程序属性

您可以在 application.properties 文件、application.yml 文件中或作为命令行开关指定各种属性。本附录列出了常见的 Spring Cloud Consul 属性,并提供了对其所依赖的底层类的引用。spring-doc.cadn.net.cn

属性贡献可能来自类路径(classpath)中的额外 JAR 文件,因此你不应将此视为详尽无遗的列表。 此外,你也可以定义自己的属性。
姓名 默认 描述

spring.cloud.consul.config.acl-tokenspring-doc.cadn.net.cn

spring.cloud.consul.config.data-keyspring-doc.cadn.net.cn

dataspring-doc.cadn.net.cn

如果格式为 Format.PROPERTIES 或 Format.YAML,则以下字段将用作键,以在 Consul 中查找配置。spring-doc.cadn.net.cn

spring.cloud.consul.config.default-contextspring-doc.cadn.net.cn

applicationspring-doc.cadn.net.cn

spring.cloud.consul.config.enabledspring-doc.cadn.net.cn

truespring-doc.cadn.net.cn

spring.cloud.consul.config.fail-fastspring-doc.cadn.net.cn

truespring-doc.cadn.net.cn

在配置查找期间抛出异常(如果为 true),否则记录警告。spring-doc.cadn.net.cn

spring.cloud.consul.config.formatspring-doc.cadn.net.cn

key-valuespring-doc.cadn.net.cn

spring.cloud.consul.config.namespring-doc.cadn.net.cn

替代 spring.application.name,用于在 Consul KV 中查找值。spring-doc.cadn.net.cn

spring.cloud.consul.config.prefixspring-doc.cadn.net.cn

spring.cloud.consul.config.prefixesspring-doc.cadn.net.cn

spring.cloud.consul.config.profile-separatorspring-doc.cadn.net.cn

,spring-doc.cadn.net.cn

spring.cloud.consul.config.watch.delayspring-doc.cadn.net.cn

1000spring-doc.cadn.net.cn

监控器的固定延迟值,单位为毫秒。默认值为 1000。spring-doc.cadn.net.cn

spring.cloud.consul.config.watch.enabledspring-doc.cadn.net.cn

truespring-doc.cadn.net.cn

如果启用了监控。默认值为 true。spring-doc.cadn.net.cn

spring.cloud.consul.config.watch.wait-timespring-doc.cadn.net.cn

55spring-doc.cadn.net.cn

等待(或阻塞)观察查询的秒数,默认为55。必须小于默认的ConsulClient(默认为60)。若要增加ConsulClient超时时间,请创建一个ConsulClient Bean,并使用自定义的ConsulRawClient及自定义HttpClient。spring-doc.cadn.net.cn

spring.cloud.consul.discovery.acl-tokenspring-doc.cadn.net.cn

spring.cloud.consul.discovery.catalog-services-watch-delayspring-doc.cadn.net.cn

1000spring-doc.cadn.net.cn

调用 watch consul catalog 之间的延迟时间(毫秒),默认值为 1000。spring-doc.cadn.net.cn

spring.cloud.consul.discovery.catalog-services-watch-timeoutspring-doc.cadn.net.cn

2spring-doc.cadn.net.cn

监控 Consul 目录时阻塞的秒数,默认值为 2。spring-doc.cadn.net.cn

spring.cloud.consul.discovery.consistency-modespring-doc.cadn.net.cn

defaultspring-doc.cadn.net.cn

健康服务请求的一致性模式。spring-doc.cadn.net.cn

spring.cloud.consul.discovery.datacentersspring-doc.cadn.net.cn

服务ID → 数据中心的映射,用于在服务器列表中查询。这允许在其他数据中心查找服务。spring-doc.cadn.net.cn

spring.cloud.consul.discovery.default-query-tagspring-doc.cadn.net.cn

在服务列表中查询的标签,如果该标签未列在 serverListQueryTags 中。可使用逗号分隔的多个标签进行指定。spring-doc.cadn.net.cn

spring.cloud.consul.discovery.default-zone-metadata-namespring-doc.cadn.net.cn

zonespring-doc.cadn.net.cn

服务实例区域来自元数据。这允许更改元数据标签名称。spring-doc.cadn.net.cn

spring.cloud.consul.discovery.deregisterspring-doc.cadn.net.cn

truespring-doc.cadn.net.cn

禁用 Consul 中服务的自动注销。spring-doc.cadn.net.cn

spring.cloud.consul.discovery.enable-tag-overridespring-doc.cadn.net.cn

启用已注册服务的标签覆盖。spring-doc.cadn.net.cn

spring.cloud.consul.discovery.enabledspring-doc.cadn.net.cn

truespring-doc.cadn.net.cn

服务发现是否已启用?spring-doc.cadn.net.cn

spring.cloud.consul.discovery.fail-fastspring-doc.cadn.net.cn

truespring-doc.cadn.net.cn

在服务注册期间抛出异常(如果为 true),否则记录警告(默认为 true)。spring-doc.cadn.net.cn

spring.cloud.consul.discovery.health-check-critical-timeoutspring-doc.cadn.net.cn

超时解除注册服务,该超时时间长于超时时间(例如 30 分钟)。需要 Consul 版本 7.x 或更高版本。spring-doc.cadn.net.cn

spring.cloud.consul.discovery.health-check-headersspring-doc.cadn.net.cn

应用于健康检查调用的请求头。spring-doc.cadn.net.cn

spring.cloud.consul.discovery.health-check-intervalspring-doc.cadn.net.cn

10sspring-doc.cadn.net.cn

执行健康检查的频率(例如每10秒一次),默认为10秒。spring-doc.cadn.net.cn

spring.cloud.consul.discovery.health-check-pathspring-doc.cadn.net.cn

/actuator/healthspring-doc.cadn.net.cn

备用服务器路径,用于执行运行状况检查。spring-doc.cadn.net.cn

spring.cloud.consul.discovery.health-check-timeoutspring-doc.cadn.net.cn

超时时间用于健康检查(例如 10 秒)。spring-doc.cadn.net.cn

spring.cloud.consul.discovery.health-check-tls-skip-verifyspring-doc.cadn.net.cn

在服务检查期间跳过证书验证,如果为 true,则执行证书验证。spring-doc.cadn.net.cn

spring.cloud.consul.discovery.health-check-urlspring-doc.cadn.net.cn

自定义健康检查 URL 以覆盖默认值。spring-doc.cadn.net.cn

spring.cloud.consul.discovery.heartbeat.actuator-health-groupspring-doc.cadn.net.cn

用于通过Actuator确定系统健康状况时要使用的actuator健康组(当为根组时为null)。spring-doc.cadn.net.cn

spring.cloud.consul.discovery.heartbeat.enabledspring-doc.cadn.net.cn

falsespring-doc.cadn.net.cn

spring.cloud.consul.discovery.heartbeat.interval-ratiospring-doc.cadn.net.cn

spring.cloud.consul.discovery.heartbeat.reregister-service-on-failurespring-doc.cadn.net.cn

falsespring-doc.cadn.net.cn

spring.cloud.consul.discovery.heartbeat.ttlspring-doc.cadn.net.cn

30sspring-doc.cadn.net.cn

spring.cloud.consul.discovery.heartbeat.use-actuator-healthspring-doc.cadn.net.cn

truespring-doc.cadn.net.cn

是否应考虑当前系统状态(通过Actuator Health端点报告)对向Consul TTL检查报告应用程序状态的影响。Actuator Health端点也必须对应用程序可用。spring-doc.cadn.net.cn

spring.cloud.consul.discovery.hostnamespring-doc.cadn.net.cn

要使用的服务器主机名。spring-doc.cadn.net.cn

spring.cloud.consul.discovery.include-hostname-in-instance-idspring-doc.cadn.net.cn

falsespring-doc.cadn.net.cn

是否将主机名包含在默认实例id中,在注册服务时。spring-doc.cadn.net.cn

spring.cloud.consul.discovery.instance-groupspring-doc.cadn.net.cn

组内服务实例。spring-doc.cadn.net.cn

spring.cloud.consul.discovery.instance-idspring-doc.cadn.net.cn

服务器唯一标识符。spring-doc.cadn.net.cn

spring.cloud.consul.discovery.instance-zonespring-doc.cadn.net.cn

服务实例区域。spring-doc.cadn.net.cn

spring.cloud.consul.discovery.ip-addressspring-doc.cadn.net.cn

当通过服务访问时要使用的 IP 地址(必须同时设置 preferIpAddress 以使用)。spring-doc.cadn.net.cn

spring.cloud.consul.discovery.lifecycle.enabledspring-doc.cadn.net.cn

truespring-doc.cadn.net.cn

spring.cloud.consul.discovery.management-enable-tag-overridespring-doc.cadn.net.cn

为已注册的管理服务启用标记重写。spring-doc.cadn.net.cn

spring.cloud.consul.discovery.management-metadataspring-doc.cadn.net.cn

元数据用于注册管理服务。spring-doc.cadn.net.cn

spring.cloud.consul.discovery.management-portspring-doc.cadn.net.cn

指定管理服务下的注册端口(默认为管理端口)。spring-doc.cadn.net.cn

spring.cloud.consul.discovery.management-suffixspring-doc.cadn.net.cn

managementspring-doc.cadn.net.cn

Suffix 用于注册管理服务时使用的后缀。spring-doc.cadn.net.cn

spring.cloud.consul.discovery.management-tagsspring-doc.cadn.net.cn

使用时注册管理服务的标签。spring-doc.cadn.net.cn

spring.cloud.consul.discovery.metadataspring-doc.cadn.net.cn

服务注册时要使用的元数据。spring-doc.cadn.net.cn

spring.cloud.consul.discovery.orderspring-doc.cadn.net.cn

0spring-doc.cadn.net.cn

发现客户端按 CompositeDiscoveryClient 用于对可用客户端进行排序的顺序。spring-doc.cadn.net.cn

spring.cloud.consul.discovery.portspring-doc.cadn.net.cn

端口,用于在其中注册服务(默认为监听端口)。spring-doc.cadn.net.cn

spring.cloud.consul.discovery.prefer-agent-addressspring-doc.cadn.net.cn

falsespring-doc.cadn.net.cn

源代码,我们将根据此确定要使用的地址。spring-doc.cadn.net.cn

spring.cloud.consul.discovery.prefer-ip-addressspring-doc.cadn.net.cn

falsespring-doc.cadn.net.cn

在注册期间使用IP地址而不是主机名。spring-doc.cadn.net.cn

spring.cloud.consul.discovery.query-passingspring-doc.cadn.net.cn

falsespring-doc.cadn.net.cn

将 'passing` 参数添加到 /v1/health/service/serviceName。这会将健康检查通过状态推送到服务器。spring-doc.cadn.net.cn

spring.cloud.consul.discovery.registerspring-doc.cadn.net.cn

truespring-doc.cadn.net.cn

在Consul中注册为服务。spring-doc.cadn.net.cn

spring.cloud.consul.discovery.register-health-checkspring-doc.cadn.net.cn

truespring-doc.cadn.net.cn

在 Consul 中注册健康检查。在服务开发期间很有用。spring-doc.cadn.net.cn

spring.cloud.consul.discovery.schemespring-doc.cadn.net.cn

httpspring-doc.cadn.net.cn

是否注册http或https服务。spring-doc.cadn.net.cn

spring.cloud.consul.discovery.server-list-query-tagsspring-doc.cadn.net.cn

服务ID映射→在服务器列表中要查询的标记。这允许通过一个或多个标记对服务进行过滤。可以指定多个标记,用逗号分隔。spring-doc.cadn.net.cn

spring.cloud.consul.discovery.service-namespring-doc.cadn.net.cn

服务名称。spring-doc.cadn.net.cn

spring.cloud.consul.discovery.tagsspring-doc.cadn.net.cn

用于注册服务的标签。spring-doc.cadn.net.cn

spring.cloud.consul.enabledspring-doc.cadn.net.cn

truespring-doc.cadn.net.cn

Spring Cloud Consul 已启用。spring-doc.cadn.net.cn

spring.cloud.consul.hostspring-doc.cadn.net.cn

localhostspring-doc.cadn.net.cn

Consul代理主机名。默认为“localhost”。spring-doc.cadn.net.cn

spring.cloud.consul.pathspring-doc.cadn.net.cn

非根目录下 Consul 的自定义路径。spring-doc.cadn.net.cn

spring.cloud.consul.portspring-doc.cadn.net.cn

8500spring-doc.cadn.net.cn

Consul 代理端口。默认值为“8500”。spring-doc.cadn.net.cn

spring.cloud.consul.retry.enabledspring-doc.cadn.net.cn

truespring-doc.cadn.net.cn

如果启用了Consul重试。spring-doc.cadn.net.cn

spring.cloud.consul.retry.initial-intervalspring-doc.cadn.net.cn

1000spring-doc.cadn.net.cn

初始重试间隔(毫秒数)。spring-doc.cadn.net.cn

spring.cloud.consul.retry.max-attemptsspring-doc.cadn.net.cn

6spring-doc.cadn.net.cn

当前最大尝试次数。spring-doc.cadn.net.cn

spring.cloud.consul.retry.max-intervalspring-doc.cadn.net.cn

2000spring-doc.cadn.net.cn

最大回退间隔。spring-doc.cadn.net.cn

spring.cloud.consul.retry.multiplierspring-doc.cadn.net.cn

1.1spring-doc.cadn.net.cn

乘数用于下一个间隔。spring-doc.cadn.net.cn

spring.cloud.consul.ribbon.enabledspring-doc.cadn.net.cn

truespring-doc.cadn.net.cn

启用了Consul和Ribbon集成。spring-doc.cadn.net.cn

spring.cloud.consul.schemespring-doc.cadn.net.cn

代理方案(HTTP/HTTPS)。如果地址中没有方案,客户端将使用HTTP。spring-doc.cadn.net.cn

spring.cloud.consul.service-registry.auto-registration.enabledspring-doc.cadn.net.cn

truespring-doc.cadn.net.cn

启用Consul服务注册表自动注册。spring-doc.cadn.net.cn

spring.cloud.consul.service-registry.enabledspring-doc.cadn.net.cn

truespring-doc.cadn.net.cn

启用Consul服务注册表功能。spring-doc.cadn.net.cn

spring.cloud.consul.tls.certificate-passwordspring-doc.cadn.net.cn

Password to open the certificate.spring-doc.cadn.net.cn

spring.cloud.consul.tls.certificate-pathspring-doc.cadn.net.cn

文件路径到证书。spring-doc.cadn.net.cn

spring.cloud.consul.tls.key-store-instance-typespring-doc.cadn.net.cn

使用哪种类型的框架进行开发。spring-doc.cadn.net.cn

spring.cloud.consul.tls.key-store-passwordspring-doc.cadn.net.cn

密码到外部密钥库。spring-doc.cadn.net.cn

spring.cloud.consul.tls.key-store-pathspring-doc.cadn.net.cn

指向外部密钥库的路径。spring-doc.cadn.net.cn