README

方法

如果您在项目中选择 Tymon JWTAuth 作为 jwt 解决方案，当您尝试刷新令牌时，此包将黑名单您的交换令牌（假设您的黑名单功能已启用）。因此，当您的客户端遇到并发使用情况时，由于该请求是在您的应用程序更新由服务器返回的 jwt 令牌之前发送的，您的请求可能会被拒绝。此包将在短时间内缓存刷新的 jwt 令牌，以确保即使在并发情况下您的客户端也能获取正确的响应。

重要更改

我们将命名空间 Unisharp\JWT 更改为 UniSharp\JWT

安装

通过 Composer

composer require unisharp/laravel-jwt

添加服务提供者

Tymon\JWTAuth\Providers\LaravelServiceProvider::class,
UniSharp\JWT\JWTServiceProvider::class,

在 Lumen 中，请使用 Tymon\JWTAuth\Providers\LumenServiceProvider::class,

接下来，在 app.php 配置文件中，在别名数组下，您可能想添加 JWTAuth 门面。

'JWTAuth' => 'Tymon\JWTAuth\Facades\JWTAuth',
'JWTFactory' => 'Tymon\JWTAuth\Facades\JWTFactory'

最后，您将想要使用以下命令发布配置

php artisan vendor:publish --provider="Tymon\JWTAuth\Providers\JWTAuthServiceProvider"
php artisan vendor:publish --provider="UniSharp\JWT\JWTServiceProvider"

不要忘记在配置文件中设置一个密钥！

$ php artisan jwt:secret

这将生成一个新的随机密钥，该密钥将用于签名您的令牌。

您就完成了！

用法

打开您的 config/auth.php 配置文件，在您的任何保护程序下的驱动程序下，只需添加 jwt-auth 作为您的驱动程序即可。确保您还设置了保护程序的 provider 以与数据库通信。

设置保护程序驱动程序

// config/auth.php
'guards' => [
    'api' => [
        'driver' => 'jwt-auth',
        'provider' => 'users'
    ],
    
    // ...
],

'providers' => [
    'users' => [
        'driver' => 'eloquent',
        'model'  => App\User::class,
    ],
],

中间件使用

保护路由的中间件

Route::get('api/content', ['middleware' => 'laravel.jwt', 'uses' => 'ContentController@content']);

保护控制器的中间件

<?php

namespace App\Http\Controllers;

class ContentController extends Controller
{
    public function __construct() 
    {
        $this->middleware('laravel.jwt');
    }
}

此中间件将在现有令牌已过期的情况下自动刷新 jwt 令牌。新的刷新 jwt 令牌将携带到响应头：Ahthorization。客户端需要用新的令牌替换过期的 jwt 令牌。

注意：以上示例假设您已按照“设置保护程序驱动程序”部分中的说明在您的 config/auth.php 文件中设置了名为 api 的保护程序，其驱动程序为 jwt-auth。

以下用法示例假设您已将默认保护程序设置为使用 jwt-auth 驱动程序的保护程序。

您还可以通过在调用任何方法之前在它前面加上 Auth::guard('api') 来显式定义保护程序。

示例： Auth::guard('api')->user()

尝试认证并返回令牌

// This will attempt to authenticate the user using the credentials passed and returns a JWT Auth Token for subsequent requests.
$token = Auth::attempt(['email' => 'user@domain.com', 'password' => '123456']);

通过 ID 单次认证

if(Auth::onceUsingId(1)) {
    // Do something with the authenticated user
}

通过凭据单次认证

if(Auth::once(['email' => 'user@domain.com', 'password' => '123456'])) {
    // Do something with the authenticated user
}

验证凭据

if(Auth::validate(['email' => 'user@domain.com', 'password' => '123456'])) {
    // Credentials are valid
}

检查用户是否已认证

if(Auth::check()) {
    // User is authenticated
}

检查用户是否为访客

if(Auth::guest()) {
    // Welcome guests!
}

注销已认证用户

Auth::logout(); // This will invalidate the current token and unset user/token values.

通过 ID 生成 JWT 认证令牌

$token = Auth::generateTokenById(1);

echo $token;

获取已认证用户

一旦用户通过中间件进行认证，您可以通过以下方式访问其详细信息：

$user = Auth::user();

您也可以使用令牌本身手动访问用户信息

$user = Auth::setToken('YourJWTAuthToken')->user();

获取已认证用户的 ID

$userId = Auth::id();

刷新过期的令牌

虽然建议您使用包提供的中间件进行刷新，但如果您愿意，您也可以使用此方法手动刷新。

刷新请求中传递的过期的令牌

$token = Auth::refresh();

刷新传递的过期令牌

Auth::setToken('ExpiredToken')->refresh();

使令牌无效

使请求中传递的令牌无效

$forceForever = false;
Auth::invalidate($forceForever);

通过手动设置使令牌无效

$forceForever = false;
Auth::setToken('TokenToInvalidate')->invalidate($forceForever);

获取令牌

$token = Auth::getToken(); // Returns current token passed in request.

获取令牌有效载荷

此方法将解码令牌并返回其原始有效载荷。

获取请求中传入的令牌的负载

$payload = Auth::getPayload();

手动获取给定令牌的负载

$payload = Auth::setToken('TokenToGetPayload')->getPayload();

unisharp / laravel-jwt

维护者

详细信息