此版本仍在开发中,目前尚不被视为稳定版本。如需最新稳定版本,请使用 Spring Cloud Commons 5.0.1spring-doc.cadn.net.cn

配置属性

下面您可以找到一组配置属性。spring-doc.cadn.net.cn

姓名 默认 描述

spring.cloud.compatibility-verifier.compatible-boot-versionsspring-doc.cadn.net.cn

Spring Boot 依赖项的默认接受版本。如果不想指定具体值,可将 {@code x} 设置为补丁版本。示例:{@code 3.5.x}spring-doc.cadn.net.cn

spring.cloud.compatibility-verifier.enabledspring-doc.cadn.net.cn

falsespring-doc.cadn.net.cn

启用 Spring Cloud 兼容性验证的创建。spring-doc.cadn.net.cn

spring.cloud.config.allow-overridespring-doc.cadn.net.cn

truespring-doc.cadn.net.cn

标志,用于指示是否可以使用 {@link #isOverrideSystemProperties() systemPropertiesOverride}。设置为 false 可防止用户意外更改默认值。默认值为 true。spring-doc.cadn.net.cn

spring.cloud.config.initialize-on-context-refreshspring-doc.cadn.net.cn

falsespring-doc.cadn.net.cn

标志位,用于在上下文刷新事件时初始化引导配置。默认值为 false。spring-doc.cadn.net.cn

spring.cloud.config.override-nonespring-doc.cadn.net.cn

falsespring-doc.cadn.net.cn

标志,用于指示当 {@link #setAllowOverride(boolean) allowOverride} 为 true 时,外部属性应具有最低优先级,且不应覆盖任何现有属性源(包括本地配置文件)。默认值为 false。此设置仅在使用配置优先引导启动时才生效。spring-doc.cadn.net.cn

spring.cloud.config.override-system-propertiesspring-doc.cadn.net.cn

truespring-doc.cadn.net.cn

标志,用于指示外部属性是否应覆盖系统属性。默认值为 true。spring-doc.cadn.net.cn

spring.cloud.decrypt-environment-post-processor.enabledspring-doc.cadn.net.cn

truespring-doc.cadn.net.cn

启用 DecryptEnvironmentPostProcessor。spring-doc.cadn.net.cn

spring.cloud.discovery.client.composite-indicator.enabledspring-doc.cadn.net.cn

truespring-doc.cadn.net.cn

启用发现客户端复合健康指标。spring-doc.cadn.net.cn

spring.cloud.discovery.client.health-indicator.enabledspring-doc.cadn.net.cn

truespring-doc.cadn.net.cn

spring.cloud.discovery.client.health-indicator.include-descriptionspring-doc.cadn.net.cn

falsespring-doc.cadn.net.cn

spring.cloud.discovery.client.health-indicator.use-services-queryspring-doc.cadn.net.cn

truespring-doc.cadn.net.cn

指示器是否应使用 {@link DiscoveryClient#getServices} 检查其健康状态。当设置为 {@code false} 时,指示器将改用更轻量级的 {@link DiscoveryClient#probe()} 方法。这在服务数量庞大的部署中非常有用,因为此时调用 {@link DiscoveryClient#getServices} 可能因返回大量服务而造成不必要的性能开销。spring-doc.cadn.net.cn

spring.cloud.discovery.client.simple.instancesspring-doc.cadn.net.cn

spring.cloud.discovery.client.simple.local.hostspring-doc.cadn.net.cn

spring.cloud.discovery.client.simple.local.instance-idspring-doc.cadn.net.cn

spring.cloud.discovery.client.simple.local.metadataspring-doc.cadn.net.cn

spring.cloud.discovery.client.simple.local.portspring-doc.cadn.net.cn

0spring-doc.cadn.net.cn

spring.cloud.discovery.client.simple.local.securespring-doc.cadn.net.cn

falsespring-doc.cadn.net.cn

spring.cloud.discovery.client.simple.local.service-idspring-doc.cadn.net.cn

spring.cloud.discovery.client.simple.local.urispring-doc.cadn.net.cn

spring.cloud.discovery.client.simple.orderspring-doc.cadn.net.cn

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

truespring-doc.cadn.net.cn

启用发现客户端健康指标。spring-doc.cadn.net.cn

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

truespring-doc.cadn.net.cn

启用特性端点。spring-doc.cadn.net.cn

spring.cloud.httpclientfactories.apache.enabledspring-doc.cadn.net.cn

truespring-doc.cadn.net.cn

启用创建 Apache HTTP 客户端工厂 Bean。spring-doc.cadn.net.cn

spring.cloud.httpclientfactories.ok.enabledspring-doc.cadn.net.cn

truespring-doc.cadn.net.cn

启用 OK Http 客户端工厂 Bean 的创建。spring-doc.cadn.net.cn

spring.cloud.hypermedia.refresh.fixed-delayspring-doc.cadn.net.cn

5000spring-doc.cadn.net.cn

spring.cloud.hypermedia.refresh.initial-delayspring-doc.cadn.net.cn

10000spring-doc.cadn.net.cn

spring.cloud.inetutils.default-hostnamespring-doc.cadn.net.cn

localhostspring-doc.cadn.net.cn

默认主机名。在发生错误时使用。spring-doc.cadn.net.cn

spring.cloud.inetutils.default-ip-addressspring-doc.cadn.net.cn

127.0.0.1spring-doc.cadn.net.cn

默认IP地址。在发生错误时使用。spring-doc.cadn.net.cn

spring.cloud.inetutils.ignored-interfacesspring-doc.cadn.net.cn

用于忽略网络接口的 Java 正则表达式列表。spring-doc.cadn.net.cn

spring.cloud.inetutils.preferred-networksspring-doc.cadn.net.cn

网络地址的Java正则表达式列表,将被优先选择。spring-doc.cadn.net.cn

spring.cloud.inetutils.timeout-secondsspring-doc.cadn.net.cn

1spring-doc.cadn.net.cn

计算主机名的超时时间(秒)。spring-doc.cadn.net.cn

spring.cloud.inetutils.use-only-site-local-interfacesspring-doc.cadn.net.cn

falsespring-doc.cadn.net.cn

是否仅使用具有站点本地地址的接口。有关更多详细信息,请参阅 {@link InetAddress#isSiteLocalAddress()}。spring-doc.cadn.net.cn

spring.cloud.loadbalancer.api-version.defaultspring-doc.cadn.net.cn

为每个请求设置应使用的默认版本。spring-doc.cadn.net.cn

spring.cloud.loadbalancer.api-version.fallback-to-available-instancesspring-doc.cadn.net.cn

falsespring-doc.cadn.net.cn

指示如果为指定版本不可用,则是否应返回所有可用实例。spring-doc.cadn.net.cn

spring.cloud.loadbalancer.api-version.headerspring-doc.cadn.net.cn

使用给定名称的HTTP标头获取版本。spring-doc.cadn.net.cn

spring.cloud.loadbalancer.api-version.media-type-parametersspring-doc.cadn.net.cn

使用给定名称的媒体类型参数来获取版本。spring-doc.cadn.net.cn

spring.cloud.loadbalancer.api-version.path-segmentspring-doc.cadn.net.cn

使用给定索引处的路径段获取版本。spring-doc.cadn.net.cn

spring.cloud.loadbalancer.api-version.query-parameterspring-doc.cadn.net.cn

使用给定名称的查询参数获取版本。spring-doc.cadn.net.cn

spring.cloud.loadbalancer.api-version.requiredspring-doc.cadn.net.cn

falsespring-doc.cadn.net.cn

指示是否需要在每次请求中使用 API 版本号。spring-doc.cadn.net.cn

spring.cloud.loadbalancer.cache.caffeine.specspring-doc.cadn.net.cn

用于创建缓存的规格。有关规格格式的更多详细信息,请参见 CaffeineSpec。spring-doc.cadn.net.cn

spring.cloud.loadbalancer.cache.capacityspring-doc.cadn.net.cn

256spring-doc.cadn.net.cn

初始缓存容量,以 int 类型表示。spring-doc.cadn.net.cn

spring.cloud.loadbalancer.cache.enabledspring-doc.cadn.net.cn

truespring-doc.cadn.net.cn

启用 Spring Cloud LoadBalancer 缓存机制。spring-doc.cadn.net.cn

spring.cloud.loadbalancer.cache.ttlspring-doc.cadn.net.cn

35sspring-doc.cadn.net.cn

生存时间(Time To Live)——从记录写入开始计时,此后缓存条目将过期的时间,以 {@link Duration} 表示。该属性的 {@link String} 必须符合 Spring Boot <code>StringToDurationConverter</code> 所规定的相应语法格式。@see <a href="https://github.com/spring-projects/spring-boot/blob/master/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/convert/StringToDurationConverter.java">StringToDurationConverter.java</a>spring-doc.cadn.net.cn

spring.cloud.loadbalancer.call-get-with-request-on-delegatesspring-doc.cadn.net.cn

truespring-doc.cadn.net.cn

如果此标志设置为 {@code true},则在从 {@code DelegatingServiceInstanceListSupplier} 派生且尚未实现该方法的类中,{@code ServiceInstanceListSupplier#get(Request request)} 方法将被实现为调用 {@code delegate.get(request)};但需排除 {@code CachingServiceInstanceListSupplier} 和 {@code HealthCheckServiceInstanceListSupplier},后者应直接置于执行网络实例检索的提供商之后、任何基于请求的过滤之前,作为实例提供者层次结构中的下一个节点。默认值为 {@code true}。spring-doc.cadn.net.cn

spring.cloud.loadbalancer.clientsspring-doc.cadn.net.cn

spring.cloud.loadbalancer.configurationsspring-doc.cadn.net.cn

defaultspring-doc.cadn.net.cn

启用预定义的负载均衡器配置。spring-doc.cadn.net.cn

spring.cloud.loadbalancer.eager-load.clientsspring-doc.cadn.net.cn

客户的名称。spring-doc.cadn.net.cn

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

truespring-doc.cadn.net.cn

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

spring.cloud.loadbalancer.health-check.initial-delayspring-doc.cadn.net.cn

0spring-doc.cadn.net.cn

HealthCheck调度器的初始延迟值。spring-doc.cadn.net.cn

spring.cloud.loadbalancer.health-check.intervalspring-doc.cadn.net.cn

25sspring-doc.cadn.net.cn

健康检查调度器重新运行的间隔时间。spring-doc.cadn.net.cn

spring.cloud.loadbalancer.health-check.pathspring-doc.cadn.net.cn

健康检查请求应访问的路径。可为每个 serviceId 单独配置。也可设置 default 值。若未进行任何配置,则将使用 /actuator/healthspring-doc.cadn.net.cn

spring.cloud.loadbalancer.health-check.portspring-doc.cadn.net.cn

健康检查请求应访问的路径。如果未设置,则使用服务实例上可用的服务端口。spring-doc.cadn.net.cn

spring.cloud.loadbalancer.health-check.refetch-instancesspring-doc.cadn.net.cn

falsespring-doc.cadn.net.cn

指示实例是否应由 HealthCheckServiceInstanceListSupplier 重新获取。如果实例可能被更新,且底层委托不提供持续的流(flux),则可以使用此选项。spring-doc.cadn.net.cn

spring.cloud.loadbalancer.health-check.refetch-instances-intervalspring-doc.cadn.net.cn

25sspring-doc.cadn.net.cn

重新获取可用服务实例的间隔时间。spring-doc.cadn.net.cn

spring.cloud.loadbalancer.health-check.repeat-health-checkspring-doc.cadn.net.cn

truespring-doc.cadn.net.cn

指示健康检查是否应持续重复。如果定期重新获取实例,将其设置为 false 可能很有用,因为每次重新获取都会触发一次健康检查。spring-doc.cadn.net.cn

spring.cloud.loadbalancer.health-check.update-results-listspring-doc.cadn.net.cn

truespring-doc.cadn.net.cn

指示 {@code healthCheckFlux} 是否应在每次获取到存活的 {@link ServiceInstance} 时发出。如果设置为 {@code false},则会先将所有存活实例收集到列表中,然后再发出整个序列。spring-doc.cadn.net.cn

spring.cloud.loadbalancer.hintspring-doc.cadn.net.cn

允许设置传递给 LoadBalancer 请求的 <code>hint</code> 值,该值随后可在 {@link ReactiveLoadBalancer} 实现中使用。spring-doc.cadn.net.cn

spring.cloud.loadbalancer.hint-header-namespring-doc.cadn.net.cn

X-SC-LB-Hintspring-doc.cadn.net.cn

允许设置用于传递基于提示的服务实例过滤提示的请求头名称。spring-doc.cadn.net.cn

spring.cloud.loadbalancer.retry.avoid-previous-instancespring-doc.cadn.net.cn

truespring-doc.cadn.net.cn

如果类路径中包含 Spring-Retry,则可将 ServiceInstanceListSupplier bean 包装为 RetryAwareServiceInstanceListSupplierspring-doc.cadn.net.cn

spring.cloud.loadbalancer.retry.backoff.enabledspring-doc.cadn.net.cn

falsespring-doc.cadn.net.cn

指示是否应应用 Reactor Retry 的退避策略。spring-doc.cadn.net.cn

spring.cloud.loadbalancer.retry.backoff.jitterspring-doc.cadn.net.cn

0.5spring-doc.cadn.net.cn

用于设置 RetryBackoffSpec.jitterspring-doc.cadn.net.cn

spring.cloud.loadbalancer.retry.backoff.max-backoffspring-doc.cadn.net.cn

Long.MAX msspring-doc.cadn.net.cn

用于设置 RetryBackoffSpec.maxBackoffspring-doc.cadn.net.cn

spring.cloud.loadbalancer.retry.backoff.min-backoffspring-doc.cadn.net.cn

5 msspring-doc.cadn.net.cn

用于设置 RetryBackoffSpec#minBackoffspring-doc.cadn.net.cn

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

truespring-doc.cadn.net.cn

启用负载均衡器重试。spring-doc.cadn.net.cn

spring.cloud.loadbalancer.retry.max-retries-on-next-service-instancespring-doc.cadn.net.cn

1spring-doc.cadn.net.cn

在下一次 ServiceInstance 上要执行的重试次数。每次重试调用前都会选择一个 ServiceInstancespring-doc.cadn.net.cn

spring.cloud.loadbalancer.retry.max-retries-on-same-service-instancespring-doc.cadn.net.cn

0spring-doc.cadn.net.cn

在同一 ServiceInstance 上要执行的重试次数。spring-doc.cadn.net.cn

spring.cloud.loadbalancer.retry.retry-on-all-exceptionsspring-doc.cadn.net.cn

falsespring-doc.cadn.net.cn

表示应对所有异常都进行重试,而不仅限于 retryableExceptions 中指定的异常。spring-doc.cadn.net.cn

spring.cloud.loadbalancer.retry.retry-on-all-operationsspring-doc.cadn.net.cn

falsespring-doc.cadn.net.cn

表示应在除 HttpMethod.GET 之外的操作上尝试重试。spring-doc.cadn.net.cn

spring.cloud.loadbalancer.retry.retryable-exceptionsspring-doc.cadn.net.cn

{}spring-doc.cadn.net.cn

A Set of Throwable classes that should trigger a retry.spring-doc.cadn.net.cn

spring.cloud.loadbalancer.retry.retryable-status-codesspring-doc.cadn.net.cn

{}spring-doc.cadn.net.cn

A Set of status codes that should trigger a retry.spring-doc.cadn.net.cn

spring.cloud.loadbalancer.service-discovery.timeoutspring-doc.cadn.net.cn

服务发现调用超时的持续时间字符串表示形式。spring-doc.cadn.net.cn

spring.cloud.loadbalancer.stats.include-pathspring-doc.cadn.net.cn

truespring-doc.cadn.net.cn

指示是否应将 {@code path} 添加到 metrics 中的 {@code uri} 标记。当使用 {@link RestTemplate} 执行具有高基数路径的负载均衡请求时,建议将其设置为 {@code false}。spring-doc.cadn.net.cn

spring.cloud.loadbalancer.stats.micrometer.enabledspring-doc.cadn.net.cn

falsespring-doc.cadn.net.cn

启用 Spring Cloud LoadBalancer 的 Micrometer 统计信息。spring-doc.cadn.net.cn

spring.cloud.loadbalancer.sticky-session.add-service-instance-cookiespring-doc.cadn.net.cn

falsespring-doc.cadn.net.cn

指示是否应由负载均衡器添加包含新选择实例的Cookie。spring-doc.cadn.net.cn

spring.cloud.loadbalancer.sticky-session.instance-id-cookie-namespring-doc.cadn.net.cn

sc-lb-instance-idspring-doc.cadn.net.cn

保存首选实例ID的Cookie名称。spring-doc.cadn.net.cn

spring.cloud.loadbalancer.subset.instance-idspring-doc.cadn.net.cn

确定性子集划分的实例ID。如果不设置,则将使用 {@link IdUtils#getDefaultInstanceId(PropertyResolver)}。spring-doc.cadn.net.cn

spring.cloud.loadbalancer.subset.sizespring-doc.cadn.net.cn

100spring-doc.cadn.net.cn

确定性子集划分的最大子集大小。spring-doc.cadn.net.cn

spring.cloud.loadbalancer.x-forwarded.enabledspring-doc.cadn.net.cn

falsespring-doc.cadn.net.cn

启用 X-Forwarded 头部。spring-doc.cadn.net.cn

spring.cloud.loadbalancer.zonespring-doc.cadn.net.cn

Spring Cloud LoadBalancer 区域。spring-doc.cadn.net.cn

spring.cloud.refresh.additional-property-sources-to-retainspring-doc.cadn.net.cn

在刷新期间要保留的额外属性源。通常仅保留系统属性源。此属性允许保留其他属性源,例如由 EnvironmentPostProcessors 创建的属性源。spring-doc.cadn.net.cn

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

truespring-doc.cadn.net.cn

启用刷新作用域及其相关功能的自动配置。spring-doc.cadn.net.cn

spring.cloud.refresh.extra-refreshablespring-doc.cadn.net.cn

truespring-doc.cadn.net.cn

用于后处理并刷新作用域的额外bean名称或类名称。spring-doc.cadn.net.cn

spring.cloud.refresh.never-refreshablespring-doc.cadn.net.cn

truespring-doc.cadn.net.cn

以逗号分隔的 Bean 名称列表或类名称,用于指定不应被刷新或重新绑定的 Bean。spring-doc.cadn.net.cn

spring.cloud.refresh.on-restart.enabledspring-doc.cadn.net.cn

truespring-doc.cadn.net.cn

启动时启用上下文刷新。spring-doc.cadn.net.cn

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

truespring-doc.cadn.net.cn

&emsp;是否启用服务自动注册。默认为 true。spring-doc.cadn.net.cn

spring.cloud.service-registry.auto-registration.fail-fastspring-doc.cadn.net.cn

falsespring-doc.cadn.net.cn

指示启动程序是否在没有 AutoServiceRegistration 的情况下失败。默认值为 false。spring-doc.cadn.net.cn

spring.cloud.service-registry.auto-registration.register-managementspring-doc.cadn.net.cn

truespring-doc.cadn.net.cn

是否要将管理注册为服务。默认值为true。spring-doc.cadn.net.cn

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

truespring-doc.cadn.net.cn

启用创建Spring Cloud实用程序 bean。spring-doc.cadn.net.cn