记一次使用分布式锁遇到设计问题

这个问题估计大部分开发都会遇到,大部分人都会遗漏,遇到这样情况,你是否立马能找到问题

源自一个需求,对一个接口进行幂等控制。当时实现思路,创建一个声明注解,标注参数的对象的字段作为幂等标记,使用注解作为切点,进行环绕通知控制对业务方法进行增强,如果幂等字段已经存在,不调用业务方法。

代码实现

定义注解
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Idempotent {

    /**
     * 唯一标识
     * @return
     */
    String uniqueKey();
}

定义切面


@Component
@Aspect
@Slf4j
public class IdempotentAspect {

    private String keyTemplate = "system:%s.%s:%s";
    
    @Autowired
    private RedisDistributedLock distributedLock;

    @Pointcut("@annotation(com.xxx.xx.Idempotency)")
    public void pointcut() {
    }

    @Around("pointcut()")
    public Object around(ProceedingJoinPoint point) throws Throwable {
        String className = point.getTarget().getClass().getName();
        MethodSignature joinPointObject = (MethodSignature) point.getSignature();
        Method method = joinPointObject.getMethod();
        Idempotency annotation = AnnotationUtils.getAnnotation(method, Idempotency.class);
        String field = annotation.uniqueKey();
        Object[] args = point.getArgs();
        String methodName = point.getSignature().getName();
        if (ArrayUtils.isEmpty(args))
            return point.proceed();
        Object targetObject = args[0];
        if (isNull(targetObject))
            return point.proceed();
        PropertyDescriptor propertyDescriptor = BeanUtils.getPropertyDescriptor(targetObject.getClass(), field);
        if (isNull(propertyDescriptor)) {
            log.warn("找不到对象属性 {}", field);
            return point.proceed();
        }
        Object fieldValue = propertyDescriptor.getReadMethod().invoke(targetObject);
        String key = format(keyTemplate,className, methodName, fieldValue.toString());
        boolean lock = distributedLock.lock(key);
        if (lock) {
            //判断fieldValue 在数据库是否存在、并且写入数据库中
            boolean canExecute = false;
            canExecute = findRecord(fieldValue);
            if (canExecute) {
                try {
                    return point.proceed();
                } finally {
                    distributedLock.releaseLock(key);
                }
            }
        }
        //略
    }

}

上面就是环绕通知详细实现,省略一些具体操作实现,获取注解的uniqueKey到执行方法的参数对象中获取field值,通过方法名+field值进行加锁,并发控制,根据数据库判断控制执行。
很简单就实现对方法进行全局幂等控制,非常自信连自测都没有进行调用,直接提交到测试环境,结果啪啪打脸。在finally 解锁方法中抛出一个异常org.springframework.dao.InvalidDataAccessApiUsageException: Unexpected exception while processing command; nested exception is org.redisson.client.RedisException: Unexpected exception while processing command。这样的结果我是很懵逼的,没道理会在这里出问题的啊。我是不是使用错API,毕竟这个是公司封装的分布式工具,在看了一个其他提交的代码,使用方式并没有任何问题。这个异常是redis执行脚本错误导致,我第一想法是解锁的lua执行出错了,找同事要了类库的源码。

异常分析

分布式锁实现

@Slf4j
@Component
public class RedisDistributedLock {

@Autowired
private RedisTemplate<String, Object> redisTemplate;

private ThreadLocal<String> lockFlag = new ThreadLocal<>();

private static final String LUA_SCRIPT = "if redis.call("get",KEYS[1]) == ARGV[1] " +
        "then " +
        "    return redis.call("del",KEYS[1]) " +
        "else " +
        "    return 0 " +
        "end ";
        
public boolean lock(String key) {
    String uuid = UUID.randomUUID().toString();
    lockFlag.set(uuid);
    boolean result = setRedis(key, 10000L);
    return result;
}

private boolean setRedis(final String key, final long expire) {
    try {
        boolean status = redisTemplate.execute((RedisCallback<Boolean>) connection -> {
            byte[] keyByte = redisTemplate.getStringSerializer().serialize(key);
            byte[] uuidByte = redisTemplate.getStringSerializer().serialize(lockFlag.get());
            boolean result = connection.set(keyByte, uuidByte, Expiration.from(expire, TimeUnit.MILLISECONDS), RedisStringCommands.SetOption.ifAbsent());
            return result;
        });
        return status;
    } catch (Exception e) {
        log.error("set redisDistributeLock occured an exception", e);
        //此处应抛出异常,用来标识redis访问失败的情况
        throw e;
    }
}

public boolean releaseLock(String key) {
    try {
        Boolean result = redisTemplate.execute((RedisCallback<Boolean>) connection -> {
            byte[] scriptByte = redisTemplate.getStringSerializer().serialize(LUA_SCRIPT);
            return connection.eval(scriptByte, ReturnType.BOOLEAN, 1
                    , redisTemplate.getStringSerializer().serialize(key)
                    , redisTemplate.getStringSerializer().serialize(lockFlag.get()));
        });
        return result;
    } catch (Exception e) {
        log.error("release redisDistributeLock occured an exception", e);
    } finally {
        lockFlag.remove();
    }
    return false;
}

这看起来是不是一切都很正常,就像标准答案一样正确,问题到底出来哪里呢。大家先别急着结果,自己想一下,所有的线索已经给出来,可以推断出问题了。

回想起两年前,被一个面试官问到一个问题,分布式要具备那些特性。在平常开发中很少使用分布锁,一点概念都没有。但是我脑子一转想到synchronizedLock这些JDK锁自备的特性,互斥可重入高性能。现在回想下,就漏掉一个高可用答案,其他都没什么问题了。而上面的问题就出现在可重入。它使用ThreadLocal<String> lockFlag来保存当前线程持有锁的标记,问题就出来这里。在切面的方法里,第二次调用lock方法,lockFlag被赋值了两次,会导致第一次赋值被同一个线程第二次加锁覆盖,然后每次解锁是都会删除锁的value,第二次解锁时lockFlag已经被删除了,所以解锁脚本执行失败了,程序才会抛出异常。lockFlag只能保存同一个线程内一次加锁,当出现一个现场多次加锁,有可能每一次加锁都不是同一个锁,这里的设计是满足不了这样的场景的。分布锁锁的可重入,我理解和JDK衍生锁不一样,不一定是同一把锁,一个线程多次调用锁,分布对不同资源进行锁定,这也算是可重入。不知道大家对分布式重入有什么看法,欢迎在评论区说出你的想法,大家一起讨论下。最后的解决方案,使用Stack替代String

心得

我想当时开发设计这个工具类时,并没有考虑可重入特性,看来八股文背得还不够熟练啊😂。经历这个问题后,可重入是每一个锁必须具备的特性,不然很容易写出死锁的代码。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 194,088评论 5 459
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 81,715评论 2 371
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 141,361评论 0 319
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,099评论 1 263
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 60,987评论 4 355
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,063评论 1 272
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,486评论 3 381
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,175评论 0 253
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,440评论 1 290
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,518评论 2 309
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,305评论 1 326
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,190评论 3 312
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,550评论 3 298
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 28,880评论 0 17
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,152评论 1 250
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,451评论 2 341
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 40,637评论 2 335

推荐阅读更多精彩内容