6. Zookeeper 依赖项
以下主题介绍如何使用 Spring Cloud Zookeeper 依赖项:
6.1. 使用 Zookeeper 依赖项
Spring Cloud Zookeeper 为您提供了提供应用程序依赖项的可能性
作为属性。作为依赖项,您可以了解已注册的其他应用程序
在 Zookeeper 中,并且您想通过 Feign(REST 客户端构建器)调用它,SpringRestTemplate
和 Spring WebFlux。
您还可以使用 Zookeeper 依赖项观察器功能来控制和监视 依赖项的状态。
6.2. 激活 Zookeeper 依赖项
包括对org.springframework.cloud:spring-cloud-starter-zookeeper-discovery
使
设置 Spring Cloud Zookeeper 依赖项的自动配置。即使您提供
属性中的依赖项,您可以关闭依赖项。为此,请将spring.cloud.zookeeper.dependency.enabled
属性设置为 false(默认为true
).
6.3. 设置 Zookeeper 依赖项
请考虑以下依赖关系表示示例:
spring.application.name: yourServiceName
spring.cloud.zookeeper:
dependencies:
newsletter:
path: /path/where/newsletter/has/registered/in/zookeeper
loadBalancerType: ROUND_ROBIN
contentTypeTemplate: application/vnd.newsletter.$version+json
version: v1
headers:
header1:
- value1
header2:
- value2
required: false
stubs: org.springframework:foo:stubs
mailing:
path: /path/where/mailing/has/registered/in/zookeeper
loadBalancerType: ROUND_ROBIN
contentTypeTemplate: application/vnd.mailing.$version+json
version: v1
required: true
接下来的几节将逐一介绍依赖项的每个部分。根属性
名称是spring.cloud.zookeeper.dependencies
.
6.3.1. 别名
在根属性下,您必须将每个依赖项表示为别名。
这是由于 Spring Cloud LoadBalancer 的约束,它要求将应用程序 ID 放在 URL 中。
因此,您无法通过任何复杂的路径,例如/myApp/myRoute/name
).
别名是您使用的名称,而不是serviceId
为DiscoveryClient
,Feign
或RestTemplate
.
在前面的示例中,别名是newsletter
和mailing
.
以下示例显示了带有newsletter
别名:
@FeignClient("newsletter")
public interface NewsletterService {
@RequestMapping(method = RequestMethod.GET, value = "/newsletter")
String getNewsletters();
}
6.3.2. 路径
路径由path
YAML 属性,是在 Zookeeper 下注册依赖项的路径。
如上一节所述,Spring Cloud LoadBalancer 对 URL 进行作。
因此,此路径不符合其要求。
这就是 Spring Cloud Zookeeper 将别名映射到正确路径的原因。
6.3.3. 负载均衡器类型
负载均衡器类型由loadBalancerType
YAML 属性。
如果您知道在调用此特定依赖项时必须应用哪种类型的负载均衡策略,则可以在 YAML 文件中提供它,它会自动应用。 您可以选择以下负载均衡策略之一:
-
STICKY:一旦选择,实例将始终被调用。
-
RANDOM:随机选择一个实例。
-
ROUND_ROBIN:一遍又一遍地迭代实例。
6.3.4.Content-Type
模板和版本
这Content-Type
模板和版本由contentTypeTemplate
和version
YAML 属性。
如果您在Content-Type
header,您不想添加此标题
满足您的每一个要求。此外,如果您想调用新版本的 API,则不要调用
想要在代码中漫游以提升 API 版本。这就是为什么你可以提供一个contentTypeTemplate
带有特殊的$version
占 位 符。该占位符将由version
YAML 属性。考虑以下示例contentTypeTemplate
:
application/vnd.newsletter.$version+json
进一步考虑以下事项version
:
v1
的组合contentTypeTemplate
和 version 导致创建Content-Type
标头,如下所示:
application/vnd.newsletter.v1+json
6.3.5. 默认标头
默认标头由headers
map 中的 YAML 中。
有时,每次调用依赖项都需要设置一些默认标头。不
在代码中执行此作,可以在 YAML 文件中设置它们,如以下示例所示headers
部分:
headers:
Accept:
- text/html
- application/xhtml+xml
Cache-Control:
- no-cache
那headers
部分的结果是将Accept
和Cache-Control
headers 与
HTTP 请求中的适当值列表。
6.3.6. 所需的依赖项
所需的依赖项由required
属性。
如果应用程序启动时需要启动其中一个依赖项,您可以将
这required: true
属性。
如果您的应用程序无法在启动时本地化所需的依赖项,它会抛出 异常,并且 Spring Context 无法设置。换句话说,您的应用程序不能 如果未在 Zookeeper 中注册所需的依赖项,则启动。
您可以在本文档后面阅读有关 Spring Cloud Zookeeper Presence Checker 的更多信息。
6.3.7. 存根
您可以为 JAR 提供一个以冒号分隔的路径,其中包含依赖项的存根,如 如以下示例所示:
stubs: org.springframework:myApp:stubs
哪里:
-
org.springframework
是groupId
. -
myApp
是artifactId
. -
stubs
是分类器。(请注意,stubs
是默认值。
因为stubs
是默认分类器,则前面的示例等于以下
例:
stubs: org.springframework:myApp
6.4. 配置 Spring Cloud Zookeeper 依赖项
您可以设置以下属性来启用或禁用部分 Zookeeper 依赖项功能:
-
spring.cloud.zookeeper.dependencies
:如果不设置此属性,则无法使用 Zookeeper 依赖项。 -
spring.cloud.zookeeper.dependency.loadbalancer.enabled
(默认启用):打开特定于 Zookeeper 的自定义负载平衡策略,包括ZookeeperServiceInstanceListSupplier
和基于依赖关系的负载平衡RestTemplate
设置。 -
spring.cloud.zookeeper.dependency.headers.enabled
(默认启用):此属性注册一个FeignBlockingLoadBalancerClient
自动将适当的标头和内容类型及其版本追加,如依赖项配置中所示。 如果没有此设置,这两个参数将不起作用。 -
spring.cloud.zookeeper.dependency.resttemplate.enabled
(默认启用):启用后,此属性将修改@LoadBalanced
-注释RestTemplate
这样它就会传递标头和内容类型,其中包含在依赖项配置中设置的版本。 如果没有此设置,这两个参数将不起作用。