Zookeeper应用场景实战一

1. Zookeeper Java客户端实战

ZooKeeper应用的开发主要通过Java客户端API去连接和操作ZooKeeper集群。可供选择的Java客户端API有：

ZooKeeper官方的Java客户端API。
第三方的Java客户端API，比如Curator。

ZooKeeper官方的客户端API提供了基本的操作。例如，创建会话、创建节点、读取节点、更新数据、删除节点和检查节点是否存在等。不过，对于实际开发来说，ZooKeeper官方API有一些不足之处，具体如下：

ZooKeeper的Watcher监测是一次性的，每次触发之后都需要重新进行注册。
会话超时之后没有实现重连机制。
异常处理烦琐，ZooKeeper提供了很多异常，对于开发人员来说可能根本不知道应该如何处理这些抛出的异常。
仅提供了简单的byte[]数组类型的接口，没有提供Java POJO级别的序列化数据处理接口。
创建节点时如果抛出异常，需要自行检查节点是否存在。
无法实现级联删除。

总之，ZooKeeper官方API功能比较简单，在实际开发过程中比较笨重，一般不推荐使用。

1.1 Zookeeper 原生Java客户端使用

引入zookeeper client依赖

<!-- zookeeper client -->
<dependency>
    <groupId>org.apache.zookeeper</groupId>
    <artifactId>zookeeper</artifactId>
    <version>3.8.0</version>
</dependency>

注意：保持与服务端版本一致，不然会有很多兼容性的问题

ZooKeeper原生客户端主要使用org.apache.zookeeper.ZooKeeper这个类来使用ZooKeeper服务。

ZooKeeper常用构造器

ZooKeeper (connectString, sessionTimeout, watcher)

connectString:使用逗号分隔的列表，每个ZooKeeper节点是一个host.port对，host 是机器名或者IP地址，port是ZooKeeper节点对客户端提供服务的端口号。客户端会任意选取connectString 中的一个节点建立连接。
sessionTimeout : session timeout时间。
watcher:用于接收到来自ZooKeeper集群的事件。

使用 zookeeper 原生 API，连接zookeeper集群

示例代码：

public class ZkClientDemo {

    private static final  String  CONNECT_STR="192.168.189.131";
    private final static  String CLUSTER_CONNECT_STR="192.168.65.163:2181,192.168.65.184:2181,192.168.65.186:2181";

    public static void main(String[] args) throws Exception {
        //获取zookeeper对象
        ZooKeeper zooKeeper = ZooKeeperFacotry.create(CLUSTER_CONNECT_STR);

        //CONNECTED
        System.out.println(zooKeeper.getState());

        Stat stat = zooKeeper.exists("/user",false);
        if(null ==stat){
            //创建持久节点
            zooKeeper.create("/user","bubble".getBytes(),
                    ZooDefs.Ids.OPEN_ACL_UNSAFE, CreateMode.PERSISTENT);
        }

        //永久监听  addWatch -m mode  /user
        zooKeeper.addWatch("/user",new Watcher() {
            @Override
            public void process(WatchedEvent event) {
                System.out.println("event:=> " + event);
                //TODO
            }
        },AddWatchMode.PERSISTENT);

        stat = new Stat();
        byte[] data = zooKeeper.getData("/user", false, stat);
        System.out.println(" data:=> "+new String(data));
        // -1: 无条件更新
        //zooKeeper.setData("/user", "third".getBytes(), -1);
        // 带版本条件更新
        int version = stat.getVersion();

        zooKeeper.setData("/user", "bubble".getBytes(), version);

        Thread.sleep(Integer.MAX_VALUE);

    }
}

public class ZooKeeperFacotry {
    private static final int SESSION_TIMEOUT = 5000;

    public static ZooKeeper create(String connectionString) throws Exception {
        final CountDownLatch connectionLatch = new CountDownLatch(1);
        ZooKeeper zooKeeper = new ZooKeeper(connectionString, SESSION_TIMEOUT, new Watcher() {
            @Override
            public void process(WatchedEvent event) {
                if (event.getType()== Event.EventType.None
                        && event.getState() == Watcher.Event.KeeperState.SyncConnected) {
                    connectionLatch.countDown();
                    System.out.println("连接建立");
                }
            }
        });

        System.out.println("等待连接建立...");
        connectionLatch.await();

        return zooKeeper;
    }
}

运行结果:

等待连接建立...
// ...省略
连接建立
CONNECTED
 data:=> bubble
event:=> WatchedEvent state:SyncConnected type:NodeDataChanged path:/user//第一次运行触发的监听
event:=> WatchedEvent state:SyncConnected type:NodeDataChanged path:/user//操作/user触发的监听，set /user bubble
event:=> WatchedEvent state:SyncConnected type:NodeDataChanged path:/user//操作一次触发一次

Zookeeper主要方法

create(path, data, acl,createMode): 创建一个给定路径的 znode，并在 znode 保存 data[]的数据，createMode指定 znode 的类型。
delete(path, version):如果给定 path 上的 znode 的版本和给定的 version 匹配，删除 znode。
exists(path, watch):判断给定 path 上的 znode 是否存在，并在 znode 设置一个 watch。
getData(path, watch):返回给定 path 上的 znode 数据，并在 znode 设置一个 watch。
setData(path, data, version):如果给定 path 上的 znode 的版本和给定的 version 匹配，设置 znode 数据。
getChildren(path, watch):返回给定 path 上的 znode 的孩子 znode 名字，并在 znode 设置一个 watch。
sync(path):把客户端 session 连接节点和 leader 节点进行同步。

方法特点：

所有获取 znode 数据的 API 都可以设置一个 watch 用来监控 znode 的变化。
所有更新 znode 数据的 API 都有两个版本: 无条件更新版本和条件更新版本。如果 version 为 -1，更新为无条件更新。否则只有给定的 version 和 znode 当前的 version 一样，才会进行更新，这样的更新是条件更新。
所有的方法都有同步和异步两个版本。同步版本的方法发送请求给 ZooKeeper 并等待服务器的响应。异步版本把请求放入客户端的请求队列，然后马上返回。异步版本通过 callback 来接受来自服务端的响应。

同步创建节点：

@Test
public void createTest() throws KeeperException, InterruptedException {
    String path = zooKeeper.create(ZK_NODE, "data".getBytes(), ZooDefs.Ids.OPEN_ACL_UNSAFE, CreateMode.PERSISTENT);
    log.info("created path: {}",path);
}

异步创建节点：

@Test
public void createAsycTest() throws InterruptedException {
     zooKeeper.create(ZK_NODE, "data".getBytes(), ZooDefs.Ids.OPEN_ACL_UNSAFE,
             CreateMode.PERSISTENT,
             (rc, path, ctx, name) -> log.info("rc  {},path {},ctx {},name {}",rc,path,ctx,name),"context");
    TimeUnit.SECONDS.sleep(Integer.MAX_VALUE);
}

修改节点数据:

@Test
public void setTest() throws KeeperException, InterruptedException {

    Stat stat = new Stat();
    byte[] data = zooKeeper.getData(ZK_NODE, false, stat);
    log.info("修改前: {}",new String(data));
    zooKeeper.setData(ZK_NODE, "changed!".getBytes(), stat.getVersion());
    byte[] dataAfter = zooKeeper.getData(ZK_NODE, false, stat);
    log.info("修改后: {}",new String(dataAfter));
}

1.2 Curator开源客户端使用

Curator是Netflix公司开源的一套ZooKeeper客户端框架，和ZkClient一样它解决了非常底层的细节开发工作，包括连接、重连、反复注册Watcher的问题以及NodeExistsException异常等。

Curator是Apache基金会的顶级项目之一，Curator具有更加完善的文档，另外还提供了一套易用性和可读性更强的Fluent风格的客户端API框架。

Curator还为ZooKeeper客户端框架提供了一些比较普遍的、开箱即用的、分布式开发用的解决方案，例如Recipe、共享锁服务、Master选举机制和分布式计算器等，帮助开发者避免了“重复造轮子”的无效开发工作。

Guava is to Java that Curator to ZooKeeper

在实际的开发场景中，使用Curator客户端就足以应付日常的ZooKeeper集群操作的需求。

官网：Welcome to Apache Curator | Apache Curator

引入依赖

Curator 包含了几个包：

