jwt-auth 的安装和配置教程

1. 项目的基础介绍和主要的编程语言

jwt-auth 是一个为 ThinkPHP 框架设计的 JSON Web Token（JWT）身份验证包。它支持通过 Header、Cookie、Param 等多种方式传递 JWT，并且提供了验证、刷新等多种中间件支持。此项目的主要编程语言是 PHP。

2. 项目使用的关键技术和框架

项目使用了 JWT（JSON Web Token）技术进行用户身份验证，这是一种基于 token 的身份验证方法，广泛应用于前后端分离的 Web 应用程序中。jwt-auth 集成了 ThinkPHP 框架，可以方便地在 ThinkPHP 应用中实现用户认证。

3. 项目安装和配置的准备工作和详细的安装步骤

准备工作

在开始安装 jwt-auth 之前，请确保您的开发环境满足以下要求：

• PHP 版本为 ~8.1.0 或 ~8.2.0
• ThinkPHP 框架版本为 ^5.1.10、^6.0.0 或 ^8.0.0
• 如果使用 2.x 版本的 jwt-auth，PHP 需要版本 8.1 以上，8.0 及以下请使用 1.x 版本

安装步骤

1. 安装 jwt-auth

   使用 Composer 安装 jwt-auth：

   $ composer require thans/tp-jwt-auth
   

2. 生成配置文件

   安装完成后，执行以下命令生成 jwt 的配置文件：

   $ php think jwt:create
   

   这会生成 jwt.php 和 .env 配置文件。注意，不建议直接修改 jwt.php 文件。

3. 配置 .env 文件

   在 .env 文件中，将会随机生成一个 secret。请确保不要随意更新此 secret，并保证其安全性。

4. 使用 jwt-auth 中间件

   在需要验证的路由或模块中添加 jwt-auth 的中间件。例如：

   use thans\jwt\facade\JWTAuth;
   
   // 获取 token
   $token = JWTAuth::builder([
       'uid' => 1
   ]);
   
   // 执行 token 验证
   JWTAuth::auth();
   
   // 刷新 token
   JWTAuth::refresh();
   
   // 获取请求中的完整 token 字符串
   $tokenStr = JWTAuth::token()->get();
   
   // 验证 token 并获取 payload
   $payload = JWTAuth::auth();
   
   // 获取 payload 中的字段，例如 uid
   $uid = $payload['uid'];
   

5. 配置 Token 传参方式

   在 jwt.php 配置文件中，可以通过 token_mode 参数来调整 Token 的接收方式和优先级。默认值为 ['header', 'cookie', 'param']。

   根据你的应用需求，可以选择通过 URL 参数、Cookie 或 Header 传递 Token。建议使用 Header 方式传递 Token。

通过以上步骤，你就可以在 ThinkPHP 应用中安装并配置 jwt-auth 进行用户认证了。记得在实际使用中根据项目需求调整配置，并确保安全。