插件窝 干货文章 如何使用ThinkPHP6进行JWT认证?

如何使用ThinkPHP6进行JWT认证?

jwt 令牌 认证 我们 95    来源:    2024-10-24

jwt(json web token)是一种轻量级的认证和授权机制,它使用json对象作为安全令牌,可以在多个系统之间安全地传输用户身份信息。而thinkphp6是一种基于php语言的高效、灵活的mvc框架,它提供了许多有用的工具和功能,其中就包括jwt认证机制。在本文中,我们将介绍如何使用thinkphp6进行jwt认证,以保障web应用程序的安全性和可靠性。

  1. 安装和配置JWT扩展

首先,我们需要在我们的应用程序中安装JWT扩展。可以通过在composer.json文件中添加依赖项来安装它:

{
    "require": {
        "firebase/php-jwt": "^5.0.0"
    }
}

然后运行以下命令安装它:

composer install

安装完成后,我们需要在配置文件中配置JWT。在config目录下创建jwt.php文件,并添加以下内容:

<?php
return [
    'key' => 'your-secret-key',
    'alg' => 'HS256',
    'exp' => 7200, // token过期时间,单位秒
];

其中“key”是一个字符串,用于生成JWT令牌的签名密钥,“alg”是JWT签名算法的名称,我们可以选择“HS256”、“HS512”、“RS256”等算法,“exp”是JWT令牌的过期时间,按秒数计算。

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

  1. 实现JWT认证控制器

接下来,我们需要创建一个JWT认证控制器,实现JWT认证。在app/controller目录下创建AuthController.php文件,并添加以下内容:

<?php
namespace appcontroller;

use FirebaseJWTJWT;
use thinkacadeDb;

class AuthController
{
    public function login()
    {
        //在这里处理用户登陆逻辑
        //...
        
        //登陆成功后生成JWT token并返回给客户端

        $secretKey = config('jwt.key'); // 获取JWT生成签名的密钥
        $alg = config('jwt.alg'); // 获取JWT加密算法
        $payload = [
            'sub' => $user->id, // 存储用户ID
            'exp' => time() + config('jwt.exp'), // 设定过期时间
        ];
        $jwt = JWT::encode($payload, $secretKey, $alg); // 生成JWT令牌
        return ['token' => $jwt]; // 返回JWT Token给客户端
    }

    public function dashboard()
    {
        //检查请求中的JWTToken是否有效,并返回用户信息

        $jwtToken = request()->header('Authorization'); // 获取JWT Token
        if (!$jwtToken) {
            // 如果token不存在,直接返回错误信息
            return ['msg' => '未验证身份,请先登录'];
        }
        $jwtInfo = JWT::decode($jwtToken, config('jwt.key'), [config('jwt.alg')]); // 使用JWT解密Token
        $userId = $jwtInfo->sub; // 获取token中存储的用户ID,用来查询用户信息
        $user = Db::table('users')->where('id', $userId)->find(); // 查询用户信息
        if (!$user) {
            // 用户不存在,直接返回错误信息
            return ['msg' => '用户不存在'];
        }
        // 返回用户信息
        return ['username' => $user['username'], 'email' => $user['email']];
    }
}

在上面的控制器代码中,我们实现了两个功能:一个是用户登陆,另一个是获取用户信息。在登陆过程中,我们生成了一个JWT令牌,并将其返回给客户端,用于后续请求中的身份验证。在dashboard方法中,我们检查了请求的Authorization头中是否包含JWT令牌,并使用JWT解密令牌,验证用户的身份是否有效。

  1. 添加JWT认证中间件

最后,我们需要在应用程序中添加一个JWT认证中间件,以保护需要认证的API接口。在app/middleware目录中创建JwtAuth.php文件,并添加以下内容:

<?php
namespace appmiddleware;

use FirebaseJWTJWT;
use thinkacadeConfig;

class JwtAuth
{
    public function handle($request, Closure $next)
    {
        //检查请求中的JWTToken是否有效

        $jwtToken = $request->header('Authorization'); // 获取JWT Token
        if (!$jwtToken) {
            // 如果token不存在,直接返回错误信息
            return response(['msg' => '未授权的API请求!'], 401);
        }
        try {
            $jwtInfo = JWT::decode($jwtToken, Config::get('jwt.key'), [Config::get('jwt.alg')]); // 使用JWT解密Token
            $request->jwtInfo = $jwtInfo; // 将解密后的JWT信息存储在请求对象中,后续控制器可以使用
            return $next($request); // 继续后续请求处理
        } catch (Exception $e) {
            // JWT Token过期或者解密失败,返回错误信息
            return response(['msg' => 'JWT Token无效或已过期!'], 401);
        }
    }
}

在上面的代码中,我们检查了请求的Authorization头中是否包含有效的JWT令牌。如果JWT令牌无效或者已过期,我们返回一个未授权的HTTP响应,否则我们继续后续请求处理,并将JWT令牌的信息存储在请求对象中,以供后续控制器使用。

最后,我们需要在应用程序的路由中使用JWT认证中间件来保护需要认证的API接口。例如,我们在routes/api.php文件中添加以下代码:

<?php
use appmiddlewareJwtAuth;

// 需要JWT认证的API接口
Route::get('dashboard', 'AuthController@dashboard')->middleware(JwtAuth::class);

在上面的代码中,我们将dashboard方法使用JwtAuth中间件进行了保护,确保只有带有有效JWT令牌的请求才能访问它。

结论

在本文中,我们介绍了如何使用ThinkPHP6进行JWT认证,以保障Web应用程序的安全性和可靠性。我们首先安装和配置了JWT扩展,然后实现了JWT认证控制器和JWT认证中间件,最后在应用程序的路由中使用JWT认证中间件来保护需要认证的API接口。通过这些步骤,我们可以在ThinkPHP6应用程序中轻松实现JWT认证机制,确保Web应用程序的安全性和可靠性。