08 Java客户端的 zookeeper 原生 API 增删改查

Love The Way You Lie 2023-01-08 10:30 112阅读 0赞

# Java客户端的 zookeeper 原生 API #

## 创建maven项目 准备连接zk服务器 ##

pom文件，基于jdk8和zk3.6.2版本

<?xml version="1.0" encoding="UTF-8"?>
    <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
        <modelVersion>4.0.0</modelVersion>
    
        <groupId>org.example</groupId>
        <artifactId>zookeeper</artifactId>
        <version>1.0-SNAPSHOT</version>
        <build>
            <plugins>
                <plugin>
                    <groupId>org.apache.maven.plugins</groupId>
                    <artifactId>maven-compiler-plugin</artifactId>
                    <configuration>
                        <source>8</source>
                        <target>8</target>
                    </configuration>
                </plugin>
            </plugins>
        </build>
    
        <properties>
            <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        </properties>
    
        <dependencies>
            <dependency>
                <groupId>junit</groupId>
                <artifactId>junit</artifactId>
                <version>4.11</version>
                <scope>test</scope>
            </dependency>
            <dependency>
                <groupId>org.apache.zookeeper</groupId>
                <artifactId>zookeeper</artifactId>
                <version>3.6.2</version>
            </dependency>
        </dependencies>
    
    </project>

## 创建zk客户端 ##

<table> 
 <thead> 
  <tr> 
   <th>构造函数详解</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>ZooKeeper(String connectString, int sessionTimeout, Watcher watcher)</td> 
  </tr> 
  <tr> 
   <td>ZooKeeper(String connectString, int sessionTimeout, Watcher watcher, boolean canBeReadOnly)</td> 
  </tr> 
  <tr> 
   <td>ZooKeeper(String connectString, int sessionTimeout, Watcher watcher, boolean canBeReadOnly, HostProvider aHostProvider)</td> 
  </tr> 
  <tr> 
   <td>ZooKeeper(String connectString, int sessionTimeout, Watcher watcher, boolean canBeReadOnly, HostProvider aHostProvider, ZKClientConfig clientConfig)</td> 
  </tr> 
  <tr> 
   <td>ZooKeeper(String connectString, int sessionTimeout, Watcher watcher, boolean canBeReadOnly, ZKClientConfig conf)</td> 
  </tr> 
  <tr> 
   <td>ZooKeeper(String connectString, int sessionTimeout, Watcher watcher, long sessionId, byte[] sessionPasswd)</td> 
  </tr> 
  <tr> 
   <td>ZooKeeper(String connectString, int sessionTimeout, Watcher watcher, long sessionId, byte[] sessionPasswd, boolean canBeReadOnly)</td> 
  </tr> 
  <tr> 
   <td>ZooKeeper(String connectString, int sessionTimeout, Watcher watcher, long sessionId, byte[] sessionPasswd, boolean canBeReadOnly, HostProvider aHostProvider)</td> 
  </tr> 
  <tr> 
   <td>ZooKeeper(String connectString, int sessionTimeout, Watcher watcher, long sessionId, byte[] sessionPasswd, boolean canBeReadOnly, HostProvider aHostProvider, ZKClientConfig clientConfig)</td> 
  </tr> 
  <tr> 
   <td>ZooKeeper(String connectString, int sessionTimeout, Watcher watcher, ZKClientConfig conf)</td> 
  </tr> 
 </tbody> 
</table>

### 取参数最多的构造函数解释一下 ###

public ZooKeeper(String connectString,
                     int sessionTimeout,
                     Watcher watcher,
                     long sessionId,
                     byte[] sessionPasswd,
                     boolean canBeReadOnly,
                     HostProvider aHostProvider,
                     ZKClientConfig clientConfig)
              throws IOException

*  为了创建ZooKeeper客户端对象，应用程序需要传递一个连接字符串，其中包含以逗号分隔的host:port对列表，每个对对应一个ZooKeeper服务器。
 *  会话建立是异步的。这个构造函数将发起到服务器的连接并立即返回—可能(通常)在会话完全建立之前返回。watcher参数指定将在状态发生任何更改时通知的监视程序。此通知可以在构造函数调用返回之前或之后的任何时间点出现。
 *  实例化的ZooKeeper客户端对象将从connectString中选择任意一个服务器并尝试连接到它。如果连接建立失败，将尝试连接字符串中的另一个服务器(顺序是不确定的，因为我们随机打乱列表)，直到连接建立。客户端将继续尝试，直到会话被显式关闭(或者会话被服务器过期)。
 *  在3.2.0中增加了:一个可选的“chroot”后缀也可以被附加到连接字符串中。这将运行客户端命令，同时解释与此根相关的所有路径(类似于unix的chroot命令)。
 *  在已建立的客户端连接上使用getessionid()和getessionpasswd()，如果重新连接，这些值必须分别作为sessionId和sessionPasswd传递。否则，如果没有重新连接，则使用不需要这些参数的另一个构造函数。
 *  为了向后兼容，还有另一个版本的ZooKeeper(String, int, Watcher, long, byte\[\]， boolean)使用默认的StaticHostProvider
 *  实例化的ZooKeeper客户端对象将从connectString中选择任意一个服务器并尝试连接到它。如果连接建立失败，将尝试连接字符串中的另一个服务器(顺序是不确定的，因为我们随机打乱列表)，直到连接建立。客户端将继续尝试，直到会话被显式关闭。
 *  在3.2.0中增加了:一个可选的“chroot”后缀也可以被附加到连接字符串中。这将运行客户端命令，同时解释与此根相关的所有路径(类似于unix的chroot命令)。

