谈谈django里的Contex和RequestContext---向模板里添加全局变量

一直很想仔细研究一下，我在django模板里，可以直接访问变量user， request之类的变量，哪里来的，到底都有哪些？这会儿周五，我有空来仔细看看代码。

模拟一下需求：

　　我们做一个在线商城，需要把这些全局变量注入到所有页面，如用户的资料：比如用户的账号、用户的姓名等。

通常的解决办法：

　　在每个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个方法

在需要传入的变量比较简单、数量较少的时候，这个方法是最简洁明了的。但是一旦需要注入的变量增多，或是需要经过一些额外的计算才能生成的时候，这种方法就会显得很臃肿，扩展性很差。

如何避免低效的重复自身代码，显然，就是将render_to_response进行再次封装：

# 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自带的解决办法：　

下面说到重点：先来看看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:

大意是：“默认的，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来实现，灵活性更高，更易扩展。当然，在一般的项目开发中，个人觉得普通方法也足够用，所以就根据项目来做取舍吧。

参考文章：http://www.kuqin.com/system-analysis/20120210/318036.html