Django使用drf-social-oauth2时如何为JWT负载自定义添加数据

完全不需要修改库源码，drf-social-oauth2底层依赖的django-oauth-toolkit已经预留了全链路的扩展钩子，仅需要通过配置+轻量的自定义逻辑，就能在不改动原有托管流程的前提下给payload添加自定义字段。 #

第一步：给JWT本身的解码Payload添加自定义字段 #

这一步解决「JWT解码后能拿到自定义字段」的核心需求，也就是让expiration_date、关联用户基础信息这类内容直接存在JWT的Claims里。
django-oauth-toolkit官方提供了CLAIM_GENERATORS配置项作为扩展入口，生成JWT时会自动调用你配置的可调用对象填充对应字段，和库本身的生成流程完全对齐。

1. 在项目的settings.py中添加如下配置：

OAUTH2_SERVER = {
    # 声明需要添加的自定义字段，值为对应生成函数的模块路径
    "CLAIM_GENERATORS": {
        "expiration_date": "your_project.utils.generate_expiration_timestamp",
        "user_profile": "your_project.utils.generate_basic_user_info",
    },
    # 配置JWT签名密钥，否则默认返回不透明令牌，无法被解码查看payload
    "OAUTH2_SIGNING_KEY": "项目签名密钥，建议从环境变量读取",
}

2. 在对应工具文件中实现生成函数，函数参数固定为(request, token, user, scope)：

# your_project/utils.py
def generate_expiration_timestamp(request, token, user, scope):
    # 直接复用库本身存储的令牌过期时间，和内置exp字段逻辑完全对齐
    return int(token.expires_at.timestamp())

def generate_basic_user_info(request, token, user, scope):
    # 按需返回需要的用户基础信息
    return {
        "user_id": user.id,
        "username": user.username,
        "display_name": user.get_full_name(),
    }

配置完成后，库生成的JWT解码后的payload会自动包含上述自定义字段，原有令牌生成、刷新、校验的逻辑完全不需要改动。 #

第二步：给接口响应体添加自定义字段 #

如果需要让POST请求auth/token/返回的JSON结构里直接带上这些自定义字段，而不只是存在于JWT内部的payload里，只需要通过序列化器扩展实现，不需要重写视图逻辑：

1. 编写继承自库自带的令牌响应序列化器的自定义序列化器，自动保留原有字段的输出逻辑：

# your_project/serializers.py
from drf_social_oauth2.serializers import RefreshTokenSerializer
from rest_framework import serializers

class CustomTokenResponseSerializer(RefreshTokenSerializer):
    # 新增自定义字段
    expiration_date = serializers.SerializerMethodField()
    user_profile = serializers.SerializerMethodField()

    def get_expiration_date(self, instance):
        # instance为库生成的BearerToken对象，直接读取属性即可
        return int(instance.expires_at.timestamp())
    
    def get_user_profile(self, instance):
        return {
            "user_id": instance.user.id,
            "username": instance.user.username,
        }

2. 在项目urls.py中，将原本由库托管的token生成接口，指向绑定了自定义序列化器的TokenView，注意将自定义路由放在库路由的前面，确保匹配优先级：

# your_project/urls.py
from django.urls import path, include
from oauth2_provider.views import TokenView
# 导入自定义序列化器
from .serializers import CustomTokenResponseSerializer

# 仅替换序列化器配置，完全保留原视图的所有令牌生成、校验逻辑
class CustomTokenView(TokenView):
    serializer_class = CustomTokenResponseSerializer

urlpatterns = [
    # 其他原有路由
    # 自定义token接口，优先级高于库自带的同路径路由
    path('auth/token/', CustomTokenView.as_view(), name='token'),
    # 正常引入库的其他路由，保留刷新令牌、社交登录换令牌等逻辑
    path('auth/', include('drf_social_oauth2.urls', namespace='drf')),
]

注意事项 #

• 自定义的Claims字段不要和JWT标准保留字段（exp/iss/sub/aud/iat）重名，否则会覆盖内置的令牌校验逻辑，导致合法令牌被判定为无效
• 所有用到的扩展点都是底层组件官方预留的标准接口，升级库版本时不需要修改自定义代码，不会出现源码修改带来的升级兼容问题
• 如果之前返回的payload里只有token字段，是因为没有配置JWT签名密钥，库默认返回的是不透明随机字符串令牌，配置签名密钥后会自动切换为可解码的JWT格式
• 自定义的序列化器扩展对社交账号换令牌的场景同样生效，因为drf-social-oauth2底层的令牌转换逻辑最终也是调用同一个TokenView完成的，不需要单独写适配逻辑
• 若使用的django-oauth-toolkit版本低于2.0，无需将配置嵌套在OAUTH2_SERVER字典内，直接在settings中声明CLAIM_GENERATORS、OAUTH2_SIGNING_KEY两个配置项即可生效

内容的提问来源于stack exchange，提问作者Carlos Reátegui