ZooKeeper

（1）ZooKeeper 介绍、安装和配置

zookeeper官网地址：https://zookeeper.apache.org。

安装和配置请自行百度。

（2）ZooKeeper 的简单示例

这里直接通过单元测试，来简单展示如果创建节点，监听节点状态改变，以及删除节点。

1、在 pom.xml 中添加依赖：

<!-- 整合zookeeper -->
<dependency>
    <groupId>org.apache.zookeeper</groupId>
    <artifactId>zookeeper</artifactId>
    <version>3.8.1</version>
</dependency>

2、编写单元测试代码：

package com.example.demo;

import org.apache.zookeeper.*;
import org.apache.zookeeper.data.ACL;
import org.apache.zookeeper.data.Stat;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.springframework.boot.test.context.SpringBootTest;

import java.io.IOException;
import java.util.ArrayList;
import java.util.List;
import java.util.Objects;

@SpringBootTest
class ZookeeperLockDemoApplicationTests {

    // 配置连接ZooKeeper服务端地址
    private final String connectString = "127.0.0.1:2181";

    // 过期时间默认3秒
    private final int sessionTimeout = 3000;

    // 定义ZooKeeper连接对象
    private ZooKeeper zooKeeper;

    /**
     * 初始化ZooKeeper连接对象
     */
    //@Test
    //@Before
    @BeforeEach
    public void contextLoads() {
        try {
            zooKeeper = new ZooKeeper(connectString, sessionTimeout, new Watcher() {
                @Override
                public void process(WatchedEvent event) {
                    // 监听并处理连接对象的状态改变事件
                    try {
                        // 获取所有子节点列表
                        List<String> children = zooKeeper.getChildren("/", true);
                        // 遍历输出各个子节点
                        children.forEach(node -> {
                            // 打印输出节点信息
                            System.out.println(node);
                        });
                    } catch (KeeperException e) {
                        e.printStackTrace();
                    } catch (InterruptedException e) {
                        e.printStackTrace();
                    }
                }
            });
        } catch (IOException e) {
            System.out.println("创建新的ZooKeeper连接失败！");
            e.printStackTrace();
        }
    }

    /**
     * 测试创建节点
     * <p>
     * 注意：如果节点已存在，则会报异常：org.apache.zookeeper.KeeperException$NodeExistsException: KeeperErrorCode = NodeExists for /testNode
     * 无法再创建新的同名子节点
     */
    @Test
    public void testCreateNode() throws KeeperException, InterruptedException {
        // 定义节点名称
        String nodeName = "/testNode";
        // 定义节点值，节点存储的数据
        byte[] nodeData = new String("测试的节点数据").getBytes();
        // 节点的权限
        ArrayList<ACL> openAclUnsafe = ZooDefs.Ids.OPEN_ACL_UNSAFE;
        // 节点的类型：持久有序、持久无序、临时有序、临时无序
        CreateMode persistent = CreateMode.PERSISTENT;
        zooKeeper.create(nodeName, nodeData, openAclUnsafe, persistent);
    }

    /**
     * 监听节点状态
     */
    @Test
    public void watchNodeStatus() {
        // 通过死循环持续监听zookeeper节点状态改变，节点状态改变的时候会执行初始化方法中定义的监听处理逻辑
        // 每一次节点的改变都会输出所有节点列表
        while (true) {
            try {
                System.out.println("正在监听节点状态 ...");
                Thread.sleep(3000);
            } catch (InterruptedException e) {
                e.printStackTrace();
            }
        }
    }

    /**
     * 判断节点是否已存在
     */
    @Test
    public void testNodeExist() throws KeeperException, InterruptedException {
        Stat exists = zooKeeper.exists("/testNode", false);
        // 如果不为空，表示节点已存在，会输出：/testNode 节点已存在
        System.out.println(Objects.nonNull(exists) ? "/testNode 节点已存在" : "/testNode 节点不存在");
    }

    /**
     * 测试删除节点
     */
    @Test
    public void testDeleteNode() throws KeeperException, InterruptedException {
        zooKeeper.delete("/testNode", 0);
    }
}