### 入参详解 ###

<table> 
 <thead> 
  <tr> 
   <th>入参</th> 
   <th>含义</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>connectString</td> 
   <td>逗号分隔的主机:端口对，每个对应一个zk服务器。举例 static final String CONNECT_ADDR = “192.168.31.207:2181,192.168.31.244:2181,192.168.31.212:2181”;</td> 
  </tr> 
  <tr> 
   <td>sessionTimeout</td> 
   <td>会话超时(毫秒)</td> 
  </tr> 
  <tr> 
   <td>watcher</td> 
   <td>将被通知状态变化的观察者对象，也可能被通知节点事件。</td> 
  </tr> 
  <tr> 
   <td>sessionId</td> 
   <td>重新连接时要使用的特定会话id</td> 
  </tr> 
  <tr> 
   <td>sessionPasswd</td> 
   <td>此会话的密码</td> 
  </tr> 
  <tr> 
   <td>canBeReadOnly</td> 
   <td>(在3.4中增加)创建的客户端在分区时是否允许进入只读模式。只读模式基本上意味着，如果客户端找不到任何多数服务器，但它可以到达分区服务器，它就会以只读模式连接到一个分区服务器，也就是说，允许读请求，而不允许写请求。</td> 
  </tr> 
  <tr> 
   <td>aHostProvider</td> 
   <td>使用它作为HostProvider来启用自定义行为</td> 
  </tr> 
  <tr> 
   <td>clientConfig</td> 
   <td>(在3.5.2中添加)通过传递这个conf对象，每个客户端可以灵活地配置与其他实例不同的属性</td> 
  </tr> 
 </tbody> 
</table>

## java zk API增删改查 ##

package learn.zk.base;
    
    import org.apache.zookeeper.CreateMode;
    import org.apache.zookeeper.Watcher.Event.EventType;
    import org.apache.zookeeper.Watcher.Event.KeeperState;
    import org.apache.zookeeper.ZooDefs;
    import org.apache.zookeeper.ZooKeeper;
    
    import java.io.IOException;
    import java.util.concurrent.CountDownLatch;
    
    /** * Zookeeper base学习笔记 * 2021-1-17 21:14:20 */
    public class ZookeeperBase { 
    
        /** * zookeeper地址 */
        static final String CONNECT_ADDR = "192.168.31.207:2181,192.168.31.244:2181,192.168.31.212:2181";
        /** * session超时时间 */
        static final int SESSION_OUT_TIME = 4000;//ms
        /** * 信号量，阻塞程序执行，用于等待zookeeper连接成功，发送成功信号 */
        static final CountDownLatch connectedSemaphore = new CountDownLatch(1);
    
        public static void main(String[] args) throws Exception { 
            ZooKeeper zk = getZKConnect();
    
            //进行阻塞
            connectedSemaphore.await();
    
            System.out.println(".....");
            //创建父节点
    		zk.create("/testRoot", "testRoot".getBytes(), ZooDefs.Ids.OPEN_ACL_UNSAFE, CreateMode.PERSISTENT);
    
            //创建子节点
    		zk.create("/testRoot/children", "children data".getBytes(), ZooDefs.Ids.OPEN_ACL_UNSAFE, CreateMode.PERSISTENT);
    
            //获取节点洗信息
    // byte[] data = zk.getData("/testRoot", false, null);
    // System.out.println(new String(data));
    // System.out.println(zk.getChildren("/testRoot", false));
    
            //修改节点的值
    // zk.setData("/testRoot", "modify data root".getBytes(), -1);
    // byte[] data = zk.getData("/testRoot", false, null);
    // System.out.println(new String(data)); 
    
            //判断节点是否存在
    // System.out.println(zk.exists("/testRoot/children", false));
            //删除节点
    // zk.delete("/testRoot/children", -1);
    // System.out.println(zk.exists("/testRoot/children", false));
    
            zk.close();
    
    
        }
    
        /** * @Author LingYi * @Description 获取zk连接 * @Date 21:27 2021/1/20 * @Return ZooKeeper **/
        public static ZooKeeper getZKConnect() throws IOException { 
    
            /** 两个创建zk的方法一样，建议使用 Lambda表达式 ZooKeeper zk = new ZooKeeper(CONNECT_ADDR, SESSION_OUT_TIME, new Watcher() { public void process(WatchedEvent event) { //获取事件的状态 KeeperState keeperState = event.getState(); EventType eventType = event.getType(); //如果是建立连接 if (KeeperState.SyncConnected == keeperState) { if (EventType.None == eventType) { //如果建立连接成功，则发送信号量，让后续阻塞程序向下执行 connectedSemaphore.countDown(); System.out.println("zk 建立连接"); } } } });*/
    
            return new ZooKeeper(CONNECT_ADDR, SESSION_OUT_TIME, (event) -> { 
                if (KeeperState.SyncConnected == event.getState() && EventType.None == event.getType()) { 
                    //如果建立连接成功，则发送信号量，让后续阻塞程序向下执行
                    connectedSemaphore.countDown();
                    System.out.println("zk 建立连接");
                }
    
            });
        }
    
    
    }

**创建节点成功**  
![在这里插入图片描述][20210120215312961.png]  
**查询节点**  
![在这里插入图片描述][20210120215452930.png]  
如果感兴趣就自己测试一下，更多API，请参考：https://zookeeper.apache.org/doc/current/apidocs/zookeeper-server/index.html

[20210120215312961.png]: /images/20221119/0c2d34f87a2748d9a299eb791d6a3cef.png
[20210120215452930.png]: /images/20221119/5c4bb3a71d9340838323d3c53896201c.png