zookeeper JAVA API 簡單操作

---

 

package org.admln.program.Zoo_Test;

import java.io.IOException;
import java.security.NoSuchAlgorithmException;
import java.util.ArrayList;
import java.util.List;

import org.apache.zookeeper.CreateMode;
import org.apache.zookeeper.WatchedEvent;
import org.apache.zookeeper.Watcher;
import org.apache.zookeeper.ZooDefs;
import org.apache.zookeeper.ZooDefs.Ids;
import org.apache.zookeeper.ZooKeeper;
import org.apache.zookeeper.data.ACL;
import org.apache.zookeeper.data.Id;
import org.apache.zookeeper.data.Stat;
import org.apache.zookeeper.server.auth.DigestAuthenticationProvider;
import org.junit.After;
import org.junit.Assert;
import org.junit.Before;
import org.junit.Test;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;


/**
 * Test Method {create/exists/delete/getChildren/setData/getData/addAuthInfo/setACL/getACL}
 * 
 * @author admln
 * @date 2015年5月12日 上午9:35:48
 */
public class ZooJavaApi {

    private static final int SESSION_TIMEOUT = 1000;
    
    public static final Logger LOGGER = LoggerFactory.getLogger(ZooJavaApi.class);
    
    public static final String HOST = "localhost:2181";
    
    private Watcher watcher = new Watcher() {
        public void process(WatchedEvent we) {
            LOGGER.info("process:" + we.getType());
        }
    };
    
    private ZooKeeper zookeeper;
    
    /*
     * 開啟服務器連接
     */
    @Before
    public void connect() throws IOException {
        zookeeper = new ZooKeeper(HOST, SESSION_TIMEOUT, watcher);
    }
    
    /*
     * 關閉服務器連接
     */
    @After
    public void close() {
        try {
            zookeeper.close();
        } catch (InterruptedException e) {
            e.printStackTrace();
        }
    }
    
    /*
     * 測試創建節點方法；
     * 調用zookeeper的 String create(final String path, byte data[], List<ACL> acl,CreateMode createMode)方法；
     * path 創建節點名；
     * data[] 節點的數據信息，字節數組類型；
     * acl 訪問權限，List數組類型；
     * createMode 節點持久化類型；
     * Assert.fail() 方法加在期望中不可能到達的地方，一旦到達，表明測試失敗，結果與預期不同
     */
    @Test
    public void testCreate() {
        String createNode = "/zk001";
        String createNodeData = "zk001Data";
        String result = null;
        try {
            result = zookeeper.create(createNode, createNodeData.getBytes(), Ids.OPEN_ACL_UNSAFE, CreateMode.PERSISTENT);
        } catch (Exception e) {
            LOGGER.error(e.getMessage());
            e.printStackTrace();
            Assert.fail();
        }
        System.out.println("成功創建了NODE：" + result);
    }
    
    /*
     * 測試刪除節點方法;
     * 調用zookeeper的delete(final String path, int version)方法;
     * path 節點名；
     * version 節點版本；
     * 版本為 -1 的話匹配所有版本
     */
    @Test
    public void testDelete() {
        String deleteNode = "/zk001";
        try {
            zookeeper.delete(deleteNode, -1);
        } catch (Exception e) {
            LOGGER.error(e.getMessage());
            e.printStackTrace();
            Assert.fail();  
        }
        System.out.println("成功刪除節點：" + deleteNode);
    }
    
    /*
     * 測試獲取節點數據方法；
     * 調用zookeeper的getData(final String path, Watcher watcher, Stat stat)方法;
     * path 節點名稱；
     * watcher 獲取節點信息時設置Watcher;
     * stat 數據的版本等信息可以通過 stat 來指定;
     */
    @Test
    public void testGetData() {
        String getDataNode = "/zk001";
        String result = null;
        try {
            byte[] bytes = zookeeper.getData(getDataNode, null, null);
            result = new String(bytes);
        } catch (Exception e) {
            LOGGER.error(e.getMessage());
            e.printStackTrace();
            Assert.fail();
        }
        System.out.println("獲取節點數據：" + result);
    }
    
