基于zookeeper的分布式锁实现

• 工做中须要写一个定时任务,因为是集群环境,天然而然想到须要经过分布式锁来保证单台执行..相信你们都会想到使用zk来实现对应的分布式锁.下面就简单介绍一下几种实现

   

  准备工做

  有几个帮助类,先把代码放上来

  ZKClient 对zk的操做作了一个简单的封装

   

  Java代码  

  1. package zk.lock;  
  2.   
  3. import org.apache.zookeeper.*;  
  4. import org.apache.zookeeper.data.Stat;  
  5. import zk.util.ZKUtil;  
  6.   
  7. import java.util.concurrent.CountDownLatch;  
  8. import java.util.concurrent.TimeUnit;  
  9.   
  10. /** 
  11.  * User: zhenghui 
  12.  * Date: 14-3-26 
  13.  * Time: 下午8:50 
  14.  * 封装一个zookeeper实例. 
  15.  */  
  16. public class ZKClient implements Watcher {  
  17.   
  18.     private ZooKeeper zookeeper;  
  19.   
  20.     private CountDownLatch connectedSemaphore = new CountDownLatch(1);  
  21.   
  22.   
  23.     public ZKClient(String connectString, int sessionTimeout) throws Exception {  
  24.         zookeeper = new ZooKeeper(connectString, sessionTimeout, this);  
  25.         System.out.println("connecting zk server");  
  26.         if (connectedSemaphore.await(10l, TimeUnit.SECONDS)) {  
  27.             System.out.println("connect zk server success");  
  28.         } else {  
  29.             System.out.println("connect zk server error.");  
  30.             throw new Exception("connect zk server error.");  
  31.         }  
  32.     }  
  33.   
  34.     public void close() throws InterruptedException {  
  35.         if (zookeeper != null) {  
  36.             zookeeper.close();  
  37.         }  
  38.     }  
  39.   
  40.     public void createPathIfAbsent(String path, boolean isPersistent) throws Exception {  
  41.         CreateMode createMode = isPersistent ? CreateMode.PERSISTENT : CreateMode.EPHEMERAL;  
  42.         path = ZKUtil.normalize(path);  
  43.         if (!this.exists(path)) {  
  44.             zookeeper.create(path, null, ZooDefs.Ids.OPEN_ACL_UNSAFE, createMode);  
  45.         }  
  46.     }  
  47.   
  48.     public boolean exists(String path) throws Exception {  
  49.         path = ZKUtil.normalize(path);  
  50.         Stat stat = zookeeper.exists(path, null);  
  51.         return stat != null;  
  52.     }  
  53.   
  54.     public String getData(String path) throws Exception {  
  55.         path = ZKUtil.normalize(path);  
  56.         try {  
  57.             byte[] data = zookeeper.getData(path, null, null);  
  58.             return new String(data);  
  59.         } catch (KeeperException e) {  
  60.             if (e instanceof KeeperException.NoNodeException) {  
  61.                 throw new Exception("Node does not exist,path is [" + e.getPath() + "].", e);  
  62.             } else {  
  63.                 throw new Exception(e);  
  64.             }  
  65.         } catch (InterruptedException e) {  
  66.             Thread.currentThread().interrupt();  
  67.             throw new Exception(e);  
  68.         }  
  69.     }  
  70.   
  71.     @Override  
  72.     public void process(WatchedEvent event) {  
  73.         if (event == null) return;  
  74.   
  75.         // 链接状态  
  76.         Watcher.Event.KeeperState keeperState = event.getState();  
  77.         // 事件类型  
  78.         Watcher.Event.EventType eventType = event.getType();  
  79.         // 受影响的path  
  80. //        String path = event.getPath();  
  81.         if (Watcher.Event.KeeperState.SyncConnected == keeperState) {  
  82.             // 成功链接上ZK服务器  
  83.             if (Watcher.Event.EventType.None == eventType) {  
  84.                 System.out.println("zookeeper connect success");  
  85.                 connectedSemaphore.countDown();  
  86.             }  
  87.         }  
  88.         //下面能够作一些重连的工做.  
  89.         else if (Watcher.Event.KeeperState.Disconnected == keeperState) {  
  90.             System.out.println("zookeeper Disconnected");  
  91.         } else if (Watcher.Event.KeeperState.AuthFailed == keeperState) {  
  92.             System.out.println("zookeeper AuthFailed");  
  93.         } else if (Watcher.Event.KeeperState.Expired == keeperState) {  
  94.             System.out.println("zookeeper Expired");  
  95.         }  
  96.     }  
  97. }  

   ZKUtil 针对zk路径的一个工具类

  Java代码  

  1. package zk.util;  
  2.   
  3. /** 
  4.  * User: zhenghui 
  5.  * Date: 14-3-26 
  6.  * Time: 下午9:56 
  7.  */  
  8. public class ZKUtil {  
  9.   
  10.     public static final String SEPARATOR = "/";  
  11.   
  12.     /** 
  13.      * 转换path为zk的标准路径 以/开头,最后不带/ 
  14.      */  
  15.     public static String normalize(String path) {  
  16.         String temp = path;  
  17.  
  18.         if(!path.startsWith(SEPARATOR)) {  
  19.             temp = SEPARATOR + path;  
  20.         }  
  21.         if(path.endsWith(SEPARATOR)) {  
  22.             temp = temp.substring(0, temp.length()-1);  
  23.             return normalize(temp);  
  24.         }else {  
  25.             return temp;  
  26.         }  
  27.     }  
  28.   
  29.     /** 
  30.      * 连接两个path,并转化为zk的标准路径 
  31.      */  
  32.     public static String contact(String path1,String path2){  
  33.         if(path2.startsWith(SEPARATOR)) {  
  34.             path2 = path2.substring(1);  
  35.         }  
  36.         if(path1.endsWith(SEPARATOR)) {  
  37.             return normalize(path1 + path2);  
  38.         } else {  
  39.             return normalize(path1 + SEPARATOR + path2);  
  40.         }  
  41.     }  
  42.   
  43.     /** 
  44.      * 字符串转化成byte类型 
  45.      */  
  46.     public static byte[] toBytes(String data) {  
  47.         if(data == null || data.trim().equals("")) return null;  
  48.         return data.getBytes();  
  49.     }  
  50. }  

   NetworkUtil 获取本机IP的工具方法

  Java代码  

  1. package zk.util;  
  2.   
  3. import java.net.InetAddress;  
  4. import java.net.NetworkInterface;  
  5. import java.util.Enumeration;  
  6.   
  7. /** 
  8.  * User: zhenghui 
  9.  * Date: 14-4-1 
  10.  * Time: 下午4:47 
  11.  */  
  12. public class NetworkUtil {  
  13.   
  14.     static private final char COLON = ':';  
  15.   
  16.     /** 
  17.      * 获取当前机器ip地址 
  18.      * 听说多网卡的时候会有问题. 
  19.      */  
  20.     public static String getNetworkAddress() {  
  21.         Enumeration<NetworkInterface> netInterfaces;  
  22.         try {  
  23.             netInterfaces = NetworkInterface.getNetworkInterfaces();  
  24.             InetAddress ip;  
  25.             while (netInterfaces.hasMoreElements()) {  
  26.                 NetworkInterface ni = netInterfaces  
  27.                         .nextElement();  
  28.                 Enumeration<InetAddress> addresses=ni.getInetAddresses();  
  29.                 while(addresses.hasMoreElements()){  
  30.                     ip = addresses.nextElement();  
  31.                     if (!ip.isLoopbackAddress()  
  32.                             && ip.getHostAddress().indexOf(COLON) == -1) {  
  33.                         return ip.getHostAddress();  
  34.                     }  
  35.                 }  
  36.             }  
  37.             return "";  
  38.         } catch (Exception e) {  
  39.             return "";  
  40.         }  
  41.     }  
  42. }  

   

  --------------------------- 正文开始  -----------------------------------

  这种实现很是简单,具体的流程以下

  
  
   对应的实现以下

  Java代码  

  1. package zk.lock;  
  2.   
  3.   
  4. import zk.util.NetworkUtil;  
  5. import zk.util.ZKUtil;  
  6.   
  7. /** 
  8.  * User: zhenghui 
  9.  * Date: 14-3-26 
  10.  * Time: 下午8:37 
  11.  * 分布式锁实现. 
  12.  * 
  13.  * 这种实现的原理是,建立某一个任务的节点,好比 /lock/tasckname 而后获取对应的值,若是是当前的Ip,那么得到锁,若是不是,则没得到 
  14.  * .若是该节点不存在,则建立该节点,并把改节点的值设置成当前的IP 
  15.  */  
  16. public class DistributedLock01 {  
  17.   
  18.     private ZKClient zkClient;  
  19.   
  20.   
  21.     public static final String LOCK_ROOT = "/lock";  
  22.     private String lockName;  
  23.   
  24.   
  25.     public DistributedLock01(String connectString, int sessionTimeout,String lockName) throws Exception {  
  26.         //先建立zk连接.  
  27.         this.createConnection(connectString,sessionTimeout);  
  28.   
  29.         this.lockName = lockName;  
  30.     }  
  31.   
  32.     public boolean tryLock(){  
  33.         String path = ZKUtil.contact(LOCK_ROOT,lockName);  
  34.         String localIp = NetworkUtil.getNetworkAddress();  
  35.         try {  
  36.             if(zkClient.exists(path)){  
  37.                 String ownnerIp = zkClient.getData(path);  
  38.                 if(localIp.equals(ownnerIp)){  
  39.                     return true;  
  40.                 }  
  41.             } else {  
  42.                 zkClient.createPathIfAbsent(path,false);  
  43.                 if(zkClient.exists(path)){  
  44.                     String ownnerIp = zkClient.getData(path);  
  45.                     if(localIp.equals(ownnerIp)){  
  46.                         return true;  
  47.                     }  
  48.                 }  
  49.             }  
  50.         } catch (Exception e) {  
  51.             e.printStackTrace();  
  52.         }  
  53.         return false;  
  54.     }  
  55.   
  56.   
  57.     /** 
  58.      * 建立zk链接 
  59.      * 
  60.      */  
  61.     protected void createConnection(String connectString, int sessionTimeout) throws Exception {  
  62.         if(zkClient != null){  
  63.             releaseConnection();  
  64.         }  
  65.         zkClient = new ZKClient(connectString,sessionTimeout);  
  66.         zkClient.createPathIfAbsent(LOCK_ROOT,true);  
  67.     }  
  68.     /** 
  69.      * 关闭ZK链接 
  70.      */  
  71.     protected void releaseConnection() throws InterruptedException {  
  72.         if (zkClient != null) {  
  73.             zkClient.close();  
  74.         }  
  75.     }  
  76.   
  77. }  

   

  总结

  网上有不少文章,你们的方法大多数都是建立一个root根节点,每个trylock的客户端都会在root下建立一个 EPHEMERAL_SEQUENTIAL 的子节点,同时设置root的child 变动watcher(为了不羊群效应,能够只添加前一个节点的变动通知) .若是建立的节点的序号是最小,则获取到锁,不然继续等待root的child 变动

• 核心技术：Maven,Springmvc mybatis shiro, Druid, Restful, Dubbo, ZooKeeper,Redis,FastDFS,ActiveMQ,Nginx 
  1.     项目核心代码结构截图
     项目模块依赖

  特别提醒：开发人员在开发的时候能够将本身的业务REST服务化或者Dubbo服务化

  2.    项目依赖介绍

     2.1 后台管理系统、Rest服务系统、Scheculer定时调度系统依赖以下图：
   

  
  
         2.2 Dubbo独立服务项目依赖以下图：

   
  
  3.  项目功能部分截图：
   
   
   
   
   
   

  
   

  zookeeper、dubbo服务启动 
   

  
   

  dubbo管控台 
   
   
   
   
   
   
   REST服务平台