[PHP知识库]Lumen 9.x 对路由限流的正确姿势【别乱抄代码了】

希望大家找到正确的操作姿势，不要直接网上生搬，其实框架内内置好了一些方法的。

配置中间件

中间件类

首先去 Laravel 拿到中间件源码：ThrottleRequests.php，然后在 app/Http/Middleware 内（可以自己任意再建立子文件夹）创建该文件。

此处我将该中间件放置到了 app/Http/Middleware/Route 目录下。

注意，我这里为了兼容 PHP 8，使用了强数据类型，根据实际环境修改该方法即可。

<?php

namespace App\Http\Middleware\Route;

// 省略 use 部分

class ThrottleRequests {
	
	// 省略前文

    /**
     * Resolve request signature.
     *
     * @param Request $request
     *
     * @return string
     *
     * @throws RuntimeException
     */
    protected function resolveRequestSignature(Request $request): string {
        // 此处加入该注释是为了让 IDE 识别 $user 变量的具体类型
        /** @var Authenticatable|null $user */
        if ($user = $request->user()) {
            // 这里在 PHPStorm/IDEA 中按住 Ctrl 后鼠标左键是可以点击进 getAuthIdentifier 方法的
            // 这是已登录（通过验证）状态下的唯一指纹
            return sha1($user->getAuthIdentifier());
        }
        
        // 未登录时 fingerprint 方法已实现了一套生成唯一指纹操作
        return $request->fingerprint();
    }
}

别再去网上抄这个代码去替换该方法了：

return sha1(
    $request->method() .
    '|' . $request->server('SERVER_NAME') .
    '|' . $request->path() .
    '|' . $request->ip()
);

应用中间件

打开 bootstrap/app.php 文件，在中间件部分应用如下设置：

$app->routeMiddleware([
    // 中间件命名可任意变更
    'auth' => App\Http\Middleware\Route\Authenticate::class, // 对应自己的登录验证中间件
    'throttle' => App\Http\Middleware\Route\ThrottleRequests::class,
]);

打开 routes/web.php 将中间件应用至路由：

$router->group([
    'namespace' => 'Home',
    'middleware' => [
        'throttle:60,1' // 次数,分钟（此为 60 次请求每分钟）
    ]
], function (Router $router) {
    $router->get('home/index', 'HomeController@index');
});

修正会出现的错误

说明

上方的操作执行完后，用户在已登录（通过 auth 中间件验证）状态下，会抛出一个异常，这是因为登录状态的唯一指纹是根据用户的 id 来的，也就是 primaryKey。

我们先来看看在 Lumen 中对用户 Token 验证的流程：

1. 用户的 Token 首先进入 App\Providers\AuthServiceProvider，通过 boot 方法中框架容器内的 viaRequest 方法进行基础验证；
2. viaRequest 方法必需返回 用户实例 或者 null，也就是说验证成功时返回的一定是一个继承自 Illuminate\Database\Eloquent\Model 的对象；
3. 请求会流转到各个中间件，比如 auth 中间件中可以做一些判断进行不同的响应（Token 过期等）。

为什么说会出现错误？前面我们为 $user 变量设置了一个数据类型注释 Authenticatable，此处的限流中间件需要获取到 primaryKey 然后在实例中拿到具体的主键数值。

实现

其实框架默认的 app/User.php 用户模型已经给出了示例，如果删掉了，参考下方操作实现即可。

假设我们的用户模型 UserModel 已创建（不用考虑所在位置），不必多说该类一定继承自 Illuminate\Database\Eloquent\Model，当然如果自己在中间实现了一个抽象 Model 类也不影响。

首先引入这些内容：

use Illuminate\Auth\Authenticatable;
use Illuminate\Contracts\Auth\Access\Authorizable as AuthorizableContract;
use Illuminate\Contracts\Auth\Authenticatable as AuthenticatableContract;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Laravel\Lumen\Auth\Authorizable;

随后让用户模型类实现上方引入的两个 Contract：

class UserModel extends Model implements AuthenticatableContract, AuthorizableContract {  }

此时 IDE 已经红线报错了，不急，继续在类中引入 3 个 trait：

class UserModel extends Model implements AuthenticatableContract, AuthorizableContract {

    use Authenticatable, Authorizable, HasFactory;
}

此处需注意，如果主键不是 id 而是 user_id 时，需要在该类中指定成员变量 protected $primaryKey = 'user_id';

合并一下代码：

use Illuminate\Auth\Authenticatable;
use Illuminate\Contracts\Auth\Access\Authorizable as AuthorizableContract;
use Illuminate\Contracts\Auth\Authenticatable as AuthenticatableContract;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Laravel\Lumen\Auth\Authorizable;

class UserModel extends Model implements AuthenticatableContract, AuthorizableContract {

    use Authenticatable, Authorizable, HasFactory;

    protected $table = 'user';

    protected $primaryKey = 'user_id';
}

至此，一个完整的兼容 Lumen 框架的路由限流中间件完成。