curator-framework是对ZooKeeper的底层API的一些封装。
curator-client提供了一些客户端的操作，例如重试策略等。
curator-recipes封装了一些高级特性，如：Cache事件监听、选举、分布式锁、分布式计数器、分布式Barrier等。

<!-- zookeeper client -->
<dependency>
  <groupId>org.apache.zookeeper</groupId>
  <artifactId>zookeeper</artifactId>
  <version>3.8.0</version>
</dependency>

<!--curator-->
<dependency>
  <groupId>org.apache.curator</groupId>
  <artifactId>curator-recipes</artifactId>
  <version>5.1.0</version>
  <exclusions>
    <exclusion>
      <groupId>org.apache.zookeeper</groupId>
      <artifactId>zookeeper</artifactId>
    </exclusion>
  </exclusions>
</dependency>

示例代码：

public class CuratorDemo {
    // ZooKeeper集群连接字符串，包括多个ZooKeeper服务器的地址和端口
    //private final static  String CLUSTER_CONNECT_STR="192.168.65.163:2181,192.168.65.184:2181,192.168.65.186:2181";
    private final static  String CLUSTER_CONNECT_STR="192.168.189.131";

    public static void main(String[] args) throws Exception {
        //构建客户端实例
        CuratorFramework curatorFramework= CuratorFrameworkFactory.builder()
                .connectString(CLUSTER_CONNECT_STR)
                .retryPolicy(new ExponentialBackoffRetry(1000,3)) // 设置重试策略
                .build();
        //启动客户端
        curatorFramework.start();

        String path = "/user";

        // 检查节点是否存在
        Stat stat = curatorFramework.checkExists().forPath(path);
        if (stat != null) {
            // 删除节点
            curatorFramework.delete()
                    .deletingChildrenIfNeeded()  // 如果存在子节点，则删除所有子节点
                    .forPath(path);  // 删除指定节点
        }
        // 创建节点
        curatorFramework.create()
                .creatingParentsIfNeeded()  // 如果父节点不存在，则创建父节点
                .withMode(CreateMode.PERSISTENT)
                .forPath(path, "Init Data".getBytes());

        // 注册节点监听
        curatorFramework.getData()
                .usingWatcher(new CuratorWatcher() {
                    @Override
                    public void process(WatchedEvent event) throws Exception {
                        byte[] bytes = curatorFramework.getData().forPath(path);
                        System.out.println("Node data changed: " + new String(bytes));
                    }
                })
                .forPath(path);

        // 更新节点数据    set /user  Update Data
        curatorFramework.setData()
                .forPath(path, "Update Data".getBytes());

       stat=new Stat();
        //查询节点数据
        byte[] bytes = curatorFramework.getData().storingStatIn(stat)
                .forPath("/user");
        System.out.println(new String(bytes));

        ExecutorService executorService = Executors.newSingleThreadExecutor();
        //异步处理，可以指定线程池
        curatorFramework.getData().inBackground((item1, item2) -> {
            System.out.println("background:"+item1+" <---> "+item2);
            System.out.println("item2.getStat()=> " + item2.getStat());
        },executorService).forPath(path);

        // 创建节点缓存,用于监听指定节点的变化
        final NodeCache nodeCache = new NodeCache(curatorFramework, path);
        // 启动NodeCache并立即从服务端获取最新数据
        nodeCache.start(true);

        // 注册节点变化监听器
        nodeCache.getListenable().addListener(new NodeCacheListener() {
            @Override
            public void nodeChanged() throws Exception {
                byte[] newData = nodeCache.getCurrentData().getData();
                System.out.println("Node data changed: " + new String(newData));
            }
        });

        // 创建PathChildrenCache
        PathChildrenCache pathChildrenCache = new PathChildrenCache(curatorFramework, path, true);
        pathChildrenCache.start();

        // 注册子节点变化监听器
        pathChildrenCache.getListenable().addListener(new PathChildrenCacheListener() {
            @Override
            public void childEvent(CuratorFramework client, PathChildrenCacheEvent event) throws Exception {
                if (event.getType() == PathChildrenCacheEvent.Type.CHILD_ADDED) {
                    ChildData childData = event.getData();
                    System.out.println("Child added: " + childData.getPath());
                } else if (event.getType() == PathChildrenCacheEvent.Type.CHILD_REMOVED) {
                    ChildData childData = event.getData();
                    System.out.println("Child removed: " + childData.getPath());
                } else if (event.getType() == PathChildrenCacheEvent.Type.CHILD_UPDATED) {
                    ChildData childData = event.getData();
                    System.out.println("Child updated: " + childData.getPath());
                }
            }
        });

        Thread.sleep(Integer.MAX_VALUE);

    }
}

运行结果

.....
Node data changed: Update Data
Update Data
background:org.apache.curator.framework.imps.CuratorFrameworkImpl@3c5f290a <---> CuratorEventImpl{type=GET_DATA, resultCode=0, path='/user', name='null', children=null, context=null, stat=40,41,1696611808183,1696611808193,1,0,0,0,11,0,40
, data=[85, 112, 100, 97, 116, 101, 32, 68, 97, 116, 97], watchedEvent=null, aclList=null, opResults=null}
item2.getStat()=> 40,41,1696611808183,1696611808193,1,0,0,0,11,0,40

Child added: /user/bubble//修改子节点触发监听器的打印
Child removed: /user/bubble

创建一个客户端实例

在使用curator-framework包操作ZooKeeper前，首先要创建一个客户端实例。这是一个CuratorFramework类型的对象，有两种方法：

使用工厂类CuratorFrameworkFactory的静态newClient()方法。

// 重试策略 
RetryPolicy retryPolicy = new ExponentialBackoffRetry(1000, 3)
//创建客户端实例
CuratorFramework client = CuratorFrameworkFactory.newClient(zookeeperConnectionString, retryPolicy);
//启动客户端
client.start();

使用工厂类CuratorFrameworkFactory的静态builder构造者方法。

//随着重试次数增加重试时间间隔变大,指数倍增长baseSleepTimeMs * Math.max(1, random.nextInt(1 << (retryCount + 1)))
RetryPolicy retryPolicy = new ExponentialBackoffRetry(1000, 3);

CuratorFramework client = CuratorFrameworkFactory.builder()
                .connectString("192.168.128.129:2181")
                .sessionTimeoutMs(5000)  // 会话超时时间
                .connectionTimeoutMs(5000) // 连接超时时间
                .retryPolicy(retryPolicy)
                .namespace("base") // 包含隔离名称
                .build();
client.start();

connectionString：服务器地址列表，在指定服务器地址列表的时候可以是一个地址，也可以是多个地址。如果是多个地址，那么每个服务器地址列表用逗号分隔, 如 host1:port1,host2:port2,host3；port3 。
retryPolicy：重试策略，当客户端异常退出或者与服务端失去连接的时候，可以通过设置客户端重新连接 ZooKeeper 服务端。而 Curator 提供了一次重试、多次重试等不同种类的实现方式。在 Curator 内部，可以通过判断服务器返回的 keeperException 的状态代码来判断是否进行重试处理，如果返回的是 OK 表示一切操作都没有问题，而 SYSTEMERROR 表示系统或服务端错误。

策略名称

描述

ExponentialBackoffRetry

重试一组次数，重试之间的睡眠时间增加

RetryNTimes

重试最大次数

RetryOneTime

只重试一次

RetryUntilElapsed

在给定的时间结束之前重试

超时时间：Curator 客户端创建过程中，有两个超时时间的设置。一个是 sessionTimeoutMs 会话超时时间，用来设置该条会话在 ZooKeeper 服务端的失效时间。另一个是 connectionTimeoutMs 客户端创建会话的超时时间，用来限制客户端发起一个会话连接到接收 ZooKeeper 服务端应答的时间。sessionTimeoutMs 作用在服务端，而 connectionTimeoutMs 作用在客户端。

创建节点

创建节点的方式如下面的代码所示，回顾我们之前课程中讲到的内容，描述一个节点要包括节点的类型，即临时节点还是持久节点、节点的数据信息、节点是否是有序节点等属性和性质。

@Test
public void testCreate() throws Exception {
    String path = curatorFramework.create().forPath("/curator-node");
    curatorFramework.create().withMode(CreateMode.PERSISTENT).forPath("/curator-node","some-data".getBytes())
    log.info("curator create node :{}  successfully.",path);
}

