使用 Zookeeper 作为注册中心实现自动服务发现

通过示例演示如何使用 Zookeeper 作为注册中心实现自动服务发现。

本示例演示 Zookeeper 作为注册中心实现自动服务发现，示例基于 Spring Boot 应用展开，可在此查看 完整示例代码

1 基本配置

1.1 增加 Maven 依赖

添加 dubbo、zookeeper 等依赖。dubbo-spring-boot-starter 将自动为应用增加 Zookeeper 相关客户端的依赖，减少用户使用 Zookeeper 成本，如使用中遇到版本兼容问题，用户也可以选择自行添加 Curator、Zookeeper Client 等依赖。

对于 Spring Boot 应用而言，可使用如下依赖：

  1. <dependency>
  2.     <groupId>org.apache.dubbo</groupId>
  3.     <artifactId>dubbo-spring-boot-starter</artifactId>
  4.     <version>3.3.0</version>
  5. </dependency>
  6. <!-- 仅当 Zookeeper Server 版本是 3.4.x 及以下时，使用此依赖 -->
  7. <dependency>
  8.     <groupId>org.apache.dubbo</groupId>
  9.     <artifactId>dubbo-zookeeper-spring-boot-starter</artifactId>
  10.     <version>3.3.0</version>
  11. </dependency>
  12. <!-- 仅当 Zookeeper Server 版本是 3.5.x 及以上时，使用此依赖
  13. <dependency>
  14.     <groupId>org.apache.dubbo</groupId>
  15.     <artifactId>dubbo-zookeeper-curator5-spring-boot-starter</artifactId>
  16.     <version>3.3.0</version>
  17. </dependency>
  18. -->

其中，dubbo-zookeeper-spring-boot-starter 或 dubbo-zookeeper-curator5-spring-boot-starter 负责管理 zookeeper 相关依赖。

注意

如果您不使用 Spring Boot，也可以使用以下方式管理依赖

  1. <dependencies>
  2.     <dependency>
  3.         <groupId>org.apache.dubbo</groupId>
  4.         <artifactId>dubbo</artifactId>
  5.         <version>3.3.0</version>
  6.     </dependency>
  7.     <!-- This dependency helps to introduce Curator and Zookeeper dependencies that are necessary for Dubbo to work with zookeeper as transitive dependencies. -->
  8.     <!-- 仅当 Zookeeper Server 版本是 3.4.x 及以下时，使用此依赖 -->
  9.     <dependency>
  10.         <groupId>org.apache.dubbo</groupId>
  11.         <artifactId>dubbo-dependencies-zookeeper</artifactId>
  12.         <version>3.3.0</version>
  13.         <type>pom</type>
  14.     </dependency>
  15.     <!-- 仅当 Zookeeper Server 版本是 3.5.x 及以上时，使用此依赖
  16.     <dependency>
  17.         <groupId>org.apache.dubbo</groupId>
  18.         <artifactId>dubbo-dependencies-zookeeper-curator5</artifactId>
  19.         <version>3.3.0</version>
  20.         <type>pom</type>
  21.     </dependency>
  22.     -->
  23. </dependencies>

1.2 选择 Zookeeper 版本

由于 Dubbo 使用 Curator 作为与 Zookeeper Server 交互的编程客户端，因此，要特别注意 Zookeeper Server 与 Dubbo 版本依赖的兼容性。

Dubbo 提供了 Zookeeper 依赖的辅助管理组件，开发者可根据当前使用的 Zookeeper Server 版本选择依赖版本：

1. 如果您是 Dubbo3 3.3 版本及以上用户，请根据如下表格选择组件：

Zookeeper Server 版本Dubbo 依赖Dubbo Starter 依赖（SpringBoot用户）
3.4.x 及以下dubbo-dependencies-zookeeperdubbo-zookeeper-spring-boot-starter
3.5.x 及以上dubbo-dependencies-zookeeper-curator5dubbo-zookeeper-curator5-spring-boot-starter

2. 如果您是 Dubbo3 3.2 及以下、Dubbo2 2.7.x 用户：

Zookeeper Server 版本Dubbo 依赖Dubbo Starter 依赖（SpringBoot用户）
3.4.x 及以下dubbo-dependencies-zookeeper不支持（自行管理）
3.5.x 及以上不支持（自行管理）不支持（自行管理）

注意

  • Dubbo 3.3.0 版本开始正式支持 JDK 17，如果您使用 JDK 17，则必须选用 dubbo-dependencies-zookeeper-curator5 或 dubbo-zookeeper-curator5-spring-boot-starter 依赖，对应的 Zookeeper Server 推荐是 3.8.0 版本及以上。

1.3 配置并启用 Zookeeper

  1. # application.yml
  2. dubbo
  3.  registry
  4.    address: zookeeper://localhost:2181
  5.    register-mode: instance # 新用户请设置此值，表示启用应用级服务发现，可选值 interface、instance、all，默认值为 all，未来版本将切换默认值为 instance

或

  1. # dubbo.properties
  2. dubbo.registry.address=zookeeper://localhost:2181
  3. # 新用户请设置此值，表示启用应用级服务发现，可选值 interface、instance、all，默认值为 all，未来版本将切换默认值为 instance
  4. dubbo.registry.register-mode=instance

