服务注册与分布式协调 / 系统课时

客户端封装与关闭

客户端封装与关闭

原生 ZooKeeper 客户端的构造方法会先返回对象,再异步建立会话。本篇把连接等待、有限重试和关闭动作收进一个可复用封装,让业务代码只在客户端真正可用后执行操作,并在退出时可靠释放会话。

学习目标

  • 区分“拿到 ZooKeeper 对象”和“收到 SyncConnected”这两个时点
  • 为幂等读取设计有上限的连接类故障重试
  • 使用 AutoCloseable 在正常退出和异常路径上关闭会话

把连接建立和“可用”分开

new ZooKeeper(connectString, sessionTimeout, watcher) 不会阻塞到服务端连接完成。构造成功只能说明客户端对象已创建,真正可执行业务请求的关键事件是 Watcher 收到 SyncConnected。因此封装层要设置自己的连接等待上限,超时后主动关闭刚创建的客户端,不能把半连接对象交给业务层。

连接等待、重试与关闭流程

下面的封装把连接等待和读取重试放在同一个类中。示例只对 exists 这种幂等读取做连接类故障重试,避免把“请求是否已经在服务端成功”无法确认的写操作直接重复提交。

java
import org.apache.zookeeper.KeeperException;
import org.apache.zookeeper.WatchedEvent;
import org.apache.zookeeper.Watcher;
import org.apache.zookeeper.ZooKeeper;
import org.apache.zookeeper.data.Stat;

import java.io.IOException;
import java.util.concurrent.CountDownLatch;
import java.util.concurrent.TimeUnit;

public final class SafeZooKeeperClient implements AutoCloseable {
    private final ZooKeeper zooKeeper;

    private SafeZooKeeperClient(ZooKeeper zooKeeper) {
        this.zooKeeper = zooKeeper;
    }

    public static SafeZooKeeperClient connect(
            String connectString,
            int sessionTimeoutMs,
            long connectTimeoutMs) throws IOException, InterruptedException {

        CountDownLatch connected = new CountDownLatch(1);

        ZooKeeper zk = new ZooKeeper(connectString, sessionTimeoutMs, (WatchedEvent event) -> {
            if (event.getState() == Watcher.Event.KeeperState.SyncConnected) {
                connected.countDown();
            }
        });

        // 构造器返回时连接可能仍在建立,因此单独等待 SyncConnected。
        if (!connected.await(connectTimeoutMs, TimeUnit.MILLISECONDS)) {
            zk.close();
            throw new IOException("ZooKeeper connect timeout");
        }

        return new SafeZooKeeperClient(zk);
    }

    public Stat existsWithRetry(String path, int maxAttempts, long backoffMs)
            throws KeeperException, InterruptedException {

        if (maxAttempts < 1) {
            throw new IllegalArgumentException("maxAttempts must be >= 1");
        }

        for (int attempt = 1; attempt <= maxAttempts; attempt++) {
            try {
                return zooKeeper.exists(path, false);
            } catch (KeeperException.ConnectionLossException
                     | KeeperException.OperationTimeoutException e) {
                // 只重试暂时性连接故障;超过上限后把原异常交给调用方。
                if (attempt == maxAttempts) {
                    throw e;
                }
                Thread.sleep(backoffMs);
            }
        }

        throw new IllegalStateException("unreachable");
    }

    @Override
    public void close() throws InterruptedException {
        zooKeeper.close();
    }

    public static void main(String[] args) throws Exception {
        String connectString = args.length > 0 ? args[0] : "127.0.0.1:2181";

        try (SafeZooKeeperClient client =
                     SafeZooKeeperClient.connect(connectString, 10_000, 5_000)) {
            Stat root = client.existsWithRetry("/", 3, 200);
            System.out.println("CONNECTED");
            System.out.println("ROOT_EXISTS=" + (root != null));
        }
    }
}

预期输出(本机 127.0.0.1:2181 已有可用 ZooKeeper 服务,且忽略客户端日志):

text
CONNECTED
ROOT_EXISTS=true

连接地址、会话超时和等待上限都应由应用配置提供。sessionTimeoutMs 是 ZooKeeper 会话参数,connectTimeoutMs 则是封装层“愿意等多久才开始业务”的本地策略,两者含义不同。

用受控重试限制故障影响

重试不能写成无限循环。连接抖动时可针对 ConnectionLossException、OperationTimeoutException 这类暂时性错误做有限次数重试,并设置固定或指数退避;达到上限后必须把失败交给上层,让调用方决定降级、报警或终止请求。

SessionExpiredException 表示原会话已经失效,通常应重建客户端,而不是继续拿旧对象重试。认证失败、节点不存在等业务语义错误也不属于“再试一次可能恢复”的范围。

在应用关闭时释放会话

ZooKeeper.close() 会结束会话并释放客户端线程、网络连接等资源。把封装实现为 AutoCloseable 后,业务层可以使用 try-with-resources,即使操作抛出异常也会进入关闭路径,比依赖 JVM 最终退出更可控。

如果客户端与整个进程同生命周期,可以由依赖注入容器的销毁回调或 JVM shutdown hook 调用同一个 close();不要同时维护多套关闭逻辑。关闭过程中若线程被中断,应恢复或继续传播中断语义,而不是静默吞掉。

验收封装行为

至少验证三条路径:服务正常时能在等待上限内进入 SyncConnected;连接地址不可达时在 connectTimeoutMs 后失败且不泄漏客户端;运行中短暂断连时,幂等读取只在限定次数内重试。这样封装层就把“何时可用、哪些错误能重试、何时必须释放”三个边界固定下来,业务代码无需重复处理连接生命周期。

按自己的节奏,确认真正理解。

目录与阅读设置

阅读设置

17

记录一个想法

客户端封装与关闭

0 / 10000 · 笔记保存到账号。未提交的修改会在关闭、离开或刷新后丢失。

登录哪都通