Django权限系统auth模块用法解读

这篇文章主要介绍了Django权限系统auth模块用法解读，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教

认证系统auth

auth模块是Django提供的标准权限管理系统,可以提供用户身份认证, 用户组和权限管理。auth可以和admin模块配合使用，快速建立网站的管理系统。

auth模块

from django.contrib import auth

django.contrib.auth中提供了许多方法，这里主要介绍其中的三个：

1 authenticate()

提供了用户认证，即验证用户名以及密码是否正确,一般需要username password两个关键字参数

如果认证信息有效，会返回一个 User 对象。authenticate()会在User 对象上设置一个属性标识那种认证后端认证了该用户，且该信息在后面的登录过程中是需要的。当我们试图登陆一个从数据库中直接取出来不经过authenticate()的User对象会报错的！！

user = authenticate(username='someone',password='somepassword')

2 login(HttpRequest, user)

该函数接受一个HttpRequest对象，以及一个认证了的User对象

此函数使用django的session框架给某个已认证的用户附加上session id等信息。

from django.contrib.auth import authenticate, login def my_view(request):   username = request.POST['username']   password = request.POST['password']   user = authenticate(username=username, password=password)   if user is not None:     login(request, user)     # Redirect to a success page.     ...   else:     # Return an 'invalid login' error message.     ...

3 logout(request) 注销用户

from django.contrib.auth import logout def logout_view(request):   logout(request)   # Redirect to a success page.

该函数接受一个HttpRequest对象，无返回值。当调用该函数时，当前请求的session信息会全部清除。该用户即使没有登录，使用该函数也不会报错。

4 is_authenticated()

要求：

1 用户登陆后才能访问某些页面，

2 如果用户没有登录就访问该页面的话直接跳到登录页面

3 用户在跳转的登陆界面中完成登陆后，自动访问跳转到之前访问的地址

// 方法一 def my_view(request):   if not request.user.is_authenticated():     return redirect('%s?next=%s' % (settings.LOGIN_URL, request.path))

# django已经为我们设计好了一个用于此种情况的装饰器：login_requier from django.contrib.auth.decorators import login_required @login_required def my_view(request):   ...

若用户没有登录，则会跳转到django默认的登录URL '/accounts/login/ ' (这个值可以在settings文件中通过LOGIN_URL进行修改)。并传递当前访问url的绝对路径 (登陆成功后，会重定向到该路径)。

User对象

User 对象属性：username， password（必填项）password用哈希算法保存到数据库

is_staff ：用户是否拥有网站的管理权限.
is_active ：是否允许用户登录, 设置为``False``，可以不用删除用户来禁止用户登录

is_authenticated()

如果是真正的 User 对象，返回值恒为 True 。用于检查用户是否已经通过了认证。

通过认证并不意味着用户拥有任何权限，甚至也不检查该用户是否处于激活状态，这只是表明用户成功的通过了认证。这个方法很重要, 在后台用request.user.is_authenticated()判断用户是否已经登录，如果true则可以向前台展示request.user.name

User

User是auth模块中维护用户信息的关系模式(继承了models.Model), 数据库中该表被命名为auth_user.

User表的SQL描述:

CREATE TABLE "auth_user" (     "id" integer NOT NULL PRIMARY KEY AUTOINCREMENT,      "password" varchar(128) NOT NULL, "last_login" datetime NULL,      "is_superuser" bool NOT NULL,      "first_name" varchar(30) NOT NULL,      "last_name" varchar(30) NOT NULL,     "email" varchar(254) NOT NULL,      "is_staff" bool NOT NULL,      "is_active" bool NOT NULL,     "date_joined" datetime NOT NULL,     "username" varchar(30) NOT NULL UNIQUE )

User对象顾名思义即为表示用户的对象，里面的属性包括以上几条：

创建好对象后，django会自动生成表，表名为auth_user，包含以上字段。具体的api文档如下所示:

    class models.User User 对象具有如下字段： username 必选。少于等于30个字符。 用户名可以包含字母、数字、_、@、+、.和- 字符。 first_name 可选。 少于等于30个字符。 last_name 可选。少于30个字符。 email 可选。邮箱地址。 password 必选。 密码的哈希及元数据。（Django 不保存原始密码）。原始密码可以无限长而且可以包含任意字符。参见密码相关的文档。 groups 与Group 之间的多对多关系。 user_permissions 与Permission 之间的多对多关系。 is_staff 布尔值。指示用户是否可以访问Admin 站点。 is_active 布尔值。指示用户的账号是否激活。 is_superuser 布尔值。只是这个用户拥有所有的权限而不需要给他们分配明确的权限。 last_login 用户最后一次登录的时间。 date_joined 账户创建的时间。当账号创建时，默认设置为当前的date/time。

