Laravel 中使用 jwt-auth 实现用户 Token 登录验证（案例实战）

本文主要是介绍Laravel 中使用 jwt-auth 实现用户 Token 登录验证（案例实战），希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

        jwt-auth（JSON Web Token Authentication）是一种基于 JSON Web Token（JWT）的用户认证机制。它是一个流行的身份验证方案，通过在用户登录后生成令牌（Token），并在每次请求中传递该令牌来验证用户身份。

下面是 jwt-auth 的工作原理：

1. 用户登录：用户提供有效的凭证（如用户名和密码）进行登录请求。
2. 生成 Token：服务器验证用户的凭证，并为用户生成一个基于 JWT 的 Token。
3. 返回 Token：服务器将生成的 Token 返回给客户端作为身份验证凭证。
4. 客户端存储 Token：客户端（通常是前端应用程序）将收到的 Token 存储在本地，可以使用 Cookie、LocalStorage 或其他机制进行存储。
5. 发送 Token：在每次请求中，客户端将 Token 作为 Authorization 头或请求参数的一部分发送给服务器。
6. 验证 Token：服务器接收到请求后，会验证收到的 Token 的有效性和合法性。
7. 鉴权：如果 Token 有效且合法，服务器会使用其中的信息来鉴定用户身份，并根据需要授权用户访问相应的资源。
8. 处理请求：如果用户通过了身份验证和授权，服务器会处理请求并返回相应的数据。

JWT Token 的结构一般包含三部分：Header、Payload 和 Signature。Header 包含了 Token 类型和算法信息；Payload 包含了 Token 的声明和自定义的附加信息；Signature 是对前两部分数据的签名，用于验证 Token 的完整性和身份验证。

        在 Laravel 框架中，我们可以使用 jwt-auth 扩展包来轻松实现用户 Token 登录验证功能。jwt-auth 提供了简单易用的接口和功能，帮助我们生成和验证使用 JWT 的用户令牌。

步骤一：安装和配置 jwt-auth

        首先，我们需要在 Laravel 项目中安装 jwt-auth 扩展包。打开终端，进入项目根目录，并执行以下命令：

composer require tymon/jwt-auth

安装完成后，我们需要执行一系列的配置步骤。首先，运行以下命令发布 jwt-auth 的核心配置文件和数据库迁移文件：

php artisan vendor:publish --provider="Tymon\JWTAuth\Providers\LaravelServiceProvider"

接下来，生成 jwt-auth 的秘钥：

php artisan jwt:secret

这将会生成一个随机字符串，并自动将其添加到 .env 文件中。

步骤二：配置用户模型和认证逻辑

在我们开始使用 jwt-auth 扩展包之前，我们需要配置相关的用户模型和认证逻辑。

首先，让我们创建一个 User 模型，并执行相应的数据库迁移。可以使用以下命令生成用户模型和迁移文件：

php artisan make:model User -m

        执行完毕后，你可以在 app 目录下找到 User 模型文件和 database/migrations 目录中生成的用户迁移文件。如果你已经有user模型了，跳过上面步骤。

        接下来，打开 User 模型文件，我们需要实现 Tymon\JWTAuth\Contracts\JWTSubject 接口中的两个方法：getJWTIdentifier 和 getJWTCustomClaims。

