AccessToken、for_user、get_token

2023-05-15 23:07 由城南城南发表于 #后端开发

在Django REST framework的SimpleJWT库中，AccessToken是一个类，用于表示一个JSON Web Token (JWT)中的访问令牌部分。访问令牌是一种常见的身份验证令牌，通常用于保护API端点。

通过SimpleJWT库，您可以使用AccessToken类创建、解析和验证JWT，以实现安全的身份验证和授权机制。访问令牌可以包含有关用户或会话的信息，以及与该令牌相关的权限和有效期信息。

具体来说，AccessToken类具有以下作用：

创建：可以使用AccessToken.for_user或AccessToken.for_token方法创建一个新的访问令牌。for_user方法创建一个针对指定用户的新访问令牌，而for_token方法将现有的访问令牌字符串转换为AccessToken实例。
解析：可以使用AccessToken.decode方法将JWT字符串解码为AccessToken实例。解码后，您可以使用访问令牌中包含的信息验证用户身份和权限。
验证：AccessToken类提供了几种验证方法，例如verify和verify_exp方法，用于确保访问令牌在有效期内且未被篡改。这些方法可以帮助您构建可靠的身份验证和授权机制，以保护API端点。

总之，AccessToken类是实现安全身份验证和授权机制的重要组件，使得您可以创建、解析和验证JWT，以及管理访问令牌相关的权限和有效期信息。

在Django REST framework的SimpleJWT库中，AccessToken.for_user是一个方法，用于创建一个针对指定用户的新访问令牌（JSON Web Token，JWT）。

AccessToken.for_user方法接受一个Django用户模型（User）实例作为输入，并返回一个新的AccessToken实例。使用该方法可以为特定用户创建一个新的JWT，其中包含该用户的身份验证信息和其他相关信息，例如访问权限、过期时间等。

以下是如何使用AccessToken.for_user方法的示例代码：

from django.contrib.auth.models import User
from rest_framework_simplejwt.tokens import AccessToken

# 获取要为其生成JWT的用户实例
user = User.objects.get(username='johndoe')

# 为用户创建一个新的JWT
access_token = AccessToken.for_user(user)
jwt = str(access_token)

在此示例中，AccessToken.for_user方法接受User实例并创建一个新的AccessToken实例，该实例包含有关用户身份验证和其他信息的有效载荷。使用str函数将访问令牌转换为JWT字符串。

在Django REST framework的SimpleJWT库中，get_token是TokenObtainPairSerializer类提供的一个辅助函数，用于在验证用户凭证后生成JSON Web Token（JWT）。

get_token函数接受一个包含用户凭证（如用户名和密码）的字典作为输入，并使用TokenObtainPairSerializer来验证凭证并生成JWT。JWT以字符串形式返回，客户端可以使用它来验证未来对受保护API端点的请求。

以下是如何使用get_token函数的示例代码：

from django.contrib.auth.models import User
from rest_framework_simplejwt.tokens import get_token

# 获取要为其生成JWT的用户实例
user = User.objects.get(username='johndoe')

# 为用户创建一个新的JWT
jwt = get_token(user)

在此示例中，get_token函数接受User实例并返回一个新的JWT字符串，该字符串包含有关用户身份验证和其他信息的有效载荷。由于函数返回JWT字符串，因此不需要像使用AccessToken.for_user方法一样将访问令牌实例转换为字符串。

总之，get_token函数是一个方便的函数，可用于创建新的JWT字符串，而不需要显式地创建访问令牌实例。如果您只需要JWT字符串而不需要操作AccessToken实例，则可以使用此函数来实现更简洁的代码。

或者

from rest_framework_simplejwt.serializers import TokenObtainPairSerializer
from rest_framework_simplejwt.tokens import AccessToken

# 创建一个包含用户凭证的字典
user_data = {'username': 'johndoe', 'password': 'mypassword'}

# 创建一个序列化器实例并验证用户凭证
serializer = TokenObtainPairSerializer(data=user_data)
serializer.is_valid(raise_exception=True)

# 使用验证后的凭证生成JWT
access_token = AccessToken.for_user(serializer.validated_data['user'])
jwt = str(access_token)

在此示例中，get_token函数并没有直接调用，而是通过调用AccessToken.for_user方法间接调用的，该方法基于验证后的用户数据返回一个新的访问令牌。然后使用str函数将访问令牌转换为JWT字符串。

AccessToken.for_user和get_token都是用于创建一个针对指定用户的新访问令牌（JSON Web Token，JWT）的函数。它们的不同之处在于返回值的类型和用法。

AccessToken.for_user返回一个AccessToken实例，需要将其转换为JWT字符串才能使用。而get_token函数直接返回一个JWT字符串，因此可以直接使用。

以下是使用这两个函数的示例代码：

from django.contrib.auth.models import User
from rest_framework_simplejwt.tokens import AccessToken, get_token

# 获取要为其生成JWT的用户实例
user = User.objects.get(username='johndoe')

# 使用AccessToken.for_user创建AccessToken实例
access_token = AccessToken.for_user(user)
jwt_1 = str(access_token)

# 使用get_token创建JWT字符串
jwt_2 = get_token(user)

# 输出结果
print(jwt_1)
print(jwt_2)

在此示例中，使用AccessToken.for_user创建access_token实例，然后使用str函数将其转换为JWT字符串。使用get_token函数直接创建JWT字符串。最后，将两个字符串打印到控制台输出。

总之，如果您需要访问令牌的其他属性（例如过期时间，scopes等），则应使用AccessToken.for_user方法来创建AccessToken实例。但是，如果您只需要JWT字符串，则可以使用更简洁的get_token函数。