0

0

laravel怎么集成JWT(JSON Web Tokens)进行API认证_laravel JWT API认证集成方法

裘德小鎮的故事

裘德小鎮的故事

发布时间:2025-11-03 22:37:02

|

719人浏览过

|

来源于php中文网

原创

首先安装 tymon/jwt-auth 包并发布配置文件,接着生成 JWT 密钥;然后修改 auth.php 中的 api 驱动为 jwt,同时在 User 模型中实现 JWTSubject 接口;之后创建 APIAuthController 处理登录和登出逻辑,最后在 api.php 中定义路由并应用 auth:api 中间件保护接口。

laravel怎么集成jwt(json web tokens)进行api认证_laravel jwt api认证集成方法

如果您正在开发一个基于 Laravel 的 API 应用,并希望实现无状态的用户认证机制,JWT(JSON Web Tokens)是一个理想的选择。它能够在客户端和服务器之间安全地传递用户身份信息。以下是将 JWT 集成到 Laravel 项目中进行 API 认证的具体步骤。

本文运行环境:MacBook Pro,macOS Sonoma

一、安装 tymon/jwt-auth 扩展包

要使用 JWT 功能,需要引入社区广泛使用的 tymon/jwt-auth Composer 包,它是 Laravel 中集成 JWT 的主流解决方案。

1、打开终端并进入您的 Laravel 项目根目录。

2、执行以下命令来安装 jwt-auth 包:

composer require tymon/jwt-auth

二、发布 JWT 配置文件

安装完成后,需要生成 JWT 的配置文件以便自定义令牌行为,例如过期时间、加密算法等。

1、运行以下 Artisan 命令以发布配置文件:

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

2、该操作会在 config/ 目录下创建一个名为 jwt.php 的配置文件,供后续修改使用。

三、生成 JWT 密钥

为了确保 token 的安全性,必须生成一个用于签名的密钥。这个密钥将被用来编码和解码 JWT。

1、在终端中执行以下命令生成 SECRET_KEY:

php artisan jwt:secret

2、此命令会自动在 .env 文件中添加一行 JWT_SECRET=随机字符串,无需手动设置。

四、配置 auth.php 支持 JWT 驱动

Laravel 的认证系统需要知道使用 JWT 作为驱动,因此需修改默认的身份验证配置。

1、打开 config/auth.php 文件。

2、找到 'guards' 数组中的 api 项,将其 driver 值从 token 修改为 jwt

'api' => [

  'driver' => 'jwt',

  'provider' => 'users',

],

五、在 User 模型中引入 JWT Subject 协议

JWT 需要能够从用户模型中提取唯一标识符(通常是主键),因此需要让 User 类实现必要的接口。

1、打开 app/Models/User.php 文件(或您实际的用户模型路径)。

2、在类中引入 Tymon\JWTAuth\Contracts\JWTSubject 接口:

use Tymon\JWTAuth\Contracts\JWTSubject;

3、让 User 类实现该接口并添加两个必需方法:

public function getJWTIdentifier()

{

  return $this->getKey(); // 返回主键值

}

public function getJWTCustomClaims()

{

  return []; // 可添加自定义声明

}

六、创建 API 认证控制器处理登录与登出

需要创建一个控制器来处理用户的登录请求并返回 JWT 令牌,同时支持注销时使令牌失效。

Lyrics Generator
Lyrics Generator

免费人工智能歌词生成器和人工智能歌曲作家

下载

1、使用 Artisan 命令生成控制器:

php artisan make:controller Auth/APIAuthController

2、在控制器中添加 login 方法,验证凭据后返回 token:

use JWTAuth;

use Illuminate\Http\Request;

public function login(Request $request)

{

  $credentials = $request->only('email', 'password');

  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'));

}

3、添加 logout 方法用于退出登录:

public function logout()

{

  JWTAuth::invalidate(JWTAuth::getToken());

  return response()->json(['message' => 'Successfully logged out']);

}

七、定义 API 路由并应用中间件保护

通过路由注册认证端点,并使用 JWT 中间件保护需要身份验证的接口。

1、打开 routes/api.php 文件。

2、添加如下路由:

use App\Http\Controllers\Auth\APIAuthController;

Route::post('login', [APIAuthController::class, 'login']);

Route::middleware('auth:api')->group(function () {

  Route::post('logout', [APIAuthController::class, 'logout']);

  Route::get('user', function () {

    return auth()->user();

  });

});

相关专题

更多
php文件怎么打开
php文件怎么打开

打开php文件步骤:1、选择文本编辑器;2、在选择的文本编辑器中,创建一个新的文件,并将其保存为.php文件;3、在创建的PHP文件中,编写PHP代码;4、要在本地计算机上运行PHP文件,需要设置一个服务器环境;5、安装服务器环境后,需要将PHP文件放入服务器目录中;6、一旦将PHP文件放入服务器目录中,就可以通过浏览器来运行它。

2643

2023.09.01

php怎么取出数组的前几个元素
php怎么取出数组的前几个元素

取出php数组的前几个元素的方法有使用array_slice()函数、使用array_splice()函数、使用循环遍历、使用array_slice()函数和array_values()函数等。本专题为大家提供php数组相关的文章、下载、课程内容,供大家免费下载体验。

1635

2023.10.11

php反序列化失败怎么办
php反序列化失败怎么办

php反序列化失败的解决办法检查序列化数据。检查类定义、检查错误日志、更新PHP版本和应用安全措施等。本专题为大家提供php反序列化相关的文章、下载、课程内容,供大家免费下载体验。

1513

2023.10.11

php怎么连接mssql数据库
php怎么连接mssql数据库

连接方法:1、通过mssql_系列函数;2、通过sqlsrv_系列函数;3、通过odbc方式连接;4、通过PDO方式;5、通过COM方式连接。想了解php怎么连接mssql数据库的详细内容,可以访问下面的文章。

952

2023.10.23

php连接mssql数据库的方法
php连接mssql数据库的方法

php连接mssql数据库的方法有使用PHP的MSSQL扩展、使用PDO等。想了解更多php连接mssql数据库相关内容,可以阅读本专题下面的文章。

1418

2023.10.23

html怎么上传
html怎么上传

html通过使用HTML表单、JavaScript和PHP上传。更多关于html的问题详细请看本专题下面的文章。php中文网欢迎大家前来学习。

1234

2023.11.03

PHP出现乱码怎么解决
PHP出现乱码怎么解决

PHP出现乱码可以通过修改PHP文件头部的字符编码设置、检查PHP文件的编码格式、检查数据库连接设置和检查HTML页面的字符编码设置来解决。更多关于php乱码的问题详情请看本专题下面的文章。php中文网欢迎大家前来学习。

1447

2023.11.09

php文件怎么在手机上打开
php文件怎么在手机上打开

php文件在手机上打开需要在手机上搭建一个能够运行php的服务器环境,并将php文件上传到服务器上。再在手机上的浏览器中输入服务器的IP地址或域名,加上php文件的路径,即可打开php文件并查看其内容。更多关于php相关问题,详情请看本专题下面的文章。php中文网欢迎大家前来学习。

1306

2023.11.13

高德地图升级方法汇总
高德地图升级方法汇总

本专题整合了高德地图升级相关教程,阅读专题下面的文章了解更多详细内容。

68

2026.01.16

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Laravel---API接口
Laravel---API接口

共7课时 | 0.6万人学习

PHP自制框架
PHP自制框架

共8课时 | 0.6万人学习

PHP面向对象基础课程(更新中)
PHP面向对象基础课程(更新中)

共12课时 | 0.7万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号