详解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 struct模块解析
Jun 12 Python
Python库urllib与urllib2主要区别分析
Jul 13 Python
python进程管理工具supervisor的安装与使用教程
Sep 05 Python
Python中使用支持向量机(SVM)算法
Dec 26 Python
不到40行代码用Python实现一个简单的推荐系统
May 10 Python
python3 mmh3安装及使用方法
Oct 09 Python
Python3 使用selenium插件爬取苏宁商家联系电话
Dec 23 Python
python2 对excel表格操作完整示例
Feb 23 Python
Python面向对象程序设计之静态方法、类方法、属性方法原理与用法分析
Mar 23 Python
python实现猜单词游戏
May 22 Python
python 实用工具状态机transitions
Nov 21 Python
Python 爬虫批量爬取网页图片保存到本地的实现代码
Dec 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
PHP中文汉字验证码
2007/04/08 PHP
PHP 杂谈《重构-改善既有代码的设计》之三 重新组织数据
2012/04/09 PHP
PHP判断手机是IOS还是Android
2015/12/09 PHP
php生成0~1随机小数的方法(必看)
2017/04/05 PHP
JS宝典学习笔记(下)
2007/01/10 Javascript
IE8 原生JSON支持
2009/04/13 Javascript
从零开始学习jQuery (十) jQueryUI常用功能实战
2011/02/23 Javascript
基于Jquery+Ajax+Json的高效分页实现代码
2011/10/29 Javascript
Javascript 键盘事件的组合使用实现代码
2012/05/04 Javascript
jQuery获取当前对象标签名称的方法
2014/02/07 Javascript
javascript跨域的4种方法和原理详解
2014/04/08 Javascript
jQuery中$.ajax()和$.getJson()同步处理详解
2015/08/12 Javascript
js+html5实现的自由落体运动效果代码
2016/01/28 Javascript
jQuery的文档处理程序详解
2016/05/10 Javascript
微信公众号 客服接口的开发实例详解
2016/09/28 Javascript
JQuery和HTML5 Canvas实现弹幕效果
2017/01/04 Javascript
node学习记录之搭建web服务器教程
2017/02/16 Javascript
JavaScript实现数字前补“0”的五种方法示例
2019/01/03 Javascript
vue cli3.0 引入eslint 结合vscode使用
2019/05/27 Javascript
浅谈laytpl 模板空值显示null的解决方法及简单的js表达式
2019/09/19 Javascript
微信小程序获取复选框全选反选选中的值(实例代码)
2019/12/17 Javascript
python中类变量与成员变量的使用注意点总结
2017/04/29 Python
运行django项目指定IP和端口的方法
2018/05/14 Python
在Python中定义一个常量的方法
2018/11/10 Python
python2和python3的输入和输出区别介绍
2018/11/20 Python
python+flask实现API的方法
2018/11/21 Python
python正则表达式的懒惰匹配和贪婪匹配说明
2020/07/13 Python
浅谈html5之sse服务器发送事件EventSource介绍
2017/08/28 HTML / CSS
俄罗斯三星品牌商店:GalaxyStore
2020/11/04 全球购物
2014年党务公开方案
2014/05/08 职场文书
2014年祖国生日寄语
2014/09/19 职场文书
社区端午节活动总结
2015/02/11 职场文书
电力安全教育培训心得体会
2016/01/11 职场文书
解决golang结构体tag编译错误的问题
2021/05/02 Golang
Python趣味挑战之给幼儿园弟弟生成1000道算术题
2021/05/28 Python
nginx配置指令之server_name的具体使用
2022/08/14 Servers