插件窝 干货文章 在ThinkPHP6中使用JWT进行认证

在ThinkPHP6中使用JWT进行认证

jwt token 中间件 AuthMiddleware 201    来源:    2024-10-24

在如今互联网应用大规模开发中,用户的安全认证是必不可少的一部分。为了确保用户的安全,常见的做法是使用json web token(jwt)进行身份验证。它可以轻松有效地实现用户身份验证和权限控制。在本文中,我们将介绍如何在thinkphp6项目中使用jwt进行认证。

什么是JSON Web Token?

JSON Web Token(JWT)是一种轻量级的身份验证机制。它的作用是在网络上安全地传输声明,它可以被用作身份验证和声明交换的一种方式。JWT包含在HTTP请求头或URL参数中,所以很容易便捷地在服务端和客户端之间传输。

JWT由三个部分组成:头部、载荷和签名。头部包含了描述签名算法和类型的信息,载荷包含了声明和数据信息,签名则用于验证JWT的合法性。JWT的载荷中可以存储任何数据,你可以自定义需要的信息。

在ThinkPHP6中使用JWT进行认证的步骤

立即学习“PHP免费学习笔记(深入)”;

步骤一:安装 jwt-auth 扩展

首先,我们需要在项目中引入 jwt-auth 扩展。在 composer.json 文件中添加如下依赖:

"tymon/jwt-auth": "^1.0.0-rc.5"

在安装完依赖后使用 composer update 更新一下。

步骤二:生成配置文件

运行下面的命令生成配置文件:

php think jwt:publish

生成配置文件后,我们需要修改配置,设置 JWT 密钥和有效期等参数,修改 /config/jwt.php 文件即可。

步骤三:编写认证中间件

JWT 的认证过程需要在服务器端完成。因此,我们需要创建一个中间件 AuthMiddleware,在请求到达控制器前,对 JWT 进行认证。

首先,我们需要创建 AuthMiddleware 文件:

php think make:middleware AuthMiddleware

在 AuthMiddleware 文件中,我们可以使用如下代码对 JWT 进行认证:

<?php
namespace appmiddleware;

use thinkacadeRequest;
use TymonJWTAuthExceptionsTokenExpiredException;
use TymonJWTAuthFacadesJWTAuth;
use thinkexceptionHttpException;

class AuthMiddleware
{
    public function handle($request, Closure $next)
    {
        //获取JWT token
        $token = JWTAuth::getToken();
        if (!$token) {
            throw new HttpException(null, 'Token not provided');
        }

        try {
            //验证JWT token
            $user = JWTAuth::authenticate($token);
            $request->user = $user;
        } catch (TokenExpiredException $exception) {
            throw new HttpException(null, 'Token expired');
        } catch (Exception $exception) {
            throw new HttpException(null, 'Token invalid');
        }

        return $next($request);
    }
}

在 handle 函数中,我们首先获取 JWT 的 token。如果 token 不存在,就会抛出 401 异常。

如果 token 存在,我们就使用 JWTAuth::authenticate($token) 验证token的合法性,成功则将用户信息绑定到请求上下文中。

需要注意的是,在上述代码中,所有抛出异常的情况都会返回 401 错误代码。

步骤四:使用中间件进行认证

在控制器中使用 AuthMiddleware 中间件进行身份验证,如下所示:

<?php
namespace appcontroller;

use appmiddlewareAuthMiddleware;

class UserController extends Base
{
    protected $middleware = [
        AuthMiddleware::class
    ];

    public function index()
    {
        return json($this->request->user, 200);
    }
}

在上述代码中,我们向控制器添加了一个 AuthMiddleware 中间件,因此在请求到达控制器之前将会自动执行该中间件。

控制器的 index 方法返回当前请求用户的信息,如果 JWT 认证正确,将返回 json 格式的用户信息。

结论

本文介绍了如何在ThinkPHP6项目中使用JWT进行认证。我们通过安装 JWT 扩展和生成配置文件、编写认证中间件、使用中间件等步骤,详细介绍了 JWT 身份验证的实现过程。 这个过程中,我们对JWT的相关知识有了更深入的了解,也为以后的互联网开发提供了有价值的经验。