<?phpnamespace App\Models;use Illuminate\Contracts\Auth\MustVerifyEmail;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Foundation\Auth\User as Authenticatable;
use Illuminate\Notifications\Notifiable;
use Tymon\JWTAuth\Contracts\JWTSubject;class User extends Authenticatable  implements JWTSubject
{use HasFactory, Notifiable;/*** The attributes that are mass assignable.** @var array*/protected $fillable = ['unionid', 'token', 'expires_at', 'nickname', 'avatar', 'created_at', 'updated_at'];/*** The attributes that should be hidden for arrays.** @var array*/protected $hidden = [
//        'password', 'remember_token',];/*** The attributes that should be cast to native types.** @var array*/protected $casts = ['email_verified_at' => 'datetime',];// 声明 JWTSubject 接口必须实现的方法public function getJWTIdentifier(){return $this->getKey();}public function getJWTCustomClaims(){return [];}
}

在 getJWTIdentifier 方法中，我们返回用户的唯一标识，通常是用户的 ID。在 getJWTCustomClaims 方法中，我们可以返回其他自定义的声明。

接下来，打开 config/auth.php 配置文件，确保 guards 中的 api 驱动使用 jwt-auth 驱动。这样 Laravel 将使用 jwt-auth 进行用户认证。

'guards' => [// ...'api' => ['driver' => 'jwt','provider' => 'users',],
],

步骤三：实现用户登录验证

现在，我们可以开始实现用户 Token 登录验证的功能了。

首先，创建一个新的控制器，用于处理用户登录逻辑：

php artisan make:controller AuthController

打开 AuthController 文件，我们可以在其中添加一个 login 方法，用于验证用户的身份信息，并生成并返回 JWT Token。

use Illuminate\Support\Facades\Auth;
use Tymon\JWTAuth\Facades\JWTAuth;public function login($code) {try {// 获取第三方登录后的 unionid$login = WechatApi::getPlatform($code);if (!$login) {throw new Exception('获取用户信息失败');}// 查找或创建对应的用户$user = User::where('unionid', $login['unionid'])->first();if (!$user) {$user = new User();$user->unionid = $login['unionid'];$user->nickname = '用户' . rand(1000, 9999);$user->save();$platfroms = UserPlatforms::create(['user_id' => $user->id,'platform_type' => 1,'platform_identifier' => $login['openid'],'access_token' => $login['access_token'],'expires_at' => date('Y-m-d H:i:s', time() + 6000),]);}// 使用 Auth::login() 方法手动登录用户Auth::login($user);// 生成并返回 JWT Token$token = JWTAuth::fromUser(Auth::user());$user->token = $token;return $user;} catch (Exception $e) {throw new Exception($e->getMessage(), $e->getCode());}}

        上述代码中，我们首先通过方法查找或创建对应的用户记录。然后，使用 Auth::login() 方法手动登录用户，将用户信息存入当前会话中。

        最后，使用 JWTAuth::fromUser() 方法为登录的用户生成 JWT，并将生成的 Token 返回给前端。

        前端在收到 Token 后，可以将其存储在客户端（如 LocalStorage 或 Cookie）中，并在后续的请求中作为授权凭证进行身份验证。

        创建一个新的中间件（例如 AuthenticateUser）来验证用户是否登录，并检查用户的身份认证信息是否有效。

在终端中运行以下命令创建新的中间件：

php artisan make:middleware AuthenticateUser

然后，在生成的中间件类中，可以这样编写逻辑来验证用户身份：

<?phpnamespace App\Http\Middleware;use App\Helpers\ApiResponse;
use Closure;
use Illuminate\Http\Request;
use Mockery\Exception;
use Tymon\JWTAuth\Exceptions\TokenInvalidException;
use Tymon\JWTAuth\Facades\JWTAuth;class AuthenticateUser {/*** 用户登录验证** @param \Illuminate\Http\Request $request* @param \Closure(\Illuminate\Http\Request): (\Illuminate\Http\Response|\Illuminate\Http\RedirectResponse) $next* @return \Illuminate\Http\JsonResponse*/public function handle(Request $request, Closure $next) {try {// 检查用户是否登录$token = JWTAuth::parseToken(); // 解析 Token$user = $token->authenticate(); // 从 Token 获取用户信息if ($user) {// 将 $user 存储到请求的属性中$request->attributes->set('user', $user);return $next($request);} else {return ApiResponse::error('用户不存在请重新登录', ApiResponse::TOKEN_INVALID_CODE);}} catch (TokenInvalidException $e) {// 将 TokenInvalidException 异常重新抛出return ApiResponse::error('token失效或错误', ApiResponse::TOKEN_INVALID_CODE);} catch (Exception $e) {// 处理其他异常情况return ApiResponse::error('验证令牌错误', ApiResponse::TOKEN_INVALID_CODE);}}
}

接下来，在 app/Http/Kernel.php 文件的 $routeMiddleware 数组中注册中间件：

protected $routeMiddleware = [// ...'auth.user' => \App\Http\Middleware\AuthenticateUser::class,
];

然后，将中间件应用到 user/getMusic 路由上。可以在 routes/api.php 文件中定义该路由：

Route::get('user/getMusic', 'UserController@getMusic')->middleware('auth.user');

        现在，当请求到达 user/getMusic 路由时，中间件会自动检查用户是否已登录。如果用户已登录，请求将会继续传递给相应的控制器方法处理；如果用户未登录，将会返回未授权的错误响应。

这篇关于Laravel 中使用 jwt-auth 实现用户 Token 登录验证（案例实战）的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！

---