3、初始化zookeeper连接对象

在调用各个单元测试方法之前，我们需要先创建一个zookeeper连接对象，我是通过 @BeforeEach 注解在调用各个方法之前进行初始化，然后编写了监听节点状态更改需要执行的业务逻辑，如果状态改变（新增/修改/删除了节点），则执行如下代码打印输出当前的子节点列表：

@Override
public void process(WatchedEvent event) {
    // 监听并处理连接对象的状态改变事件
    try {
        // 获取所有子节点列表
        List<String> children = zooKeeper.getChildren("/", true);
        // 遍历输出各个子节点
        children.forEach(node -> {
        // 打印输出节点信息
        System.out.println(node);
        });
        } catch (KeeperException e) {
        e.printStackTrace();
        } catch (InterruptedException e) {
        e.printStackTrace();
    }
}

4、新建节点

执行 testCreateNode 方法创建子节点，我们可以在终端通过zookeeper客户端查看当前的子节点列表。

    /**
     * 测试创建节点
     * <p>
     * 注意：如果节点已存在，则会报异常：org.apache.zookeeper.KeeperException$NodeExistsException: KeeperErrorCode = NodeExists for /testNode
     * 无法再创建新的同名子节点
     */
    @Test
    public void testCreateNode() throws KeeperException, InterruptedException {
        // 定义节点名称
        String nodeName = "/testNode";
        // 定义节点值，节点存储的数据
        byte[] nodeData = new String("测试的节点数据").getBytes();
        // 节点的权限
        ArrayList<ACL> openAclUnsafe = ZooDefs.Ids.OPEN_ACL_UNSAFE;
        // 节点的类型：持久有序、持久无序、临时有序、临时无序
        CreateMode persistent = CreateMode.PERSISTENT;
        zooKeeper.create(nodeName, nodeData, openAclUnsafe, persistent);
    }

在终端使用命令：

# 进入客户端
zkCli.sh
# 查看当前/下面所有子节点
ls /

注意：如果存在同名节点，也就是节点已存在，再创建的时候就会报错。

5、监听节点状态改变

执行 watchNodeStatus 方法，通过死循环持续监听节点状态的改变，如果状态改变，就会自动执行初始化zookeeper连接对象中定义的监听业务逻辑。

    /**
     * 监听节点状态
     */
    @Test
    public void watchNodeStatus() {
        // 通过死循环持续监听zookeeper节点状态改变，节点状态改变的时候会执行初始化方法中定义的监听处理逻辑
        // 每一次节点的改变都会输出所有节点列表
        while (true) {
            try {
                System.out.println("正在监听节点状态 ...");
                Thread.sleep(3000);
            } catch (InterruptedException e) {
                e.printStackTrace();
            }
        }
    }

我们可以在终端下通过zookeeper客户端直接使用命令创建和删除节点，看看zookeeper会不会自动执行我们定义的监听业务逻辑代码，在终端执行如下命令：

# 创建节点
create /tempNode
# 删除节点
delete /tempNode

可以看到控制台输出的日志，分析日志我们可以看到我们定义的监听业务逻辑代码每次在节点状态更改之后都会自动执行。

6、判断节点是否存在

    /**
     * 判断节点是否已存在
     */
    @Test
    public void testNodeExist() throws KeeperException, InterruptedException {
        Stat exists = zooKeeper.exists("/testNode", false);
        // 如果不为空，表示节点已存在，会输出：/testNode 节点已存在
        System.out.println(Objects.nonNull(exists) ? "/testNode 节点已存在" : "/testNode 节点不存在");
    }

7、删除节点

    /**
     * 测试删除节点
     */
    @Test
    public void testDeleteNode() throws KeeperException, InterruptedException {
        zooKeeper.delete("/testNode", 0);
    }

执行完删除方法之后，我们可以到终端进入zookeeper客户端通过命令查看是否已删除，我这边看到是删除成功了。

还是使用命令：

ls /

OK！有关在springboot对zookeeper的简单操作示例就展示到此为止，更多用法请参考官网或其他博客。

参考：
基于Springboot整合zookeeper实现对节点的创建、监听与判断