ZooKeeper是一个分布式协调服务,在很多开源的分布式服务中都有使用!现在介绍一下ZK的基本API的使用

 

 ZK的主要特性:

  •  客户端如果对ZK的一个数据节点注册一个Watcher监听,那么当该数据节点的内容或子节点列表发生变更时zk服务器都会向所有订阅客户端发送变更通知
  • 对于在ZK上创建的临时节点,一旦客户端与服务器见的会话失败,那么该临时节点也会自动清除
  • ZK将会保证客户端无法重复创建一个已经存在的数据节点

基于zk的这两个特性可以解决很多分布式问题。

 

ZK作为一个分布式服务框架,主要用来解决分布式数据一致性问题,它提供了简单分布式元语,并且对多种语言提供了API,下面是介绍JAVA客户端API的使用。

 

     ZK提供的API接口一般有一个同步接口一个异步接口,使用方法基本相同。

 

  • 客户端可以通过创建一个org.apache.zookeeper.ZooKeeper的实例来连接服务器。主要的构造方法有:

  

ZooKeeper(String connectString,int sessionTimeout,Watcher watcher)
        ZooKeeper(String connectString,int sessionTimeout,Watcher watcher,boolean canReadOnly)
        ZooKeeper(String connectString,int sessionTimeout,Watcher watcher,long sessionId,byte[] sessionPasswd)
        ZooKeeper(String connectString,int sessionTimeout,Watcher watcher,long sessionId,byte[] sessionPasswd,boolean canReadOnly)
       connectString:值ZK服务器列表,如localhost:2181,127.0.0.1:2181

      sessionTimeout:指会话超时时间,以毫秒为单位的整数值;在一个会话周期内,zk客户端和服务器会通过心跳维持会话的有效性,在sessionTimeout时间内,如果连接断开,zk客户端会主动和服务器建立连接

     watcher:Watcher事件通知处理器

    canReadOnly:这是一个boolean值,用于标识当前会话是否支持“read-only”模式。默认情况下,在ZK集群中,一个机器如果和集群中的半数以及半数以上的机器失去连接,那么这个机器将不再处理客户端请求(读请求+写请求均不处理);但是有时候我们希望在发生此类故障时不影响读取请求的处理,这个就是zk的read-only 模式

    sessionId和sessionPasswd,分别代表会话Id和会话密钥。这连个参数可以唯一确定一个会话。

 

  • 创建节点常用的接口是

String create(final String path,byte[] data,List<ACL>acl,CreateModel createModel);
       String create(final String path,byte[] data,List<ACL> acl,CreateModel,StringCallback cb,Object ctx);
        如果节点已经存在则抛出一个NodeExistsException异常
  
 回调接口
    StringCallback{
    public void (int rc,String path,Object ctx,String name)
 }

    rc是result code 服务端响应结果码。客户端可以从这个结果码中识别出API的调用结果,常见的结果码有:

      0(OK),接口调用成功

      -4(ConnectionLoss),客户端和服务器连接断开

     -110(NodeExists) 节点已存在

    -112(SessionExpired)会话已过期

   path: 接口调用传入的数据节点的节点路径

   ctx: 接口调用传入的ctx参数

  name: 实际在服务器端创建的节点名

 

  • 删除节点常用的接口:

       void delete(final String path,int version);

       void delete(final String path,int version,VoidCallback cb,Object ctx);

     如果删除的节点不存在则会抛出一个NoNodeException,如果删除数据的版本号不正确则抛出一个BadVersionException

 

  • 获取子节点列表的接口:

     List<String> getChildren(final String path,Watcher watcher);

     List<String> getChildren(final String path,boolean watcher);

     void  getChildren(final String path,Watcher watcher,ChildrenCallback cb,Object ctx);

     void  getChildren(final String path,boolean watcher,ChildrenCallback cb,Object ctx);

     List<String> getChildren(final String path,Watcher watcher,Stat stat);

     List<String> getChildren(final String path,boolean watcher,Stat stat);

     void getChildren(final String path,Watcher watcher,Stat stat,ChildrenCallback cb,Object ctx);

     void getChildren(final String path,boolean watcher,Stat stat,ChildrenCallback cb,Object ctx);

 

  • 获取节点数据的接口

  byte[] getData(final String path,Watcher watcher,Stat stat);

  byte[] getData(final String path,boolean watcher,Stat stat);

   void getData(final String path,Watcher watcher,Stat stat,DataCallback cb,Object ctx);

   void getData(final String path,boolean watcher,Stat stat,DataCallback cb,Object ctx);

 

  • 更新数据的接口

     Stat  setData(final String path,byte[] data,int version);

    void setData(final String path,byte[] data,int version,StatCallback cb,Object ctx);

   如果数据的版本不一致则抛出一个BadVersionExcepion

 

    zk的数据版本是从0开始计数的。如果客户端传入的是-1,则表示zk服务器需要基于最新的数据进行更新。如果对zk的数据节点的更新操作没有原子性要求则可以使用-1.

 

  • 检测节点是否存在的接口

      Stat exists(final String path,Watcher watcher);

      Stat exists(final String path,boolean watcher);

     void exists(final String path, Watcher watcher,StatCallback cb,Object ctx);

     void exists(final String path,boolean watcher,StatCallback cb,Object ctx);

 

  • version 说明

      version参数用于指定节点数据的版本,表明本次更新操作是针对指定数据版本进行的。这是ZK对 CAS(Compare and Swap)的实现,只有数据的版本和预期的版本一致时才会更新数据,这样可以有效避免分布式环境下并发更新的问题。如果多个客户端并发更新,则只有一个可 以更新成功,其他的因为版本不一致则不会更新数据。zk中version和传统意义上的软件版本概念上有很大的不同,在ZK中,version表示的是对 节点数据内容,子节点列表或是ACL信息修改的次数。在一个节点数据创建完毕后,其viersion=0,表示当前节点数据自创建以后被修改0次,修改一 次版本的值增加1;使用-1表示使用基于最新版本进行修改,即每次都会执行更新!version强调的是变更次数,即使前后两次变更的内容的值没有发生变化,version的值依然会变更。

 

   在创建zk的客户端时在构造方法中默认设置一个Watcher,这个Watcher作为zk会话期间的默认watcher.同时zk也可以通过 getData, getChildren,exist三个接口向zk注册watcher.

 

