Spring Boot加一个注解，轻松实现 Redis 分布式锁("Spring Boot仅需一注解，快速搞定Redis分布式锁实现")

原创

ithorizon 6个月前 (10-21) 阅读数 26 #后端开发

在分布式系统中，为了保证数据的一致性和防止竞态条件，分布式锁是一个非常重要的工具。在Spring Boot应用中，使用Redis实现分布式锁可以带来高性能和可靠性。本文将介绍怎样通过一个简洁的注解，轻松实现Redis分布式锁的功能。

一、分布式锁简介

分布式锁重点解决的是在分布式系统中，多个进程或线程在访问共享资源时的同步问题。与传统的锁相比，分布式锁可以在不同的机器或JVM之间共享，从而保证整个系统的一致性。

二、Redis分布式锁的优势

Redis分布式锁具有以下优势：

高性能：Redis是内存数据库，读写速度快，适合高并发场景。

可重入：Redis分布式锁可以赞成可重入，避免死锁。

可阻塞：Redis分布式锁可以阻塞等待，直到获取锁。

高可用：Redis赞成主从复制和哨兵模式，节约系统可用性。

三、Spring Boot实现Redis分布式锁

在Spring Boot中，我们可以通过自定义注解和AOP（面向切面编程）来简化Redis分布式锁的实现。下面是具体步骤：

3.1 添加依赖性

首先，在pom.xml中添加Redis客户端和Spring Boot AOP的依赖性：


<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-data-redis</artifactId>
</dependency>
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-aop</artifactId>
</dependency>

3.2 创建RedisLock注解

创建一个RedisLock注解，用于标记需要加锁的方法：


import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface RedisLock {
    String key();
    long waitTime() default 10000;
    long leaseTime() default 30000;
}

3.3 创建RedisLockAspect切面类

创建一个RedisLockAspect类，用于拦截带有RedisLock注解的方法，并实现分布式锁的逻辑：


import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.data.redis.core.StringRedisTemplate;
import org.springframework.stereotype.Component;
@Aspect
@Component
public class RedisLockAspect {
    @Autowired
    private StringRedisTemplate redisTemplate;
    @Around("@annotation(redisLock)")
    public Object around(ProceedingJoinPoint point, RedisLock redisLock) throws Throwable {
        String key = redisLock.key();
        long waitTime = redisLock.waitTime();
        long leaseTime = redisLock.leaseTime();
        boolean isLocked = redisTemplate.opsForValue().setIfAbsent(key, "locked", leaseTime);
        if (!isLocked) {
            long endTime = System.currentTimeMillis() + waitTime;
            while (System.currentTimeMillis() < endTime) {
                if (redisTemplate.opsForValue().setIfAbsent(key, "locked", leaseTime)) {
                    isLocked = true;
                    break;
                }
                Thread.sleep(100);
            }
        }
        if (!isLocked) {
            throw new RuntimeException("获取分布式锁落败");
        }
        try {
            return point.proceed();
        } finally {
            redisTemplate.delete(key);
        }
    }
}

3.4 使用RedisLock注解

在需要加锁的方法上使用RedisLock注解，并指定key、waitTime和leaseTime参数：


import org.springframework.stereotype.Service;
@Service
public class SomeService {
    @RedisLock(key = "someKey", waitTime = 10000, leaseTime = 30000)
    public void someMethod() {
        // 业务逻辑
    }
}