auth模块提供了很多API管理用户信息, 在必要的时候我们可以导入User表进行操作, 比如其它表需要与User建立关联时.

from django.contrib.auth.models import User

新建用户

user = User.objects.create_user(username, email, password)

建立user对象

user.save()

需要调用save()方法新用户才会写入数据库

auth模块不存储用户密码明文而是存储一个Hash值, 比如迭代使用Md5算法.

一般在注册操作中会用到该方法，实现注册一个用户，用到的函数是User.objects.create_user()，在新建用户的时候需要判断用户是否存在，我的实现方式是，User.objects.get(username=xxx)去获取一个用户User对象，用try except实现，如果用户不存在则抛出User.DoesNotExist异常，在这个异常中进行创建用户的操作。具体代码如下:

# 注册操作 from django.contrib.auth.models import User try:   User.objects.get(username=username)   data = {'code': '-7', 'info': u'用户已存在'} except User.DoesNotExist:   user = User.objects.create_user(username, email, password)   if user is not None:     user.is_active = False     user.save()

认证用户

先导入函数

from django.contrib.auth import authenticate

使用关键字参数传递账户和凭据:

user = authenticate(username=username, password=password)

认证用户的密码是否有效, 若有效则返回代表该用户的user对象, 若无效则返回None.

该方法不检查is_active标志位.

修改密码

用户需要修改密码的时候首先要让他输入原来的密码，如果给定的字符串通过了密码检查，返回 True

def change_password(request):     if request.is_ajax():         data = json.loads(request.POST.get('data'))         oldPassword = data.get('oldPassword')         newPassword = data.get('newPassword')         confirmPassword = data.get('confirmPassword')         if request.user.check_password(oldPassword):     # 判断旧密码是否正确             request.user.set_password(newPassword)             request.user.save()             result = {'status': 0, "info": "密码修改登录成功！！"}         else:             result = {'status': 1, "info": "原密码不正确！！"}         return HttpResponse(json.dumps(result))     return render(request, 'changepassword.html')

修改密码是User的实例方法, 该方法不验证用户身份:

user.set_password(new_password)

通常该方法需要和authenticate配合使用:

user = auth.authenticate(username=username, password=old_password) if user is not None:     user.set_password(new_password)     user.save()

from django.contrib.auth import authenticate, login, logout # 认证操作 ca = Captcha(request) if ca.validate(captcha_code):   user = authenticate(username=username, password=password)   if user is not None:     if user.is_active:       # 登录成功       login(request, user)  # 登录用户       data = {'code': '1', 'info': u'登录成功', 'url': 'index'}     else:       data = {'code': '-5', 'info': u'用户未激活'}   else:       data = {'code': '-4', 'info': u'用户名或密码错误'} else:   data = {'code': '-6', 'info': u'验证码错误'}

退出登录

logout会移除request中的user信息, 并刷新session:

from django.contrib.auth import logout def logout_view(request):     logout(request) from django.contrib.auth import authenticate, login, logout def logout_system(request):     """     退出登录     :param request:     :return:     """     logout(request)     return HttpResponseRedirect('/')

只允许登录的用户访问

@login_required修饰器修饰的view函数会先通过session key检查是否登录, 已登录用户可以正常的执行操作, 未登录用户将被重定向到login_url指定的位置.

若未指定login_url参数, 则重定向到settings.LOGIN_URL

from django.contrib.auth.decorators import login_required @login_required(login_url='/accounts/login/') def my_view(request):     ...from django.contrib.auth.decorators import login_required @login_required def user_index(request):     """     用户管理首页     :param request:     :return:     """     if request.method == "GET":         # 用户视图实现

Group

django.contrib.auth.models.Group定义了用户组的模型，每个用户组拥有id和name两个字段，该模型在数据库被映射为auth_group数据表。

User对象中有一个名为groups的多对多字段，多对多关系由auth_user_groups数据表维护。Group对象可以通过user_set反向查询用户组中的用户。

我们可以通过创建删除Group对象来添加或删除用户组。

# add group = Group.objects.create(name=group_name) group.save() # del group.delete()

我们可以通过标准的多对多字段操作管理用户与用户组的关系:

用户加入用户组user.groups.add(group)或group.user_set.add(user)
用户退出用户组user.groups.remove(group)或group.user_set.remove(user)
用户退出所有用户组user.groups.clear()
用户组中所有用户退出组group.user_set.clear()

