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

首先安装 tymon/jwt-auth 包并发布配置文件，接着生成 JWT 密钥；然后修改 auth.php 中的 api 驱动为 jwt，同时在 User 模型中实现 JWTSubject 接口；之后创建 APIAuthController 处理登录和登出逻辑，最后在 api.php 中定义路由并应用 auth: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 令牌，同时支持注销时使令牌失效。

集简云

软件集成平台，快速建立企业自动化与智能化

22

查看详情

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

  });

});

以上就是laravel怎么集成JWT（JSON Web Tokens）进行API认证_laravel JWT API认证集成方法的详细内容，更多请关注php中文网其它相关文章！