Laravel 的JWT、Laravel的JWT自定义Payload

在现代Web开发中，JWT（JSON Web Token）是一种常用的认证机制，它能够安全地在客户端和服务器之间传递信息。Laravel 是一个非常流行的PHP框架，支持多种认证方式，包括JWT。介绍如何在Laravel中使用JWT，并展示如何自定义JWT的payload。

解决方案

通过以下步骤解决如何在Laravel中使用JWT以及如何自定义JWT的payload：

1. 安装JWT库
2. 配置JWT
3. 创建JWT令牌
4. 自定义JWT payload
5. 验证JWT令牌

安装JWT库

我们需要安装JWT库。Laravel 社区中最常用的JWT库是 tymon/jwt-auth。可以通过Composer来安装：

bash
composer require tymon/jwt-auth


安装完成后，需要在 config/app.php 中注册服务提供者和门面：

php
// config/app.php</p>

<p>'providers' => [
    // ...
    TymonJWTAuthProvidersLaravelServiceProvider::class,
],</p>

<p>'aliases' => [
    // ...
    'JWTAuth' => TymonJWTAuthFacadesJWTAuth::class,
    'JWTFactory' => TymonJWTAuthFacadesJWTFactory::class,
],

接下来，发布JWT配置文件：

bash
php artisan vendor:publish --provider="TymonJWTAuthProvidersLaravelServiceProvider"


配置JWT

打开 config/jwt.php 文件，根据需要进行配置。例如，设置密钥：

php
'keys' => [
'secret' => env('JWT_SECRET', 'your-secret-key'),
],


确保在 .env 文件中设置 JWT_SECRET：

env
JWT_SECRET=your-secret-key


创建JWT令牌

在Laravel中，我们可以使用 JWTAuth 门面来创建JWT令牌。以下是一个示例控制器方法，用于生成JWT令牌：

php
use IlluminateHttpRequest;
use JWTAuth;
use TymonJWTAuthExceptionsJWTException;</p>

<p>class AuthController extends Controller
{
    public function login(Request $request)
    {
        $credentials = $request->only('email', 'password');</p>

<pre><code>    try {
        if (! $token = JWTAuth::attempt($credentials)) {
            return response()->json(['error' => 'invalid_credentials'], 401);
        }
    } catch (JWTException $e) {
        return response()->json(['error' => 'could_not_create_token'], 500);
    }

    return response()->json(compact('token'));
}

}

自定义JWT payload

默认情况下，JWT payload包含用户ID等基本信息。如果需要添加自定义数据，可以使用 JWTFactory 来创建自定义payload。

方法一：使用 JWTFactory

php
use TymonJWTAuthFacadesJWTFactory;</p>

<p>public function customPayload()
{
    $payload = JWTFactory::sub(1) // 用户ID
                         ->customClaim('role', 'admin') // 自定义claim
                         ->make();</p>

<pre><code>$token = JWTAuth::encode($payload);

return response()->json(compact('token'));

}

方法二：在 attempt 方法中自定义payload

你也可以在 attempt 方法中自定义payload：

php
use IlluminateHttpRequest;
use JWTAuth;
use TymonJWTAuthExceptionsJWTException;</p>

<p>class AuthController extends Controller
{
    public function login(Request $request)
    {
        $credentials = $request->only('email', 'password');</p>

<pre><code>    try {
        if (! $token = JWTAuth::attempt($credentials, ['role' => 'admin'])) {
            return response()->json(['error' => 'invalid_credentials'], 401);
        }
    } catch (JWTException $e) {
        return response()->json(['error' => 'could_not_create_token'], 500);
    }

    return response()->json(compact('token'));
}

}

验证JWT令牌

为了验证JWT令牌，可以在控制器中使用 auth:api 中间件：

php
use IlluminateHttpRequest;
use JWTAuth;</p>

<p>class UserController extends Controller
{
    public function __construct()
    {
        $this->middleware('auth:api');
    }</p>

<pre><code>public function profile()
{
    $user = JWTAuth::parseToken()->authenticate();

    return response()->json($user);
}

}

通过以上步骤，你可以在Laravel中成功使用JWT，并自定义JWT的payload。希望对你有所帮助！