在 Curator 中，可以使用 create 函数创建数据节点，并通过 withMode 函数指定节点类型（持久化节点，临时节点，顺序节点，临时顺序节点，持久化顺序节点等），默认是持久化节点，之后调用 forPath 函数来指定节点的路径和数据信息。

一次性创建带层级结构的节点

@Test
public void testCreateWithParent() throws Exception {
    String pathWithParent="/node-parent/sub-node-1";
    String path = curatorFramework.create().creatingParentsIfNeeded().forPath(pathWithParent);
    log.info("curator create node :{}  successfully.",path);
}

获取数据

@Test
public void testGetData() throws Exception {
    byte[] bytes = curatorFramework.getData().forPath("/curator-node");
    log.info("get data from  node :{}  successfully.",new String(bytes));
}

更新节点

我们通过客户端实例的 setData() 方法更新 ZooKeeper 服务上的数据节点，在setData 方法的后边，通过 forPath 函数来指定更新的数据节点路径以及要更新的数据。

@Test
public void testSetData() throws Exception {
    curatorFramework.setData().forPath("/curator-node","changed!".getBytes());
    byte[] bytes = curatorFramework.setData().forPath("/curator-node");
    log.info("get data from  node /curator-node :{}  successfully.",new String(bytes));
}

删除节点

@Test
public void testDelete() throws Exception {
    String pathWithParent="/node-parent";
    curatorFramework.delete().guaranteed().deletingChildrenIfNeeded().forPath(pathWithParent);
}

guaranteed：该函数的功能如字面意思一样，主要起到一个保障删除成功的作用，其底层工作方式是：只要该客户端的会话有效，就会在后台持续发起删除请求，直到该数据节点在 ZooKeeper 服务端被删除。

deletingChildrenIfNeeded：指定了该函数后，系统在删除该数据节点的时候会以递归的方式直接删除其子节点，以及子节点的子节点。

异步接口

Curator 引入了BackgroundCallback 接口，用来处理服务器端返回来的信息，这个处理过程是在异步线程中调用，默认在 **EventThread **中调用，也可以自定义线程池。

public interface BackgroundCallback
{
    /**
     * Called when the async background operation completes
     *
     * @param client the client
     * @param event operation result details
     * @throws Exception errors
     */
    public void processResult(CuratorFramework client, CuratorEvent event) throws Exception;
}

如上接口，主要参数为 client 客户端，和服务端事件 event。

inBackground 异步处理默认在EventThread中执行

@Test
public void test() throws Exception {
    curatorFramework.getData().inBackground((item1, item2) -> {
        log.info(" background: {}", item2);
    }).forPath(ZK_NODE);

    TimeUnit.SECONDS.sleep(Integer.MAX_VALUE);
}

指定线程池

@Test
public void test() throws Exception {
    ExecutorService executorService = Executors.newSingleThreadExecutor();
    
    curatorFramework.getData().inBackground((item1, item2) -> {
        log.info(" background: {}", item2);
    },executorService).forPath(ZK_NODE);

    TimeUnit.SECONDS.sleep(Integer.MAX_VALUE);
}

Curator 监听器

/**
 * Receives notifications about errors and background events
 */
public interface CuratorListener
{
    /**
     * Called when a background task has completed or a watch has triggered
     *
     * @param client client
     * @param event the event
     * @throws Exception any errors
     */
    public void eventReceived(CuratorFramework client, CuratorEvent event) throws Exception;
}

针对 background 通知和错误通知。使用此监听器之后，调用inBackground 方法会异步获得监听

Curator Caches

Curator 引入了 Cache 来实现对 Zookeeper 服务端事件监听，Cache 事件监听可以理解为一个本地缓存视图与远程 Zookeeper 视图的对比过程。Cache 提供了反复注册的功能。Cache 分为两类注册类型：节点监听和子节点监听。

node cache:

NodeCache 对某一个节点进行监听

public NodeCache(CuratorFramework client,
                         String path)
Parameters:
client - the client
path - path to cache

可以通过注册监听器来实现，对当前节点数据变化的处理

public void addListener(NodeCacheListener listener)
     Add a change listener
Parameters:
listener - the listener

@Slf4j
public class NodeCacheTest extends AbstractCuratorTest{

    public static final String NODE_CACHE="/node-cache";

    @Test
    public void testNodeCacheTest() throws Exception {

        createIfNeed(NODE_CACHE);
        NodeCache nodeCache = new NodeCache(curatorFramework, NODE_CACHE);
        nodeCache.getListenable().addListener(new NodeCacheListener() {
            @Override
            public void nodeChanged() throws Exception {
                log.info("{} path nodeChanged: ",NODE_CACHE);
                printNodeData();
            }
        });

        nodeCache.start();
    }

    public void printNodeData() throws Exception {
        byte[] bytes = curatorFramework.getData().forPath(NODE_CACHE);
        log.info("data: {}",new String(bytes));
    }
}

path cache:

PathChildrenCache 会对子节点进行监听，但是不会对二级子节点进行监听

public PathChildrenCache(CuratorFramework client,
                         String path,
                         boolean cacheData)
Parameters:
client - the client
path - path to watch
cacheData - if true, node contents are cached in addition to the stat

可以通过注册监听器来实现，对当前节点的子节点数据变化的处理

public void addListener(PathChildrenCacheListener listener)
     Add a change listener
Parameters:
listener - the listener

@Slf4j
public class PathCacheTest extends AbstractCuratorTest{

    public static final String PATH="/path-cache";

    @Test
    public void testPathCache() throws Exception {

        createIfNeed(PATH);
        PathChildrenCache pathChildrenCache = new PathChildrenCache(curatorFramework, PATH, true);
        pathChildrenCache.getListenable().addListener(new PathChildrenCacheListener() {
            @Override
            public void childEvent(CuratorFramework client, PathChildrenCacheEvent event) throws Exception {
                log.info("event:  {}",event);
            }
        });

        // 如果设置为true则在首次启动时就会缓存节点内容到Cache中
        pathChildrenCache.start(true);
    }
}

tree cache:

TreeCache 使用一个内部类TreeNode来维护这个一个树结构。并将这个树结构与ZK节点进行了映射。所以TreeCache 可以监听当前节点下所有节点的事件。

public TreeCache(CuratorFramework client,
                         String path,
                         boolean cacheData)
Parameters:
client - the client
path - path to watch
cacheData - if true, node contents are cached in addition to the stat

可以通过注册监听器来实现，对当前节点的子节点，及递归子节点数据变化的处理

public void addListener(TreeCacheListener listener)
     Add a change listener
Parameters:
listener - the listener

@Slf4j
public class TreeCacheTest extends CuratorBaseOperations {

    public static final String TREE_CACHE="/tree-path";

    @Test
    public void testTreeCache() throws Exception {
        CuratorFramework curatorFramework = getCuratorFramework();
        createIfNeed(TREE_CACHE);
        TreeCache treeCache = new TreeCache(curatorFramework, TREE_CACHE);
        treeCache.getListenable().addListener(new TreeCacheListener() {
            @Override
            public void childEvent(CuratorFramework client, TreeCacheEvent event) throws Exception {
                log.info(" tree cache: {}",event);

                Map<String, ChildData> currentChildren = treeCache.getCurrentChildren(TREE_CACHE);
                log.info("currentChildren: {}",currentChildren);
            }
        });
        treeCache.start();
    }
}

运行结果

