开启 Django 的 Debug 之旅

Question

之前一直苦于 Django 页面的调试之难，寻寻觅觅，终于发现了一个好用的工具，解决了网页调试的很多问题。

当前 django-debug-toolbar 版本：1.6，支持 python 3.5，支持 Django >=1.8

django-debug-toolbar 就是我们这里要介绍的工具。

在 Virtualenv 虚拟环境中，我们可以很方便的进行 pip 安装就可以了。

$ pip install django-debug-toolbar

接下来我们需要在项目里做一些配置以便可以把这个 debug-toolbar 用起来。

一、修改 settings.py

编辑： prj/settings.py ，

1、在 INSTALLED_APPS 列表最后加上 debug_toolbar 。

INSTALLED_APPS = [
    # ...
    'django.contrib.staticfiles',
    # ...
    'debug_toolbar',
]

2、在 MIDDLEWARE_CLASSES 列表后面添加 DebugToolbarMiddleware 。

MIDDLEWARE_CLASSES = [
    # ...
    'debug_toolbar.middleware.DebugToolbarMiddleware',
]

3、设置静态文件目录 STATIC_ROOT

STATIC_URL = '/static/'
STATIC_ROOT = os.path.join(BASE_DIR, 'static')

然后记得在项目目录里创建个 static 目录，如果还没有的话

$ mkdir static

4、 INTERNAL_IPS 设置允许显示调试信息的访问地址

添加允许显示调试信息的访问地址，一般我们用本地访问，所以设置为

INTERNAL_IPS = [
    '127.0.0.1',
]

5、取消 DjDT 默认的 JQuery 路径指定

DjDT 默认指定了 JQUERY_URL 的路径为： //ajax.googleapis.com/ajax/libs/jquery/2.1.4/jquery.min.js
但众所周知，天朝是访问不到 google 的，这就导致了 DjDT 图标迟迟显示不出来，让人感觉以为没有加载成功。因此我们可以取消这个默认设置，以使用网站默认的 JQuery 路径。

# 一些默认设置调整
DEBUG_TOOLBAR_CONFIG = {
    'JQUERY_URL': '',  # 使用网站默认的 JQuery
}

6、 DEBUG_TOOLBAR_PANELS 设置开启的调试工具栏面板项

默认设置是如下的，没有修改默认你也可以不用配置它，如果你有用到第三方插件，就需要配置 DEBUG_TOOLBAR_PANELS 了。

DEBUG_TOOLBAR_PANELS = [
    'debug_toolbar.panels.versions.VersionsPanel',
    'debug_toolbar.panels.timer.TimerPanel',
    'debug_toolbar.panels.settings.SettingsPanel',
    'debug_toolbar.panels.headers.HeadersPanel',
    'debug_toolbar.panels.request.RequestPanel',
    'debug_toolbar.panels.sql.SQLPanel',
    'debug_toolbar.panels.staticfiles.StaticFilesPanel',
    'debug_toolbar.panels.templates.TemplatesPanel',
    'debug_toolbar.panels.cache.CachePanel',
    'debug_toolbar.panels.signals.SignalsPanel',
    'debug_toolbar.panels.logging.LoggingPanel',
    'debug_toolbar.panels.redirects.RedirectsPanel',
]

二、修改 urls.py

编辑： prj/urls.py

# 导入 django 的 settings
from django.conf import settings

...

# 在项目的 urls 后添加
if settings.DEBUG:
    import debug_toolbar
    urlpatterns += [
        url(r'^__debug__/', include(debug_toolbar.urls)),
    ]

三、收集 debug_toolbar 的模板等静态文件

如果第一点的第 3 项已做到的话，直接收集，在项目目录里：

$ ./manage.py collectstatic

四，运行服务器，测试

把服务器运行起来。在项目目录里：

$ ./manage.py runserver

打开浏览器，输入地址： http:/127.0.0.1:8000/admin，你就可以看到页面右侧有一个 DjDT 的图标或者是 debug_toolbar 面板了。

更多的面板查看使用或者第三方插件的安装，后面再探索…

更多 debug-toolbar 细节，可参考官方文档 Django Debug Toolbar