Django——如何在Django模板中注入全局变量?——part1

问题:TEMPLATE_CONTEXT_PROCESSORS代表着什么?

问题描述:无法在项目的settings.py文件中找到TEMPLATE_CONTEXT_PROCESSORS

————————————————————正文————————————————————

我们在做一些网站项目的时候,可能会遇到需要把某个全局变量注入到所有页面的情况,比如我们做一个在线商城,那么可能需要将用户的资料:比如用户的账号、用户的姓名等注入到每个页面里面。

TeamCola中每个页面右上角都会出现的用户名

但是如果用常规的方法,也就是在每个views方法中通过render_to_response方法注入用户数据的话,这样就会做非常多的重复工作,就像下面这样:

def views_meth1(request):
    return render_to_response(‘template_1.html‘, {‘user‘: request.user})
 
def views_meth2(request):
    return render_to_response(‘template_2.html‘, {‘user‘: request.user})
 
def views_meth3(request):
    return render_to_response(‘template_3.html‘, {‘user‘: request.user})
 
# ...剩下的N个方法

这在需要传入的变量比较简单、数量较少的时候还行,一旦需要注入的变量多一些,或是需要经过一些额外的计算才能生成的时候,那就麻烦大了。所以如何避免这种repeat yourself的2B模式呢?我们可以选择如下的一种模式:

在每次创建新的django项目的时候,一般来说我们都会在根目录中创建一个类似名为utils.py的工具module,在这个module中,我们可以通过定义一个自己的render方法,来为每次模板的渲染注入指定的全局变量:

# in utils.py:
def mp_render(request, template, context={}):
    context[‘user‘] = request.user
 
    return render_to_response(template, context)
 
# in views.py:
from utils import mp_render
 
def views_meth1(request):
    return mp_render(request, ‘template_1.html‘)
 
def views_meth2(request):
    return mp_render(request, ‘template_2.html‘)
 
def views_meth3(request):
    return mp_render(request, ‘template_3.html‘)

很好理解吧,这样以后有新增加的全局变量需要注入的话,只需要修改mp_render方法就行了。嗯,这是很普通的方法,既然是普通方法,那就再来个文艺点的吧。

先来看看django文档里面对于render_to_response这个方法的定义吧,在’Required arguments’里面,有提到这个方法的第三个参数,叫context_instance,对于这个参数的说明如下:

The context instance to render the template with. By default, the template will be rendered with a Context instance (filled with values from dictionary). If you need to use context processors, render the template with a RequestContext instance instead. Your code might look something like this:

return render_to_response(‘my_template.html‘,
                          my_data_dictionary,
                          context_instance=RequestContext(request))

大意是:“默认的,render_to_response方法的第二个dictionary参数会被填充为一个Context对象注入进html模板文件里面。如果你需要使用context processors,那么需要使用一个RequestContext对象来渲染模板。”

那么什么是context processors呢?看完这一段文档的定义以后,应该一切就很明了了。

首先需要明白在django模板系统中,有两种封装模板变量的类,一个是django.template.Context,这是最常用的,我们在使 用render_to_response方法的时候传入的第二个dictionary参数,就会被这个Context类封装一次,然后传到模板当中;另一 个是django.template.RequestContext,它和Context类相比有两个不同之处。第一个不同的是,在生成一个 RequestContext变量的时候,需要传入一个HttpRequest对象作为它的第一个参数:

c = RequestContext(request, {‘foo‘: ‘bar‘, })

第二个区别是,它会增加一些自动注入模板的变量,这些变量从哪儿来呢?在django的settings.py里有一部分是配置 TEMPLATE_CONTEXT_PROCESSORS的,这个配置中的那一个个的tuple元素其实是一个个可以被调用的方法,而这些方法都会接收一 个HttpRequest对象作为参数,而最终return一个dictionary,这个dictionary里面的元素就会成为 RequestContext中自动注入模板的变量。我们看看settings.py中TEMPLATE_CONTEXT_PROCESSORS的某一个 元素 django.contrib.auth.context_processors.auth 对应的代码吧:

# in django/contrib/auth/context_processors.py
def auth(request):
    """ ignore doc string """
    def get_user():
        ....
 
    return {
        ‘user‘: SimpleLazyObject(get_user),
        ‘messages‘: messages.get_messages(request),
        ‘perms‘:  lazy(lambda: PermWrapper(get_user()), PermWrapper)(),
    }

可以看到,auth方法最后返回的一个字典中,包含了三个元素,所以如果在使用render_to_response方法时,传入了第三个RequestContext参数,那么在它所渲染的模板中,就可以获取到对应的user、messages、perms变量了。

所以最后文艺解决方法是,在每一个需要注入全局变量的views方法中,调用render_to_response的时候,都传入第三个RequestContext对象参数即可:

def views_meth1(request):
    d1 = {‘method‘: 1}
 
    return render_to_response(‘template_1.html‘, d1, context_instance=RequestContext(request))
 
def views_meth2(request):
    d2 = {‘method‘: 2}
 
    return render_to_response(‘template_2.html‘, d2, context_instance=RequestContext(request))
 
def views_meth3(request):
    d3 = {‘method‘: 3}
 
    return render_to_response(‘template_2.html‘, d3, context_instance=RequestContext(request))

这样需要注入的全局对象,就可以通过扩展TEMPLATE_CONTEXT_PROCESSORS来实现,灵活性更高,更易扩展。当然,在一般的项目开发中,个人觉得普通方法也足够用,所以就根据项目来做取舍吧。

时间: 2024-10-10 01:31:37

Django——如何在Django模板中注入全局变量?——part1的相关文章

Django——如何在Django模板中注入全局变量?——part2

模版中的变量由context中的值来替换,如果在多个页面模版中含有相同的变量,比如:每个页面都需要{{user}},笨办法就是在每个页面的请求视图中都把user放到context中. Python代码   from django.temlate import loader,Context t = loader.get_template('xx.html') c = Context({'user':'zhangsan'}) return HttpResponse(t.render(c))   #h

django url路径与模板中样式相对路径的问题

static目录下有css和js及image等文件夹,里面放置网站的一些静态文件,static位于网站根目录下,django中配置静态文件这个就细说,网上都有,昨天在添加新内容时发现一个问题,我的url如果存在多个"/"的话(我的是3个以上如:/a/b/c/d),模板中调用到的静态文件将无法获取模板中静态文件的引用: <link rel="stylesheet" type="text/css" href="../../static

如何在Java Filter 中注入 Service

在项目中遇到一个问题,在 Filter中注入 Serivce失败,注入的service始终为null.如下所示: public class WeiXinFilter implements Filter{ @Autowired private UsersService usersService; public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOExc

如何在 ejs 模板中使用 helper function 外部函数进行特殊处理?

一般我们想要在 ejs 模板中使用外部函数用于特殊的处理,比如:<%= ellipsis(title, 30) %> 通常的做法是: 使用 app.locals 来定义: app.locals.ellipsis = function(str, len) { return str; } // 使用 <%= ellipsis(title, 20) %> 使用 ejs.filters 来定义,详细用法: var ejs = require('ejs'); ejs.filters.elli

Django测试开发-34- xadmin模板中添加action插件

一.action插件介绍 1. Action插件在数据列表页面上提供数据选择功能.可以在Action之后专门处理所选数据.批量删除功能作为默认操作提供. 2. 要启用Action,开发人员可以设置Model 中Class的属性“actions”,这是一种列表类型. xadmin官方地址:https://xadmin.readthedocs.io/en/latest/plugins.html 二.具体操作 1. 首先需要一个Action类,继承BaseActionView from xadmin.

Django测试开发-29- xadmin模板中详情页面布局form_layout详解

现状: xadmin的详情页面默认是一行展示一个字段 使用form_layout: 1. 可以设置必填和非必填字段 2. 可以设置显示不显示字段, 3. 可以设置不可以编辑的字段 一.未使用form_layout之前 models.py class ArticleClassify(models.Model): '''文章分类''' article_classify = models.CharField(max_length=30, verbose_name="分类", default=

django模板中的自定义过滤器

(1)在APP下创建templatetags文件夹,与Models.py.views.py等同级,templatetags文件夹下添加__init__.py文件,可为空,再添加一个模块文件,例如cpt_filters.py,目录结构如下 myapp/ __init__.py models.py templatetags/ __init__.py cpt_filters.py views.py admin.py appa.py 目录下添加__init__.py文件可让python知道这里是pyth

django 模板中url的处理

在模板中直接添加‘/home’这样的链接是十分不推荐的,因为这是一个相对的链接,在不同网页中打开可能会返回不一样的结果. 所以推荐的是 <a href="{{ object.get_absolute_url }}">{{ object.name }}</a> 这种方式,或者 <a href={% url 'article' article.pk %} > 这里第二种方式同时需要在urls.py中设置, url(r'^article/(?P<pk

Django 模板中引用静态资源(js,css等)

Django 模板中免不了要用到一些js和CSS文件,查了很多网页,被弄得略晕乎,还是官网靠谱,给个链接大家可以自己看英文的. https://docs.djangoproject.com/en/1.6/howto/static-files/ 大致步骤是这样的: 1.确保setting.py里的installed_apps中包括了django.contrib.staticfiles,没有的话大家给添上就行. 2.同样是在setting.py里面进行添加,我们需要添加静态资源相关的配置.可以这么写