# 创建组 try:     Group.objects.get(name=role_name)     data = {'code': -7, 'info': u'组名已存在'} except Group.DoesNotExist:     groups = Group.objects.create(name=role_name)     if log_manage == 'true':         permission = Permission.objects.get(codename='access_log')         groups.permissions.add(permission)     if role_manage == 'true':         permission = Permission.objects.get(codename='access_role_manage')         groups.permissions.add(permission)     if user_manage == 'true':         permission = Permission.objects.get(codename='access_user_manage')         groups.permissions.add(permission)     if get_users is not None:         for user in get_users:             # 每个user添加组属性             db_user = get_object_or_404(User, username=user)             db_user.groups.add(groups)             data = {'code': 1, 'info': u'添加成功'}     return HttpResponse(json.dumps(data))

Permission

Django的auth系统提供了模型级的权限控制，即可以检查用户是否对某个数据表拥有增(add), 改(change), 删(delete)权限。

auth系统无法提供对象级的权限控制，即检查用户是否对数据表中某条记录拥有增改删的权限。如果需要对象级权限控制可以使用django-guardian.

假设在博客系统中有一张article数据表管理博文， auth可以检查某个用户是否拥有对所有博文的管理权限，但无法检查用户对某一篇博文是否拥有管理权限。

检查用户权限

user.has_perm方法用于检查用户是否拥有操作某个模型的权限:

user.has_perm('blog.add_article') user.has_perm('blog.change_article') user.has_perm('blog.delete_article')

上述语句检查用户是否拥有blog这个app中article模型的添加权限，若拥有权限则返回True。

has_perm仅是进行权限检查, 即是用户没有权限它也不会阻止程序员执行相关操作。

permission_required修饰器可以代替has_perm并在用户没有相应权限时重定向到登录页或者抛出异常。

# permission_required(perm[, login_url=None, raise_exception=False]) @permission_required('blog.add_article') def post_article(request):     pass

每个模型默认拥有增(add), 改(change), 删(delete)权限。在django.contrib.auth.models.Permission模型中保存了项目中所有权限。

该模型在数据库中被保存为auth_permission数据表。每条权限拥有id ,name , content_type_id, codename四个字段。

管理用户权限

User和Permission通过多对多字段user.user_permissions关联，在数据库中由auth_user_user_permissions数据表维护。

添加权限: user.user_permissions.add(permission)
删除权限: user.user_permissions.delete(permission)
清空权限: user.user_permissions.clear()

用户拥有他所在用户组的权限，使用用户组管理权限是一个更方便的方法。Group中包含多对多字段permissions，在数据库中由auth_group_permissions数据表维护。

添加权限: group.permissions.add(permission)
删除权限: group.permissions.delete(permission)
清空权限: group.permissions.clear()

自定义权限

在定义Model时可以使用Meta自定义权限:

class Discussion(models.Model):   ...   class Meta:       permissions = (           ("create_discussion", "Can create a discussion"),           ("reply_discussion", "Can reply discussion"),       )

在上一点中用到的Permission.objects.get(codename='access_user_manage')是通过权限模型创建，需要在models中创建一个权限类，然后在meta中进行定义codename。

class AccessControl(models.Model):     """     自定义权限控制     """     class Meta:         permissions = (             ('access_dashboard', u'控制面板'),             ('access_log', u'日志管理'),             ('access_role_manage', u'角色管理'),             ('access_user_manage', u'用户管理'),         )

运行后，会自动在数据库中创建相应的表，并且插入数据。

在创建好权限之后，下一步就是在各个视图中插入权限控制代码了。permission_required()，参数为当前应用名.codename。这样就能控制用户访问，如果用户非法访问则会清空session退出登录。

@permission_required('webcenter.access_role_manage') @login_required def role_index(request):     """     角色管理首页     :param request:     :return:     """

同时在前端模板页面中也需要进行权限控制，前端要获取request对象的话，后端返回就需要使用render函数，render(request,xxx,xxx)，具体代码就如下：

{% if request.user.is_superuser or 'webcenter.access_user_manage' in request.user.get_group_permissions or 'webcenter.access_role_manage' in request.user.get_group_permissions or 'webcenter.access_log' in request.user.get_group_permissions  %}                  站点管理         {% if request.user.is_superuser or 'webcenter.access_log' in request.user.get_group_permissions %}       日志管理
   {% endif %}   {% if request.user.is_superuser or 'webcenter.access_role_manage' in request.user.get_group_permissions %}       角色管理
   {% endif %}   {% if request.user.is_superuser or 'webcenter.access_user_manage' in request.user.get_group_permissions %}       用户管理
   {% endif %} 
 {% endif %}

判断用户是否拥有自定义权限: