Django框架——auth模块
auth模块简介
auth模块是对登录认证方法的一种封装,之前我们获取用户输入的用户名及密码后需要自己从user表里查询有没有用户名和密码符合的对象,
而有了auth模块之后就可以很轻松的去验证用户的登录信息是否存在于数据库中。
除此之外,auth还对session做了一些封装,方便我们校验用户是否已登录
auth模块引入
from django.contrib import auth
auth模块常用方法
authenticate()
-
这个方法提供了用户的登录认证功能,可以用来验证用户名密码是否正确,它需要把username和password全部都作为参数丢进去,它会将密码用自己的方法进行加密,然后再与表中的加密密码进行校验,如果验证成功就会返回一个user对象,如果不成功就会返回None
-
authenticate()会在User 对象上设置一个属性标识那种认证后端认证了该用户,且该信息在后面的登录过程中是需要的。当我们试图登陆一个从数据库中直接取出来不经过authenticate()的User对象会报错
from django.contrib import auth def login(request): if request.method == 'POST': username = request.POST.get('username') password = request.POST.get('password') user_obj = auth.authenticate(request, username=username, password=password) print(user_obj) ''' 1.自动查找auth_user标签 2.自动给密码加密再比对 该方法注意事项 括号内必须同时传入用户名或者密码 不能只传用户名 '''
创建用户对象的三个方法
-
create():创建一个普通用户,密码是明文的。
-
create_user():创建一个普通用户,密码是密文的。
-
create_superuser():创建一个超级用户,密码是密文的,要多传一个邮箱 email 参数。
参数:
-
username: 用户名。
-
password:密码。
-
email:邮箱 (create_superuser 方法要多加一个 email)。
from django.contrib.auth.models import User User.objects.create(username='runboo',password='123')
from django.contrib.auth.models import User User.objects.create_user(username='runbooo',password='123')
from django.contrib.auth.models import User User.objects.create_superuser(username='runboooo',password='123',email='runboo@163.com')
-
-
login(request, user_obj)
-
该方法用于用户的登录,当authenticate()方法验证成功之后,就可以用这个方法完成用户的登录
-
他的参数有两个,一个是request对象,另一个是登录的用户对象
-
用这个方法登录之后可以在任意的地方通过request.user拿到当前登录用户对象
-
他的本质是会在后端为该用户生成相关的session数据
def login(request): if request.method == 'POST': username = request.POST.get('username') password = request.POST.get('password') user_obj = auth.authenticate(request, username=username, password=password) print(user_obj) ''' 1.自动查找auth_user标签 2.自动给密码加密再比对 该方法注意事项 括号内必须同时传入用户名或者密码 不能只传用户名 ''' if user_obj: # 保存用户状态 # 可以在任意地方通过request.user拿到当前登录用户 auth.login(request, user_obj) print('用户登陆成功') return render(request, 'login.html')
logout(request)
-
该方法用于对用户的注销,也就是退出登录功能
-
使用该方法后,当前请求的session信息会全部清除。即使用户没有登陆,也不会报错
def logout(request): auth.logout(request) # 类似于request.session.flush() return redirect(to='/login/')
is_authenticated()
-
该方法用于判断当前请求是否通过了认证
def login(request): if request.method == 'POST': username = request.POST.get('username') password = request.POST.get('password') user_obj = auth.authenticate(request, username=username, password=password) print(user_obj) ''' 1.自动查找auth_user标签 2.自动给密码加密再比对 该方法注意事项 括号内必须同时传入用户名或者密码 不能只传用户名 ''' print(request.user.is_authenticated) # False if user_obj: # 保存用户状态 # 可以在任意地方通过request.user拿到当前登录用户 auth.login(request, user_obj) print('用户登陆成功') print(request.user.is_authenticated) # True return render(request, 'login.html')
login_required
-
这是auth模块提供给我们的一个装饰器方法
-
可以用于快捷的给某个视图函数添加登录校验
-
它可以带一个参数,
login_url
,如验证结果为当前用户未登录就会自动跳转到指定的地址 -
这是一个局部的url,可以设置全局url,在settings.py文件加一行配置代码
LOGIN_URL = '/login/'
-
注意:局部url的优先级大于全局url
@login_required(login_url='/login/') # 用户没有登陆的话就跳转到指定的网址 在配置文件内可以设置全局跳转地址 def home(request): # 登入的情况就是登入用户的用户名 # 没有登录的情况就是 AnonymousUser 匿名用户的意思 print(request.user) # 判断当前是否有用户登录 返回值是True和False print(request.user.is_authenticated) return HttpResponse('OK')
create_user()
-
这是auth模块提供的创建新用户的方法,需要提供必要参数username和password
-
通常用于注册功能
def register(request): if request.method == 'POST': username = request.POST.get('username') password = request.POST.get('password') phone = request.POST.get('phone') user_obj = User.objects.filter(username=username) if user_obj: return HttpResponse(f'用户{username}已存在') # 不能用create来创建,因为那样做是明文传入,authenticate就没办法验证了,因为它是加密的 res = User.objects.create_user(username=username, password=password, phone=phone) print(f'用户{username}注册成功') return render(request, 'register.html')
check_password(password)
-
这是用于验证输入的密码与当前登录用户的密码是否一致
-
他的内部会先加密输入的密码,然后再进行比对
-
返回值是False和True
def set_pwd(request): if request.method == 'POST': old_password = request.POST.get('old_password') new_password = request.POST.get('new_password') confirm_password = request.POST.get('confirm_password') # 验证两次密码是否一致 if new_password == confirm_password: # 验证新老密码是否一致 is_right = request.user.check_password(old_password) print(f'验证新老密码是否一致:>>>{is_right}')
set_password(password)
-
这是用于修改密码的方法,在使用完这个方法之后还要用save方法
def set_pwd(request): if request.method == 'POST': old_password = request.POST.get('old_password') new_password = request.POST.get('new_password') confirm_password = request.POST.get('confirm_password') # 验证两次密码是否一致 if new_password == confirm_password: # 验证新老密码是否一致 is_right = request.user.check_password(old_password) print(f'验证新老密码是否一致:>>>{is_right}') if is_right: # 修改密码 request.user.set_password(new_password) request.user.save() print('修改密码成功') return redirect(to='/login/') return render(request, 'set_pwd.html', locals())
User对象的属性
-
User对象属性:
-
username
-
password
-
-
is_staff :
-
用户是否拥有网站的管理权限.
-
-
is_active :
-
是否允许用户登录
-
设置为 False,可以在不删除用户的前提下禁止用户登录。
-
扩展默认的auth_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表了。