Django认证系统--Auth模块
Django自带的用户认证
我们在开发一个网站的时候，无可避免的需要设计实现网站的用户系统。此时我们需要实现包括用户注册、用户登录、用户认证、注销、修改密码等功能，这还真是个麻烦的事情呢。
Django作为一个完美主义者的终极框架，当然也会想到用户的这些痛点。它内置了强大的用户认证系统--auth，它默认使用 auth_user 表来存储用户数据。
举个例子：
用session写一个登陆
会比较麻烦
urls.py
from django.contrib import admin
from django.urls import path
from app01 import views
urlpatterns = [
path(‘admin/‘, admin.site.urls),
path(‘login/‘, views.login),
path(‘index/‘, views.index),
]urls.py
views.py
from django.shortcuts import render,redirect
# Create your views here.
from django.contrib import auth
from app01 import models
from functools import wraps
#检测用户是否登录过的装饰器
def check_login(func):
@wraps(func)
def inner(request,*args,**kwargs):
if request.session.get("is_login") == "1":
return func(request,*args,**kwargs)
else:
return redirect(‘/login/‘)
return inner
def login(request):
if request.method == "POST":
username = request.POST.get("username")
password = request.POST.get("password")
user = models.User.objects.filter(username = username,password = password)
if user:
#证明登录的用户在数据库中存在
request.session["is_login"] = "1"
# request.session[‘username‘] = username
#注意这里的user是一个QuerySet对象，相当于一个列表，不能直接 .id
request.session[‘user_id‘] = user[0].id
#1.生产一个特殊的字符串
#2.特殊字符串当做key，在数据库的django_session表中对应一个session value
#3.在响应中向浏览器写一个Cookie Cookie的值就是 特殊的字符串
return redirect(‘/index/‘)
return render(request,‘login.html‘)
@check_login
def index(request):
# username = request.session.get(‘username‘)
user_id = request.session.get(‘user_id‘)
user_queryset = models.User.objects.filter(id=user_id)
#print(user_obj,type(user_obj))
#print(user_obj[0],type(user_obj[0]))
if user_queryset:
return render(request,‘index.html‘,{‘user‘:user_obj[0]})
else:
return render(request,‘index.html‘,{‘user‘:‘匿名用户‘})views.py
login.html
<!DOCTYPE html>
<html lang="zh-CN">
<head>
<meta charset="UTF-8">
<title>登录页面</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
{% load static %}
<link rel="stylesheet" href="{% static ‘bootstrap/css/bootstrap.min.css‘ %}">
<link rel="stylesheet" href="{% static ‘fontAwesome/css/font-awesome.min.css‘ %}">
<link rel="stylesheet" href="{% static ‘sweetalert/sweetalert.css‘ %}">
</head>
<body>
<h1>欢迎登录！！</h1>
<form action="/login/" method="post">
{% csrf_token %}
<p>
<label for="">用户名：
<input type="text" name="username">
</label>
</p>
<p>
<label for="">密码：
<input type="password" name="password">
</label>
</p>
<p>
<input type="submit" value="登录">
</p>
</form>
<script src="{% static ‘jquery-3.2.1.min.js‘ %}"></script>
<script src="{% static ‘setupajax.js‘ %}"></script>
<script src="{% static ‘bootstrap/js/bootstrap.min.js‘ %}"></script>
<script src="{% static ‘sweetalert/sweetalert.min.js‘ %}"></script>
</body>
</html>login.html
index.html
<!DOCTYPE html>
<html lang="zh-CN">
<head>
<meta charset="UTF-8">
<title>index</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
{% load static %}
<link rel="stylesheet" href="{% static ‘bootstrap/css/bootstrap.min.css‘ %}">
<link rel="stylesheet" href="{% static ‘fontAwesome/css/font-awesome.min.css‘ %}">
<link rel="stylesheet" href="{% static ‘sweetalert/sweetalert.css‘ %}">
</head>
<body>
<h1>这是index页面</h1>
<p>欢迎，{{ user.username }} {{ user.password }}</p>
<script src="{% static ‘jquery-3.2.1.min.js‘ %}"></script>
<script src="{% static ‘setupajax.js‘ %}"></script>
<script src="{% static ‘bootstrap/js/bootstrap.min.js‘ %}"></script>
<script src="{% static ‘sweetalert/sweetalert.min.js‘ %}"></script>
</body>
</html>index.html
使用auth模块来写
将上面的views.py修改
views.py
from django.shortcuts import render,redirect
# Create your views here.
from django.contrib import auth
def login(request):
if request.method == "POST":
username = request.POST.get(‘username‘)
password = request.POST.get(‘password‘)
#判断用户名和密码对不对
user = auth.authenticate(username=username, password=password)
#将登录的用户信息封装到request.user中
auth.login(request,user)
if user:
return redirect(‘/index/‘)
return render(request,‘login.html‘)
def index(request):
print(request.user.username)
return render(request,‘index.html‘)views.py
auth模块
from django.contrib import auth
auth中提供了许多实用方法：
authenticate()
验证的时候是去auth_user表中验证的。
而要在auth_user表中添加一条信息，可以使用：
#创建超级用户 python manage.py createsuperuser
提供了用户认证功能，即验证用户名以及密码是否正确，一般需要username 、password两个关键字参数。
如果认证成功（用户名和密码正确有效），便会返回一个 User 对象。
authenticate()会在该 User 对象上设置一个属性来标识后端已经认证了该用户，且该信息在后续的登录过程中是需要的。
用法：
user = authenticate(username=‘theuser‘,password=‘thepassword‘)
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_obj = authenticate(username=username, password=password)
if user_obj:
login(request, user_obj)
# Redirect to a success page.
...
else:
# Return an ‘invalid login‘ error message.
...注意：
只要使用login(request, user_obj)之后，request.user就能拿到当前登录的用户对象。否则request.user得到的是一个匿名用户对象（AnonymousUser Object）。
详细原理请查看 AuthenticationMiddleware 中间件源码。
logout(request)
该函数接受一个HttpRequest对象，无返回值。
当调用该函数时，当前请求的session信息会全部清除。该用户即使没有登录，使用该函数也不会报错。
用法：
from django.contrib.auth import logout def logout_view(request): logout(request) # Redirect to a success page.
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 ‘/accounts/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_obj = User.objects.create_superuser（username=‘用户名‘,password=‘密码‘,email=‘邮箱‘,...）
check_password(raw_password)
auth 提供的一个检查密码是否正确的方法，需要提供当前请求用户的密码。
密码正确返回True，否则返回False。
用法：
ok = user_obj.check_password(‘密码‘)
或者直接针对当前请求的user对象校验原密码是否正确：
ok = request.user.check_password(raw_password=‘原密码‘)
set_password(raw_password)
auth 提供的一个修改密码的方法，接收 要设置的新密码 作为参数。
注意：设置完一定要调用用户对象的save方法！！！
用法：
user_obj.set_password(‘新密码‘) user_obj.save()
一个修改密码功能的简单示例
@login_required
def set_password(request):
user = request.user
err_msg = ‘‘
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:
err_msg = ‘新密码不能为空‘
elif new_password != repeat_password:
err_msg = ‘两次密码不一致‘
else:
user.set_password(new_password)
user.save()
return redirect("/login/")
else:
err_msg = ‘原密码输入错误‘
content = {
‘err_msg‘: err_msg,
}
return render(request, ‘set_password.html‘, content)
修改密码示例修改密码示例
用户对象的属性
user_obj能够拿到认证所用用户表的数据属性，比如username， password等。
其他常用属性含义如下：
is_staff ： 用户是否拥有网站的管理权限.
is_active ： 是否允许用户登录, 设置为 False，可以在不删除用户的前提下禁止用户登录。
扩展默认的auth_user表
这内置的认证系统这么好用，但是auth_user表字段都是固定的那几个，我在项目中没法拿来直接使用啊！
比如，我想要加一个存储用户手机号的字段，怎么办？
聪明的你可能会想到新建另外一张表然后通过一对一和内置的auth_user表关联，这样虽然能满足要求但是有没有更好的实现方式呢？
答案是当然有了。
我们可以通过继承内置的 AbstractUser 类，来定义一个自己的Model类。
这样既能根据项目需求灵活的设计用户表，又能使用Django强大的认证系统了。
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表那样使用我们的UserInfo表了。比如：
创建普通用户：
UserInfo.objects.create_user(username=‘用户名‘, password=‘密码‘)
创建超级用户：
UserInfo.objects.create_superuser(username=‘用户名‘, password=‘密码‘)
再次注意：
一旦我们指定了新的认证系统所使用的表，我们就需要重新在数据库中创建该表，而不能继续使用原来默认的auth_user表了。