django基础——上下文处理器

什么是上下文处理器？

上下文处理器是Django中的一种组件，它可以让我们在渲染模板时向其中提供一些额外的上下文信息，如request参数，或者一些全局性的模板变量。它可以返回一个字典，把这些额外的信息添加到渲染模板时的上下文中，从而让这些信息在模板中可以访问。

如何定义上下文处理器？

我们可以在app中的任何一个文件中定义我们自己的上下文处理器。我们需要定义一个函数，它接受一个request参数，并返回一个字典。

def my_context_processor(request):
    my_variable = 'Hello World!'
    return {'my_variable': my_variable}

我们可以在settings.py文件中，定义这个上下文处理器的路径。例如，如果我们的上下文处理器函数定义在myapp/context_processors.py文件中，那么我们可以在settings.py文件中添加如下代码：

TEMPLATES = [
    {
        ...
        'OPTIONS': {
            'context_processors': [
                'django.template.context_processors.request',
                'django.contrib.auth.context_processors.auth',
                'myapp.context_processors.my_context_processor',
            ],
        },
    },
]

注意上面的代码中，除了我们定义的my_context_processor函数外，还包括了Django自带的context_processor，例如request和auth等，我们只需要把我们自定义的处理器添加到这个列表中即可。

上下文处理器应用场景

全局性的模板变量

当我们需要在整个项目的模板中提供某个数据，但是这个数据不方便在每个视图函数中都传递，这时候就可以使用上下文处理器。例如，我们可以定义一个上下文处理器，提供一个站点名称的变量，它可以被整个项目中的模板使用。

from django.conf import settings
def site_name(request):
    return {
        'SITE_NAME': settings.SITE_NAME,
    }

然后，我们需要在settings.py文件中，添加如下配置：

TEMPLATES = [
    {
        ...
        'OPTIONS': {
            'context_processors': [
                ...
                'myapp.context_processors.site_name',
            ],
        },
    },
]

最后，在模板中就可以使用这个SITE_NAME变量了：

<title>{{ SITE_NAME }}</title>

视图函数和模板之间的中间变量传递

有时候，我们需要在模板中使用某个数据，这个数据需要在视图函数中处理一遍才能获取，这时候就可以使用上下文处理器来传递中间变量。例如，我们在某个视图函数中处理一个字典，然后需要把这个字典传递给模板，模板中需要用到这个字典中的某个值。

def my_view(request):
    my_data = {
        'name': 'Tom',
        'age': 20,
    }
    return render(request, 'my_template.html', {'my_data': my_data})

但是如果这个字典需要在多个视图函数中使用，把这个字典传递给每个视图函数又太麻烦了，这时候就可以使用上下文处理器。

def my_context_processor(request):
    my_data = {
        'name': 'Tom',
        'age': 20,
    }
    return {'my_data': my_data}

然后，在settings.py文件中，添加如下配置：

TEMPLATES = [
    {
        ...
        'APP_DIRS': True,
        'OPTIONS': {
            'context_processors': [
                ...
                'myapp.context_processors.my_context_processor',
            ],
        },
    },
]

最后，在模板中就可以直接使用这个my_data变量了：

<p>My name is {{ my_data.name }}, and I am {{ my_data.age }} years old.</p>

总结

上下文处理器是Django中一个非常有用的组件，它可以让我们在模板中方便地使用一些额外的数据。上下文处理器可以用来传递全局性的变量，也可以用来传递视图函数和模板之间的中间变量。

如果使用得当，上下文处理器可以让我们写出更加干净，优雅的代码。但是如果使用不当，上下文处理器也可能会让我们的代码变得零散，难以维护。因此，在使用上下文处理器时，一定要慎重选择，不要滥用上下文处理器。