etcd：一款比Redis更骚的分布式锁的实现方式！用它

最新推荐文章于 2024-07-30 00:10:26 发布

2401_83330354

最新推荐文章于 2024-07-30 00:10:26 发布

阅读量787

点赞数 21

分类专栏：程序员文章标签： etcd redis 分布式

本文链接：https://blog.csdn.net/2401_83330354/article/details/138858794

版权

程序员专栏收录该内容

717 篇文章 2 订阅

订阅专栏

建立连接

客户端连接 etcd，以 /etcd/lock 为前缀创建全局唯一的 key，假设第一个客户端对应的 key=“/etcd/lock/UUID1”，第二个为 key=“/etcd/lock/UUID2”；客户端分别为自己的 key 创建租约 - Lease，租约的长度根据业务耗时确定；

创建定时任务作为租约的“心跳”

当一个客户端持有锁期间，其它客户端只能等待，为了避免等待期间租约失效，客户端需创建一个定时任务作为“心跳”进行续约。此外，如果持有锁期间客户端崩溃，心跳停止，key 将因租约到期而被删除，从而锁释放，避免死锁；

客户端将自己全局唯一的 key 写入 etcd

执行 put 操作，将步骤 1 中创建的 key 绑定租约写入 Etcd，根据 Etcd 的 Revision 机制，假设两个客户端 put 操作返回的 Revision 分别为 1、2，客户端需记录 Revision 用以接下来判断自己是否获得锁；

客户端判断是否获得锁

客户端以前缀 /etcd/lock/ 读取 key-Value 列表，判断自己 key 的 Revision 是否为当前列表中最小的，如果是则认为获得锁；否则监听列表中前一个 Revision 比自己小的 key 的删除事件，一旦监听到删除事件或者因租约失效而删除的事件，则自己获得锁；

执行业务

获得锁后，操作共享资源，执行业务代码

释放锁

完成业务流程后，删除对应的key释放锁

肝代码

有了以上理论做基础，我们开始etcd分布式锁的代码实现。

jetcd客户端

jetcd是etcd的Java客户端，它提供了丰富的接口来操作etcd，使用方便。

redis数据准备

初始化库存stock=300，再设置一个lucky=0，表示抢到库存的人，实际场景中可以是用户订单信息，每扣减一个库存，lucky便加1。

etcd分布式锁的实现

由于etcd的Lock接口有一套自己的实现，zookeeper的Lock接口也有自己的一套实现，redis…各种分布式锁实现方案都有自己的Lock，因此，我封装了一个模板方法：

/**

@program: distributed-lock
@description: 各种分布式锁的基类，模板方法
@author: 行百里者
@create: 2020/10/14 12:29
**/
public class AbstractLock implements Lock {
@Override
public void lock() {
throw new RuntimeException(“请自行实现该方法”);
}

@Override
public void lockInterruptibly() throws InterruptedException {
throw new RuntimeException(“请自行实现该方法”);
}

@Override
public boolean tryLock() {
throw new RuntimeException(“请自行实现该方法”);
}

@Override
public boolean tryLock(long time, TimeUnit unit) throws InterruptedException {
throw new RuntimeException(“请自行实现该方法”);
}

@Override
public void unlock() {
throw new RuntimeException(“请自行实现该方法”);
}

@Override
public Condition newCondition() {
throw new RuntimeException(“请自行实现该方法”);
}
}

有了这个模板方法之后，后续分布式锁的实现均可以继承这个模板方法类。

etcd分布式锁的实现：

@Data
public class EtcdDistributedLock extends AbstractLock {
private final static Logger LOGGER = LoggerFactory.getLogger(EtcdDistributedLock.class);

private Client client;
private Lock lockClient;
private Lease leaseClient;
private String lockKey;
//锁路径，方便记录日志
private String lockPath;
//锁的次数
private AtomicInteger lockCount;
//租约有效期。作用 1：客户端崩溃，租约到期后自动释放锁，防止死锁 2：正常执行自动进行续租
private Long leaseTTL;
//续约锁租期的定时任务，初次启动延迟，默认为1s，根据实际业务需要设置
private Long initialDelay = 0L;
//定时任务线程池
ScheduledExecutorService scheduledExecutorService;
//线程与锁对象的映射
private final ConcurrentMap<Thread, LockData> threadData = Maps.newConcurrentMap();

public EtcdDistributedLock(Client client, String lockKey, Long leaseTTL, TimeUnit unit) {
this.client = client;
this.lockClient = client.getLockClient();
this.leaseClient = client.getLeaseClient();
this.lockKey = lockKey;
this.leaseTTL = unit.toNanos(leaseTTL);
scheduledExecutorService = Executors.newSingleThreadScheduledExecutor();
}

@Override
public void lock() {

}

@Override
public void unlock() {

}
}