2023-10-07 01:03:44.105 [main-EventThread] INFO  o.a.curator.framework.state.ConnectionStateManager --- State change: CONNECTED
2023-10-07 01:03:44.106 [Curator-ConnectionStateManager-0] INFO  com.bubble.zk_demo.curator.CuratorStandaloneBase --- 连接成功！
2023-10-07 01:03:44.113 [main-EventThread] INFO  org.apache.curator.framework.imps.EnsembleTracker --- New config event received: {}
2023-10-07 01:03:44.113 [main-EventThread] INFO  org.apache.curator.framework.imps.EnsembleTracker --- New config event received: {}
2023-10-07 01:03:44.119 [main] INFO  com.bubble.zk_demo.curator.CuratorStandaloneBase --- path /tree-path created! 
2023-10-07 01:03:44.133 [Curator-TreeCache-0] INFO  com.bubble.zk_demo.curator.cache.TreeCacheTest ---  tree cache: TreeCacheEvent{type=NODE_ADDED, data=ChildData{path='/tree-path', stat=117,117,1696615424405,1696615424405,0,0,0,0,13,0,117
, data=[49, 57, 50, 46, 49, 54, 56, 46, 49, 56, 57, 46, 49]}}
2023-10-07 01:03:44.134 [Curator-TreeCache-0] INFO  com.bubble.zk_demo.curator.cache.TreeCacheTest --- currentChildren: {}
2023-10-07 01:03:44.136 [Curator-TreeCache-0] INFO  com.bubble.zk_demo.curator.cache.TreeCacheTest ---  tree cache: TreeCacheEvent{type=INITIALIZED, data=null}
2023-10-07 01:03:44.136 [Curator-TreeCache-0] INFO  com.bubble.zk_demo.curator.cache.TreeCacheTest --- currentChildren: {}
//修改节点值触发的监听
2023-10-07 01:04:45.104 [Curator-TreeCache-0] INFO  com.bubble.zk_demo.curator.cache.TreeCacheTest ---  tree cache: TreeCacheEvent{type=NODE_UPDATED, data=ChildData{path='/tree-path', stat=117,118,1696615424405,1696615485384,1,0,0,0,13,0,117
, data=[49, 57, 50, 46, 49, 54, 56, 46, 49, 56, 57, 46, 50]}}
2023-10-07 01:04:45.104 [Curator-TreeCache-0] INFO  com.bubble.zk_demo.curator.cache.TreeCacheTest --- currentChildren: {}

2. Zookeeper在分布式命名服务中的实战

命名服务是为系统中的资源提供标识能力。ZooKeeper的命名服务主要是利用ZooKeeper节点的树形分层结构和子节点的顺序维护能力，来为分布式系统中的资源命名。

哪些应用场景需要用到分布式命名服务呢？典型的有：

分布式API目录
分布式节点命名
分布式ID生成器

2.1 分布式API目录

为分布式系统中各种API接口服务的名称、链接地址，提供类似JNDI（Java命名和目录接口）中的文件系统的功能。借助于ZooKeeper的树形分层结构就能提供分布式的API调用功能。

著名的Dubbo分布式框架就是应用了ZooKeeper的分布式的JNDI功能。在Dubbo中，使用ZooKeeper维护的全局服务接口API的地址列表。大致的思路为：

服务提供者（Service Provider）在启动的时候，向ZooKeeper上的指定节点/dubbo/${serviceName}/providers写入自己的API地址，这个操作就相当于服务的公开。
服务消费者（Consumer）启动的时候，订阅节点/dubbo/{serviceName}/providers下的服务提供者的URL地址，获得所有服务提供者的API。

2.2 分布式节点的命名

一个分布式系统通常会由很多的节点组成，节点的数量不是固定的，而是不断动态变化的。比如说，当业务不断膨胀和流量洪峰到来时，大量的节点可能会动态加入到集群中。而一旦流量洪峰过去了，就需要下线大量的节点。再比如说，由于机器或者网络的原因，一些节点会主动离开集群。

如何为大量的动态节点命名呢？

一种简单的办法是可以通过配置文件，手动为每一个节点命名。但是，如果节点数据量太大，或者说变动频繁，手动命名则是不现实的，这就需要用到分布式节点的命名服务。

可用于生成集群节点的编号的方案：

（1）使用数据库的自增ID特性，用数据表存储机器的MAC地址或者IP来维护。

（2）使用ZooKeeper持久顺序节点的顺序特性来维护节点的NodeId编号。

在第2种方案中，集群节点命名服务的基本流程是：

启动节点服务，连接ZooKeeper，检查命名服务根节点是否存在，如果不存在，就创建系统的根节点。
在根节点下创建一个临时顺序ZNode节点，取回ZNode的编号把它作为分布式系统中节点的NODEID。
如果临时节点太多，可以根据需要删除临时顺序ZNode节点。

2.3 分布式的ID生成器

在分布式系统中，分布式ID生成器的使用场景非常之多：

大量的数据记录，需要分布式ID。
大量的系统消息，需要分布式ID。
大量的请求日志，如restful的操作记录，需要唯一标识，以便进行后续的用户行为分析和调用链路分析。
分布式节点的命名服务，往往也需要分布式ID。
。。。

传统的数据库自增主键已经不能满足需求。在分布式系统环境中，迫切需要一种全新的唯一ID系统，这种系统需要满足以下需求：

（1）全局唯一：不能出现重复ID。

（2）高可用：ID生成系统是基础系统，被许多关键系统调用，一旦宕机，就会造成严重影响。

有哪些分布式的ID生成器方案呢？大致如下：

Java的UUID。（不推荐）
分布式缓存Redis生成ID：利用Redis的原子操作INCR和INCRBY，生成全局唯一的ID。
Twitter的SnowFlake算法。
ZooKeeper生成ID：利用ZooKeeper的顺序节点，生成全局唯一的ID。
MongoDb的ObjectId:MongoDB是一个分布式的非结构化NoSQL数据库，每插入一条记录会自动生成全局唯一的一个“_id”字段值，它是一个12字节的字符串，可以作为分布式系统中全局唯一的ID。

基于Zookeeper实现分布式ID生成器

在ZooKeeper节点的四种类型中，其中有以下两种类型具备自动编号的能力

PERSISTENT_SEQUENTIAL持久化顺序节点。
EPHEMERAL_SEQUENTIAL临时顺序节点。

ZooKeeper的每一个节点都会为它的第一级子节点维护一份顺序编号，会记录每个子节点创建的先后顺序，这个顺序编号是分布式同步的，也是全局唯一的。

可以通过创建ZooKeeper的临时顺序节点的方法，生成全局唯一的ID

@Slf4j
public class IDMaker extends CuratorBaseOperations {

    private String createSeqNode(String pathPefix) throws Exception {
        CuratorFramework curatorFramework = getCuratorFramework();
        //创建一个临时顺序节点
        String destPath = curatorFramework.create()
                .creatingParentsIfNeeded()
                .withMode(CreateMode.EPHEMERAL_SEQUENTIAL)
                .forPath(pathPefix);
        return destPath;
    }

    public String  makeId(String path) throws Exception {
        String str = createSeqNode(path);
        if(null != str){
            //获取末尾的序号
            int index = str.lastIndexOf(path);
            if(index>=0){
                index+=path.length();
                return index<=str.length() ? str.substring(index):"";
            }
        }
        return str;
    }
}

测试

@Slf4j
public class IDMakerTest {

    @Test
    public void testMarkId() throws Exception {
        IDMaker idMaker = new IDMaker();
        idMaker.init();
        String pathPrefix = "/idmarker/id-";
        //模拟5个线程创建id
        for(int i=0;i<5;i++){
            new Thread(()->{
                for (int j=0;j<10;j++){
                    String id = null;
                    try {
                        id = idMaker.makeId(pathPrefix);
                        log.info("线程{}第{}次创建id为{}",Thread.currentThread().getName(),
                                j,id);
                    } catch (Exception e) {
                        e.printStackTrace();
                    }
                }
            },"thread"+i).start();
        }

        Thread.sleep(Integer.MAX_VALUE);

    }
}

运行结果

