同步

Author: Yurunsoft

src/Annotation/BlockingConsumer.php

@@ -1,33 +1,34 @@
 <?php
+
 namespace Imi\RateLimit\Annotation;
 
 use Imi\Bean\Annotation\Base;
 use Imi\Bean\Annotation\Parser;
 
 /**
- * 阻塞等待消费
- * 
+ * 阻塞等待消费.
+ *
  * 当触发限流时，自动阻塞（协程挂起）等待
- * 
+ *
  * @Annotation
  * @Target("METHOD")
  * @Parser("\Imi\Bean\Parser\NullParser")
  */
 class BlockingConsumer extends Base
 {
     /**
-     * 只传一个参数时的参数名
+     * 只传一个参数时的参数名.
+     *
      * @var string
      */
     protected $defaultFieldName = 'timeout';
 
     /**
-     * 超时时间，单位：秒
-     * 
+     * 超时时间，单位：秒.
+     *
      * 为 null 不限制
      *
      * @var int|null
      */
     public $timeout;
-
-}
+}

src/Annotation/RateLimit.php

@@ -1,68 +1,69 @@
 <?php
+
 namespace Imi\RateLimit\Annotation;
 
 use Imi\Bean\Annotation\Base;
 use Imi\Bean\Annotation\Parser;
 
 /**
- * 限流器注解
+ * 限流器注解.
+ *
  * @Annotation
  * @Target("METHOD")
  * @Parser("\Imi\Bean\Parser\NullParser")
  */
 class RateLimit extends Base
 {
     /**
-     * 限流器名称
+     * 限流器名称.
      *
      * @var string
      */
     public $name;
 
     /**
-     * 总容量
+     * 总容量.
      *
      * @var int
      */
     public $capacity;
 
     /**
-     * 单位时间内生成填充的数量
-     * 
+     * 单位时间内生成填充的数量.
+     *
      * 不设置或为null时，默认值与 $capacity 相同
      *
      * @var int
      */
     public $fill;
 
     /**
-     * 单位时间，默认为：秒(second)
-     * 
+     * 单位时间，默认为：秒(second).
+     *
      * 支持：microsecond、millisecond、second、minute、hour、day、week、month、year
      *
      * @var string
      */
     public $unit = 'second';
 
     /**
-     * 每次扣除数量，默认为1
+     * 每次扣除数量，默认为1.
      *
      * @var int
      */
     public $deduct = 1;
 
     /**
-     * 触发限流的回调
+     * 触发限流的回调.
      *
      * @var callable
      */
     public $callback;
 
     /**
-     * 连接池名称，留空取默认 redis 连接池
+     * 连接池名称，留空取默认 redis 连接池.
      *
      * @var string|null
      */
     public $poolName;
-
-}
+}

src/Annotation/WorkerLimit.php

@@ -1,52 +1,53 @@
 <?php
+
 namespace Imi\RateLimit\Annotation;
 
 use Imi\Bean\Annotation\Base;
 use Imi\Bean\Annotation\Parser;
 
 /**
- * 并发工作数限制注解
+ * 并发工作数限制注解.
+ *
  * @Annotation
  * @Target("METHOD")
  * @Parser("\Imi\Bean\Parser\NullParser")
  */
 class WorkerLimit extends Base
 {
     /**
-     * 限流器名称
+     * 限流器名称.
      *
      * @var string
      */
     public $name;
 
     /**
-     * 最大同时工作数量
+     * 最大同时工作数量.
      *
      * @var int
      */
     public $max;
 
     /**
-     * 工作超时时间，单位：秒，支持小数点精确到毫秒
-     * 
+     * 工作超时时间，单位：秒，支持小数点精确到毫秒.
+     *
      * 默认为null，则不限制（不推荐不安全，有隐患）
      *
      * @var float|null
      */
     public $timeout;
 
     /**
-     * 触发限流的回调
+     * 触发限流的回调.
      *
      * @var callable
      */
     public $callback;
 
     /**
-     * 连接池名称，留空取默认 redis 连接池
+     * 连接池名称，留空取默认 redis 连接池.
      *
      * @var string|null
      */
     public $poolName;
-
-}
+}

src/Aspect/RateLimitAspect.php

@@ -1,16 +1,17 @@
 <?php
+
 namespace Imi\RateLimit\Aspect;
 
-use Imi\Aop\PointCutType;
-use Imi\Bean\BeanFactory;
-use Imi\Aop\AroundJoinPoint;
 use Imi\Aop\Annotation\Around;
 use Imi\Aop\Annotation\Aspect;
-use Imi\RateLimit\RateLimiter;
 use Imi\Aop\Annotation\PointCut;
-use Imi\RateLimit\Annotation\RateLimit;
+use Imi\Aop\AroundJoinPoint;
+use Imi\Aop\PointCutType;
 use Imi\Bean\Annotation\AnnotationManager;
