Django之auth模块

Auth简介

Auth模块是Django自带的用户认证模块

我们在开发一个网站的时候, 无可避免的需要设计网站的用户系统, 此时我们西药实现包括用户注册、用户登录、用户认证、注销、修改密码等功能, Django它内置了强大的用户认证系统auth, 是默认使用auth_user表来存储用户数据

User模型

User模型是这个框架的核心部分, 他的完整路径是在 django.contrib.auth.User 

User模型字段

1. username: 用户名. 150个字符以内, 可以包含数字和英文字符, 以及_、@、+、.和-字符. 不能为空且必须唯一

2. first_name: 在30个字符以内, 可以用为空

3. last_name: 在150个字符以内, 可以为空

4. email: 邮箱, 可以为空

5. password: 密码, 经过哈希过后的密码

6. groups: 分组, 一个用户可以属于多个分组, 一个分组可以拥有多个用户. groups这个字段跟Group的一个多对多的关系

7. user_permissions: 权限, 一个用户可以拥有多个权限, 一个权限可以被多个用户所用和permission属于一种多对多的关系

8. is_staff: 是否可以进入到admin的站点, 代表是否是员工

9. is_active: 是否可用的, 对于一些想要闪出账号的数据, 我们设置这个值为False就可以了, 而不是真正的从数据可中删除

10. is_superuser: 是否是超级管理员, 如果是超级管理员, 那么拥有整个网站的所有权限

11. last_login: 上次登录的时间

12. data_joined: 账号创建的时间

Auth模块常用方法

from django.contrib import auth

authenticate()

提供了用户认证功能, 即验证用户名以及密码是否正确, 一般需要使用username、password两个关键字参数, 如果认证成功(用户名和密码正确有效), 便会返回一个User对象

authenticate()会在该User对象上设置一个属性来标识后端已经认证了该用户, 且该信息在后续的登录过程中是需要的

用法:

from django.contrib.auth import authenticate


def login(request):
    username = request.POST.get('username')
    password = request.POST.get('password')
    print(username, password)  # yyf yyf123456789
    user = authenticate(username=username, password=password)
    if user:
        print(user)  # yyf
        print(type(user))  # <class 'django.contrib.auth.models.User'>
        print(user.username)  # yyf
        return HttpResponse('ok')

login(HttpRequest, user)

该函数接受一个HttpRequest对象, 以及一个经过认证的User对象

该函数实现一个用户登录的功能, 它本质上会在后端为该用户生产相关session数据

用法:

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)

loginout(request)

该函数接受一个HttpRequest对象, 无返回值

当调用函数时, 当前请求的session信息会全部清除, 该用户即使没有登录, 使用该函数也不会报错

用法:

from django.contrib.auth import logout

def logout_view(request):
    logout(request)

is_authenticated()

用来判断当前请求是否通过了认证

用法:

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

login_requierd()

auth给我提供的一个装饰器工具, 用来快捷的给某个视图添加登录校验

用法:

from django.contrib.auth.decorators import login_required

@login_required
def my_view(request):
    ....

若用户没有登录, 则会跳转到django默认的登录URL'/acounts/login/'并传递当前访问url的绝对路径(登录成功后, 悔重定向到该路径)

如果需要自定义登录的URL, 则需要在settings.py文件中通过LOGIN_URL进行修改

示例:

LOGIN_URL = '/login/'   # 这里配置成你项目登录页面的路由

 create_user()

auth提供的一个创建新用户的方法, 需要提供必要参数(username、password)等

用法:

from django.contrib.auth.models import User
user = User.objects.create_user(username='用户名', password='密码', email='邮箱'.....)

create_superuser()

auth提供的一个创建新的超级用户的方法, 需要提供必要参数(username, password)等

from django.contrib.auth.models import User
user = User.objects.create_superuser(username='用户名', password='密码',email='邮箱')

check_password(password)

auth提供的一个检查密码是否正确的方法, 需要提供当前请求用户的密码

密码正确返回True, 否则返回False

res = user.check_password('密码')

set_password(password)

auth提供的一个修改密码的方法, 接收要设置的新密码作为参数

注意: 设置完一定要调用用户对象的save方法

user.set_password(password='')
user.save()

@login_required
def set_password(request):
    back_dic = {'code': 200, 'msg': '', 'data': None}
    user = request.user
    if request.method == 'POST':
        old_password = request.POST.get('old_password', '')
        new_password = request.POST.get('new_password', '')
        repeat_password = request.POST.get('repeat_password', '')
        if user.check_password(old_password):
            if not new_password:
                back_dic['msg'] = '新密码不能为空'
            elif new_password != repeat_password:
                back_dic['msg'] = '两次密码不一致'
            else:
                user.set_password(new_password)
                user.save()
                return redirect('/login/')
        else:
            back_dic['msg'] = '原密码输入错误'
    return render(request, 'set_password.html', local())

User对象的属性

User对象属性: username, password

is_staff: 用户是否拥有网站的管理权限

is_actice: 是否允许用户登录, 设置为False, 可以在不删除用户的前提下禁止用户登录

 

给密码加密的方法

django.contrib.auth.hashers.make_password

from django.contrib.auth.hashers import make_password

password = make_passwork(password)

 

自定义User表

如果需要添加字段, 就需要继承内置的AbstractUser类, 来定义一个自己的Model类

from django.contrib.auth.models import AbstractUser
class UserInfo(AbstractUser):
    nid = models.AutoField(primary_key=True)
    phone = models.CharField(max_length=11, null=True, unique=True)
    
    def __str__(self):
        return self.username

自定义auth_user表之后, 一定要在settings.py中告诉Django, 我们使用新的UserInfo表来认证用户

# 引用Django自带的User表, 继承使用时需要设置
AUTH_USER_MODEL = 'app名.UserInfo'

一旦我们指定了新的认证系统所使用的表, 我们就需要重新在数据库中创建该表, 而不能使用原来默认的auth_user表