分布式锁

说明

Zebra提供了基于Redis的分布式锁，以便同个微服务下各个实例做分布式协调。

样例

请参考 TODO

开发

引入依赖

引入如下依赖

  1. <dependency>
  2.     <groupId>com.guosen</groupId>
  3.     <artifactId>zebra-distributed-lock</artifactId>
  4.     <version>${zebra.version}</version>
  5. </dependency>

配置

配置样例

  1. zebra.distributed.lock.type=redis
  2. zebra.distributed.lock.redis.host=192.168.1.10
  3. zebra.distributed.lock.redis.port=6379
  4. zebra.distributed.lock.redis.db=0
  5. zebra.distributed.lock.redis.password=passwordOfRedis

配置说明

配置项 类型 说明
zebra.distributed.lock.type String 分布式锁类型，当前只支持 redis。
zebra.distributed.lock.redis.host String 分布式锁使用的 Redis IP 或者域名
zebra.distributed.lock.redis.port Integer 分布式锁使用的 Redis 端口，默认值为 6379
zebra.distributed.lock.redis.db Integer 分布式锁使用的 Redis 数据库，默认为 0
zebra.distributed.lock.redis.password String 分布式锁使用的 Redis 密码，如果没有密码，则不配置

代码

  1. DistributedLock distributedLock = DistributedLocks.getLock(lockName, 30L);
  2. if (distributedLock == null) {
  3.     LOGGER.error("Failed to get lock of name : {}", lockName);
  4.     return "Failed to get lock " + lockName;
  5. }
  7. if (!distributedLock.tryLock()) {
  8.     LOGGER.error("Failed to try lock");
  9.     return "Failed to try lock " + lockName;
  10. }
  12. // 注意，必须用try/finally 或者 try/catch/finally来释放锁
  13. try {
  14.     // 干活
  15.     doSomeThingWithinLock();
  16. }
  17. finally {
  18.     distributedLock.unlock();
  19. }

注意

  1. DistributedLocks.getLock 第二个参数为预估的持有锁时间（为了确保程序挂掉后，锁能够自动释放），单位为秒，请确保该时间和业务执行时间基本一致；
  2. 获取锁和尝试加锁都必须检查返回结果，加锁成功后在 finally 里面释放锁。