在 Django settings.py 中注册 context processor 需将函数完整路径(如 'myapp.context_processors.site_info')写入 TEMPLATES'OPTIONS' 列表,函数必须接收 request 参数并返回字典,否则模板无法使用。

怎么在 Django settings.py 里注册 context processor
必须把处理器函数路径写进 TEMPLATES 配置的 'context_processors' 列表里,否则变量根本不会进模板上下文。
常见错误是只写了函数名(比如 my_context_processor),漏掉模块路径;或者写成可调用对象(比如加了括号 my_context_processor()),导致启动时报 TypeError: 'dict' object is not callable。
- 正确写法:
'myapp.context_processors.site_info' - 路径必须从项目根目录可导入,比如
myproject/myapp/context_processors.py,且该文件里有定义好的函数 - Django 默认自带几个(如
django.template.context_processors.static),别误删,否则STATIC_URL在模板里会变成未定义 - 如果用的是
django.template.backends.django.DjangoTemplates后端,'context_processors'必须在'OPTIONS'里,不在顶层
context processor 函数长什么样、返回什么
它就是一个接收单个参数 request 的普通函数,**必须返回一个字典**。Django 会把这个字典里的键值对自动合并进所有模板的上下文。
注意:不能返回 None,也不能返回非字典类型,否则模板渲染时抛 ValueError: The context must be a dict rather than None.
- 函数签名固定:
def site_info(request): - 返回值必须是
dict,例如:return {'site_name': 'MySite', 'is_staff': request.user.is_staff} - 里面可以访问
request,但别做耗时操作(如数据库查询),因为每个模板渲染都会调用——除非你确定所有页面都需要这个数据 - 不推荐在 processor 里调用
request.session.save()或修改 session,容易引发并发问题
为什么模板里用不到刚加的变量?常见排查点
不是代码写错,就是加载顺序或作用域没理清。最常踩的坑是:以为全局注入就等于“所有模板都能用”,其实它只对通过 render() 或 TemplateResponse 渲染的模板生效,HttpResponse + 手动 template.render() 不走 context processor 流程。
- 确认视图用了
render(request, 'xxx.html', context),而不是HttpResponse(template.render(context, request)) - 检查是否在
settings.py多个TEMPLATES配置中改错了位置(比如改了测试环境的配置,却在开发环境跑) - 如果用了类视图(如
TemplateView),确保没覆盖get_context_data且没手动 return 空字典 - 调试技巧:在 processor 函数里加
print(f"called with {request.path}"),看控制台有没有输出,快速判断是否被触发
和视图传参、自定义模板标签比,context processor 适合干啥
它只适合放那些「全站一致、无请求差异、低开销」的变量。比如站点标题、备案号、CDN 域名前缀。一旦涉及用户权限判断、动态菜单、分页信息,就该回到视图里按需传,别硬塞进 processor。
- 适合:
DEBUG标志、GOOGLE_ANALYTICS_ID、current_year = datetime.now().year - 不适合:
user_permissions(已由auth.context_processors.auth负责)、unread_count(应查缓存+视图级控制)、sidebar_items(不同用户不同,且可能触发 N+1) - 性能敏感点:processor 每次渲染都执行,哪怕模板里根本没用到那个变量。所以别在里面做
User.objects.get()这种操作










