Django:一个基于类的视图,具有mixins和dispatch方法

时间:2015-01-07 16:39:22

标签: django django-views mixins

通常,我使用基于类的视图的dispatch方法来设置一些初始变量或根据用户的权限添加一些逻辑。

例如,

from django.views.generic import FormView
from braces.views import LoginRequiredMixin

class GenerateReportView(LoginRequiredMixin, FormView):
    template_name = 'reporting/reporting_form.html'
    form_class = ReportForm

    def get_form(self, form_class):
        form = form_class(**self.get_form_kwargs())
        if not self.request.user.is_superuser:
            form.fields['report_type'].choices = [
                choice for choice in form.fields['report_type'].choices
                if choice[0] != INVOICE_REPORT
            ]
        return form

按预期工作:当匿名用户访问页面时,调用LoginRequiredMixin dispatch方法,然后将用户重定向到登录页面。

但是,如果我想为此视图添加一些权限或设置一些初始变量,例如,

class GenerateReportView(LoginRequiredMixin, FormView):

    def dispatch(self, *args, **kwargs):
        if not (
            self.request.user.is_superuser or
            self.request.user.is_manager
        ):
            raise Http404
        return super(GenerateReportView, self).dispatch(*args, **kwargs)

在某些情况下它不起作用,因为视图继承的mixins的dispatch方法尚未被调用。因此,例如,为了能够请求用户的权限,我必须从LoginRequiredMixin重复验证:

class GenerateReportView(LoginRequiredMixin, FormView):

    def dispatch(self, *args, **kwargs):
        if self.request.user.is_authenticated() and not (
            self.request.user.is_superuser or
            self.request.user.is_manager
        ):
            raise Http404
        return super(GenerateReportView, self).dispatch(*args, **kwargs)

这个例子很简单,但有时在mixin中有一些更复杂的逻辑:它检查权限,进行一些计算并将其存储在类属性中等。

现在我通过从mixin中复制一些代码(如上例中的代码)或通过将视图的dispatch方法中的代码复制到另一个mixin并在第一个执行后继承它来解决它它们按顺序排列(这不是那么漂亮,因为这个新的mixin仅由一个视图使用)。

有没有正确的方法来解决这些问题?

4 个答案:

答案 0 :(得分:4)

我会编写自定义类,检查所有权限

from django.views.generic import FormView
from braces.views import AccessMixin

class SuperOrManagerPermissionsMixin(AccessMixin):
    def dispatch(self, request, *args, **kwargs):
        if not request.user.is_authenticated():
            return self.handle_no_permission(request)
        if self.user_has_permissions(request):
            return super(SuperOrManagerPermissionsMixin, self).dispatch(
                request, *args, **kwargs)
        raise Http404 #or return self.handle_no_permission

    def user_has_permissions(self, request):
        return self.request.user.is_superuser or self.request.user.is_manager

# a bit simplyfied, but with the same redirect for anonymous and logged users
# without permissions


class SuperOrManagerPermissionsMixin(AccessMixin):
    def dispatch(self, request, *args, **kwargs):
        if self.user_has_permissions(request):
            return super(SuperOrManagerPermissionsMixin, self).dispatch(
                request, *args, **kwargs)
        else:
            return self.handle_no_permission(request)

    def user_has_permissions(self, request):
        return request.user.is_authenticated() and (self.request.user.is_superuser
                                                    or self.request.user.is_manager)


class GenerateReportView(SuperOrManagerPermissionsMixin, FormView):
#Remove next two lines, don't need it
    def dispatch(self, *args, **kwargs):
        #or put some logic here
        return super(GenerateReportView, self).dispatch(*args, **kwargs)

类GenerateReportView(SuperOrManagerPermissionsMixin,FormView)的实现不需要重写调度方法

如果你使用多重继承,其中一个父类需要一些改进,最好先改进它。它使代码更清晰。

答案 1 :(得分:3)

这是一个老帖子,但其他人可能会遇到所以这里是我提出的解决方案。

当你说

  

" [...]我想为此视图添加一些权限或设置一些权限   初始变量,例如[...]"

您可以编写一个单独的方法来设置这些变量,然后在get(和if if needed)方法中调用该方法,而不是在视图的dispatch方法中设置这些初始变量。它们在调度后被调用,因此设置初始变量不会与mixin中的调度发生冲突。 所以重写方法

def set_initial_variables():
    self.hey = something
    return 

def get(blablabla):
    self.set_initial_variables()
    return super(blabla, self).get(blabla)

这可能比在您查看的调度中复制和粘贴mixin的代码更清晰。

答案 2 :(得分:2)

对于您提供的示例,我会使用django-braces中的UserPassesTestMixin

class GenerateReportView(UserPassesTestMixin, FormView):
    def test_func(self, user):
        return user.is_superuser or user.is_manager

如果这不适合你更复杂的逻辑,那么创建一个单独的mixin听起来就像一个好的方法,因为它很好地封装了复杂的逻辑。

修改
从django 1.9开始,UserPassesTestMixin现在包含在django中:https://docs.djangoproject.com/en/1.11/topics/auth/default/#django.contrib.auth.mixins.UserPassesTestMixin

答案 3 :(得分:0)

可以使用Django UserPassesTestMixin mixin或@user_passes_test装饰器来完成。

UserPassesTestMixin的示例

from django.contrib.auth.mixins import UserPassesTestMixin


class SuperUserOrManagerRequiredMixin(UserPassesTestMixin):
    def test_func(self):
        if self.request.user.is_superuser or self.request.user.is_manager:
            return True

        return False


class MyView(LoginRequiredMixin, SuperUserOrManagerRequiredMixin, View):
    ...