+use Imi\Bean\BeanFactory;
 use Imi\RateLimit\Annotation\BlockingConsumer;
+use Imi\RateLimit\Annotation\RateLimit;
+use Imi\RateLimit\RateLimiter;
 
 /**
  * @Aspect
@@ -19,30 +20,34 @@ class RateLimitAspect
 {
     /**
      * 处理限流
+     *
      * @PointCut(
      *         type=PointCutType::ANNOTATION,
      *         allow={
      *             RateLimit::class
      *         }
      * )
      * @Around
+     *
      * @return mixed
      */
     public function parse(AroundJoinPoint $joinPoint)
     {
         $className = BeanFactory::getObjectClass($joinPoint->getTarget());
         $method = $joinPoint->getMethod();
+        /** @var RateLimit|null $rateLimit */
         $rateLimit = AnnotationManager::getMethodAnnotations($className, $method, RateLimit::class)[0] ?? null;
+        /** @var BlockingConsumer|null $blockingConsumer */
         $blockingConsumer = AnnotationManager::getMethodAnnotations($className, $method, BlockingConsumer::class)[0] ?? null;
-        if(null === $blockingConsumer)
+        if (null === $blockingConsumer)
         {
             $result = RateLimiter::limit($rateLimit->name, $rateLimit->capacity, $rateLimit->callback, $rateLimit->fill, $rateLimit->unit, $rateLimit->deduct, $rateLimit->poolName);
         }
         else
         {
             $result = RateLimiter::limitBlock($rateLimit->name, $rateLimit->capacity, $rateLimit->callback, $blockingConsumer->timeout, $rateLimit->fill, $rateLimit->unit, $rateLimit->deduct, $rateLimit->poolName);
         }
-        if(true === $result)
+        if (true === $result)
         {
             return $joinPoint->proceed();
         }

src/Aspect/WorkerLimitAspect.php

@@ -1,15 +1,16 @@
 <?php
+
 namespace Imi\RateLimit\Aspect;
 
-use Imi\Aop\PointCutType;
-use Imi\Bean\BeanFactory;
-use Imi\Aop\AroundJoinPoint;
 use Imi\Aop\Annotation\Around;
 use Imi\Aop\Annotation\Aspect;
 use Imi\Aop\Annotation\PointCut;
-use Imi\RateLimit\Annotation\WorkerLimit;
+use Imi\Aop\AroundJoinPoint;
+use Imi\Aop\PointCutType;
 use Imi\Bean\Annotation\AnnotationManager;
+use Imi\Bean\BeanFactory;
 use Imi\RateLimit\Annotation\BlockingConsumer;
+use Imi\RateLimit\Annotation\WorkerLimit;
 use Imi\RateLimit\WorkerLimiter;
 
 /**
@@ -19,33 +20,38 @@ class WorkerLimitAspect
 {
     /**
      * 处理工作限流
+     *
      * @PointCut(
      *         type=PointCutType::ANNOTATION,
      *         allow={
      *             WorkerLimit::class
      *         }
      * )
      * @Around
+     *
      * @return mixed
      */
     public function parse(AroundJoinPoint $joinPoint)
     {
         $className = BeanFactory::getObjectClass($joinPoint->getTarget());
         $method = $joinPoint->getMethod();
+        /** @var WorkerLimit|null $workerLimit */
         $workerLimit = AnnotationManager::getMethodAnnotations($className, $method, WorkerLimit::class)[0] ?? null;
+        /** @var BlockingConsumer|null $blockingConsumer */
         $blockingConsumer = AnnotationManager::getMethodAnnotations($className, $method, BlockingConsumer::class)[0] ?? null;
-        if(null === $blockingConsumer)
+        if (null === $blockingConsumer)
         {
-            $result = WorkerLimiter::call(function() use($joinPoint){
+            $result = WorkerLimiter::call(function () use ($joinPoint) {
                 return $joinPoint->proceed();
             }, $workerLimit->name, $workerLimit->max, $workerLimit->timeout, $workerLimit->callback, $workerLimit->poolName);
         }
         else
         {
-            $result = WorkerLimiter::callBlock(function() use($joinPoint){
+            $result = WorkerLimiter::callBlock(function () use ($joinPoint) {
                 return $joinPoint->proceed();
             }, $workerLimit->name, $workerLimit->max, $workerLimit->timeout, $blockingConsumer->timeout, $workerLimit->callback, $workerLimit->poolName);
         }
+
         return $result;
     }
 }

src/Exception/RateLimitException.php

@@ -1,10 +1,10 @@
 <?php
+
 namespace Imi\RateLimit\Exception;
 
 /**
- * 限流异常
+ * 限流异常.
  */
 class RateLimitException extends \Exception
 {
-
-}
+}