    /*
     * 測試設置節點數據方法；
     * 調用zookeeper的setData(final String path, byte data[], int version)方法
     * path 節點名稱；
     * data[] 節點數據；
     * version 節點版本；
     * 版本設為-1則匹配所有版本;
     * 返回 Stat 類型實例，通過Stat可以獲取節點各種信息，例如版本
     */
    @Test
    public void testSetData() {
        String setDataNode = "/zk001";
        String setNodeData = "/zk001DataSetTest";
        Stat tempStat = null;
        try {
            tempStat = zookeeper.setData(setDataNode, setNodeData.getBytes(), -1);
            
        } catch (Exception e) {
            LOGGER.error(e.getMessage());
            e.printStackTrace();
            Assert.fail();
        }
        System.out.println("成功設置數據：" + setNodeData + "; 設置后的版本為：" + tempStat.getVersion());
    }
    
    /*
     * 測試判斷節點是否存在方法；
     * 調用zookeeper的exists(String path, boolean watch)方法；
     * path 節點名；
     * watch 是否監聽;
     * 返回Stat類型的實例，可以獲取各種信息;
     */
    @Test
    public void testExists() {
        String existsNode = "/zk001";
        Stat tempStat = null; 
        try {
            tempStat = zookeeper.exists(existsNode, false);
        } catch (Exception e) {
            LOGGER.error(e.getMessage());
            e.printStackTrace();
            Assert.fail();
        }
        System.out.println(tempStat.getCzxid() == 0 ? "節點是否存在:否":"節點是否存在:是");
    }
    
    /*
     * 測試獲取子節點方法;
     * 調用zookeeper的getChildren(String path, boolean watch)方法；
     * path 節點名稱；
     * watch 是否設置監聽;
     * 返回值為一個String類型的List;
     */
    @Test
    public void testGetChildren() {
        String parentNode = "/zk001";
        List<String> list = null; 
        try {
            list = zookeeper.getChildren(parentNode, false);
        } catch (Exception e) {
            LOGGER.error(e.getMessage());
            e.printStackTrace();
            Assert.fail();
        }
        if(list.isEmpty()) {
            System.out.println(parentNode + "無子節點");
        }else {
            System.out.print(parentNode + "的子節點有：");
            for(String str : list) {
                System.out.print(" " + str);
            }
        }
    }
    
    /*
     * 測試設置節點訪問權限方法；
     * 調用zookeeper的setACL(final String path, List<ACL> acl, int version)方法；
     * path 節點名稱；
     * acl 設置的權限信息；
     * version 設置權限的版本；
     * 返回Stat類型的屍體，可以查看節點信息；
     */
    @Test
    public void testSetAcl() {
        String aclNode = "/zk001/zk002";
        String scheme = "digest";
        String authInfo = "admln:admln";
        List<ACL> acls = new ArrayList<ACL>();
        try {
            Id id1 = new Id(scheme,DigestAuthenticationProvider.generateDigest(authInfo));
            ACL acl1 = new ACL(ZooDefs.Perms.ALL, id1);
            acls.add(acl1);
            Id id2 = new Id(scheme,DigestAuthenticationProvider.generateDigest("guest:guest"));
            ACL acl2 = new ACL(ZooDefs.Perms.READ, id2);
            acls.add(acl2);
        } catch (NoSuchAlgorithmException e) {
            e.printStackTrace();
        }
        try {
            zookeeper.setACL(aclNode, acls, -1);
        } catch (Exception e) {
            LOGGER.error(e.getMessage());
            e.printStackTrace();
            Assert.fail();
        }
        System.out.println("成功為" + aclNode + "添加了ACL,scheme為：" + scheme + ",驗證信息為：" + authInfo);
    }
    