或

  1. <dubbo:registry address="zookeeper://localhost:2181" register-mode="instance" />

address 是启用 zookeeper 注册中心唯一必须指定的属性，而在生产环境下，address 通常被指定为集群地址，如

address=zookeeper://10.20.153.10:2181?backup=10.20.153.11:2181,10.20.153.12:2181

protocol 与 address 分开配置的模式也可以，如

<dubbo:registry protocol="zookeeper" address="10.20.153.10:2181,10.20.153.11:2181,10.20.153.12:2181" />

2 高级配置

2.1 认证与鉴权

如果 Zookeeper 开启认证，Dubbo 支持指定 username、password 的方式传入身份标识。

  1. # application.yml
  2. dubbo
  3.  registry
  4.    address: zookeeper://localhost:2181
  5.    register-mode: instance # 新用户请设置此值，表示启用应用级服务发现，可选值 interface、instance、all
  6.    username: hello
  7.    password: 1234

也可以直接将参数扩展在 address 上 address=zookeeper://hello:1234@localhost:2181

2.2 分组隔离

通过指定 group 属性，可以在同一个 Zookeeper 集群内实现微服务地址的逻辑隔离。比如可以在一套集群内隔离出多套开发环境，在地址发现层面实现隔离。

  1. # application.yml
  2. dubbo
  3.  registry
  4.    address: zookeeper://localhost:2181
  5.    register-mode: instance # 新用户请设置此值，表示启用应用级服务发现，可选值 interface、instance、all
  6.    group: daily1

2.3 其他扩展配置

配置连接、会话过期时间

  1. # application.yml
  2. dubbo
  3.  registry
  4.    address: zookeeper://localhost:2181
  5.    register-mode: instance # 新用户请设置此值，表示启用应用级服务发现，可选值 interface、instance、all
  6.    timeout: 30 * 1000* # 连接超时时间，默认 30s
  7.    session: 60 * 1000* # 会话超时时间，默认 60s

Zookeeper 注册中心还支持其他一些控制参数，具体可参见Registry 配置项手册

3 工作原理

在前面的一节中，我们讲解了应用级服务发现与接口级服务发现的区别，在 Zookeeper 实现中，它们的存储结构也存在较大差异。总体来说，Zookeeper 注册中心实现支持以下高可用能力：

  • 当提供者出现断电等异常停机时，注册中心能自动删除提供者信息
  • 当注册中心重启时，能自动恢复注册数据，以及订阅请求
  • 当会话过期时，能自动恢复注册数据，以及订阅请求
  • 当设置 registry.check=false 时，记录失败注册和订阅请求，后台定时重试

3.1 接口级节点结构

/user-guide/images/zookeeper.jpg

流程：

  • 服务提供者启动时: 向 /dubbo/com.foo.BarService/providers 目录下写入自己的 URL 地址。
  • 服务消费者启动时: 订阅 /dubbo/com.foo.BarService/providers 目录下的提供者 URL 地址。并向 /dubbo/com.foo.BarService/consumers 目录下写入自己的 URL 地址
  • 监控中心启动时: 订阅 /dubbo/com.foo.BarService 目录下的所有提供者和消费者 URL 地址。

可通过 registry.group 设置 zookeeper 的根节点，不配置将使用默认的 /dubbo 根节点。

3.2 应用级节点结构

3.2.1 地址列表

使用Zookeeper注册中心 - 图2

应用级服务发现的地址结构比接口级更精简，它以应用名为粒度分发地址列表。服务提供者启动时，向 /services/app 目录下写入自己的 URL 地址，相比于接口级别的 URL，应用级别的 URL 更简单，只包含一些实例级别的参数，如 tri://ip:port?region=hangzhou。

可通过 registry.group 设置 zookeeper 的根节点，如设置 registry.group=dubbo 后，地址根节点变为 /dubbo。不配置将使用默认的 /services 根节点。在与 Spring Cloud Gateway 共用情况下，使用 /services 根节点会导致 dubbo 地址被 gateway 消费，此时可考虑设置独立 group。

注意

在应用级服务发现模型中，接口级别的配置信息由消费者与提供者之间自行协商同步，不再由注册中心负责同步，从而大大减少了注册中心地址同步压力。

3.2.2 接口应用映射

在应用级服务发现中，zookeeper 注册中心还会存储一份额外的元数据，用于解决 接口名到应用名 之间的映射关系，其存储结构如下：

使用Zookeeper注册中心 - 图3

service1 节点的 value 值是应用列表，可通过 get /dubbo/mapping/service1 查看：app1,app2

3.2.3 元数据

如果您用的是应用级服务发现的集中式元数据模式（默认是点对点的元数据模式，可通过 dubbo.registry.metadata-type=remote 开启）。在开启集中式元数据模式后，zookeeper 中还会发现以下节点内容：

使用Zookeeper注册中心 - 图4

每个 revision 下是该应用的部署元数据信息，包含完整的接口服务列表及其配置信息。

最后修改 September 13, 2024: Refactor website structure (#2860) (1a4b998f54b)