Django权限机制的实现
1. Django权限机制概述
权限机制能够约束用户行为，控制页面的显示内容，也能使API更加安全和灵活；用好权限机制，能让系统更加强大和健壮。因此，基于Django的开发，理清Django权限机制是非常必要的。 1.1 Django的权限控制
Django用user, group和permission完成了权限机制，这个权限机制是将属于model的某个permission赋予user或group，可以理解为全局的权限，即如果用户A对数据模型（model）B有可写权限，那么A能修改model B的所有实例（objects）。group的权限也是如此，如果为group C 赋予model B的可写权限，则隶属于group C 的所有用户，都可以修改model B的所有实例。
这种权限机制只能解决一些简单的应用需求，而大部分应用场景下，需要更细分的权限机制。以博客系统为例，博客系统的用户可分为『管理员』、『编辑』、『作者』和『读者』四个用户组；博客系统管理员和编辑具有查看、修改和删除所有的文章的权限，作者只能修改和删除自己写的文章，而读者则只有阅读权限。管理员、编辑和读者的权限，我们可以用全局权限做控制，而对于作者，全局权限无法满足需求，仅通过全局权限，要么允许作者编辑不属于自己的文章，要么让作者连自己的文章都无法修改。
上述的应用场景，Django自带的权限机制无法满足需求，需要引入另一种更细的权限机制：对象权限（object permission）。
Object Permission是一种对象颗粒度上的权限机制，它允许为每个具体对象授权。仍沿用最开始的例子，如果model B有三个实例 B1，B2 和B3，如果我们把B1的可写权限赋予用户A，则A可以修改B1对象，而对B2，B3无法修改。对group也一样，如果将B2的可写权限赋予group C，则隶属于group C的所有用户均可以修改B2，但无法修改B1和B3。结合Django自带权限机制和object permission，博客系统中作者的权限控制迎刃而解：系统全局上不允许作者编辑文章，而对于属于作者的具体文章，赋予编辑权限即可。
Django其实包含了object permission的框架，但没有具体实现，object permission的实现需要借助第三方app django-guardian，我们在开发中用调用django guradian封装好的方法即可。 1.2 Django的权限项
Django用permission对象存储权限项，每个model默认都有三个permission，即add model, change model和delete model。例如，定义一个名为『Car』model，定义好Car之后，会自动创建相应的三个permission：add_car, change_car和delete_car。Django还允许自定义permission，例如，我们可以为Car创建新的权限项：drive_car, clean_car, fix_car等等。
需要注意的是，permission总是与model对应的，如果一个object不是model的实例，我们无法为它创建/分配权限。 2 Django 自带权限机制的应用 2.1 Permission
如上文所述，Django定义每个model后，默认都会添加该model的add, change和delete三个permission，自定义的permission可以在我们定义model时手动添加：
class Task(models.Model): ... class Meta: permissions = ( ("view_task", "Can see available tasks"), ("change_task_status", "Can change the status of tasks"), ("close_task", "Can remove a task by setting its status as closed"), )
每个permission都是django.contrib.auth.Permission类型的实例，该类型包含三个字段name, codename 和 content_type，其中 content_type反应了permission属于哪个model，codename如上面的view_task，代码逻辑中检查权限时要用， name是permission的描述，将permission打印到屏幕或页面时默认显示的就是name。
在model中创建自定义权限，从系统开发的角度，可理解为创建系统的内置权限，如果需求中涉及到用户使用系统时创建自定义权限，则要通过下面方法：
from myapp.models import BlogPost from django.contrib.auth.models import Permission from django.contrib.contenttypes.models import ContentType
content_type = ContentType.objects.get_for_model(BlogPost) permission = Permission.objects.create(codename='can_publish', name='Can Publish Posts', content_type=content_type)
2.2 User Permission管理
User对象的user_permission字段管理用户的权限：
myuser.user_permissions = [permission_list] myuser.user_permissions.add(permission, permission, ...) #增加权限 myuser.user_permissions.remove(permission, permission, ...) #删除权限 myuser.user_permissions.clear() #清空权限
############################################################## # 注：上面的permission为django.contrib.auth.Permission类型的实例 ##############################################################
检查用户权限用has_perm()方法：
myuser.has_perm('myapp.fix_car')
has_perm()方法的参数，即permission的codename，但传递参数时需要加上model 所属app的前缀，格式为.。
无论permission赋予user还是group，has_perm()方法均适用
附注：
user.get_all_permissions()方法列出用户的所有权限，返回值是permission name的list user.get_group_permissions()方法列出用户所属group的权限，返回值是permission name的list。
2.3 Group Permission管理
group permission管理逻辑与user permission管理一致，group中使用permissions字段做权限管理：
group.permissions = [permission_list] group.permissions.add(permission, permission, ...) group.permissions.remove(permission, permission, ...) group.permissions.clear()。
权限检查：
依然使用user.has_perm()方法。 2.4 permission_required 装饰器
权限能约束用户行为，当业务逻辑中涉及到权限检查时，decorator能够分离权限验证和核心的业务逻辑，使代码更简洁，逻辑更清晰。permission的 decorator为permission_required：
from django.contrib.auth.decorators import permission_required
@permission_required('car.drive_car') def my_view(request): ...
2.5 Template中的权限检查
Template中使用全局变量perms存储当前用户的所有权限，权限检查可以参考下面例子：
{% if perms.main.add_page %} <li class="dropdown"> <a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-expanded="false">Pages <span class="caret"></span></a> <ul class="dropdown-menu" role="menu"> <li><a href="{% url 'main:admin_pages' %}">All Pages</a></li> <li><a href="{% url 'main:admin_page' %}">New Page</a></li> <li><a href="{% url 'main:admin_pages' %}?draft=true">Drafts</a></li> </ul> </li> {% endif %}
3 基于Django-guardian的object permission的应用
Django-guardian基于django的原生逻辑扩展了django的权限机制，应用django-guardian后，可以使用django-guardian提供的方法以及django的原生方法检查全局权限，django-guardian提供的object permission机制使django的权限机制更加完善。
django-guardian详细的使用文档请参考官方文档，其object permission常用方法如下：
from guardian.shortcuts import assign_perm, get_perms from guardian.core import ObjectPermissionChecker from guardian.decorators import permission_required
3.1 添加object permission
添加object permission使用assign_perm()方法，如为用户添加对mycar对象的drive_car权限：
assign_perm('myapp.drive_car', request.user, mycar)
assign_perm()方法也可用于group
assign_perm('myapp.drive_car', mygroup, mycar)
3.2 权限检查 3.2.1 Global permission
get_perms()方法用于检查用户的“全局权限”（global permission），与user.has_perm()异曲同工，如：
############################# # It works! ############################# if not 'main.change_post' in get_perms(request.user, post): raise HttpResponse('Forbidden')
############################# # It works, too! ############################# if not request.user.has_perm('main.change_post') return HttpResponse('Forbidden')
例子中虽然把post object作为参数传给get_perms()方法，但它只检查user的全局权限中是否有main.change_post权限，很多情况下可用原生的user.has_perm取代，但user和group均可作为get_perms()的传入参数，某些情况下可以使代码更简洁。 3.2.2 Object permission
Django-guardian中使用ObjectPermissionChecker检查用户的object permission，示例如下：
checker = ObjectPermissionChecker(request.user) print checker.has_perm('main.change_post', post)
3.3 permission_required装饰器
guardian.decorators.permission_required是django-guardian权限检查的decorator，既可以检查全局权限，又可以检查对象权限（object permission），其中，accept_global_perms参数指出是否检查user的global permission，如：
from guardian.decorators import permission_required
class DeletePost(View): @method_decorator(permission_required('main.delete_post', (models.Post, 'id', 'pk'), accept_global_perms=True)) def get(self, request, pk): try: pk = int(pk) cur_post = models.Post.objects.get(pk=pk) is_draft = cur_post.is_draft
url = reverse('main:admin_posts') if is_draft: url = '{0}?draft=true'.format(url) cur_post.delete() except models.Post.DoesNotExist: raise Http404
return redirect(url)
注：
decorator中的(models.Post, ‘id’, ‘pk’)部分，用于指定object实例，如果忽略这个参数，则不论accept_global_perms值为True还是False，均仅仅检查全局权限。 4 结论
Django原生提供了一种简单的全局权限（global permission）控制机制，但很多应用场景下，对象权限（object permission）更加有用；django-guardian是目前比较活跃的一个django extension，提供了一种有效的object permission控制机制，与django原生机制一脉相承，推荐使用。
当我们为应用创建一个Models, 在同步到数据库里，django默认给了三个权限 ，就是 add, change, delete权限。
首先，我们创建一个perm_test的project, 然后再创建一个school的app.
django-admin.py startproject perm_test
cd perm_test
python manage.py startapp schoolmodels:
from django.db import models
# Create your models here.
class Student(models.Model):
name = models.CharField('姓名', max_length=64)
age = models.SmallIntegerField('年龄')
choices = (
(1, '男'),
(2, '女'),
(3, '未知')
)
sex = models.SmallIntegerField('性别', choices=choices)admin.py
from django.contrib import admin
# Register your models here.
from . import models
admin.site.register(models.Student)同步到数据库并创建superuser:
python manage.py makemigrations
python manage.py migrate
python manage.py createsuperuser启动web服务，登录admin（http://localhost:8000）
python manage.py runserver在后台先创建一个用户试试， 看到选择权限的地方如下：
先不加任何权限保存后,用新用户登录admin:
直接提示无权修改任何东西，因为没有任何权限。
尝试增加一个Student的change的权限，刷新一下：
只有修改的权限, 因为我们加的就是修改的权限, 但是这里好你有删除选项,执行试一下
无法显示,显然是没有权限 删除的
到django shell里查询一下权限：
>>> python manage.py shell
>>> from django.contrib.auth.models import User
>>> user_obj = User.objects.get(name='lishi')
#可以使用dir来看有哪些方法可以用
>>> dir(user_obj)
#获取用户的所有权限
>>> user_obj.get_all_permissions()
{'school.change_student'}以上这些都是django内置的权限， 那我们怎么来定义自己的权限呢？
下面来定义自己的权限 并应用在自己的页面上呢？
首先要说的是，我们必须为url设置name, 因为权限需要和urlname配合使用，urlname就是url(r’’, views.method, name=’urlname’)里的name值。还要建立权限名称和具体操作的映射关系， 即权限名称与(urlname, 请求方法，参数列表)的对应关系，如果用字典表示，就是这样的：
{'add student', 'get', []}第一步，要在models中建立权限的名称和描述信息，这个信息是在django admin中设置权限时显示的信息
第二步，建立一个权限表Permission, 将权限的名称,url名称，请求方法(get or post), 参数列表保存进去
第三步， 定义判断权限的方法
下面来实验一下，我们定义一个查看学员列表的权限：
第一步： 在models中建立权限表，我是将映射关系存放在数据库中：
class Permission(models.Model):
name = models.CharField("权限名称", max_length=64)
url = models.CharField('URL名称', max_length=255)
chioces = ((1, 'GET'), (2, 'POST'))
per_method = models.SmallIntegerField('请求方法', choices=chioces, default=1)
argument_list = models.CharField('参数列表', max_length=255, help_text='多个参数之间用英文半角逗号隔开', blank=True, null=True)
describe = models.CharField('描述', max_length=255)
def __str__(self):
return self.name
class Meta:
verbose_name = '权限表'
verbose_name_plural = verbose_name
#权限信息，这里定义的权限的名字，后面是描述信息，描述信息是在django admin中显示权限用的
permissions = (
('views_student_list', '查看学员信息表'),
('views_student_info', '查看学员详细信息'),
)第二步：在权限表中添加内容，将对应权限写入数据库：
第三步: 定义权限验证方法, 逻辑是这样,请求访问学员列表, 先获取url地址，根据url地址得到urlname, 再获取请求方法和参数，然后使用urlname, 请求方法，参数列表到数据库中查询，能查询到之后说明这个权限存在；然后再使用request.user.has_perm()来判断该用户是否具有该权限。
在应用school目录下建立permission.py文件，我们将权限验证方法写在这里面：
from django.shortcuts import render
from school import models
from django.db.models import Q
from django.core.urlresolvers import resolve #此方法可以将url地址转换成url的name
def perm_check(request, *args, **kwargs):
url_obj = resolve(request.path_info)
url_name = url_obj.url_name
perm_name = ''
#权限必须和urlname配合使得
if url_name:
#获取请求方法，和请求参数
url_method, url_args = request.method, request.GET
url_args_list = []
#将各个参数的值用逗号隔开组成字符串，因为数据库中是这样存的
for i in url_args:
url_args_list.append(str(url_args[i]))
url_args_list = ','.join(url_args_list)
#操作数据库
get_perm = models.Permission.objects.filter(Q(url=url_name) and Q(per_method=url_method) and Q(argument_list=url_args_list))
if get_perm:
for i in get_perm:
perm_name = i.name
perm_str = 'school.%s' % perm_name
if request.user.has_perm(perm_str):
print('====》权限已匹配')
return True
else:
print('---->权限没有匹配')
return False
else:
return False
else:
return False #没有权限设置，默认不放过
def check_permission(fun): #定义一个装饰器，在views中应用
def wapper(request, *args, **kwargs):
if perm_check(request, *args, **kwargs): #调用上面的权限验证方法
return fun(request, *args, **kwargs)
return render(request, '403.html', locals())
return wapper到这里自定义权限已经完成了，接下来要做的是在我们自己的页面中使用：
创建一个student_list.html页面，展示学员列表：
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>Title</title>
</head>
<body>
<table>
<tr>
<td>姓名</td>
<td>年龄</td>
<td>性别</td>
</tr>
{% for student_obj in students_obj %}
<tr>
<td>{{ student_obj.name }}</td>
<td>{{ student_obj.age }}</td>
<td>{{ student_obj.get_sex_display }}</td>
</tr>
{% endfor %}
</table>
</body>
</html>创建views方法：
from django.shortcuts import render
from school import models
from school.permission import check_permission
# Create your views here.
@check_permission
def students(request):
students_obj = models.Student.objects.all()
return render(request, 'students_list.html', locals())我们使用装饰器的方法来检查权限。当用户具有权限时，返回渲染的页面。但似乎还少了点什么，在权限验证方法里，当检测没有权限时返加403页面，所以我们还要创建一个403页面403.html：
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>Title</title>
</head>
<body>
<h1>403</h1>
<h2>You don't have enought permissions to this action!</h2>
</body>
</html>最后建立urls.py吧：
project下的urls.py:
from django.conf.urls import url, include
from django.contrib import admin
urlpatterns = [
url(r'^admin/', admin.site.urls),
url(r'^school/', include('school.urls')),
]school下的urls.py:
from django.conf.urls import url
from school import views
urlpatterns = [
url(r'students/$', views.students, name='students_list'),
]到这算是完全写好了，下面来验证一下：
登录admin设置一下lishi的权限，我们先不给任何权限，访问http://localhost:8000/school/students看看结果：
访问结果, 是我们想要的结果,提示没有权限:
再给lishi一个查看的权限：
再来访问一下:
