Django 向DRF简单JWT有效载荷添加声明

在本文中，我们将介绍如何使用Django框架向DRF（Django Rest Framework）简单JWT（JSON Web Token）有效载荷中添加声明。JWT是一种用于客户端和服务器之间进行安全通信的开放标准。DRF简单JWT是一种用于Django和DRF的JWT实现，使我们能够轻松地在我们的应用程序中实现认证和授权。

阅读更多：Django 教程

简介

DRF简单JWT是一种轻量级的认证插件，用于在DRF中使用JWT进行身份验证。它提供了生成和验证JWT的功能，使我们能够安全地将用户身份信息传递给服务器，并进行身份验证和授权。

在默认情况下，DRF简单JWT有效载荷中只包含用户的id和用户名。但有时我们可能需要添加其他自定义的声明，以满足特定的应用需求，例如用户角色、权限等。

接下来，我们将详细介绍如何添加自定义声明到DRF简单JWT有效载荷中，并给出相应的示例说明。

添加声明到有效载荷

要添加声明到DRF简单JWT有效载荷中，我们需要定义一个自定义JWT有效载荷处理器，并使用它来生成JWT。下面是一个示例：

from datetime import datetime, timedelta
from rest_framework_simplejwt.tokens import TokenError
from rest_framework_simplejwt.serializers import TokenObtainPairSerializer
from rest_framework_simplejwt.views import TokenObtainPairView

class CustomPayloadHandler(TokenObtainPairSerializer):
    @classmethod
    def get_token(cls, user):
        token = super().get_token(user)

        # 添加自定义声明
        token['role'] = user.role
        token['permissions'] = user.permissions

        return token

class CustomTokenObtainPairView(TokenObtainPairView):
    serializer_class = CustomPayloadHandler

    def post(self, request, *args, **kwargs):
        response = super().post(request, *args, **kwargs)

        # 在响应中添加自定义声明
        user = request.user
        if user:
            response.data['role'] = user.role
            response.data['permissions'] = user.permissions

        return response

在上述示例中，我们定义了一个名为CustomPayloadHandler的自定义JWT有效载荷处理器，继承自TokenObtainPairSerializer。在get_token方法中，我们调用父类的get_token方法获取原始的JWT，并在其基础上添加了自定义的声明。

然后，我们定义了一个名为CustomTokenObtainPairView的自定义视图，继承自TokenObtainPairView。在这个视图中，我们使用了CustomPayloadHandler作为序列化器，并在post方法中将自定义声明添加到响应中。

最后，我们需要将自定义视图添加到urls.py文件中，以替换默认的TokenObtainPairView。示例如下：

from django.urls import path
from .views import CustomTokenObtainPairView

urlpatterns = [
    path('api/token/', CustomTokenObtainPairView.as_view(), name='token_obtain_pair'),
]

现在，当我们使用默认的TokenObtainPairSerializer生成JWT时，JWT的有效载荷将包含我们添加的自定义声明。

示例说明

为了更好地理解如何添加自定义声明到DRF简单JWT有效载荷中，我们来考虑一个示例。假设我们有一个名为User的模型，有两个字段：role和permissions。

首先，我们需要定义User模型和相关的视图和URL。然后，我们可以使用上述自定义JWT有效载荷处理器和自定义视图来添加声明。

from django.db import models
from django.contrib.auth.models import AbstractUser

class User(AbstractUser):
    ROLE_CHOICES = (
        ('user', 'User'),
        ('admin', 'Admin'),
    )

    role = models.CharField(max_length=255, choices=ROLE_CHOICES)
    permissions = models.TextField(blank=True, null=True)

# ...

from rest_framework import generics, permissions
from .serializers import UserSerializer

class UserListView(generics.ListAPIView):
    queryset = User.objects.all()
    serializer_class = UserSerializer
    permission_classes = [permissions.IsAuthenticated]

在上述示例中，我们定义了一个User模型，并在其中添加了role和permissions字段，用于存储用户角色和权限。

然后，我们定义了一个名为UserListView的视图，用于显示所有用户的信息。在该视图中，我们使用了permissions.IsAuthenticated来确保只有被认证的用户才能查看用户列表。这是DRF提供的一个默认的权限类。

接下来，我们需要定义UserSerializer来处理User模型的序列化和反序列化操作。在UserSerializer中，我们可以使用DRF的Serializer类和ModelSerializer类来定义字段和模型的关联关系。

from rest_framework import serializers
from .models import User

class UserSerializer(serializers.ModelSerializer):
    class Meta:
        model = User
        fields = ['id', 'username', 'role', 'permissions']

在上述示例中，我们定义了一个UserSerializer，并指定其对应的模型为User，字段为id、username、role和permissions。

现在，我们可以使用自定义的视图和序列化器来生成JWT，并在有效载荷中添加自定义声明。示例如下：

$ curl -X POST -H "Content-Type: application/json" -d '{"username":"admin","password":"admin123"}' http://localhost:8000/api/token/

{
    "access": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9...",
    "refresh": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9..."
}

在上述示例中，我们通过curl命令向TokenObtainPairView的URL发送了用户名和密码，并获得了包含自定义声明的JWT。可以看到，在access和refresh字段中，我们添加的自定义声明role和permissions已经包含在JWT的有效载荷中。

总结

本文介绍了如何使用Django框架向DRF简单JWT有效载荷中添加声明。首先，我们了解了DRF简单JWT和JWT的基本原理。然后，我们演示了如何添加自定义JWT有效载荷处理器和自定义视图，并给出了相应的示例说明。通过本文的学习，我们可以更好地理解和使用DRF简单JWT来满足我们应用程序中的身份验证和授权需求。