    /*
     * 測試獲取節點權限信息方法；
     * 調用zookeeper的getACL(final String path, Stat stat)方法；
     * path 節點名稱;
     * stat 節點狀態信息；
     * 返回一個ACL列表;
     */
    @Test
    public void testGetAcl() {
        String getAclNode = "/zk001/zk002";
        List<ACL> list = null;
        try {
            list = zookeeper.getACL(getAclNode, new Stat());
        } catch (Exception e) {
            LOGGER.error(e.getMessage());
            e.printStackTrace();
            Assert.fail();
        }
        if(list.isEmpty()) {
            System.out.println(getAclNode + " 沒有ACL權限設置");
        }else {
            System.out.println(getAclNode + " 的ACL權限信息： ");
            for(ACL acl : list) {
                System.out.print("\t" + acl.toString());
            }
        }
    }
    /*
     * 測試權限驗證方法；
     * 調用zookeeper的addAuthInfo(String scheme, byte auth[])方法；
     * scheme 權限類型；
     * auth[] 權限信息；
     */
    @Test
    public void testAddAuthInfo() {
        String addAuthInfoNode = "/zk001/zk002";
        String scheme = "digest";
        String authInfo = "admln:admln";
        String result = null;
        try {
            byte[] bytes = zookeeper.getData(addAuthInfoNode, null, null);
            result = new String(bytes);
        } catch (Exception e) {
            System.out.println("沒有提供驗證信息前獲取節點信息：" + result + " ,返回錯誤信息：" + e.getMessage());
        }
        zookeeper.addAuthInfo(scheme, authInfo.getBytes());
        try {
            byte[] bytes = zookeeper.getData(addAuthInfoNode, null, null);
            result = new String(bytes);
        } catch (Exception e) {
            System.out.println("沒有提供驗證信息前獲取節點信息：" + result + " ,返回錯誤信息：" + e.getMessage());
        }
        System.out.println("提供驗證信息后獲取節點信息：" + result);
    }
}

 

---

方法簡介：

String create(String path, byte[] data, List<ACL> acl,CreateMode createMode)	創建一個給定的目錄節點 path, 並給它設置數據，CreateMode 標識有四種形式的目錄節點，分別是 PERSISTENT：持久化目錄節點，這個目錄節點存儲的數據不會丟失；PERSISTENT_SEQUENTIAL：順序自動編號的目錄節點，這種目錄節點會根據當前已近存在的節點數自動加 1，然后返回給客戶端已經成功創建的目錄節點名；EPHEMERAL：臨時目錄節點，一旦創建這個節點的客戶端與服務器端口也就是 session 超時，這種節點會被自動刪除；EPHEMERAL_SEQUENTIAL：臨時自動編號節點
Stat exists(String path, boolean watch)	判斷某個 path 是否存在，並設置是否監控這個目錄節點，這里的 watcher 是在創建 ZooKeeper 實例時指定的 watcher，exists方法還有一個重載方法，可以指定特定的watcher
Stat exists(String path,Watcher watcher)	重載方法，這里給某個目錄節點設置特定的 watcher，Watcher 在 ZooKeeper 是一個核心功能，Watcher 可以監控目錄節點的數據變化以及子目錄的變化，一旦這些狀態發生變化，服務器就會通知所有設置在這個目錄節點上的 Watcher，從而每個客戶端都很快知道它所關注的目錄節點的狀態發生變化，而做出相應的反應
void delete(String path, int version)	刪除 path 對應的目錄節點，version 為 -1 可以匹配任何版本，也就刪除了這個目錄節點所有數據
List<String>getChildren(String path, boolean watch)	獲取指定 path 下的所有子目錄節點，同樣 getChildren方法也有一個重載方法可以設置特定的 watcher 監控子節點的狀態
Stat setData(String path, byte[] data, int version)	給 path 設置數據，可以指定這個數據的版本號，如果 version 為 -1 怎可以匹配任何版本
byte[] getData(String path, boolean watch, Stat stat)	獲取這個 path 對應的目錄節點存儲的數據，數據的版本等信息可以通過 stat 來指定，同時還可以設置是否監控這個目錄節點數據的狀態
voidaddAuthInfo(String scheme, byte[] auth)	客戶端將自己的授權信息提交給服務器，服務器將根據這個授權信息驗證客戶端的訪問權限。
Stat setACL(String path,List<ACL> acl, int version)	給某個目錄節點重新設置訪問權限，需要注意的是 Zookeeper 中的目錄節點權限不具有傳遞性，父目錄節點的權限不能傳遞給子目錄節點。目錄節點 ACL 由兩部分組成：perms 和 id。 Perms 有 ALL、READ、WRITE、CREATE、DELETE、ADMIN 幾種  而 id 標識了訪問目錄節點的身份列表，默認情況下有以下兩種： ANYONE_ID_UNSAFE = new Id("world", "anyone") 和 AUTH_IDS = new Id("auth", "") 分別表示任何人都可以訪問和創建者擁有訪問權限。
List<ACL>getACL(String path,Stat stat)	獲取某個目錄節點的訪問權限列表

部分內容參考自：

http://www.cnblogs.com/ggjucheng/p/3370359.html

http://jm-blog.aliapp.com/?p=947

---