一、项目背景

基于redisson封装通用性组件，目前实现接口限流、加锁、防重提交功能。

二、快速开始

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

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

2.1 项目配置

#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"

2.2 分布式锁

//最小化使用
@RedissonLock
public String get(String userId)


//完整配置
@RedissonLock(value = "lockKey", param = "#user.id", waitTime = 10, leaseTime = 30, type = LockType.FAIR, timeUnit = TimeUnit.SECONDS)
public String get(User user)


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

public String get(User user) {  
    String key = user.getId();
    // ....
    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: 公平锁/普通锁 默认公平锁

2.3 限流器

//最小化使用
@RateLimiter
public String get(String userId)

//完整配置
@RateLimiter(value="getUserInfo",param = "#user.id",rate = 100,rateInterval = 1 ,timeUnit = TimeUnit.MINUTES)
public String get(User user)

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

2.4 防重提交

//最小化使用
@RepeatSubmit
public String get(String userId)

//完整配置
@RepeatSubmit(value="getUserInfo",param = "#user.id",expireTime = 10,waitExpire = true,validateForm=true,timeUnit = TimeUnit.SECONDS)
public String get(User user)

• 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)

• 顺序为首先@RepeatSubmit，其次@RateLimiter，最后@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()));
        //jdk17 语法
        String errorMsg = switch (e.getType()) {
            case TryLockFail -> "排队中，请重试";
            case RateLimiterException -> "系统繁忙，请重试！";
            case RepeatException -> "请勿重复提交！";
//          更多异常见 org.smilexizheng.exception.ExceptionType 
            default -> "系统繁忙！";
        };
        return R.error(errorMsg);
    }
}

常见问题：

1.spring Controller 自定义参数注入 传递用户信息

欢迎提出使用中的问题