Python pyjwt 模块：实用工具集

Travis Tang

2024-07-25

Python pyjwt模块

在现代应用程序中，JSON Web Token（JWT）作为一种安全机制，广泛应用于用户认证与信息交换。Python 中的 pyjwt 模块提供了简单而强大的工具来创建、解码和验证 JWT。通过这个模块，您可以轻松管理用户会话以及保护您的 API 接口，提高应用程序的安全性。该模块兼容 Python 3.6 及更高版本。

应用场景

pyjwt 模块的主要用途在于实现用户身份验证和信息传递。以下是一些常见的应用场景：

用户权限管理：通过 JWT 为不同用户分配不同的权限，确保用户只能访问其有权使用的资源。
单点登录：应用多个子系统时，通过 JWT 实现用户的单点登录功能，避免重复登录的烦恼。
API 身份验证：在 RESTful API 中使用 JWT 进行身份验证，确保只有权限用户可以访问特定的 API 接口。

安装说明

pyjwt 并不是 Python 的默认库，但可以通过 pip 进行简单安装。以下是安装命令：

1	pip install PyJWT

用法举例

示例 1：生成 JWT

import jwt  # 导入jwt模块
import datetime  # 导入日期时间模块

# 定义一个秘钥，用于加密生成JWT
SECRET_KEY = 'your_secret_key'

# 创建一个payload，包含需要的信息
payload = {
    'user_id': 123,  # 用户ID
    'exp': datetime.datetime.utcnow() + datetime.timedelta(minutes=30)  # 设置jwt的过期时间
}

# 生成JWT
token = jwt.encode(payload, SECRET_KEY, algorithm='HS256')  # 使用HS256算法加密JWT
print(token)  # 打印生成的JWT

示例 2：解码 JWT

import jwt  # 导入jwt模块

# 使用之前生成的token
token = 'your_jwt_token'  # 此处替换为实际的JWT

try:
    # 解码JWT以获取payload信息
    decoded_payload = jwt.decode(token, SECRET_KEY, algorithms=['HS256'])  # 使用相同的秘钥和算法解码
    print(decoded_payload)  # 打印解码后的payload
except jwt.ExpiredSignatureError:
    print('Token已经过期')  # 如果token过期，捕获异常并打印提示
except jwt.InvalidTokenError:
    print('无效的Token')  # 捕获无效token的异常并提示

示例 3：验证 JWT 并获取用户信息

import jwt  # 导入jwt模块

# 使用之前生成的token
token = 'your_jwt_token'  # 此处替换为实际的JWT

try:
    # 解码并验证JWT
    decoded_payload = jwt.decode(token, SECRET_KEY, algorithms=['HS256'])  # 解码并验证token
    user_id = decoded_payload['user_id']  # 获取用户ID
    print(f'用户ID: {user_id}')  # 打印用户ID
except jwt.ExpiredSignatureError:
    print('Token已经过期')  # 捕获过期异常
except jwt.InvalidTokenError:
    print('无效的Token')  # 捕获无效token的异常

软件和库版本不断更新

由于软件和库版本不断更新，如果本文档不再适用或有误，请留言或联系我进行更新。让我们一起营造良好的学习氛围。感谢您的支持！ - Travis Tang

在这篇文章中，我们介绍了 pyjwt 模块的实用性和应用场景，并提供了多个详细的使用示例。强烈建议大家关注本人的博客全糖冲击博客，优点是包含所有 Python 标准库使用教程，方便查询和学习。我的博客致力于为大家提供丰富的学习资源和实际应用示例，让您迅速掌握 Python 编程的精髓。希望通过我的分享，您能在学习旅程中事半功倍，共同进步！