........
2023-10-07 01:00:17.459 [main-EventThread] INFO  o.a.curator.framework.state.ConnectionStateManager --- State change: CONNECTED
2023-10-07 01:00:17.459 [Curator-ConnectionStateManager-0] INFO  com.bubble.zk_demo.curator.CuratorStandaloneBase --- 连接成功！
2023-10-07 01:00:17.468 [main-EventThread] INFO  org.apache.curator.framework.imps.EnsembleTracker --- New config event received: {}
2023-10-07 01:00:17.468 [main-EventThread] INFO  org.apache.curator.framework.imps.EnsembleTracker --- New config event received: {}
2023-10-07 01:00:17.478 [thread1] INFO  c.bubble.zk_demo.curator.namingserver.IDMakerTest --- 线程thread1第0次创建id为0000000001
2023-10-07 01:00:17.478 [thread0] INFO  c.bubble.zk_demo.curator.namingserver.IDMakerTest --- 线程thread0第0次创建id为0000000002
2023-10-07 01:00:17.478 [thread4] INFO  c.bubble.zk_demo.curator.namingserver.IDMakerTest --- 线程thread4第0次创建id为0000000000
2023-10-07 01:00:17.478 [thread2] INFO  c.bubble.zk_demo.curator.namingserver.IDMakerTest --- 线程thread2第0次创建id为0000000003
2023-10-07 01:00:17.478 [thread3] INFO  c.bubble.zk_demo.curator.namingserver.IDMakerTest --- 线程thread3第0次创建id为0000000004
2023-10-07 01:00:17.478 [thread1] INFO  c.bubble.zk_demo.curator.namingserver.IDMakerTest --- 线程thread1第1次创建id为0000000005
2023-10-07 01:00:17.478 [thread0] INFO  c.bubble.zk_demo.curator.namingserver.IDMakerTest --- 线程thread0第1次创建id为0000000006
2023-10-07 01:00:17.478 [thread4] INFO  c.bubble.zk_demo.curator.namingserver.IDMakerTest --- 线程thread4第1次创建id为0000000007
2023-10-07 01:00:17.478 [thread2] INFO  c.bubble.zk_demo.curator.namingserver.IDMakerTest --- 线程thread2第1次创建id为0000000008
2023-10-07 01:00:17.478 [thread3] INFO  c.bubble.zk_demo.curator.namingserver.IDMakerTest --- 线程thread3第1次创建id为0000000009
2023-10-07 01:00:17.478 [thread1] INFO  c.bubble.zk_demo.curator.namingserver.IDMakerTest --- 线程thread1第2次创建id为0000000010
2023-10-07 01:00:17.478 [thread0] INFO  c.bubble.zk_demo.curator.namingserver.IDMakerTest --- 线程thread0第2次创建id为0000000011
2023-10-07 01:00:17.478 [thread4] INFO  c.bubble.zk_demo.curator.namingserver.IDMakerTest --- 线程thread4第2次创建id为0000000012
2023-10-07 01:00:17.478 [thread2] INFO  c.bubble.zk_demo.curator.namingserver.IDMakerTest --- 线程thread2第2次创建id为0000000013
2023-10-07 01:00:17.478 [thread3] INFO  c.bubble.zk_demo.curator.namingserver.IDMakerTest --- 线程thread3第2次创建id为0000000014
2023-10-07 01:00:17.478 [thread0] INFO  c.bubble.zk_demo.curator.namingserver.IDMakerTest --- 线程thread0第3次创建id为0000000016
2023-10-07 01:00:17.478 [thread1] INFO  c.bubble.zk_demo.curator.namingserver.IDMakerTest --- 线程thread1第3次创建id为0000000015
2023-10-07 01:00:17.490 [thread4] INFO  c.bubble.zk_demo.curator.namingserver.IDMakerTest --- 线程thread4第3次创建id为0000000017
2023-10-07 01:00:17.490 [thread2] INFO  c.bubble.zk_demo.curator.namingserver.IDMakerTest --- 线程thread2第3次创建id为0000000018
2023-10-07 01:00:17.490 [thread3] INFO  c.bubble.zk_demo.curator.namingserver.IDMakerTest --- 线程thread3第3次创建id为0000000019
2023-10-07 01:00:17.490 [thread0] INFO  c.bubble.zk_demo.curator.namingserver.IDMakerTest --- 线程thread0第4次创建id为0000000020
2023-10-07 01:00:17.490 [thread1] INFO  c.bubble.zk_demo.curator.namingserver.IDMakerTest --- 线程thread1第4次创建id为0000000021
2023-10-07 01:00:17.490 [thread4] INFO  c.bubble.zk_demo.curator.namingserver.IDMakerTest --- 线程thread4第4次创建id为0000000023
2023-10-07 01:00:17.490 [thread2] INFO  c.bubble.zk_demo.curator.namingserver.IDMakerTest --- 线程thread2第4次创建id为0000000022
2023-10-07 01:00:17.490 [thread0] INFO  c.bubble.zk_demo.curator.namingserver.IDMakerTest --- 线程thread0第5次创建id为0000000025
2023-10-07 01:00:17.490 [thread3] INFO  c.bubble.zk_demo.curator.namingserver.IDMakerTest --- 线程thread3第4次创建id为0000000024
2023-10-07 01:00:17.490 [thread1] INFO  c.bubble.zk_demo.curator.namingserver.IDMakerTest --- 线程thread1第5次创建id为0000000026
2023-10-07 01:00:17.498 [thread4] INFO  c.bubble.zk_demo.curator.namingserver.IDMakerTest --- 线程thread4第5次创建id为0000000027
2023-10-07 01:00:17.498 [thread2] INFO  c.bubble.zk_demo.curator.namingserver.IDMakerTest --- 线程thread2第5次创建id为0000000028
2023-10-07 01:00:17.498 [thread0] INFO  c.bubble.zk_demo.curator.namingserver.IDMakerTest --- 线程thread0第6次创建id为0000000029
2023-10-07 01:00:17.498 [thread1] INFO  c.bubble.zk_demo.curator.namingserver.IDMakerTest --- 线程thread1第6次创建id为0000000030
2023-10-07 01:00:17.498 [thread3] INFO  c.bubble.zk_demo.curator.namingserver.IDMakerTest --- 线程thread3第5次创建id为0000000031
2023-10-07 01:00:17.498 [thread4] INFO  c.bubble.zk_demo.curator.namingserver.IDMakerTest --- 线程thread4第6次创建id为0000000032
2023-10-07 01:00:17.498 [thread2] INFO  c.bubble.zk_demo.curator.namingserver.IDMakerTest --- 线程thread2第6次创建id为0000000033
2023-10-07 01:00:17.498 [thread0] INFO  c.bubble.zk_demo.curator.namingserver.IDMakerTest --- 线程thread0第7次创建id为0000000034
2023-10-07 01:00:17.498 [thread1] INFO  c.bubble.zk_demo.curator.namingserver.IDMakerTest --- 线程thread1第7次创建id为0000000035
2023-10-07 01:00:17.498 [thread3] INFO  c.bubble.zk_demo.curator.namingserver.IDMakerTest --- 线程thread3第6次创建id为0000000036
2023-10-07 01:00:17.506 [thread4] INFO  c.bubble.zk_demo.curator.namingserver.IDMakerTest --- 线程thread4第7次创建id为0000000037
2023-10-07 01:00:17.506 [thread2] INFO  c.bubble.zk_demo.curator.namingserver.IDMakerTest --- 线程thread2第7次创建id为0000000038
2023-10-07 01:00:17.508 [thread0] INFO  c.bubble.zk_demo.curator.namingserver.IDMakerTest --- 线程thread0第8次创建id为0000000039
2023-10-07 01:00:17.508 [thread1] INFO  c.bubble.zk_demo.curator.namingserver.IDMakerTest --- 线程thread1第8次创建id为0000000040
2023-10-07 01:00:17.508 [thread3] INFO  c.bubble.zk_demo.curator.namingserver.IDMakerTest --- 线程thread3第7次创建id为0000000041
2023-10-07 01:00:17.508 [thread4] INFO  c.bubble.zk_demo.curator.namingserver.IDMakerTest --- 线程thread4第8次创建id为0000000042
2023-10-07 01:00:17.508 [thread2] INFO  c.bubble.zk_demo.curator.namingserver.IDMakerTest --- 线程thread2第8次创建id为0000000043
2023-10-07 01:00:17.508 [thread0] INFO  c.bubble.zk_demo.curator.namingserver.IDMakerTest --- 线程thread0第9次创建id为0000000044
2023-10-07 01:00:17.508 [thread1] INFO  c.bubble.zk_demo.curator.namingserver.IDMakerTest --- 线程thread1第9次创建id为0000000045
2023-10-07 01:00:17.508 [thread3] INFO  c.bubble.zk_demo.curator.namingserver.IDMakerTest --- 线程thread3第8次创建id为0000000046
2023-10-07 01:00:17.508 [thread4] INFO  c.bubble.zk_demo.curator.namingserver.IDMakerTest --- 线程thread4第9次创建id为0000000047
2023-10-07 01:00:17.508 [thread2] INFO  c.bubble.zk_demo.curator.namingserver.IDMakerTest --- 线程thread2第9次创建id为0000000048
2023-10-07 01:00:17.518 [thread3] INFO  c.bubble.zk_demo.curator.namingserver.IDMakerTest --- 线程thread3第9次创建id为0000000049