其中lock方法的实现：

@Override
public void lock() {
Thread currentThread = Thread.currentThread();
LockData existsLockData = threadData.get(currentThread);
//System.out.println(currentThread.getName() + " 加锁 existsLockData：" + existsLockData);
//锁重入
if (existsLockData != null && existsLockData.isLockSuccess()) {
int lockCount = existsLockData.lockCount.incrementAndGet();
if (lockCount < 0) {
throw new Error(“超出etcd锁可重入次数限制”);
}
return;
}
//创建租约，记录租约id
long leaseId;
try {
leaseId = leaseClient.grant(TimeUnit.NANOSECONDS.toSeconds(leaseTTL)).get().getID();
//续租心跳周期
long period = leaseTTL - leaseTTL / 5;
//启动定时续约
scheduledExecutorService.scheduleAtFixedRate(new KeepAliveTask(leaseClient, leaseId),
initialDelay,
period,
TimeUnit.NANOSECONDS);

//加锁
LockResponse lockResponse = lockClient.lock(ByteSequence.from(lockKey.getBytes()), leaseId).get();
if (lockResponse != null) {
lockPath = lockResponse.getKey().toString(StandardCharsets.UTF_8);
LOGGER.info(“线程：{} 加锁成功，锁路径：{}”, currentThread.getName(), lockPath);
}

//加锁成功，设置锁对象
LockData lockData = new LockData(lockKey, currentThread);
lockData.setLeaseId(leaseId);
lockData.setService(scheduledExecutorService);
threadData.put(currentThread, lockData);
lockData.setLockSuccess(true);
} catch (InterruptedException | ExecutionException e) {
e.printStackTrace();
}
}

简而言之，加锁的代码就是按照如下步骤来的：

检查锁重入性
设置租约
开启定时任务心跳检查
阻塞获取锁
加锁成功，设置锁对象

业务处理完成（扣减库存）后，解锁：

@Override
public void unlock() {
Thread currentThread = Thread.currentThread();
//System.out.println(currentThread.getName() + " 释放锁…“);
LockData lockData = threadData.get(currentThread);
//System.out.println(currentThread.getName() + " lockData " + lockData);
if (lockData == null) {
throw new IllegalMonitorStateException(“线程：” + currentThread.getName() + " 没有获得锁，lockKey：” + lockKey);
}
int lockCount = lockData.lockCount.decrementAndGet();
if (lockCount > 0) {
return;
}
if (lockCount < 0) {
throw new IllegalMonitorStateException(“线程：” + currentThread.getName() + " 锁次数为负数，lockKey：" + lockKey);
}
try {
//正常释放锁
if (lockPath != null) {
lockClient.unlock(ByteSequence.from(lockPath.getBytes())).get();
}
//关闭续约的定时任务
lockData.getService().shutdown();
//删除租约
if (lockData.getLeaseId() != 0L) {
leaseClient.revoke(lockData.getLeaseId());
}
} catch (InterruptedException | ExecutionException e) {
//e.printStackTrace();
LOGGER.error(“线程：” + currentThread.getName() + “解锁失败。”, e);
} finally {
//移除当前线程资源
threadData.remove(currentThread);
}
LOGGER.info(“线程：{} 释放锁”, currentThread.getName());
}

解锁过程：

重入性检查
移除当前锁的节点路径释放锁
清除重入的线程资源

接口测试

/**

@program: distributed-lock
@description: etcd分布式锁演示-高并发下库存扣减
@author: 行百里者
@create: 2020/10/15 13:24
**/
@RestController
public class StockController {

private final StringRedisTemplate redisTemplate;

@Value(“${server.port}”)
private String port;

@Value(“${etcd.lockPath}”)
private String lockKey;

private final Client etcdClient;

public StockController(StringRedisTemplate redisTemplate, @Value(“${etcd.servers}”) String servers) {
//System.out.println(“etcd servers:” + servers);
this.redisTemplate = redisTemplate;
this.etcdClient = Client.builder().endpoints(servers.split(“,”)).build();
}

@RequestMapping(“/stock/reduce”)
public String reduceStock() {