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

2024-06-04 19:04

本文主要是介绍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 登录验证(案例实战)的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/1030857

相关文章

SpringBoot集成redisson实现延时队列教程

《SpringBoot集成redisson实现延时队列教程》文章介绍了使用Redisson实现延迟队列的完整步骤,包括依赖导入、Redis配置、工具类封装、业务枚举定义、执行器实现、Bean创建、消费... 目录1、先给项目导入Redisson依赖2、配置redis3、创建 RedissonConfig 配

Python的Darts库实现时间序列预测

《Python的Darts库实现时间序列预测》Darts一个集统计、机器学习与深度学习模型于一体的Python时间序列预测库,本文主要介绍了Python的Darts库实现时间序列预测,感兴趣的可以了解... 目录目录一、什么是 Darts?二、安装与基本配置安装 Darts导入基础模块三、时间序列数据结构与

Python使用FastAPI实现大文件分片上传与断点续传功能

《Python使用FastAPI实现大文件分片上传与断点续传功能》大文件直传常遇到超时、网络抖动失败、失败后只能重传的问题,分片上传+断点续传可以把大文件拆成若干小块逐个上传,并在中断后从已完成分片继... 目录一、接口设计二、服务端实现(FastAPI)2.1 运行环境2.2 目录结构建议2.3 serv

C#实现千万数据秒级导入的代码

《C#实现千万数据秒级导入的代码》在实际开发中excel导入很常见,现代社会中很容易遇到大数据处理业务,所以本文我就给大家分享一下千万数据秒级导入怎么实现,文中有详细的代码示例供大家参考,需要的朋友可... 目录前言一、数据存储二、处理逻辑优化前代码处理逻辑优化后的代码总结前言在实际开发中excel导入很

MyBatis分页查询实战案例完整流程

《MyBatis分页查询实战案例完整流程》MyBatis是一个强大的Java持久层框架,支持自定义SQL和高级映射,本案例以员工工资信息管理为例,详细讲解如何在IDEA中使用MyBatis结合Page... 目录1. MyBATis框架简介2. 分页查询原理与应用场景2.1 分页查询的基本原理2.1.1 分

Spring Security简介、使用与最佳实践

《SpringSecurity简介、使用与最佳实践》SpringSecurity是一个能够为基于Spring的企业应用系统提供声明式的安全访问控制解决方案的安全框架,本文给大家介绍SpringSec... 目录一、如何理解 Spring Security?—— 核心思想二、如何在 Java 项目中使用?——

SpringBoot+RustFS 实现文件切片极速上传的实例代码

《SpringBoot+RustFS实现文件切片极速上传的实例代码》本文介绍利用SpringBoot和RustFS构建高性能文件切片上传系统,实现大文件秒传、断点续传和分片上传等功能,具有一定的参考... 目录一、为什么选择 RustFS + SpringBoot?二、环境准备与部署2.1 安装 RustF

Nginx部署HTTP/3的实现步骤

《Nginx部署HTTP/3的实现步骤》本文介绍了在Nginx中部署HTTP/3的详细步骤,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学... 目录前提条件第一步:安装必要的依赖库第二步:获取并构建 BoringSSL第三步:获取 Nginx

springboot中使用okhttp3的小结

《springboot中使用okhttp3的小结》OkHttp3是一个JavaHTTP客户端,可以处理各种请求类型,比如GET、POST、PUT等,并且支持高效的HTTP连接池、请求和响应缓存、以及异... 在 Spring Boot 项目中使用 OkHttp3 进行 HTTP 请求是一个高效且流行的方式。

MyBatis Plus实现时间字段自动填充的完整方案

《MyBatisPlus实现时间字段自动填充的完整方案》在日常开发中,我们经常需要记录数据的创建时间和更新时间,传统的做法是在每次插入或更新操作时手动设置这些时间字段,这种方式不仅繁琐,还容易遗漏,... 目录前言解决目标技术栈实现步骤1. 实体类注解配置2. 创建元数据处理器3. 服务层代码优化填充机制详