基于zookeeper分布式锁的实现
1、Zookeeper的节点类型
1. 持久节点
节点创建后就会一直存在，直到主动删除，不会因为创建改节点的客户端会话消失而消失。
2.持久顺序节点
持久的，顺序节点，Zk会维护这个时序，记录子节点的创建的先后顺序。
3.临时节点
临时节点的生命周期和客户端会话绑定，如果客户端会话失效（不是连接断开），那么这个节点被自动清除掉，临时节点下面不能创建子节点
4.临时顺序节点
临时顺序节点，也是临时节点，不过是带有顺序的，客户端会话消失节点就消失，Zk的分布式锁主要是运用的这个特性。
2、Zookeeper的分布式锁架构图
3、Zookeeper的分布式锁流程分析
总体思路可以如下：
1. 获取分布式锁时在Lock节点下创建临时顺序节点，释放锁的时候删除该临时节点。
2. 客户端调用createNode方法在Lock节点下创建临时顺序节点。然后调用getChildren获取所有子节点。
2.1 如果发现当前自己创建的节点的序号是最小的话，就认定该客户端获取到锁。
2.2 如果发现不是最小的节点。说明获取锁失败，此时客户端需要找到比自己小的节点，对其注册事件监听器。
3. 当前获取到锁的客户端删除当前最小节点，那么注册过事件监听器的客户端会收到通知，此时再次判断是否自己的节点是最小的，是的话直接获取到锁，不是的话重复步骤监听比自己小的节点的事件。
4、Zookeeper的分布式锁流程图
5、分布式锁的代码实现：
public class BaseDistributedLock {
private final ZkClient client;
private final String path;
private final String basePath;
private final String lockName;
private static final Integer MAX_RETRY_COUNT = 10;
public BaseDistributedLock( String path, String lockName) {
client= new ZkClient("127.0.0.1:2181");
this.basePath = path;
this.path = path.concat("/").concat(lockName);
this.lockName = lockName;
}
private void deleteOurPath(String ourPath) throws Exception {
client.delete(ourPath);
}
private String createLockNode(ZkClient client, String path) throws Exception {
return client.createEphemeralSequential(path, null);
}
/**
* 获取锁的核心方法
*
* @param startMillis
* @param millisToWait
* @param ourPath
* @return
* @throws Exception
*/
private boolean waitToLock(long startMillis, Long millisToWait, String ourPath) throws Exception {
boolean haveTheLock = false;
boolean doDelete = false;
try {
while (!haveTheLock) {
//该方法实现获取locker节点下的所有顺序节点，并且从小到大排序
List<String> children = getSortedChildren();
String sequenceNodeName = ourPath.substring(basePath.length() + 1);
//计算刚才客户端创建的顺序节点在locker的所有子节点中排序位置，如果是排序为0，则表示获取到了锁
int ourIndex = children.indexOf(sequenceNodeName);
/*如果在getSortedChildren中没有找到之前创建的[临时]顺序节点，这表示可能由于网络闪断而导致
*Zookeeper认为连接断开而删除了我们创建的节点，此时需要抛出异常，让上一级去处理
*上一级的做法是捕获该异常，并且执行重试指定的次数 见后面的 attemptLock方法 */
if (ourIndex < 0) {
throw new ZkNoNodeException("节点没有找到: " + sequenceNodeName);
}
//如果当前客户端创建的节点在locker子节点列表中位置大于0，表示其它客户端已经获取了锁
//此时当前客户端需要等待其它客户端释放锁，
boolean isGetTheLock = ourIndex == 0;
//如何判断其它客户端是否已经释放了锁？从子节点列表中获取到比自己次小的哪个节点，并对其建立监听
String pathToWatch = isGetTheLock ? null : children.get(ourIndex - 1);
if (isGetTheLock) {
haveTheLock = true;
} else {
//如果次小的节点被删除了，则表示当前客户端的节点应该是最小的了，所以使用CountDownLatch来实现等待
String previousSequencePath = basePath.concat("/").concat(pathToWatch);
final CountDownLatch latch = new CountDownLatch(1);
final IZkDataListener previousListener = new IZkDataListener() {
//次小节点删除事件发生时，让countDownLatch结束等待
//此时还需要重新让程序回到while，重新判断一次！
public void handleDataDeleted(String dataPath) throws Exception {
latch.countDown();
}
public void handleDataChange(String dataPath, Object data) throws Exception {
// ignore
}
};
try {
//如果节点不存在会出现异常
client.subscribeDataChanges(previousSequencePath, previousListener);
if (millisToWait != null) {
millisToWait -= (System.currentTimeMillis() - startMillis);
startMillis = System.currentTimeMillis();
if (millisToWait <= 0) {
doDelete = true; // timed out - delete our node
break;
}
latch.await(millisToWait, TimeUnit.MICROSECONDS);
} else {
latch.await();
}
} catch (ZkNoNodeException e) {
//ignore
} finally {
client.unsubscribeDataChanges(previousSequencePath, previousListener);
}
}
}
} catch (Exception e) {
//发生异常需要删除节点
doDelete = true;
throw e;
} finally {
//如果需要删除节点
if (doDelete) {
deleteOurPath(ourPath);
}
}
return haveTheLock;
}
private String getLockNodeNumber(String str, String lockName) {
int index = str.lastIndexOf(lockName);
if (index >= 0) {
index += lockName.length();
return index <= str.length() ? str.substring(index) : "";
}
return str;
}
private List<String> getSortedChildren() throws Exception {
try {
List<String> children = client.getChildren(basePath);
Collections.sort(
children,
new Comparator<String>() {
public int compare(String lhs, String rhs) {
return getLockNodeNumber(lhs, lockName).compareTo(getLockNodeNumber(rhs, lockName));
}
}
);
return children;
} catch (ZkNoNodeException e) {
client.createPersistent(basePath, true);
return getSortedChildren();
}
}
protected void releaseLock(String lockPath) throws Exception {
deleteOurPath(lockPath);
}
protected String attemptLock(long time, TimeUnit unit) throws Exception {
final long startMillis = System.currentTimeMillis();
final Long millisToWait = (unit != null) ? unit.toMillis(time) : null;
String ourPath = null;
boolean hasTheLock = false;
boolean isDone = false;
int retryCount = 0;
//网络闪断需要重试一试
while (!isDone) {
isDone = true;
try {
//createLockNode用于在locker（basePath持久节点）下创建客户端要获取锁的[临时]顺序节点
ourPath = createLockNode(client, path);
/**
* 该方法用于判断自己是否获取到了锁，即自己创建的顺序节点在locker的所有子节点中是否最小
* 如果没有获取到锁，则等待其它客户端锁的释放，并且稍后重试直到获取到锁或者超时
*/
hasTheLock = waitToLock(startMillis, millisToWait, ourPath);
} catch (ZkNoNodeException e) {
if (retryCount++ < MAX_RETRY_COUNT) {
isDone = false;
} else {
throw e;
}
}
}
if (hasTheLock) {
return ourPath;
}
return null;
}
}
/**
* @author: hanjinping
* @Date: 2019/10/28
* @Description:
*/
public interface DistributedLock {
/**
* 获取锁，如果没有得到就等待
*/
public void acquire() throws Exception;
/**
* 获取锁，直到超时
* @param time 超时时间
* @param unit time参数的单位
* @return 是否获取到锁
* @throws Exception
*/
public boolean acquire(long time, TimeUnit unit) throws Exception;
/**
* 释放锁
*/
public void release() throws Exception;
}
/**
* 锁接口的具体实现，主要借助于继承的父类BaseDistributedLock来实现的接口方法
* <p>
* 该父类是基于Zookeeper实现分布式锁的具体细节实现
*/
public class SimpleDistributedLockMutex extends BaseDistributedLock implements DistributedLock {
/*用于保存Zookeeper中实现分布式锁的节点，如名称为locker：/locker，
*该节点应该是持久节点，在该节点下面创建临时顺序节点来实现分布式锁 */
private final String basePath;
/*锁名称前缀，locker下创建的顺序节点例如都以lock-开头，这样便于过滤无关节点
*这样创建后的节点类似：lock-00000001，lock-000000002*/
private static final String LOCK_NAME ="lock-";
/*用于保存某个客户端在locker下面创建成功的顺序节点，用于后续相关操作使用（如判断）*/
private String ourLockPath;
/**
* 用于获取锁资源，通过父类的获取锁方法来获取锁
*
* @param time 获取锁的超时时间
* @param unit time的时间单位
* @throws Exception
* @return是否获取到锁
*/
private boolean internalLock(long time, TimeUnit unit) throws Exception {
//如果ourLockPath不为空则认为获取到了锁，具体实现细节见attemptLock的实现
ourLockPath = attemptLock(time, unit);
return ourLockPath != null;
}
/**
* 传入Zookeeper客户端连接对象，和basePath
*
* @param client Zookeeper客户端连接对象
* @param basePath basePath是一个持久节点
*/
public SimpleDistributedLockMutex( String basePath) {
/*调用父类的构造方法在Zookeeper中创建basePath节点，并且为basePath节点子节点设置前缀
*同时保存basePath的引用给当前类属性*/
super(basePath, LOCK_NAME);
this.basePath = basePath;
}
/**
* 获取锁，直到超时，超时后抛出异常
*/
public void acquire() throws Exception {
//-1表示不设置超时时间，超时由Zookeeper决定
if (!internalLock(-1, null)) {
throw new IOException("连接丢失!在路径:'" + basePath + "'下不能获取锁!");
}
}
/**
* 获取锁，带有超时时间
*/
public boolean acquire(long time, TimeUnit unit) throws Exception {
return internalLock(time, unit);
}
/**
* 释放锁
*/
public void release() throws Exception {
releaseLock(ourLockPath);
}
本文章为转载内容，我们尊重原作者对文章享有的著作权。如有内容错误或侵权问题，欢迎原作者联系我们进行内容更正或删除文章。
