Django Debug Toolbar 在 DRF JWT 认证项目中的使用技巧

2025-05-28 07:46:11作者：翟江哲Frasier

在基于 Django REST Framework (DRF) 开发 API 接口时，很多开发者会选择使用 JWT (JSON Web Token) 作为认证机制。然而，这种架构下会遇到一个常见问题：Django Debug Toolbar (DDT) 无法正常工作，特别是当我们需要使用 SQL 面板来分析 N+1 查询问题时。

问题背景

当项目采用 DRF 的 APIView 并配合 Simple JWT 认证时，所有接口返回的都是 JSON 数据，没有传统的 HTML 页面渲染。而 Django Debug Toolbar 的工作原理是依赖 HTML 响应来注入调试面板，这就导致了调试工具栏无法显示的问题。

解决方案

1. 创建调试专用视图

最直接的解决方案是专门为开发环境创建一个简单的视图，返回基本的 HTML 页面：

from django.contrib.admin.views.decorators import staff_member_required
from django.http import HttpResponse

@staff_member_required
def debug_view(request):
    return HttpResponse("<html><body></body></html>")

这个视图不需要任何业务逻辑，只需要返回一个空的 HTML 页面即可。通过访问这个视图，DDT 就能正常加载，然后我们可以通过历史面板查看其他 API 请求的调试信息。

2. 配置 URL 路由

确保这个调试视图只在开发环境中可用：

# urls.py
from django.conf import settings

if settings.DEBUG:
    urlpatterns += [
        path('__debug__/', debug_view, name='debug_view'),
    ]

3. 使用历史面板

访问调试视图后，DDT 的历史面板会显示所有请求记录。即使其他 API 请求返回的是 JSON，它们的调试信息也会被记录下来。点击历史面板中的刷新按钮，就能看到最近的请求列表，然后可以查看每个请求的 SQL 查询等详细信息。

技术原理

Django Debug Toolbar 的工作原理是：

检测到 HTML 响应时，在响应内容中注入调试面板的 HTML 和 JavaScript
通过中间件收集请求过程中的各种调试信息
将这些信息存储在服务器端，通过特定的 URL 端点提供给前端面板

即使 API 请求本身返回 JSON，调试信息仍然会被收集。我们只需要一个入口点（即返回 HTML 的视图）来加载调试面板，然后就可以通过这个面板查看所有请求的调试数据。

进阶技巧

对于更复杂的需求，可以考虑以下方法：

自定义中间件：创建一个中间件，在开发环境下强制为特定请求添加调试信息
日志输出：修改 DDT 的配置，将 SQL 查询等信息输出到日志文件
API 端点：创建一个特殊的 API 端点，返回最近请求的调试信息

注意事项

确保调试视图只在开发环境可用
考虑添加适当的权限控制（如 staff_member_required）
生产环境一定要禁用 DDT，避免性能和安全问题

通过这种方法，开发者可以在保持 JWT 认证的同时，充分利用 Django Debug Toolbar 的强大功能来优化 API 性能。

django-debug-toolbar

jazzband/django-debug-toolbar: 是一个用于 Django 开发的调试工具栏，可以提供多种调试工具和性能分析功能，可以用于 Django 应用程序的开发和调试。

项目地址：https://gitcode.com/gh_mirrors/dj/django-debug-toolbar

登录后查看全文

项目优选

收起

kernel

deepin linux kernel

pytorch

Ascend Extension for PyTorch

本项目是CANN提供的数学类基础计算算子库，实现网络在NPU上加速计算。

Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台，包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分，采用java语言实现，可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用

Java

RuoYi-Vue3

🎉 (RuoYi)官方仓库基于SpringBoot，Spring Security，JWT，Vue3 & Vite、Element Plus 的前后端分离权限管理系统

🔥LeetCode solutions in any programming language | 多种编程语言实现 LeetCode、《剑指 Offer（第 2 版）》、《程序员面试金典（第 6 版）》题解

Java

openGauss-server

openGauss kernel ~ openGauss is an open source relational database management system

TorchAir 支持用户基于PyTorch框架和torch_npu插件在昇腾NPU上使用图模式进行推理。