掌握Django装饰器，Web开发技能up up！

创作时间:

2025-01-21 20:51:33

作者:

@小白创作中心

掌握Django装饰器，Web开发技能up up！

装饰器是Python中一个非常强大的功能，它允许开发者在不修改原函数代码的情况下，为其添加新的功能。在Django框架中，装饰器被广泛应用于视图函数，用于实现权限控制、缓存管理、日志记录等功能。掌握装饰器的使用，可以让你的代码更加简洁、模块化，符合Django的“不要重复自己”（DRY）原则。

装饰器基础

在Python中，装饰器本质上是一个接受函数作为参数的高阶函数。它可以在不修改原函数代码的情况下，为其添加新的功能。装饰器的语法糖使用@符号，如下所示：

def my_decorator(func):
    def wrapper(*args, **kwargs):
        print("Something is happening before the function is called.")
        result = func(*args, **kwargs)
        print("Something is happening after the function is called.")
        return result
    return wrapper

@my_decorator
def say_hello():
    print("Hello!")

say_hello()

在这个例子中，my_decorator就是一个装饰器，它为say_hello函数添加了额外的打印功能，而无需修改say_hello函数本身的代码。

Django内置装饰器

Django框架提供了许多内置的装饰器，用于简化常见任务的开发。以下是一些常用的装饰器：

HTTP请求方法限制

require_http_methods装饰器用于限定视图只接受指定的HTTP方法。例如：

from django.views.decorators.http import require_http_methods

@require_http_methods(["GET", "POST"])
def my_view(request):
    # 视图逻辑
    pass

类似的装饰器还有require_GET和require_POST，分别限制请求为GET或POST方法。

缓存控制

cache_control装饰器用于添加Cache-Control头部，控制缓存行为：

from django.views.decorators.cache import cache_control

@cache_control(max_age=3600)
def my_view(request):
    # 视图逻辑
    pass

never_cache装饰器则用于设置响应为不缓存：

from django.views.decorators.cache import never_cache

@never_cache
def my_view(request):
    # 视图逻辑
    pass

登录验证

login_required装饰器用于确保用户已登录才能访问视图：

from django.contrib.auth.decorators import login_required

@login_required
def cities(request):
    # 视图逻辑
    pass

类视图中的装饰器

在基于类的视图（CBV）中使用装饰器需要借助django.utils.decorators模块中的method_decorator。以下是三种常见的使用方式：

直接在类方法上添加装饰器

from django.views import View
from django.utils.decorators import method_decorator

class MyLogin(View):
    @method_decorator(login_auth)
    def get(self, request):
        return HttpResponse("get 请求")

    @method_decorator(login_auth)
    def post(self, request):
        return HttpResponse("post 请求")

在类上面添加装饰器

from django.views import View
from django.utils.decorators import method_decorator

@method_decorator(login_auth, name='get')
@method_decorator(login_auth, name='post')
class MyLogin(View):
    def get(self, request):
        return HttpResponse("get 请求")

    def post(self, request):
        return HttpResponse("post 请求")

重写`dispatch`方法

from django.views import View
from django.utils.decorators import method_decorator

class MyLogin(View):
    @method_decorator(login_auth)
    def dispatch(self, request, *args, **kwargs):
        pass

    def get(self, request):
        return HttpResponse("get 请求")

    def post(self, request):
        return HttpResponse("post 请求")

需要注意的是，Django官方不建议直接在类方法上使用装饰器，无论该装饰器能否正常工作。

自定义装饰器

除了使用Django内置的装饰器，你还可以根据项目需求创建自定义装饰器。例如，免除CSRF认证的装饰器：

from django.views.decorators.csrf import csrf_exempt
from django.utils.decorators import method_decorator

class MyBaseView(View):
    @method_decorator(csrf_exempt)
    def dispatch(self, request, *args, **kwargs):
        print('before')
        ret = super(MyBaseView, self).dispatch(request, *args, **kwargs)
        print('after')
        return ret