详解Django中六个常用的自定义装饰器


Posted in Python onJuly 04, 2018

装饰器作用

decorator是当今最流行的设计模式之一,很多使用它的人并不知道它是一种设计模式。这种模式有什么特别之处? 有兴趣可以看看Python Wiki上例子,使用它可以很方便地修改对象行为,通过使用类似例中的接口将修改动作封装在装饰对象中。

decorator 可以动态地修改函数、方法或类的功能,而无需创建子类或修改类的源代码。正因为如此,装饰器可以让代码将变得更干净、更可读、更可维护(这很重要!),并且减少了许多冗余但又不得不写的代码,使我们可以使用单个方法向多个类添加功能。

对于装饰器的重用性和易用性,Django里面的@login_required就是一个很好的例子。使用它只用一句代码就可以检查用户是否通过身份验证,并将未登录用户重定向到登录url。

该装饰器的使用方法如下:

from django.contrib.auth.decorators import login_required

@login_required(login_url='/accounts/login/')
def my_view(request):
  ...

每次用户试图访问 my_view 时,都会进入 login_required 中的代码。

Django装饰器

下面介绍一些个人认为比较有用的,或者是之前使用过的具有积极效果的装饰器。事先声明,如要实现同样的业务场景,并不是只有本文中的方法。Django可以实现各种各样的装饰器,这完全根据您的需要进行定制。

Group Required

有时需要保护一些视图,只允许某些用户组访问。这时就可以使用下面的装饰器来检查用户是否属于该用户组。

from django.contrib.auth.decorators import user_passes_test

def group_required(*group_names):
  """Requires user membership in at least one of the groups passed in."""

  def in_groups(u):
    if u.is_authenticated():
      if bool(u.groups.filter(name__in=group_names)) | u.is_superuser:
        return True
    return False
  return user_passes_test(in_groups)


# The way to use this decorator is:
@group_required('admins', 'seller')
def my_view(request, pk):
  ...

有关此装饰器更多的介绍,可以参考这里。

Anonymous required

这个装饰器是参考Django自带的 login_required 装饰器,但是功能是相反的情况,即用户必须是未登录的,否则用户将被重定向到 settings.py 中定义的地址。当我们想要已登录的用户不允许进入某些视图(比如登录)时,非常有用。

def anonymous_required(function=None, redirect_url=None):

  if not redirect_url:
    redirect_url = settings.LOGIN_REDIRECT_URL

  actual_decorator = user_passes_test(
    lambda u: u.is_anonymous(),
    login_url=redirect_url
  )

  if function:
    return actual_decorator(function)
  return actual_decorator


# The way to use this decorator is:
@anonymous_required
def my_view(request, pk):
  ...

有关此装饰器更多的介绍,可以参考这里。

Superuser required

这个装饰器和上面的 group_required 类似, 但是它只允许超级用户才能访问视图。

from django.core.exceptions import PermissionDenied


def superuser_only(function):
  """Limit view to superusers only."""

  def _inner(request, *args, **kwargs):
    if not request.user.is_superuser:
      raise PermissionDenied
    return function(request, *args, **kwargs)

  return _inner


# The way to use this decorator is:
@superuser_only
def my_view(request):
  ...

有关此装饰器更多的介绍,可以参考这里。

Ajax required

这个装饰器用于检查请求是否是AJAX请求,在使用jQuery等Javascript框架时,这是一个非常有用的装饰器,也是一种保护应用程序的好方法。

from django.http import HttpResponseBadRequest


def ajax_required(f):
  """
  AJAX request required decorator
  use it in your views:
 
  @ajax_required
  def my_view(request):
    ....
 
  """

  def wrap(request, *args, **kwargs):
    if not request.is_ajax():
      return HttpResponseBadRequest()
    return f(request, *args, **kwargs)

  wrap.__doc__ = f.__doc__
  wrap.__name__ = f.__name__
  return wrap


# The way to use this decorator is:
@ajax_required
def my_view(request):
  ...

有关此装饰器更多的介绍,可以参考这里。

Time it

如果您需要改进某个视图的响应时间,或者只想知道运行需要多长时间,那么这个装饰器非常有用。

def timeit(method):

  def timed(*args, **kw):
    ts = time.time()
    result = method(*args, **kw)
    te = time.time()
    print('%r (%r, %r) %2.2f sec' % (method.__name__, args, kw, te - ts))
    return result

  return timed


# The way to use this decorator is:
@timeit
def my_view(request):
  ...

有关此装饰器更多的介绍,可以参考这里。

自定义功能

下面这个装饰器只是一个示例,测试你能够轻松地检查某些权限或某些判断条件,并100%自己定制。

 想象你有一个博客、购物论坛,如果用户需要有很多积分才能发表评论,这是一个避免垃圾信息的好方法。下面创建一个装饰器来检查用户是否已登录并拥有超过10个积分,这样才可以发表评论,否则将抛出一个Forbidden。

from django.http import HttpResponseForbidden

logger = logging.getLogger(__name__)
def user_can_write_a_review(func):
  """View decorator that checks a user is allowed to write a review, in negative case the decorator return Forbidden"""

  @functools.wraps(func)
  def wrapper(request, *args, **kwargs):
    if request.user.is_authenticated() and request.user.points < 10:
      logger.warning('The {} user has tried to write a review, but does not have enough points to do so'.format( request.user.pk))
      return HttpResponseForbidden()

    return func(request, *args, **kwargs)

  return wrapper

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持三水点靠木。

Python 相关文章推荐
Python中使用Boolean操作符做真值测试实例
Jan 30 Python
Python 的内置字符串方法小结
Mar 15 Python
关于Python数据结构中字典的心得
Dec 04 Python
python爬虫爬取快手视频多线程下载功能
Feb 28 Python
实例讲解python中的协程
Oct 08 Python
浅谈Python批处理文件夹中的txt文件
Mar 11 Python
python使用BeautifulSoup与正则表达式爬取时光网不同地区top100电影并对比
Apr 15 Python
python3 深浅copy对比详解
Aug 12 Python
python爬虫 2019中国好声音评论爬取过程解析
Aug 26 Python
Python 日志logging模块用法简单示例
Oct 18 Python
Python对Tornado请求与响应的数据处理
Feb 12 Python
解决安装新版PyQt5、PyQT5-tool后打不开并Designer.exe提示no Qt platform plugin的问题
Apr 24 Python
浅析Python pandas模块输出每行中间省略号问题
Jul 03 #Python
python中datetime模块中strftime/strptime函数的使用
Jul 03 #Python
pandas.DataFrame选取/排除特定行的方法
Jul 03 #Python
python 中字典嵌套列表的方法
Jul 03 #Python
Django项目开发中cookies和session的常用操作分析
Jul 03 #Python
Python嵌套列表转一维的方法(压平嵌套列表)
Jul 03 #Python
Python使用matplotlib实现基础绘图功能示例
Jul 03 #Python
You might like
在IIS7.0下面配置PHP 5.3.2运行环境的方法
2010/04/13 PHP
phpMyAdmin 链接表的附加功能尚未激活的问题
2010/08/01 PHP
作为PHP程序员应该了解MongoDB的五件事
2013/06/03 PHP
PHP读取、解析eml文件及生成网页的方法示例
2017/09/04 PHP
PHP生成随机码的思路与方法实例探索
2019/04/11 PHP
js传值 判断
2006/10/26 Javascript
JavaScript中的16进制字符(改进)
2011/11/21 Javascript
HTML页面弹出居中可拖拽的自定义窗口层
2014/05/07 Javascript
JavaScript图片轮播代码分享
2015/07/31 Javascript
JavaScript获取当前运行脚本文件所在目录的方法
2016/02/03 Javascript
Markdown+Bootstrap图片自适应属性详解
2016/05/21 Javascript
AngularJS基础 ng-class-odd 指令示例
2016/08/01 Javascript
JS跨域请求的问题解析
2018/12/03 Javascript
JS使用栈判断给定字符串是否是回文算法示例
2019/03/04 Javascript
vue实现后台管理权限系统及顶栏三级菜单显示功能
2019/06/19 Javascript
开发中常用的25个JavaScript单行代码(小结)
2019/06/28 Javascript
vue-axios同时请求多个接口 等所有接口全部加载完成再处理操作
2020/11/09 Javascript
python逐行读取文件内容的三种方法
2014/01/20 Python
Python网络爬虫出现乱码问题的解决方法
2017/01/05 Python
利用python爬取散文网的文章实例教程
2017/06/18 Python
python OpenCV学习笔记之绘制直方图的方法
2018/02/08 Python
详解Python计算机视觉 图像扭曲(仿射扭曲)
2019/03/27 Python
Python3 chardet模块查看编码格式的例子
2019/08/14 Python
python 并发下载器实现方法示例
2019/11/22 Python
Django框架中间件定义与使用方法案例分析
2019/11/28 Python
python 控制台单行刷新,多行刷新实例
2020/02/19 Python
使用python-Jenkins批量创建及修改jobs操作
2020/05/12 Python
苹果中国官方网站:Apple中国
2016/07/22 全球购物
苏宁红孩子母婴商城:redbaby
2017/02/12 全球购物
北京泡泡网网络有限公司.net面试题
2012/07/17 面试题
学生自我鉴定范文
2013/10/04 职场文书
应届大学生自荐信
2013/12/05 职场文书
建材业务员岗位职责
2013/12/08 职场文书
生活部的活动方案
2014/08/19 职场文书
毕业设计指导教师评语
2014/12/30 职场文书
如何搭建 MySQL 高可用高性能集群
2021/06/21 MySQL