Django装饰器的使用 (类视图)

kirin

发布于 2021-02-04 08:03:28

1.2K00

代码可运行

文章被收录于专栏：Kirin博客Kirin博客

运行总次数：0

代码可运行

4 类视图使用装饰器

为类视图添加装饰器，可以使用三种方法。

为了理解方便，我们先来定义一个为函数视图准备的装饰器（在设计装饰器时基本都以函数视图作为考虑的被装饰对象），及一个要被装饰的类视图。


 
  def my_decorator(func):
 
 
  
 
  def wrapper(request, *args, **kwargs):
 
 
  
 
  print(‘自定义装饰器被调用了’)
 
 
  
 
  print(‘请求路径%s’ % request.path)
 
 
  
 
   return func(request, *args, **kwargs)
 
 
  
 
   return wrapper
 
 
  
 
  
 
 
  
 
  class DemoView(View):
 
 
  
 
  def get(self, request):
 
 
  
 
  print(‘get方法’)
 
 
  
 
   return HttpResponse(‘ok’)
 
 
  
 
  
 
 
  
 
  def post(self, request):
 
 
  
 
  print(‘post方法’)
 
 
  
 
   return HttpResponse(‘ok’)

4.1 在URL配置中装饰

urlpatterns = [
 
 
  
 
  url(r’^demo/$’, my_decorate(DemoView.as_view()))
 
 
  
 
  ]

此种方式最简单，但因装饰行为被放置到了url配置中，单看视图的时候无法知道此视图还被添加了装饰器，不利于代码的完整性，不建议使用。

此种方式会为类视图中的所有请求方法都加上装饰器行为（因为是在视图入口处，分发请求方式前）。

4.2 在类视图中装饰

在类视图中使用为函数视图准备的装饰器时，不能直接添加装饰器，需要使用method_decorator将其转换为适用于类视图方法的装饰器。

from django.utils.decorators import method_decorator
 
 
  
 
  
 
 
  
 
  # 为全部请求方法添加装饰器
 
 
  
 
  class DemoView(View):
 
 
  
 
  
 
 
  
 
   @method_decorator(my_decorator)
 
 
  
 
  def dispatch(self, *args, **kwargs):
 
 
  
 
   return super().dispatch(*args, **kwargs)
 
 
  
 
  
 
 
  
 
  def get(self, request):
 
 
  
 
  print(‘get方法’)
 
 
  
 
   return HttpResponse(‘ok’)
 
 
  
 
  
 
 
  
 
  def post(self, request):
 
 
  
 
  print(‘post方法’)
 
 
  
 
   return HttpResponse(‘ok’)
 
 
  
 
  
 
 
  
 
  
 
 
  
 
  # 为特定请求方法添加装饰器
 
 
  
 
  class DemoView(View):
 
 
  
 
  
 
 
  
 
   @method_decorator(my_decorator)
 
 
  
 
  def get(self, request):
 
 
  
 
  print(‘get方法’)
 
 
  
 
   return HttpResponse(‘ok’)
 
 
  
 
  
 
 
  
 
  def post(self, request):
 
 
  
 
  print(‘post方法’)
 
 
  
 
   return HttpResponse(‘ok’)

method_decorator装饰器还支持使用name参数指明被装饰的方法

  # 为全部请求方法添加装饰器
 
 
  
 
  @method_decorator(my_decorator, name=‘dispatch’)
 
 
  
 
  class DemoView(View):
 
 
  
 
   def get(self, request):
 
 
  
 
  print(‘get方法’)
 
 
  
 
   return HttpResponse(‘ok’)
 
 
  
 
  
 
 
  
 
   def post(self, request):
 
 
  
 
  print(‘post方法’)
 
 
  
 
   return HttpResponse(‘ok’)
 
 
  
 
  
 
 
  
 
  
 
 
  
 
  # 为特定请求方法添加装饰器
 
 
  
 
  @method_decorator(my_decorator, name=‘get’)
 
 
  
 
  class DemoView(View):
 
 
  
 
   def get(self, request):
 
 
  
 
  print(‘get方法’)
 
 
  
 
   return HttpResponse(‘ok’)
 
 
  
 
  
 
 
  
 
   def post(self, request):
 
 
  
 
  print(‘post方法’)
 
 
  
 
   return HttpResponse(‘ok’)

为什么需要使用method_decorator???

为函数视图准备的装饰器，其被调用时，第一个参数用于接收request对象

   def my_decorate(func):
 
 
  
 
   def wrapper(request, *args, **kwargs): # 第一个参数request对象 
 
 
  
 
  …代码省略…
 
 
  
 
   return func(request, *args, **kwargs)
 
 
  
 
   return wrapper

而类视图中请求方法被调用时，传入的第一个参数不是request对象，而是self 视图对象本身，第二个位置参数才是request对象

  
 
  class DemoView(View):
 
 
  
 
   def dispatch(self, request, *args, **kwargs):
 
 
  
 
  …代码省略…
 
 
  
 
  
 
 
  
 
   def get(self, request):
 
 
  
 
  …代码省略…

所以如果直接将用于函数视图的装饰器装饰类视图方法，会导致参数传递出现问题。

method_decorator的作用是为函数视图装饰器补充第一个self参数，以适配类视图方法。

如果将装饰器本身改为可以适配类视图方法的，类似如下，则无需再使用method_decorator。


 
   def my_decorator(func):
 
 
  
 
   def wrapper(self, request, *args, **kwargs): # 此处增加了self 
 
 
  
 
  print(‘自定义装饰器被调用了’)
 
 
  
 
  print(‘请求路径%s’ % request.path)
 
 
  
 
   return func(self, request, *args, **kwargs) # 此处增加了self 
 
 
  
 
   return wrapper

4.3 构造Mixin扩展类

使用面向对象多继承的特性。


  class MyDecoratorMixin(object):
 
 
  
 
   @classmethod
 
 
  
 
  def as_view(cls, *args, **kwargs):
 
 
  
 
  view = super().as_view(*args, **kwargs)
 
 
  
 
  view = my_decorator(view)
 
 
  
 
   return view
 
 
  
 
  
 
 
  
 
  class DemoView(MyDecoratorMixin, View):
 
 
  
 
  def get(self, request):
 
 
  
 
  print(‘get方法’)
 
 
  
 
   return HttpResponse(‘ok’)
 
 
  
 
  
 
 
  
 
  def post(self, request):
 
 
  
 
  print(‘post方法’)
 
 
  
 
   return HttpResponse(‘ok’)