基于Zookeeper实现SnowFlakeID算法

Twitter（推特）的SnowFlake算法是一种著名的分布式服务器用户ID生成算法。SnowFlake算法所生成的ID是一个64bit的长整型数字，如图10-2所示。这个64bit被划分成四个部分，其中后面三个部分分别表示时间戳、工作机器ID、序列号。

SnowFlakeID的四个部分，具体介绍如下：

（1）第一位占用1 bit，其值始终是0，没有实际作用。

（2）时间戳占用41 bit，精确到毫秒，总共可以容纳约69年的时间。

（3）工作机器id占用10 bit，最多可以容纳1024个节点。

（4）序列号占用12 bit。这个值在同一毫秒同一节点上从0开始不断累加，最多可以累加到4095。

在工作节点达到1024顶配的场景下，SnowFlake算法在同一毫秒最多可以生成的ID数量为： 1024 * 4096 =4194304，在绝大多数并发场景下都是够用的。

SnowFlake算法的优点：

生成ID时不依赖于数据库，完全在内存生成，高性能和高可用性。
容量大，每秒可生成几百万个ID。
ID呈趋势递增，后续插入数据库的索引树时，性能较高。

SnowFlake算法的缺点：

依赖于系统时钟的一致性，如果某台机器的系统时钟回拨了，有可能造成ID冲突，或者ID乱序。
在启动之前，如果这台机器的系统时间回拨过，那么有可能出现ID重复的危险。

基于zookeeper实现雪花算法：

public class SnowflakeIdGenerator {

    /**
     * 单例
     */
    public static SnowflakeIdGenerator instance =
            new SnowflakeIdGenerator();

    /**
     * 初始化单例
     *
     * @param workerId 节点Id,最大8091
     * @return the 单例
     */
    public synchronized void init(long workerId) {
        if (workerId > MAX_WORKER_ID) {
            // zk分配的workerId过大
            throw new IllegalArgumentException("woker Id wrong: " + workerId);
        }
        instance.workerId = workerId;
    }

    private SnowflakeIdGenerator() {

    }

    /**
     * 开始使用该算法的时间为: 2017-01-01 00:00:00
     */
    private static final long START_TIME = 1483200000000L;

    /**
     * worker id 的bit数，最多支持8192个节点
     */
    private static final int WORKER_ID_BITS = 13;

    /**
     * 序列号，支持单节点最高每毫秒的最大ID数1024
     */
    private final static int SEQUENCE_BITS = 10;

    /**
     * 最大的 worker id ，8091
     * -1 的补码（二进制全1）右移13位, 然后取反
     */
    private final static long MAX_WORKER_ID = ~(-1L << WORKER_ID_BITS);

    /**
     * 最大的序列号，1023
     * -1 的补码（二进制全1）右移10位, 然后取反
     */
    private final static long MAX_SEQUENCE = ~(-1L << SEQUENCE_BITS);

    /**
     * worker 节点编号的移位
     */
    private final static long WORKER_ID_SHIFT = SEQUENCE_BITS;

    /**
     * 时间戳的移位
     */
    private final static long TIMESTAMP_LEFT_SHIFT = WORKER_ID_BITS + SEQUENCE_BITS;

    /**
     * 该项目的worker 节点 id
     */
    private long workerId;

    /**
     * 上次生成ID的时间戳
     */
    private long lastTimestamp = -1L;

    /**
     * 当前毫秒生成的序列
     */
    private long sequence = 0L;

    /**
     * Next id long.
     *
     * @return the nextId
     */
    public Long nextId() {
        return generateId();
    }

    /**
     * 生成唯一id的具体实现
     */
    private synchronized long generateId() {
        long current = System.currentTimeMillis();

        if (current < lastTimestamp) {
            // 如果当前时间小于上一次ID生成的时间戳，说明系统时钟回退过，出现问题返回-1
            return -1;
        }

        if (current == lastTimestamp) {
            // 如果当前生成id的时间还是上次的时间，那么对sequence序列号进行+1
            sequence = (sequence + 1) & MAX_SEQUENCE;

            if (sequence == MAX_SEQUENCE) {
                // 当前毫秒生成的序列数已经大于最大值，那么阻塞到下一个毫秒再获取新的时间戳
                current = this.nextMs(lastTimestamp);
            }
        } else {
            // 当前的时间戳已经是下一个毫秒
            sequence = 0L;
        }

        // 更新上次生成id的时间戳
        lastTimestamp = current;

        // 进行移位操作生成int64的唯一ID

        //时间戳右移动23位
        long time = (current - START_TIME) << TIMESTAMP_LEFT_SHIFT;

        //workerId 右移动10位
        long workerId = this.workerId << WORKER_ID_SHIFT;

        return time | workerId | sequence;
    }

    /**
     * 阻塞到下一个毫秒
     */
    private long nextMs(long timeStamp) {
        long current = System.currentTimeMillis();
        while (current <= timeStamp) {
            current = System.currentTimeMillis();
        }
        return current;
    }
}

测试

@Slf4j
public class SnowflakeIdTest {

    /**
     * The entry point of application.
     *
     * @param args the input arguments
     * @throws InterruptedException the interrupted exception
     */
    public static void main(String[] args) throws InterruptedException
    {
        //创建worker节点
        long workerId = SnowflakeIdWorker.instance.getId();
        SnowflakeIdGenerator.instance.init(workerId);
        ExecutorService threadPool = Executors.newFixedThreadPool(10);

        final HashSet idSet = new HashSet();
        Collections.synchronizedCollection(idSet);
        long start = System.currentTimeMillis();
        log.info(" start generate id *");
        int threadCount = 10;
        int turn = 50000;
        CountDownLatch countDownLatch = new CountDownLatch(threadCount);
        for (int i = 0; i < threadCount; i++)
            threadPool.execute(() ->
            {
                for (long j = 0; j < turn; j++)
                {
                    long id = SnowflakeIdGenerator.instance.nextId();
                    synchronized (idSet)
                    {
                        if (j % 10000 == 0)
                        {
                            log.info("线程{}生成第{}个 id 为:{}",
                                    Thread.currentThread().getName(),j,id);
                        }
                        idSet.add(id);
                    }
                }
                countDownLatch.countDown();
            });
        countDownLatch.await(50000, TimeUnit.MICROSECONDS);
        threadPool.shutdown();
        threadPool.awaitTermination(10, TimeUnit.SECONDS);
        long end = System.currentTimeMillis();
        log.info(" end generate id ");
        log.info("* cost " + (end - start) + " ms!");
    }
}

运行结果

