redis: redisson实现分布式锁、限流、防重提交，依赖即可使用的注解工具

项目开源地址

快速开始

<dependency>
    <groupId>io.github.smilexizheng</groupId>
    <artifactId>redisson-tool-spring-boot-starter</artifactId>
    <version>1.0.1</version>
</dependency>

组件已经发布到maven中央仓库，最新版本的依赖

项目配置

#redisson工具
redisson-tool:
  #启用功能
  enabled: true
  #redisson配置文件
  path: lock/redisson-lock.yml
  #分布式锁
  lock-enabled: true
  #限流
  rate-limiter-enabled: true
  #防重提交
  repeat-submit-enabled: true

lock/redisson-lock.yml 参考redisson的声明式配置

---
singleServerConfig:
  idleConnectionTimeout: 10000
  connectTimeout: 10000
  timeout: 3000
  retryAttempts: 3
  retryInterval: 1500
  password: 123456789
  subscriptionsPerConnection: 5
  clientName: mainRedis
  address: "redis://127.0.0.1:6379"
  subscriptionConnectionMinimumIdleSize: 1
  subscriptionConnectionPoolSize: 50
  connectionMinimumIdleSize: 24
  connectionPoolSize: 64
  database: 6
  dnsMonitoringInterval: 5000
threads: 16
nettyThreads: 32
codec: !<org.redisson.codec.Kryo5Codec> { }
transportMode: "NIO"

分布式锁

//最小化使用
@RedissonLock
public String get(String userId){
        return "helloWorld"+userId;
}

//完整配置
@RedissonLock(value = "lockKey", param = "#userId", waitTime = 10, leaseTime = 30, type = LockType.FAIR, timeUnit = TimeUnit.SECONDS)
public String get(String userId){
        return "helloWorld"+userId;
}


//编程式使用
@Autowired 
private LockClient lockClient;

public String get(String userId) {  
    String key = "user:"+userId;
    String data= lockClient.lock(key, LockType.FAIR,10,20, TimeUnit.SECONDS,()->{               
          return "hello"+key;
        });
    return data;
}

• value：key 默认空，可不填
• param: key的二级参数 支持spel,默认空
• waitTime: 等待时间，默认 30
• leaseTime: 自定解锁时间 默认60
• timeUnit：时间单位 默认秒
• type: 公平锁/普通锁 默认公平锁

限流器

//最小化使用
@RateLimiter
public String get(String userId){
        return "helloWorld"+userId;
}

//完整配置
@RateLimiter(value="getUserInfo",param = "#userId",rate = 100,rateInterval = 1 ,timeUnit = TimeUnit.MINUTES)
public String get(String userId){
        return "helloWorld"+userId;
}

• value：key 默认空，可不填
• param: key的二级参数 支持spel,默认空
• rate: 等待时间，默认 100
• rateInterval: 自定解锁时间 默认 1
• timeUnit：时间单位 默认 分钟

防重提交

//最小化使用
@RepeatSubmit
public String get(String userId){
        return "helloWorld"+userId;
}

//完整配置
@RepeatSubmit(value="getUserInfo",param = "#userId",expireTime = 10,waitExpire = true,validateForm=true,timeUnit = TimeUnit.SECONDS)
public String get(String userId){
        return "helloWorld"+userId;
}

• value：key 默认空，可不填
• param: key的二级参数 支持spel,默认空
• expireTime: 等待时间，默认 10
• waitExpire: true 等待时间自动过期， false 执行完立即过期。默认true
• timeUnit：时间单位 默认 分钟
• validateForm: 是否校验表单 默认true

三、 配置说明

3.1 key的自动生成

• value 作为key使用，默认空可不填，使用切入方法的JoinPoint.StaticPart转hex 作为key
• param 作为粒度控制，比如某用户，某类型，支持spel

3.2 混合使用的处理次序

    
    @RedissonLock
    @RepeatSubmit
    @RateLimiter
    public String get(String key) {
        return "hello";
    }

• 使用@Order控制切面执行顺序
• 1.@RepeatSubmit 防重提交
• 2.@RateLimiter 限流器
• 3.@RedissonLock 分布式锁

四、捕获异常 响应式处理

创建异常处理类 GlobalExceptionHandler，可进行错误日志记录，正确返回错误信息。
参考：

/**
 * 自定义异常处理
 */
@ControllerAdvice
public class GlobalExceptionHandler {

    private static final Logger logger = LoggerFactory.getLogger(GlobalExceptionHandler.class);

    @ExceptionHandler(value = RedissonToolException.class)
    @ResponseBody
    public R rateLimiterExceptionHandler(RedissonToolException e,HttpServletRequest req){
        logger.error(String.format("[%s]%s：%s",req.getRequestURL().toString(),e.getType().toString(),e.getMessage()));
        String errorMsg;
        switch (e.getType()){
            case TryLockFail:
                errorMsg = "排队中，请重试";
                break;
            case RateLimiterException:
                errorMsg ="系统繁忙，请重试！";
                break;
            case RepeatException:
                errorMsg ="请勿重复提交！";
                break;
//          更多异常见 org.smilexizheng.exception.ExceptionType 
            default:
                errorMsg ="系统繁忙！";
                break;
        }
        return R.error(errorMsg);
    }
}