Django - 如何在基于类的视图方法中使用装饰器？

Question

我正在使用Django 1.8开发网站。以下是一个视图的示例：

class ProfileView(View):
    template_name = 'index.html'

    # Return profile of any role (client/employee/admin)
    # Login required
    def get(self, request, *args, **kwargs):
        try:
            profile = Profile.objects.get(user=request.user)
            agency = None

            if request.user.is_employee():
                employee = EmployeeProfile.objects.get(profile=profile)
                agency = employee.agency

            if request.user.is_manager():
                agency = Agency.objects.get(manager=request.user)

        except (Profile.DoesNotExist, EmployeeProfile.DoesNotExist, Agency.DoesNotExist) as e:
            return HttpResponseRedirect('/404')

        return render(request, self.template_name, {"profile": profile, "agency": agency})

    # Client sign up
    # No decorator is needed
    def post(self, request):
        sign_up = SignUpForm(request.POST, request.FILES)

        response = json.loads(utils.create_user(sign_up,request.POST['avatar']))
        if response['profile'] is None:
            return JsonResponse({"code": 400, "response": response['message']})
        profile = serializers.deserialize("json", response['profile']).next().object

        group = Group.objects.get(name='clients')
        profile.user.groups.add(group)

        return HttpResponseRedirect('/')

问题是，我能根据发向控制器（视图）的请求类型使用不同的装饰器吗？

- Josseline Perdomo

Answer 1

自Django 1.9起，根据文档，可以按照以下方式应用装饰器：

from django.contrib.auth.decorators import login_required
from django.utils.decorators import method_decorator

@method_decorator(login_required, name='dispatch')
class YourClassBasedView(TemplateView):
    ...

其中 name 是要被装饰的方法的名称。

或者在几个装饰器的情况下：

from django.contrib.auth.decorators import login_required
from django.views.decorators.cache import never_cache
from django.utils.decorators import method_decorator

decorators = [never_cache, login_required]

@method_decorator(decorators, name='dispatch')
class YourClassBasedView(TemplateView):
    ...

- TitanFighter

Answer 2

有一个非常简单的解决方案可以实现你想要的，而且它不需要装饰dispatch方法。您必须在您的方法（get / post）上使用method_decorator并将decorator call（而不是decorator本身）作为参数传递。

在你的情况下，代码如下：

from django.utils.decorators import method_decorator

class ProfileView(View):
    template_name = 'index.html'

    # Return profile of any role (client/employee/admin)
    @method_decorator(login_required())
    def get(self, request, *args, **kwargs):
        ...

    # Client sign up
    # No decorator is needed
    def post(self, request):
        ...

请注意login_required装饰器中的括号。

您可以传递任何函数式装饰器，包括自定义的装饰器。例如：

def white_list_check():
    def decorator(func):
        def wrapper(request, *args, **kwargs):
            ip = request.META.get('REMOTE_ADDR', '0.0.0.0')
            if ip in WHITE_LIST:
                return func(request, *args, **kwargs)
            else:
                return HttpResponseForbidden()
        return wrapper
    return decorator

接着，再一次：

class YourView(View):

    @method_decorator(white_list_check())
    def get(self, request):
        ...

- Martín De la Fuente

---

请注意，使用Django 2.2（以及可能的所有更新版本），您无需将装饰器调用传递给method_decorator，只需传递装饰器本身即可。 - hlongmore

Answer 3

有些修饰器，比如never_cache，可以在urls.py中使用，而不是在views.py中使用老的方式。

例如，never_cache修饰器：

在旧式的views.py中：

from django.views.decorators.cache import never_cache

@never_cache
def oldstyle_view(request):
    # and so on

使用基于类的视图时，在urls.py中：

from django.views.decorators.cache import never_cache

urlpatterns = patterns('',
     (r'someurl/^$', never_cache(SomeClassBasedView.as_view())),
)

注意：这对于那些在views.py中没有完整视图定义的视图非常方便，否则装饰器也可以应用于视图中的depatch方法。

编辑于2015年8月1日

- michel.iamit

---

它显示了URL中的错误：'function'对象没有属性'as_view'。 - usman imtiaz

Answer 4

您可以重载dispatch方法，根据请求类型调用不同的装饰器：

from django.utils.decorators import method_decorator

class ProfileView(View):
    ... 

    def dispatch(self, *args, **kwargs):
        dispatch_method = super(ProfileView, self).dispatch

        if self.request.method == 'GET':
            dispatch_method = method_decorator(my_get_decorator)(dispatch_method)
        elif self.request.method == 'POST':
            dispatch_method = method_decorator(my_post_decorator)(dispatch_method)

        return dispatch_method(*args, **kwargs)

- Ozgur Vatansever

Answer 5

你需要将装饰器应用到基于类的视图的调度方法上。可以按照以下方式完成：

class ProfileView(View):

    @youdecorator
    def dispatch(self,request,*args,**kwargs):
        return super(ProfileView,self).dispatch(request,*args,**kwargs)
    //Rest of your code.

- Animesh Sharma