zookeeper 提供了java api来进行node的创建、删除、数据的获取设置、子节点的状态的观察、权限的设置。并且zookeeper客户端提供了异步操作,并有监听机制,更为方便的提供对zookeeper数据的监听和维护,本文通过几个例子来进行java api的学习和使用。
依赖引入
java api要引入mvn依赖,这里采用3.4.8,如下所示:
<dependency>
<groupId>org.apache.zookeeper</groupId>
<artifactId>zookeeper</artifactId>
<version>3.4.8</version>
</dependency>
创建zookeeper会话
API
Zookeeper client提供了以下几个初始化函数,初始化函数是异步的,会立即返回,大多数情况下状态为CONNECTING
,当真正建立连接成功后会发送状态改变
事件给客户端。client得到这个通知才算是真正建立好连接。
public ZooKeeper(String connectString, int sessionTimeout, Watcher watcher)
public ZooKeeper(String connectString, int sessionTimeout, Watcher watcher,
boolean canBeReadOnly)
public ZooKeeper(String connectString, int sessionTimeout, Watcher watcher,
long sessionId, byte[] sessionPasswd)
public ZooKeeper(String connectString, int sessionTimeout, Watcher watcher,
long sessionId, byte[] sessionPasswd, boolean canBeReadOnly)
参数含义:
- connectString是zookeeper server的ip:port,可以有多个,之间用,分割: “127.0.0.1:3000,127.0.0.1:3001,127.0.0.1:3002”,客户端
- sessionTimeOut:会话超时时间,时间单位是毫秒,会话周期内进行心跳检查,如果一个会话周期内检测不到心跳,会话就失效。
- watcher: 事件监听器,有些api是异步的,会监听事件,当事件发生后发送给客户端,客户端通过实现改监听器来处理接收到的事件
- sessionId+sessionPasswd: 客户端连接后会生成一个sessionId和sessionPasswd,两个字段唯一确定一个会话,zookeeper可以根据这个sessionId+sessionPasswd来恢复一个会话 [#getSessionId] [#getSessionPasswd]
- canBeReadOnly: 表示当前会话是否支持
read-only
模式,默认情况下,zookeeper集群中一个机器如果和集群中过半的机器失去网络连接,那么这个机器不再接受客户端请求,但是某些情况下,这种情况我们仍然希望zk服务可以提供读服务,写服务肯定是无法提供的,这个就是zk的read-only
模式
实战
-
先创建一个基本的会话实例,然后利用该实例的sessionId和sessionPasswd进行恢复会话。
package com.example.zookeeper.javaapi; import org.apache.zookeeper.WatchedEvent; import org.apache.zookeeper.Watcher; import org.apache.zookeeper.ZooKeeper; import java.util.concurrent.CountDownLatch; public class ZookeeperConstructorExample implements Watcher { // 利用countDownLatch进行阻塞直到连接建立 private static CountDownLatch connectedSemaphore = new CountDownLatch(1); public static void main(String[] args) throws Exception { ZooKeeper zooKeeper = new ZooKeeper("localhost:2181", 5000, new ZookeeperConstructorExample()); System.out.println(zooKeeper.getState()); connectedSemaphore.await(); System.out.println("Zookeeper session establshed"); // 利用sessionId和sessionPasswd恢复连接 long sessionId = zooKeeper.getSessionId(); byte[] sessionPasswd = zooKeeper.getSessionPasswd(); zooKeeper = new ZooKeeper("localhost:2181", 5000, new ZookeeperConstructorExample(), 1L, "test".getBytes()); zooKeeper = new ZooKeeper("localhost:2181", 5000, new ZookeeperConstructorExample(), sessionId, sessionPasswd); Thread.sleep(Integer.MAX_VALUE); } @Override public void process(WatchedEvent watchedEvent) { System.out.println("Receive watched event: " + watchedEvent); if (Event.KeeperState.SyncConnected == watchedEvent.getState()) { connectedSemaphore.countDown(); } } }
-
运行结果
// 在客户端构造函数调用后立即返回,但是并未建立好连接 CONNECTING // 三次握手结束,连接建立 Receive watched event: WatchedEvent state:SyncConnected type:None path:null Zookeeper session establshed // 利用不合法的sessionId和sessionPasswd会得到会话过期的事件通知 Receive watched event: WatchedEvent state:Expired type:None path:null // 利用不合法的sessionId和sessionPasswd会进行会话重用 Receive watched event: WatchedEvent state:SyncConnected type:None path:null // 会话心跳 Receive watched event: WatchedEvent state:Disconnected type:None path:null Receive watched event: WatchedEvent state:SyncConnected type:None path:null
创建节点
API
提供了两个create方法,一个同步创建,一个异步创建,异步创建函数需要提供callback来对接口进行处理。
// 同步创建,等待直至创建完成
public String create(final String path, byte data[], List<ACL> acl,
CreateMode createMode)
// 异步创建,结果回调接口中处理
public void create(final String path, byte data[], List<ACL> acl,
CreateMode createMode, StringCallback cb, Object ctx)
参数解析:
- Path: 创建的路径
- data: 创建完成后的初始内容
- createMode: 节点类型,四种选择持久(PERSISTENG),持久顺序(PERSISTENT_SEQUENTIAL),临时(EMHEMERAL),临时顺序(EMHEMERAL_SEQUENTIAL)
- acl: 节点的acl策略
- cb: 异步回调接口,需要实现process方法
public void processResult(int rc, String path, Object ctx, String name)
- rc: 服务端响应码,0是调用成功,-4是连接断开,-110节点已存在,-112会话过期
- Path: create函数中的path
- ctx: create函数中的ctx
- Name: 实际在服务端创建的节点名
- ctx: 可以在回调函数中使用的一个对象
实战
-
先创建一个基本的会话实例,然后利用该实例进行同步&异步的创建节点
package com.example.zookeeper.javaapi; import org.apache.zookeeper.*; import java.util.concurrent.CountDownLatch; public class ZookeeperCreateNodeExample implements Watcher { // 利用countDownLatch进行阻塞直到连接建立 private static CountDownLatch connectedSemaphore = new<