2023-10-07 01:12:30.441 [main-EventThread] INFO  o.a.curator.framework.state.ConnectionStateManager --- State change: CONNECTED
2023-10-07 01:12:30.442 [Curator-ConnectionStateManager-0] INFO  com.bubble.zk_demo.curator.CuratorStandaloneBase --- 连接成功！
2023-10-07 01:12:30.448 [main-EventThread] INFO  org.apache.curator.framework.imps.EnsembleTracker --- New config event received: {}
2023-10-07 01:12:30.449 [main-EventThread] INFO  org.apache.curator.framework.imps.EnsembleTracker --- New config event received: {}
2023-10-07 01:12:30.474 [main] INFO  c.bubble.zk_demo.curator.namingserver.SnowflakeIdTest ---  start generate id *
2023-10-07 01:12:30.476 [pool-4-thread-1] INFO  c.bubble.zk_demo.curator.namingserver.SnowflakeIdTest --- 线程pool-4-thread-1生成第0个 id 为:1790262749490577408
2023-10-07 01:12:30.476 [pool-4-thread-3] INFO  c.bubble.zk_demo.curator.namingserver.SnowflakeIdTest --- 线程pool-4-thread-3生成第0个 id 为:1790262749490577410
2023-10-07 01:12:30.476 [pool-4-thread-6] INFO  c.bubble.zk_demo.curator.namingserver.SnowflakeIdTest --- 线程pool-4-thread-6生成第0个 id 为:1790262749490577412
2023-10-07 01:12:30.476 [pool-4-thread-4] INFO  c.bubble.zk_demo.curator.namingserver.SnowflakeIdTest --- 线程pool-4-thread-4生成第0个 id 为:1790262749490577453
2023-10-07 01:12:30.476 [pool-4-thread-2] INFO  c.bubble.zk_demo.curator.namingserver.SnowflakeIdTest --- 线程pool-4-thread-2生成第0个 id 为:1790262749490577409
2023-10-07 01:12:30.476 [pool-4-thread-8] INFO  c.bubble.zk_demo.curator.namingserver.SnowflakeIdTest --- 线程pool-4-thread-8生成第0个 id 为:1790262749490577477
2023-10-07 01:12:30.476 [pool-4-thread-5] INFO  c.bubble.zk_demo.curator.namingserver.SnowflakeIdTest --- 线程pool-4-thread-5生成第0个 id 为:1790262749490577468
2023-10-07 01:12:30.477 [pool-4-thread-7] INFO  c.bubble.zk_demo.curator.namingserver.SnowflakeIdTest --- 线程pool-4-thread-7生成第0个 id 为:1790262749490577416
2023-10-07 01:12:30.478 [pool-4-thread-10] INFO  c.bubble.zk_demo.curator.namingserver.SnowflakeIdTest --- 线程pool-4-thread-10生成第0个 id 为:1790262749490577482
2023-10-07 01:12:30.478 [pool-4-thread-9] INFO  c.bubble.zk_demo.curator.namingserver.SnowflakeIdTest --- 线程pool-4-thread-9生成第0个 id 为:1790262749490577481
2023-10-07 01:12:30.547 [pool-4-thread-6] INFO  c.bubble.zk_demo.curator.namingserver.SnowflakeIdTest --- 线程pool-4-thread-6生成第10000个 id 为:1790262750086168838
2023-10-07 01:12:30.556 [pool-4-thread-4] INFO  c.bubble.zk_demo.curator.namingserver.SnowflakeIdTest --- 线程pool-4-thread-4生成第10000个 id 为:1790262750161666780
2023-10-07 01:12:30.578 [pool-4-thread-7] INFO  c.bubble.zk_demo.curator.namingserver.SnowflakeIdTest --- 线程pool-4-thread-7生成第10000个 id 为:1790262750346216432
2023-10-07 01:12:30.594 [pool-4-thread-2] INFO  c.bubble.zk_demo.curator.namingserver.SnowflakeIdTest --- 线程pool-4-thread-2生成第10000个 id 为:1790262750480433418
2023-10-07 01:12:30.597 [pool-4-thread-8] INFO  c.bubble.zk_demo.curator.namingserver.SnowflakeIdTest --- 线程pool-4-thread-8生成第10000个 id 为:1790262750505599648
2023-10-07 01:12:30.608 [pool-4-thread-8] INFO  c.bubble.zk_demo.curator.namingserver.SnowflakeIdTest --- 线程pool-4-thread-8生成第20000个 id 为:1790262750597874351
2023-10-07 01:12:30.633 [pool-4-thread-6] INFO  c.bubble.zk_demo.curator.namingserver.SnowflakeIdTest --- 线程pool-4-thread-6生成第20000个 id 为:1790262750807589505
2023-10-07 01:12:30.649 [pool-4-thread-4] INFO  c.bubble.zk_demo.curator.namingserver.SnowflakeIdTest --- 线程pool-4-thread-4生成第20000个 id 为:1790262750941807275
2023-10-07 01:12:30.666 [pool-4-thread-9] INFO  c.bubble.zk_demo.curator.namingserver.SnowflakeIdTest --- 线程pool-4-thread-9生成第10000个 id 为:1790262751084413200
2023-10-07 01:12:30.670 [pool-4-thread-1] INFO  c.bubble.zk_demo.curator.namingserver.SnowflakeIdTest --- 线程pool-4-thread-1生成第10000个 id 为:1790262751117967610
2023-10-07 01:12:30.683 [pool-4-thread-3] INFO  c.bubble.zk_demo.curator.namingserver.SnowflakeIdTest --- 线程pool-4-thread-3生成第10000个 id 为:1790262751227020199
2023-10-07 01:12:30.687 [pool-4-thread-2] INFO  c.bubble.zk_demo.curator.namingserver.SnowflakeIdTest --- 线程pool-4-thread-2生成第20000个 id 为:1790262751260574361
2023-10-07 01:12:30.694 [pool-4-thread-10] INFO  c.bubble.zk_demo.curator.namingserver.SnowflakeIdTest --- 线程pool-4-thread-10生成第10000个 id 为:1790262751319293986
2023-10-07 01:12:30.699 [pool-4-thread-5] INFO  c.bubble.zk_demo.curator.namingserver.SnowflakeIdTest --- 线程pool-4-thread-5生成第10000个 id 为:1790262751361237527
2023-10-07 01:12:30.699 [pool-4-thread-8] INFO  c.bubble.zk_demo.curator.namingserver.SnowflakeIdTest --- 线程pool-4-thread-8生成第30000个 id 为:1790262751361237589
2023-10-07 01:12:30.720 [pool-4-thread-4] INFO  c.bubble.zk_demo.curator.namingserver.SnowflakeIdTest --- 线程pool-4-thread-4生成第30000个 id 为:1790262751537398236
2023-10-07 01:12:30.738 [pool-4-thread-6] INFO  c.bubble.zk_demo.curator.namingserver.SnowflakeIdTest --- 线程pool-4-thread-6生成第30000个 id 为:1790262751688393287
2023-10-07 01:12:30.751 [pool-4-thread-7] INFO  c.bubble.zk_demo.curator.namingserver.SnowflakeIdTest --- 线程pool-4-thread-7生成第20000个 id 为:1790262751797445477
2023-10-07 01:12:30.758 [pool-4-thread-2] INFO  c.bubble.zk_demo.curator.namingserver.SnowflakeIdTest --- 线程pool-4-thread-2生成第30000个 id 为:1790262751856165768
2023-10-07 01:12:30.765 [pool-4-thread-1] INFO  c.bubble.zk_demo.curator.namingserver.SnowflakeIdTest --- 线程pool-4-thread-1生成第20000个 id 为:1790262751914885757
2023-10-07 01:12:30.768 [pool-4-thread-3] INFO  c.bubble.zk_demo.curator.namingserver.SnowflakeIdTest --- 线程pool-4-thread-3生成第20000个 id 为:1790262751940051228
2023-10-07 01:12:30.775 [pool-4-thread-9] INFO  c.bubble.zk_demo.curator.namingserver.SnowflakeIdTest --- 线程pool-4-thread-9生成第20000个 id 为:1790262751998772139
2023-10-07 01:12:30.788 [pool-4-thread-10] INFO  c.bubble.zk_demo.curator.namingserver.SnowflakeIdTest --- 线程pool-4-thread-10生成第20000个 id 为:1790262752107823274
2023-10-07 01:12:30.810 [pool-4-thread-4] INFO  c.bubble.zk_demo.curator.namingserver.SnowflakeIdTest --- 线程pool-4-thread-4生成第40000个 id 为:1790262752292372664
2023-10-07 01:12:30.814 [pool-4-thread-3] INFO  c.bubble.zk_demo.curator.namingserver.SnowflakeIdTest --- 线程pool-4-thread-3生成第30000个 id 为:1790262752325927641
2023-10-07 01:12:30.824 [pool-4-thread-3] INFO  c.bubble.zk_demo.curator.namingserver.SnowflakeIdTest --- 线程pool-4-thread-3生成第40000个 id 为:1790262752409813500
2023-10-07 01:12:30.832 [pool-4-thread-7] INFO  c.bubble.zk_demo.curator.namingserver.SnowflakeIdTest --- 线程pool-4-thread-7生成第30000个 id 为:1790262752476922621
2023-10-07 01:12:30.850 [pool-4-thread-2] INFO  c.bubble.zk_demo.curator.namingserver.SnowflakeIdTest --- 线程pool-4-thread-2生成第40000个 id 为:1790262752627916964
2023-10-07 01:12:30.858 [pool-4-thread-6] INFO  c.bubble.zk_demo.curator.namingserver.SnowflakeIdTest --- 线程pool-4-thread-6生成第40000个 id 为:1790262752695025715
2023-10-07 01:12:30.872 [pool-4-thread-9] INFO  c.bubble.zk_demo.curator.namingserver.SnowflakeIdTest --- 线程pool-4-thread-9生成第30000个 id 为:1790262752812466932
2023-10-07 01:12:30.885 [pool-4-thread-10] INFO  c.bubble.zk_demo.curator.namingserver.SnowflakeIdTest --- 线程pool-4-thread-10生成第30000个 id 为:1790262752921518631
2023-10-07 01:12:30.898 [pool-4-thread-8] INFO  c.bubble.zk_demo.curator.namingserver.SnowflakeIdTest --- 线程pool-4-thread-8生成第40000个 id 为:1790262753030570681
2023-10-07 01:12:30.906 [pool-4-thread-7] INFO  c.bubble.zk_demo.curator.namingserver.SnowflakeIdTest --- 线程pool-4-thread-7生成第40000个 id 为:1790262753097679390
2023-10-07 01:12:30.929 [pool-4-thread-1] INFO  c.bubble.zk_demo.curator.namingserver.SnowflakeIdTest --- 线程pool-4-thread-1生成第30000个 id 为:1790262753290617713
2023-10-07 01:12:30.959 [pool-4-thread-5] INFO  c.bubble.zk_demo.curator.namingserver.SnowflakeIdTest --- 线程pool-4-thread-5生成第20000个 id 为:1790262753542275827
2023-10-07 01:12:30.966 [pool-4-thread-1] INFO  c.bubble.zk_demo.curator.namingserver.SnowflakeIdTest --- 线程pool-4-thread-1生成第40000个 id 为:1790262753600996220
2023-10-07 01:12:30.972 [pool-4-thread-9] INFO  c.bubble.zk_demo.curator.namingserver.SnowflakeIdTest --- 线程pool-4-thread-9生成第40000个 id 为:1790262753651327184
2023-10-07 01:12:30.990 [pool-4-thread-10] INFO  c.bubble.zk_demo.curator.namingserver.SnowflakeIdTest --- 线程pool-4-thread-10生成第40000个 id 为:1790262753802322148
2023-10-07 01:12:31.017 [pool-4-thread-5] INFO  c.bubble.zk_demo.curator.namingserver.SnowflakeIdTest --- 线程pool-4-thread-5生成第30000个 id 为:1790262754028815348
2023-10-07 01:12:31.029 [pool-4-thread-5] INFO  c.bubble.zk_demo.curator.namingserver.SnowflakeIdTest --- 线程pool-4-thread-5生成第40000个 id 为:1790262754129478187
2023-10-07 01:12:31.040 [main] INFO  c.bubble.zk_demo.curator.namingserver.SnowflakeIdTest ---  end generate id 
2023-10-07 01:12:31.040 [main] INFO  c.bubble.zk_demo.curator.namingserver.SnowflakeIdTest --- * cost 566 ms!

