增加针对Session限速功能

Author: chqiuu

README.md

@@ -16,7 +16,7 @@
 <dependency>
     <groupId>com.github.chqiuu</groupId>
     <artifactId>spring-redis-current-limit</artifactId>
-    <version>1.0.0</version>
+    <version>Latest Version</version>
  </dependency>
 ```
 ### 2.  注册spring-redis-current-limit
@@ -215,6 +215,11 @@ public class LimiterController {
 1. [个人博客](https://blog.csdn.net/QIU176161650)
 2. [GitHub](https://github.com/chqiuu)
 
+#### 参考
+
+[将JAR包发布到Maven中央仓库](https://blog.csdn.net/liaomin416100569/article/details/86494819)
+[在Maven中央存储库中发布github项目](https://blog.csdn.net/weixin_26711867/article/details/108946638)
+
 #### 版本信息
 
 #####  1.0.0

pom.xml

@@ -5,7 +5,7 @@
     <groupId>com.github.chqiuu</groupId>
     <artifactId>spring-redis-current-limit</artifactId>
     <packaging>jar</packaging>
-    <version>1.0.0</version>
+    <version>1.0.3</version>
     <name>spring-redis-current-limit</name>
     <description>基于注解的应用级网关限流框架</description>
     <url>https://github.com/chqiuu/spring-redis-current-limit</url>

src/main/java/com/github/chqiuu/redis/limit/annotation/CurrentLimit.java

@@ -2,6 +2,7 @@
 
 
 import com.github.chqiuu.redis.limit.enums.LimitTypeEnum;
+import com.github.chqiuu.redis.limit.enums.TypeLimitModelEnum;
 
 import java.lang.annotation.*;
 
@@ -55,4 +56,11 @@
      * 设置限流类型。默认值：LOCAL
      */
     LimitTypeEnum limitType() default LimitTypeEnum.LOCAL;
+
+    /**
+     * 设置在类上设置注解限流模式，当为ElementType.TYPE时有效
+     *
+     * @return 在类上设置注解限流模式
+     */
+    TypeLimitModelEnum typeLimitModel() default TypeLimitModelEnum.EACH;
 }

…mit/aspect/ObjectCurrentLimitAspect.java …limit/aspect/TypeCurrentLimitAspect.javasrc/main/java/com/github/chqiuu/redis/limit/aspect/ObjectCurrentLimitAspect.java renamed to src/main/java/com/github/chqiuu/redis/limit/aspect/TypeCurrentLimitAspect.java src/main/java/com/github/chqiuu/redis/limit/aspect/ObjectCurrentLimitAspect.java renamed to src/main/java/com/github/chqiuu/redis/limit/aspect/TypeCurrentLimitAspect.java

@@ -1,6 +1,7 @@
 package com.github.chqiuu.redis.limit.aspect;
 
 import com.github.chqiuu.redis.limit.annotation.CurrentLimit;
+import com.github.chqiuu.redis.limit.enums.TypeLimitModelEnum;
 import com.github.chqiuu.redis.limit.exception.CurrentLimitException;
 import com.github.chqiuu.redis.limit.strategy.BaseCurrentLimiter;
 import lombok.AllArgsConstructor;
@@ -13,7 +14,7 @@
 import org.springframework.stereotype.Component;
 
 /**
- * 限流切面实现（对象）
+ * 限流切面实现（类）
  * 对象切面优先于方法切面
  *
  * @author chqiu
@@ -23,7 +24,7 @@
 @Aspect
 @Component
 @AllArgsConstructor
-public class ObjectCurrentLimitAspect {
+public class TypeCurrentLimitAspect {
 
     private final BaseCurrentLimiter currentLimiter;
 
@@ -44,7 +45,11 @@ public void withinPointcut(CurrentLimit currentLimit) {
      */
     @Before(value = "withinPointcut(currentLimit)", argNames = "joinPoint,currentLimit")
     public void doWithinBefore(JoinPoint joinPoint, CurrentLimit currentLimit) {
-        boolean isAllowAccess = currentLimiter.check(joinPoint, true, currentLimit.key(), currentLimit.limitType(), currentLimit.limit(), currentLimit.interval(), currentLimit.step());
+        boolean isMethod = true;
+        if (TypeLimitModelEnum.TOTAL.equals(currentLimit.typeLimitModel())) {
+            isMethod = false;
+        }
+        boolean isAllowAccess = currentLimiter.check(joinPoint, isMethod, currentLimit.key(), currentLimit.limitType(), currentLimit.limit(), currentLimit.interval(), currentLimit.step());
         if (!isAllowAccess) {
             throw new CurrentLimitException(currentLimit.message());
         }

src/main/java/com/github/chqiuu/redis/limit/config/EnableCurrentLimitConfiguration.java

@@ -27,7 +27,7 @@
  */
 @Slf4j
 @Configuration
-@ComponentScan(basePackages = "com.chqiuu.redis.limit")
+@ComponentScan(basePackages = "com.github.chqiuu.redis.limit")
 public class EnableCurrentLimitConfiguration {
 
     /**

src/main/java/com/github/chqiuu/redis/limit/enums/LimitTypeEnum.java

@@ -26,6 +26,14 @@ public enum LimitTypeEnum {
      * 根据用户限流。此系统中所有限流方法（或类）单位时间内只允许此用户访问n次
      */
     USER_GLOBAL,
+    /**
+     * 根据Session限流。此方法（或类）单位时间内只允许此 SessionId 访问n次
+     */
+    SESSION,
+    /**
+     * 根据Session限流。此系统中所有限流方法（或类）单位时间内只允许此 SessionId 访问n次
+     */
+    SESSION_GLOBAL,
     /**
      * 自定义限流方法，详细使用请参考使用文档
      */

src/main/java/com/github/chqiuu/redis/limit/enums/TypeLimitModelEnum.java

@@ -0,0 +1,21 @@
+package com.github.chqiuu.redis.limit.enums;
+
+/**
+ * 在类上做限流的模式枚举类
+ *
+ * 在类上限流模式可分为两种：
+ * 第一种是该类中所有方法都采用相同的限流方式。例如，需要该类中每个方法每30秒只允许调用10次；
+ * 第二种是该类进行整体限流（此处类配置限流优先于方法上配置的限流）。例如，需要该类中所有方法每30秒只允许调用10次。
+ *
+ * @author chqiu
+ */
+public enum TypeLimitModelEnum {
+    /**
+     * 该类中所有方法都采用相同的限流方式。例如，需要该类中每个方法每30秒只允许调用10次
+     */
+    EACH,
+    /**
+     * 该类进行整体限流。例如，需要该类中所有方法每30秒只允许调用10次
+     */
+    TOTAL;
+}

src/main/java/com/github/chqiuu/redis/limit/strategy/BaseCurrentLimiter.java

@@ -46,6 +46,25 @@ String getCurrentKey(JoinPoint joinPoint, LimitTypeEnum limitType, boolean isMet
         assert requestAttributes != null;
         HttpServletRequest request = requestAttributes.getRequest();
         switch (limitType) {
+            case SESSION_GLOBAL:
+                // 以SessionId作为key
+                if (request.getSession() != null) {
+                    key.append(request.getSession().getId());
+                } else {
+                    throw new CurrentLimitException("获取不到用户Session，request.getSession().getId()为空");
+                }
+                break;
+            case SESSION:
+                // 以SessionId加方法（或类）作为key
+                if (request.getSession() != null) {
+                    key.append(request.getSession().getId());
+                    if (isMethod) {
+                        key.append(getMethodName((MethodSignature) joinPoint.getSignature()));
+                    }
+                } else {
+                    throw new CurrentLimitException("获取不到用户Session，request.getSession().getId()为空");
+                }
+                break;
             case USER_GLOBAL:
                 // 以用户信息作为key
                 if (request.getUserPrincipal() != null) {