Watcher是通知的处理器,WatchedEvent的属性有 KeeperState ,EventType



zookeeper怎么实现cp的 zookeeperapi_服务器



    1. public class
    2. final private
    3. final private
    4. private
    5.       
    6. /**
    7.      * Create a WatchedEvent with specified type, state and path
    8.      */
    9. public
    10. this.keeperState = keeperState;  
    11. this.eventType = eventType;  
    12. this.path = path;  
    13.     }



     WatchedEvent的KeeperStat和EventType对应关系

    KeeperState

    EventType

    触发条件

    备注

    SyncConnected

    None

    客户端与服务器成功建立会话

    会话是连接状态

    NodeCreated

    Watcher监听的节点创建成功

    NodeDeleted

    Watcher监听的节点被删除

    NodeDataChanged

    Watcher监听的节点数据内容发生变更

    NodeChildrenChanged

    Watcher监听的节点子列表发生变更

    Disconnected

    None

    客户端与服务器断开连接

     

    Expired

    None

    会话超时

     

    AuthFailed

    None

     

     

     

    •  Watcher特性说明

          一次性


               一旦watcher被触发,ZK都会从相应的存储中移除。因此在使用Watcher时需要谨记使用前一定要注册

         客户端串行执行

            客户端Watcher回调的过程是一个串行同步的过程,这是为了保证顺序。同时需要谨记千万不要因为一个Watcher的处理逻辑影响了整个客户端的Watcher回调

         轻量

            WatchedEvent是ZK整个Watcher通知机制的最小通知单元。从上文已经介绍了这个数据结构中只包含三部分:通知状态,事件类型,节点路径。也就是说,Watcher通知仅仅告诉客户端发生了什么事情,而不会说明事件的具体内容。

     



    zookeeper怎么实现cp的 zookeeperapi_服务器



      1. /**
      2.  *
      3.  * @author zhangwei_david
      4.  * @version $Id: ZKDemo.java, v 0.1 2015年5月2日 上午9:10:56 zhangwei_david Exp $
      5.  */
      6. public class
      7.   
      8. private static ZooKeeper authZK = null;  
      9.   
      10. private static String    path   = "/zk-demo";  
      11.   
      12. /**
      13.      *
      14.      * @param args
      15.      * @throws Exception
      16.      */
      17. public static void main(String[] args) throws
      18.         sync();  
      19. 300);  
      20.         createZKWithSessionIdAndSessionPasswd();  
      21.         authCreate();  
      22.     }  
      23.   
      24. /**
      25.      * 指定权限
      26.      *
      27.      * @throws Exception
      28.      */
      29. private static void authCreate() throws
      30. final CountDownLatch latch = new CountDownLatch(1);  
      31. new ZooKeeper("localhost:2181", 5000, new
      32.   
      33. public void
      34. "监听器,监听到的事件时:"
      35. if
      36. //如果客户端已经建立连接闭锁减一
      37. "建立连接");  
      38.                     latch.countDown();  
      39.                 }  
      40.             }  
      41.         });  
      42. // 等待连接建立
      43.         latch.await();  
      44. // 增加权限
      45. "digest", "foo:true".getBytes());  
      46. // 判断path 是否已经存在
      47. if (authZK.exists(path, true) == null) {  
      48. "init".getBytes(), Ids.CREATOR_ALL_ACL, CreateMode.PERSISTENT);  
      49.         }  
      50. "/auth", "test".getBytes(), Ids.CREATOR_ALL_ACL,  
      51.             CreateMode.EPHEMERAL);  
      52.         System.out.println(str);  
      53.   
      54.     }  
      55.   
      56. private static void createZKWithSessionIdAndSessionPasswd() throws
      57. // 初始化一个闭锁
      58. final CountDownLatch latch = new CountDownLatch(1);  
      59.   
      60. /**
      61.          * 创建一个ZooKeeper对象,localhost:2181是zk服务器的主机名和端口号
      62.          *  50000  sessionTimeout session超时时间
      63.          *  Watcher 默认的WatchedEvent事件处理器
      64.          */
      65. new ZooKeeper("localhost:2181", 50000, new
      66.   
      67. public void
      68. /**
      69.                  * 如果zk客户端和服务器已经建立连接,闭锁减一
      70.                  */
      71. if
      72.                     latch.countDown();  
      73.                 }  
      74.             }  
      75.         });  
      76. // 等待闭锁为0,即一直等待zk客户端和服务器建立连接
      77.         latch.await();  
      78.   
      79. // 通过sessionId,和sessionPasswd创建一个复用的ZK客户端
      80. new ZooKeeper(path, 50000, new
      81.   
      82. public void
      83.   
      84.             }  
      85.         }, originalZk.getSessionId(), originalZk.getSessionPasswd());  
      86.   
      87. "复用zk" + zkCopy + " original zk="
      88.   
      89.     }  
      90.   
      91. /**
      92.      *
      93.      *
      94.      * @return
      95.      * @throws Exception
      96.      */
      97. private static ZooKeeper sync() throws
      98. // 初始化一个闭锁
      99. final CountDownLatch latch = new CountDownLatch(1);  
      100.   
      101. /**
      102.          * 创建一个ZooKeeper对象,localhost:2181是zk服务器的主机名和端口号
      103.          *  50000  sessionTimeout session超时时间
      104.          *  Watcher 默认的WatchedEvent事件处理器
      105.          */
      106. new ZooKeeper("localhost:2181", 50000, new
      107.   
      108. public void
      109. "默认监听器,KeeperStat:" + event.getState() + ", EventType:"
      110. ", path:"
      111. /**
      112.                  * 如果zk客户端和服务器已经建立连接,闭锁减一
      113.                  */
      114. if
      115.                     latch.countDown();  
      116.                 }  
      117.             }  
      118.         });  
      119. // 等待闭锁为0,即一直等待zk客户端和服务器建立连接
      120.         latch.await();  
      121.   
      122. true, new
      123.   
      124. public void processResult(int rc, String path, Object ctx, byte[] data, Stat stat) {  
      125. "rc=" + rc + ",path=" + path + "data=" + data + " Stat="
      126. ", data=" + (data == null ? "null" : new
      127.             }  
      128. null);  
      129.   
      130. // 创建一个临时节点,非安全的权限
      131. "/linshi", "ephemeral".getBytes(), Ids.OPEN_ACL_UNSAFE,  
      132. new
      133.   
      134. public void processResult(int
      135. if (rc == 0) {  
      136. "成功创建一个临时节点");  
      137.                     }  
      138.                 }  
      139. null);  
      140.   
      141. // 更新path节点数据
      142. new Date().getTime()).getBytes(), -1, new
      143.   
      144. public void processResult(int
      145. if (rc == 0) {  
      146. "成功更新节点数据, rc=0, path=" + path + ", stat="
      147.                 }  
      148.             }  
      149. null);  
      150.   
      151. /**
      152.          * 如果该节点不存在则创建持久化的节点
      153.          * ZK的节点有三位,持久化节点(PERSISTENT),临时节点(EPHEMERAL),顺序节点(SEQUENTIAL)
      154.          * 具体的组合有 /**
      155. 
      156.         PERSISTENT,
      157.         //持久化序列节点
      158.         PERSISTENT_SEQUENTIAL,
      159. 
      160.         EPHEMERAL ,
      161.         //临时序列节点
      162.         EPHEMERAL_SEQUENTIAL
      163.          *
      164.          */
      165. // 创建一个持久化节点,如果该节点已经存在则不需要再次创建
      166. if (zk.exists(path, true) == null) {  
      167. "".getBytes(), Ids.OPEN_ACL_UNSAFE, CreateMode.PERSISTENT);  
      168.         }  
      169. // 删除持久化序列节点
      170. try
      171. "/seq ", 1, new
      172.   
      173. public void processResult(int
      174. "删除" + ZKDemo.path + "/seq 的结果是:rc=" + rc + " path="
      175. ",context="
      176.                 }  
      177. null);  
      178. catch
      179. // 示例代码创建新的持久节点前,如果以前存在则删除,如果不存在则或抛出一个NoNodeException
      180.         }  
      181. // 创建一个持久化序列节点
      182.         String seqPath = zk  
      183. "/seq ", null, Ids.OPEN_ACL_UNSAFE, CreateMode.PERSISTENT);  
      184. //读取子节点列表,并注册一个监听器
      185. new
      186.   
      187. public void
      188.                 System.out.println(event);  
      189.             }  
      190.         });  
      191. //更新节点数据
      192. "seqDemo".getBytes(), -1);  
      193.   
      194. //创建临时节点
      195. "/test", "test".getBytes(), Ids.OPEN_ACL_UNSAFE, CreateMode.EPHEMERAL);  
      196. // 删除节点
      197. "/test", 0);  
      198.   
      199. // 异步创建临时序列节点
      200. "/test", "123".getBytes(), Ids.OPEN_ACL_UNSAFE,  
      201. new
      202.   
      203. public void processResult(int
      204. "创建临时节点的结果是:result code=" + rc + ", path="
      205. " context=" + ctx + ", name="
      206.                 }  
      207. "Test Context");  
      208.   
      209. 5);  
      210.   
      211. // 更新数据
      212. if (zk.exists(path + "/test", true) != null) {  
      213. "/test", "testData".getBytes(), -1);  
      214.         }  
      215. "/test2", "123".getBytes(), Ids.OPEN_ACL_UNSAFE, CreateMode.EPHEMERAL);  
      216. // 使用默认监听器,获取子节点
      217. true);  
      218. // 获取所有节点下的数据
      219. new
      220. for
      221. byte[] data = zk.getData(path + "/" + str, true, stat);  
      222.   
      223. "获取节点:" + str + " 的数据是:"
      224. null ? "null" : new
      225.         }  
      226. return
      227.     }  
      228. }


      zookeeper怎么实现cp的 zookeeperapi_服务器



      1. 2015-06-26 07:37:29  [ main:0 ] - [ INFO ]  Initiating client connection, connectString=localhost:2181 sessionTimeout=50000 watcher=com.cathy.demo.zk.ZKDemo$4@8102c8
      2. 2015-06-26 07:37:29  [ main-SendThread(0:0:0:0:0:0:0:1:2181):32 ] - [ INFO ]  Opening socket connection to server 0:0:0:0:0:0:0:1/0:0:0:0:0:0:0:1:2181. Will not attempt to authenticate using SASL (unknown error)  
      3. 2015-06-26 07:37:29  [ main-SendThread(0:0:0:0:0:0:0:1:2181):32 ] - [ INFO ]  Socket connection established to 0:0:0:0:0:0:0:1/0:0:0:0:0:0:0:1:2181, initiating session  
      4. 2015-06-26 07:37:29  [ main-SendThread(0:0:0:0:0:0:0:1:2181):47 ] - [ INFO ]  Session establishment complete on server 0:0:0:0:0:0:0:1/0:0:0:0:0:0:0:1:2181, sessionid = 0x14e2ceda3d6000c, negotiated timeout = 40000
      5. 默认监听器,<span style="color: #ff0000;">KeeperStat:SyncConnected, EventType:None</span>, path:null
      6. rc=0,path=/zk-demodata=[B@dca3b1 Stat=128,1002,1430525410663,1435275420998,31,344,0,0,13,8,1008
      7. , data=1435275420998
      8. 默认监听器,<span style="color: #ff0000;">KeeperStat:SyncConnected, EventType:NodeDataChanged</span>, path:/zk-demo  
      9. 成功更新节点数据, rc=0, path=/zk-demo, stat=128,1012,1430525410663,1435275449577,32,344,0,0,13,8,1008
      10.   
      11. 删除/zk-demo/seq 的结果是:rc=0 path=/zk-demo/seq ,context=null
      12. WatchedEvent<span style="color: #ff0000;"> state:SyncConnected type:NodeChildrenChanged</span> path:/zk-demo  
      13. 创建临时节点的结果是:result code=0, path=/zk-demo/test context=Test Context, name=/zk-demo/test0000000178  
      14. 获取节点:test0000000175 的数据是:123
      15. 获取节点:curator 的数据是:192.168.1.102
      16. 获取节点:testData 的数据是:��