Django基础之-Auth
补充:django_migrations表
django_migrations表是用来记录迁移过程数据的。
表中的名字就是settings文件中的INSTALLED_APPS的应用名。
INSTALLED_APPS = [ # 已安装的应用
'django.contrib.admin',
'django.contrib.auth',
'django.contrib.contenttypes',
'django.contrib.sessions',
'django.contrib.messages',
'django.contrib.staticfiles',
'app01.apps.App01Config',
]
当你在迁移记录时,没有任何变化,或者迁移命令失败时,或一系列问题时,migrations文件夹、django_migrations表完全可以删除掉。
一 Auth模块是什么
Auth模块是Django自带的用户认证模块:
我们在开发一个网站的时候,无可避免的需要设计实现网站的用户系统。此时我们需要实现包括用户注册、用户登录、用户认证、注销、修改密码等功能,这还真是个麻烦的事情呢。
Django作为一个完美主义者的终极框架,当然也会想到用户的这些痛点。它内置了强大的用户认证系统–auth,它默认使用 auth_user 表来存储用户数据。
# django自带的后台管理系统依赖的就是auth_user表
要想登录django的后台管理系统,必须要创建一个超级用户出来。命令行创建超级用户的语句:
python manage.py createsuperuser
重点:
- 控制台中邮箱可填写也可不填写
- echoed打印的语法
- 密码至少8位字符
内部一些字段:
- password:被auth模块加密后的密码,使用sha256加密
- is_superuser:是否为超级用户(1,超级用户;0,不是超级用户)
- data_joined:注册时间
- is_active:判断用户是否被锁定
- username: 用户名
二 auth模块常用方法
导入auth模块
from django.contrib import auth
1.authenticate()
提供了用户认证功能,即验证用户名以及密码是否正确,一般需要username 、password两个关键字参数。
如果认证成功(用户名和密码正确有效),便会返回一个 User 对象。
authenticate()会在该 User 对象上设置一个属性来标识后端已经认证了该用户,且该信息在后续的登录过程中是需要的。
用法:
user_obj = auth.authenticate(request, username=username, password=password)
print(user_obj)
"""
注意事项:
1. 用户名和密码必须两者都传递
2. 返回值是use_obj对象
3. 打印对象会直接得到用户名,因为内部重写了__str__方法
4. 当用户名和密码错误的时候,返回None
"""
验证用户名和密码是否正确案例
def login(request):
if request.method == 'POST':
username = request.POST.get('username')
password = request.POST.get('password')
"""
比较用户名和密码,会有两个问题
1. 去哪个表里查询数据------>auth_user表
2. 密码如何比较--> auth_user表中的密码是加密后的,数据中的密码是明文,不能比较
解决方式
借助于auth模块,不用考虑上述两个问题
"""
# 1. 认证功能:验证用户名以及密码是否正确
user_obj = auth.authenticate(request, username=username, password=password)
print(user_obj) # admin
# 可以使用对象点属性的方法,取出表中的任何字段了
print(user_obj.username) # admin
print(user_obj.password)
print(user_obj.email) # 123@qq.com
return render(request, 'login.html')
2.login(HttpRequest, user)
该函数接受一个HttpRequest对象,以及一个经过认证的User对象。
该函数实现一个用户登录的功能。它本质上会在后端为该用户生成相关session数据。
原来学习的是的登录成功后,使用session来保存用户信息。
request.session['username'] = user_obj.username
request.session['id'] = user_obj.id
如果你用了auth模块,就要用一整套。直接使用auth模块中的保存信息方法,用法:
auth.login(request, user_obj)
用户登录的案例
def login(request):
if request.method == 'POST':
username = request.POST.get('username')
password = request.POST.get('password')
# 1. 认证功能:验证用户名以及密码是否正确
user_obj = auth.authenticate(request, username=username, password=password)
print(user_obj) # admin
if user_obj: # 用户已经注册
# 2. 登录功能,要保存用户的信息
"""
如果你用了auth模块,就要用一整套
"""
auth.login(request, user_obj) # 就相当于内部用了session保存用户信息request.session['username'] = user_obj.username
request.a = user_obj
"""
它还有一个更加强大的功能,只要你用了auth.login方法,那么,后续你可以在任何方法里面通过: request.user拿到用户对象
相当于request.user = user_obj
"""
return redirect('/home/')
return render(request, 'login.html')
def home(request):
print(request.user.username) # admin
return HttpResponse('我是home页面')
3.is_authenticated()
用来判断当前请求是否通过了认证。
用法:
def home(request):
# 如何判断用户是否登录了?
# 登录成功返回True;登录失败返回,False
print(request.user.is_authenticated()) # True
return HttpResponse('我是home页面')
4.login_requierd
auth 给我们提供的一个装饰器工具,用来快捷的给某个视图添加登录校验。
登录成功后才能访问home页面案例:
from django.contrib.auth.decorators import login_required
# home函数必须登录之后才能访问?
@login_required
def home(request):
return HttpResponse('我是home页面')
若用户没有登录,则会跳转到django默认的 登录URL ‘/accounts/login/ ’ 并传递当前访问url的绝对路径 (登陆成功后,会重定向到该路径)。
eg:
http://127.0.0.1:8000/accounts/login/?next=/home/
如果需要自定义登录的URL,有两种方式。
方式1:装饰器传参,局部添加
@login_required(login_url='自定义的URL')
def home(request):
return HttpResponse('我是home页面')
方式2:settings.py文件中通过设置LOGIN_URL进行修改,全局添加
settings.py:
LOGIN_URL = '/login/' # 这里配置成你项目登录页面的路由
views.py:
from django.contrib.auth.decorators import login_required
@login_required
def func(request):
return HttpResponse('func')
如果全局设置了,局部也设置了自定义的登录URL,地址会跳转到哪里?会跳转到局部。
说明路由的查找顺序是:先局部,后全局。
5.check_password(old_password)
auth 提供的一个检查密码是否正确的方法,需要提供当前请求用户的密码。
密码正确返回True,否则返回False。
用法:
ok = user.check_password('旧密码')
6.set_password(new_password)
auth 提供的一个修改密码的方法,接收 要设置的新密码 作为参数。
注意:设置完一定要调用用户对象的save方法!!!
用法:
user.set_password(password='')
user.save()
修改密码案例
views.py:
@login_required # 1. 修改密码,用户一定要登录
def set_password(request):
# 如果没有登录就显示匿名用户:AnonymousUser
print(request.user) # AnonymousUser
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')
# 2. 先验证两次密码是否一致
if new_password == confirm_password:
# 3. 验证旧密码是否正确
is_right = request.user.check_password(old_password)
if is_right:
# 4. 修改新的密码
request.user.set_password(new_password) # 这一句没有真正的操作数据库
request.user.save() # 才真正的操作数据库(update)
return redirect('/login/')
return render(request, 'set_password.html', locals()) # 前端要使用request.user对象
前端:
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>修改密码页面</title>
<link rel="stylesheet" href="https://cdn.bootcdn.net/ajax/libs/twitter-bootstrap/3.4.1/css/bootstrap.min.css">
<script src="https://cdn.bootcdn.net/ajax/libs/jquery/3.6.4/jquery.min.js"></script>
<script src="https://cdn.bootcdn.net/ajax/libs/twitter-bootstrap/3.4.1/css/bootstrap.min.css"></script>
</head>
<body>
<form action="" method="post">
{% csrf_token %}
{# 前端也可以获取用户名 #}
<p>username: <input type="text" disabled value="{{ request.user.username }}"></p>
<p>old_password: <input type="password" name="old_password"></p>
<p>new_password: <input type="password" name="new_password"></p>
<p>confirm_password: <input type="password" name="confirm_password"></p>
<input type="submit">
</form>
</body>
</html>
7.logout(request)
该函数接受一个HttpRequest对象,无返回值。
当调用该函数时,当前请求的session信息会全部清除。该用户即使没有登录,使用该函数也不会报错。
注销功能案例
from django.contrib.auth import logout
# 注销功能案例
def logout_view(request):
logout(request) # 内部执行了request.session.flush()代码
return redirect('/home/')
8.create(self, **kwargs)
创建不加密的普通用户。
9.create_user()
auth 提供的一个创建新用户的方法,需要提供必要参数(username、password)等。创建加密的普通用户。
用法:
from django.contrib.auth.models import User
user = User.objects.create_user(username='用户名',password='密码')
10.create_superuser()
auth 提供的一个创建新的超级用户的方法,需要提供必要参数(username、password、email)等。
用法:
from django.contrib.auth.models import User
user = User.objects.create_superuser(username='用户名',password='密码',email='邮箱',...)
注册用户案例
from django.contrib.auth.models import User
# 注册用户案例
def register(request):
if request.method == 'POST':
# 1.接收前端数据
username = request.POST.get('username')
password = request.POST.get('password')
# 2.参数验证...
# 3.入库
# 3.1 创建用户,不可用
# 生成不加密的密码,后续不能进行登录验证
# 因为登录auth.authenticate()验证时,底层auth会加密
User.objects.create(username=username, password=password) # 不加密
# 3.2 创建用户,普通用户
User.objects.create_user(username=username, password=password) # 加密的
# 3.3 代码创建超级用户,email必填
User.objects.create_superuser(username=username, email='123@qq.com', password=password)
return redirect('/home/')
return render(request, 'register.html')
User对象的属性
User对象属性:username, password
-
is_staff : 用户是否拥有网站的管理权限.
-
is_active : 是否允许用户登录, 设置为 False,可以在不删除用户的前提下禁止用户登录。
三 扩展默认的auth_user表
这内置的认证系统这么好用,但是auth_user表字段都是固定的那几个,我在项目中没法拿来直接使用啊!
比如,我想要加一个存储用户手机号的字段,怎么办?
聪明的你可能会想到新建另外一张表然后通过一对一和内置的auth_user表关联,这样虽然能满足要求但是有没有更好的实现方式呢?
答案是当然有了。
我们可以通过继承内置的 AbstractUser 类,来定义一个自己的Model类。
这样既能根据项目需求灵活的设计用户表,又能使用Django强大的认证系统了。
from django.contrib.auth.models import AbstractUser
# 扩展auth_user表,就必须继承AbstractUser类,不在继承models.Model
class UserInfo(AbstractUser):
phone = models.CharField(max_length=64)
avatar = models.CharField(max_length=64)
注意:
按上面的方式扩展了内置的auth_user表之后,一定要在settings.py中告诉Django,我现在使用我新定义的UserInfo表来做用户认证。写法如下:
# 引用Django自带的User表,继承使用时需要设置
AUTH_USER_MODEL = "app名.UserInfo"
一旦我们指定了新的认证系统所使用的表,我们就需要重新在数据库中创建该表,而不能继续使用原来默认的auth_user表了。
注意事项:
"""
注意事项:
1. 扩展字段的时候,默认的字段不要动,只写自己要增加的字段
2. 如果你扩展了这张表,那么,auth_user表就不存在了,有的是你自己新建的这张表
3. 新建出来的这张表里面的字段,有之前auth_user表的所有字段外加自己添加的字段
4. 需要在settings.py文件中添加一个变量,告诉django我要用现在新的表替代原来的auth_user表
AUTH_USER_MODEL = '应用名.类名'
AUTH_USER_MODEL = 'app01.UserInfo'
5. 如果你在扩展这张表之前已经执行了数据库迁移命令,需要重新换库
6. 如果你已经迁移了,还想扩展,怎么办?
1. 换库
2. 删很多应用的migrations文件夹(删除配置(INSTALLED_APPS)中的所有应用中的migrations文件夹,删除django_migrations表中的所有数据) ---> 就是将之前的所有的迁移记录删除掉
7. 得出结论:在执行迁移命令之前就扩展好
"""
重点:扩展表一定要在数据库迁移命令之前。迁移之后要在settings.py文件中添加变量:AUTH_USER_MODEL = '应用名.类名'。这样之后,这张表就可以跟普通表一样使用了,增删改查字段。
Django继承AbstractUser新建User Model时出现fields.E304错误
错误详情
SystemCheckError: System check identified some issues:
ERRORS:
app01.UserInfo.groups: (fields.E304) Reverse accessor for 'UserInfo.groups' clashes with reverse accessor for 'User.groups'.
HINT: Add or change a related_name argument to the definition for 'UserInfo.groups' or 'User.groups'.
app01.UserInfo.user_permissions: (fields.E304) Reverse accessor for 'UserInfo.user_permissions' clashes with reverse accessor for 'User.user_permissions'.
HINT: Add or change a related_name argument to the definition for 'UserInfo.user_permissions' or 'User.user_permissions'.
auth.User.groups: (fields.E304) Reverse accessor for 'User.groups' clashes with reverse accessor for 'UserInfo.groups'.
HINT: Add or change a related_name argument to the definition for 'User.groups' or 'UserInfo.groups'.
auth.User.user_permissions: (fields.E304) Reverse accessor for 'User.user_permissions' clashes with reverse accessor for 'UserInfo.user_permissions'.
HINT: Add or change a related_name argument to the definition for 'User.user_permissions' or 'UserInfo.user_permissions'.
Process finished with exit code 1
解决方法
settings.py文件需要配置如下
app01 -- 你的项目app名字
UserInfo -- 你的models中的扩写auth的表模型名字
AUTH_USER_MODEL = 'app01.UserInfo'