Process finished with exit code 0

3. zookeeper实现分布式队列

常见的消息队列有:RabbitMQ，RocketMQ，Kafka等。Zookeeper作为一个分布式的小文件管理系统，同样能实现简单的队列功能。Zookeeper不适合大数据量存储，官方并不推荐作为队列使用，但由于实现简单，集群搭建较为便利，因此在一些吞吐量不高的小型系统中还是比较好用的。

3.1 设计思路

1.创建队列根节点：在Zookeeper中创建一个持久节点，用作队列的根节点。所有队列元素的节点将放在这个根节点下。

2.实现入队操作：当需要将一个元素添加到队列时，可以在队列的根节点下创建一个临时有序节点。节点的数据可以包含队列元素的信息。

3.实现出队操作：当需要从队列中取出一个元素时，可以执行以下操作：

获取根节点下的所有子节点。
找到具有最小序号的子节点。
获取该节点的数据。
删除该节点。
返回节点的数据。

/**
 * 入队
 * @param data
 * @throws Exception
 */
public void enqueue(String data) throws Exception {
    // 创建临时有序子节点
    zk.create(QUEUE_ROOT + "/queue-", data.getBytes(StandardCharsets.UTF_8),
            ZooDefs.Ids.OPEN_ACL_UNSAFE, CreateMode.EPHEMERAL_SEQUENTIAL);
}

/**
 * 出队
 * @return
 * @throws Exception
 */
public String dequeue() throws Exception {
    while (true) {
        List<String> children = zk.getChildren(QUEUE_ROOT, false);
        if (children.isEmpty()) {
            return null;
        }

        Collections.sort(children);

        for (String child : children) {
            String childPath = QUEUE_ROOT + "/" + child;
            try {
                byte[] data = zk.getData(childPath, false, null);
                zk.delete(childPath, -1);
                return new String(data, StandardCharsets.UTF_8);
            } catch (KeeperException.NoNodeException e) {
                // 节点已被其他消费者删除，尝试下一个节点
            }
        }
    }
}

3.2 使用Apache Curator实现分布式队列

Apache Curator是一个ZooKeeper客户端的封装库，提供了许多高级功能，包括分布式队列。

public class CuratorDistributedQueueDemo {
    private static final String QUEUE_ROOT = "/curator_distributed_queue";

    public static void main(String[] args) throws Exception {
        CuratorFramework client = CuratorFrameworkFactory.newClient("localhost:2181",
                new ExponentialBackoffRetry(1000, 3));
        client.start();

        // 定义队列序列化和反序列化
        QueueSerializer<String> serializer = new QueueSerializer<String>() {
            @Override
            public byte[] serialize(String item) {
                return item.getBytes();
            }

            @Override
            public String deserialize(byte[] bytes) {
                return new String(bytes);
            }
        };

        // 定义队列消费者
        QueueConsumer<String> consumer = new QueueConsumer<String>() {
            @Override
            public void consumeMessage(String message) throws Exception {
                System.out.println("消费消息: " + message);
            }

            @Override
            public void stateChanged(CuratorFramework curatorFramework, ConnectionState connectionState) {

            }
        };

        // 创建分布式队列
        DistributedQueue<String> queue = QueueBuilder.builder(client, consumer, serializer, QUEUE_ROOT)
                .buildQueue();
        queue.start();

        // 生产消息
        for (int i = 0; i < 5; i++) {
            String message = "Task-" + i;
            System.out.println("生产消息: " + message);
            queue.put(message);
            Thread.sleep(1000);
        }

        Thread.sleep(10000);
        queue.close();
        client.close();
    }
}

3.3 注意事项

使用Curator的DistributedQueue时，默认情况下不使用锁。当调用QueueBuilder的lockPath()方法并指定一个锁节点路径时，才会启用锁。如果不指定锁节点路径，那么队列操作可能会受到并发问题的影响。

在创建分布式队列时，指定一个锁节点路径可以帮助确保队列操作的原子性和顺序性。分布式环境中，多个消费者可能同时尝试消费队列中的消息。如果不使用锁来同步这些操作，可能会导致消息被多次处理或者处理顺序出现混乱。当然，并非所有场景都需要指定锁节点路径。如果您的应用场景允许消息被多次处理，或者处理顺序不是关键问题，那么可以不使用锁。这样可以提高队列操作的性能，因为不再需要等待获取锁。

// 创建分布式队列
QueueBuilder<String> builder = QueueBuilder.builder(client, consumer, serializer, "/order");
//指定了一个锁节点路径/orderlock,用于实现分布式锁，以保证队列操作的原子性和顺序性。
queue = builder.lockPath("/orderlock").buildQueue();
//启动队列,这时队列开始监听ZooKeeper中/order节点下的消息。
queue.start();

标签： zookeeper 服务器

本文转载自: https://blog.csdn.net/qq_45061342/article/details/141297942
版权归原作者 bubble小拾 所有，如有侵权，请联系我们删除。

Zookeeper应用场景实战一

1. Zookeeper Java客户端实战

1.1 Zookeeper 原生Java客户端使用

ZooKeeper常用构造器

示例代码：

Zookeeper主要方法

1.2 Curator开源客户端使用

引入依赖

示例代码：

创建一个客户端实例

创建节点

一次性创建带层级结构的节点

获取数据

更新节点

删除节点

异步接口

指定线程池

Curator 监听器

Curator Caches

2. Zookeeper在分布式命名服务中的实战

2.1 分布式API目录

2.2 分布式节点的命名

2.3 分布式的ID生成器

基于Zookeeper实现分布式ID生成器

基于Zookeeper实现SnowFlakeID算法

3. zookeeper实现分布式队列

3.1 设计思路

3.2 使用Apache Curator实现分布式队列

3.3 注意事项

发表评论

“Zookeeper应用场景实战一”的评论:

关于作者

overfit同步小助手

相关阅读

文章导航