Python Django中如何自定义Token生成规则_重写DRF的TokenObtainPairView

星晨同学_5915

星晨同学_5915

2026-05-01

303人浏览

原创

必须重写TokenObtainPairSerializer而非仅视图,因get_token是静态方法且默认逻辑硬编码;自定义字段需在get_token中通过token["key"]=value安全注入,并预加载关联数据;refresh后字段丢失因TokenRefreshView不调用重写的get_token。

python django中如何自定义token生成规则_重写drf的tokenobtainpairview

为什么直接继承 TokenObtainPairView 会失效

因为 TokenObtainPairView 默认使用 SimpleJWT 的 TokenObtainPairSerializer,而该序列化器的 get_token 方法是静态的、硬编码在类内部的——你重写视图类本身,不碰序列化器,token payload 依然走默认逻辑。

常见错误现象:access_token 里还是只有 user_id 和 exp,加字段没反应;或者自定义 claim(如 role、department)完全不出现。

  • 必须重写序列化器,不是只重写视图
  • 视图类需通过 serializer_class 显式指向新序列化器
  • SimpleJWT 的 get_token 方法返回的是 AccessToken 实例,不是 dict,不能直接赋值,要用 token["key"] = value 方式注入

如何在 get_token 中安全添加用户字段

假设你要把 User.username、User.email 和自定义的 profile.role 写进 token,且确保字段存在、类型安全、不暴露敏感信息。

关键点在于:不要在 get_token 里做数据库查询(它在认证阶段同步执行),所有数据应来自已加载的 user 对象或其预关联的 profile。

python学习
python学习

Python 编程学习助手 skill,面向零基础用户。 当用户表达以下意图时触发: - 学习 Python 基础概念(变量、数据类型、循环、函数、类等) - 请求 Python 练习题或测验 - 请求审查或调试 Python 代码 - 请求 Python 项目实战指导(爬虫、数据分析、Web 开发等入门项目) - 泛化表述如"教我 Python""我想学编程""Python 怎么写""帮我学 Python" 此 skill

下载
  • 用 select_related("profile") 预加载 profile(在自定义用户模型的 get_user_model() 查询中处理,或在登录前中间件里优化)
  • 检查字段是否存在再写入,避免 AttributeError:if hasattr(user, "profile") and user.profile.role:
  • 避免写入密码哈希、手机号等敏感字段,token 是 Base64 编码,非加密,仅防篡改
  • 示例写法:
    def get_token(cls, user):
        token = super().get_token(user)
        token["username"] = user.username
        token["email"] = user.email
        if hasattr(user, "profile") and user.profile.role:
            token["role"] = user.profile.role
        return token

重写 TokenObtainPairView 时要注意的路由和配置

Django REST Framework Simple JWT 默认路径是 /api/token/,但如果你直接替换视图,却忘了改 urls.py 或 settings 中的 TOKEN_OBTAIN_PAIR_VIEW,Django 还是会加载原始视图。

  • 确保 urls.py 显式注册你的视图:path("api/token/", MyTokenObtainPairView.as_view(), name="token_obtain_pair")
  • 不用改 settings.py 里的 DEFAULT_AUTHENTICATION_CLASSES,那个只影响后续请求校验,不影响 token 生成
  • 如果用了 TokenRefreshView,它不依赖 TokenObtainPairView,无需重写;但刷新后的 token 不含你新加的字段(因为刷新只延长 exp,不重新调用 get_token),这点常被忽略
  • 调试时可用 curl -X POST ... | jq 查看实际返回的 token payload,别只信文档或前端 log

为什么 refresh 后自定义字段丢失了

TokenRefreshView 调用的是 TokenRefreshSerializer,它只解码旧 refresh_token,提取其中的 user_id,再调用 AccessToken.for_user(user) ——这个方法不走你重写的 get_token,而是走 AccessToken 类的默认构造逻辑。

所以即使你重写了 get_token,refresh 返回的新 access_token 也不会包含自定义字段。

  • 解决办法:重写 TokenRefreshSerializer.get_token,或更稳妥地——在 settings.py 中设置 SIMPLE_JWT["ACCESS_TOKEN_LIFETIME"] 足够长,并避免频繁 refresh
  • 若必须支持 refresh 时带字段,得自定义 TokenRefreshView 并替换其 serializer_class,指向一个继承自 TokenRefreshSerializer 的类,在其中手动重建 token(不推荐,破坏 JWT 语义)
  • 真正该放 refresh 里的,只有不可变标识(如 user_id),动态字段(如 role)建议在每次请求时从 DB 或缓存查,而不是塞进 token
实际项目里,最易被忽略的是 refresh 行为与自定义字段的割裂——开发时只测 login,上线后才发现权限变更不实时。token 设计不是越“全”越好,而是权衡可维护性与安全性。

Python免费学习笔记(深入):立即使用
在学习笔记中,你将探索 Python 的核心概念和高级技巧!

相关专题

更多
python打包成可执行文件
python打包成可执行文件

本专题为大家带来python打包成可执行文件相关的文章,大家可以免费的下载体验。

2023.07.20

1811

4

python能做什么
python能做什么

python能做的有:可用于开发基于控制台的应用程序、多媒体部分开发、用于开发基于Web的应用程序、使用python处理数据、系统编程等等。本专题为大家提供python相关的各种文章、以及下载和课程。

2023.07.25

4784

7

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.07.31

1769

3

python教程
python教程

Python已成为一门网红语言,即使是在非编程开发者当中,也掀起了一股学习的热潮。本专题为大家带来python教程的相关文章,大家可以免费体验学习。

2023.08.03

28537

23

python环境变量的配置
python环境变量的配置

Python是一种流行的编程语言,被广泛用于软件开发、数据分析和科学计算等领域。在安装Python之后,我们需要配置环境变量,以便在任何位置都能够访问Python的可执行文件。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

3427

5

python eval
python eval

eval函数是Python中一个非常强大的函数,它可以将字符串作为Python代码进行执行,实现动态编程的效果。然而,由于其潜在的安全风险和性能问题,需要谨慎使用。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

3427

5

scratch和python区别
scratch和python区别

scratch和python的区别:1、scratch是一种专为初学者设计的图形化编程语言,python是一种文本编程语言;2、scratch使用的是基于积木的编程语法,python采用更加传统的文本编程语法等等。本专题为大家提供scratch和python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

1223

5

python合并两个列表
python合并两个列表

Python是一种强大的编程语言,具有许多方便的功能和工具。在Python中,有多种方法可以合并两个列表。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.10

616

4

python是前端还是后端
python是前端还是后端

Python属于前端也属于后端,其灵活性和丰富的生态系统使得开发人员能够在不同的领域中灵活运用。本专题为大家提供python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

2663

5

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Uvicorn官方安装与入门手册
Uvicorn官方安装与入门手册

共0课时 | 0人学习

Python uv官方项目管理指南
Python uv官方项目管理指南

共0课时 | 0人学习

Python uv官方安装与入门文档
Python uv官方安装与入门文档

共0课时 | 0人学习