Django高级之Auth模块

auth组件介绍

Auth模块是Django自带的用户认证模块:
我们在开发一个网站的时候,无可避免的需要设计实现网站的用户系统。此时我们需要实现包括用户注册、用户登录、用户认证、注销、修改密码等功能,这还真是个麻烦的事情呢。
Django作为一个完美主义者的终极框架,当然也会想到用户的这些痛点。它内置了强大的用户认证系统–auth,它默认使用 auth_user 表来存储用户数据。

示例

前端form表单
auth_login

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>auth</title>
    <link rel="stylesheet" href="/static/bootstrap-3.3.7-dist/css/bootstrap.min.css">
    <script src="/static/bootstrap-3.3.7-dist/js/bootstrap.min.js"></script>
    <script src="/static/jquery-3.3.1.js"></script>
</head>
<body>
<form action="" method="post">
    {% csrf_token %}
    <p>用户名:<input type="text" name="username"></p>
    <p>密码:<input type="password" name="password"></p>
    <input type="submit" value="提交">
</form>
</body>
</html>

auth_home

<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
    <link rel="stylesheet" href="/static/bootstrap-3.3.7-dist/css/bootstrap.min.css">
    <script src="/static/bootstrap-3.3.7-dist/js/bootstrap.min.js"></script>
    <script src="/static/jquery-3.3.1.js"></script>
</head>
<body>
<h1>我是auth home页面</h1>
{% if request.user.is_authenticated %}
    {{ request.user.username }} 欢迎
{% else %}
    <a href="/auth_login/">登录</a>
{% endif %}

</body>
</html>

auth_register

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
    <link rel="stylesheet" href="/static/bootstrap-3.3.7-dist/css/bootstrap.min.css">
    <script src="/static/bootstrap-3.3.7-dist/js/bootstrap.min.js"></script>
    <script src="/static/jquery-3.3.1.js"></script>
</head>
<body>
<form action="" method="post">
    {% csrf_token %}
    <p>用户名:<input type="text" name="username"></p>
    <p>密码:<input type="password" name="password"></p>
    <p>密码:<input type="password" name="re_password"></p>
    <p>邮箱:<input type="email" name="email"></p>
    <input type="submit" value="提交">
</form>
</body>
</html>

后端

from django.shortcuts import render, redirect, HttpResponse
from django.contrib.auth.models import User
from django.contrib.auth import authenticate, login, logout
from django.contrib.auth.decorators import login_required


def auth_login(request):
    if request.method == 'GET':
        return render(request, 'auth_login.html')
    elif request.method == 'POST':
        username = request.POST.get('username')
        password = request.POST.get('password')
        user = authenticate(username=username, password=password)
        if user:
            # 登录
            login(request, user)
            next = request.GET.get('next')
            if not next:
                next = '/auth_home/'
            return redirect(next)
        else:
            return HttpResponse('用户密码错误')


@login_required(login_url='/auth_login/')
def auth_order(request):
    return HttpResponse('我是order, 必须登录才能看')


def auth_home(request):
    # 获取session表中用户名
    print(request.user)
    # 判断用户是否登录
    if request.user.is_authenticated:
        print('用户登录')
    else:
        print('没有登陆')
    return render(request, 'auth_home.html')


def auth_logout(request):
    logout(request)  # 注销
    # 重定向登陆页面
    return redirect('/auth_login/')


def auth_register(request):
    if request.method == 'GET':
        return render(request, 'auth_register.html')
    else:
        username = request.POST.get('username')
        password = request.POST.get('password')
        email = request.POST.get('email')
        # 创建超级用户
        User.objects.create_superuser(username=username,password=password,email=email)
        # 创建普通用户
        # User.objects.create_user(username=username,password=password)
        return redirect('/auth_login/')

    
def auth_check_password(request):
    pass

路由

from django.contrib import admin
from django.urls import path
from app01 import views

urlpatterns = [
    path('admin/', admin.site.urls),
    path('auth_login/', views.auth_login),
    path('auth_home/', views.auth_home),
    path('auth_logout/', views.auth_logout),
    path('auth_order/', views.auth_order),
    path('auth_register/', views.auth_register),
]
1 django提供的用户认证,创建,修改密码。。。用户相关操作
2 不需要创建用户表了,默认带了
3 插入数据(创建用户):
    python3 manage.py createsuperuser

auth组件常用方法

auth模块常用方法

from django.contrib import auth

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

# 导入auth_user表
from django.contrib.auth.models import User
# 导入认证
from django.contrib.auth import authenticate
user = authenticate(username='usernamer',password='password')

login(HttpRequest, user)

该函数接受一个HttpRequest对象,以及一个经过认证的User对象。
该函数实现一个用户登录的功能。它本质上会在后端为该用户生成相关session数据。

from django.contrib.auth import login
   
# 登录成功后调用
login(request, user)

logout(request)

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

from django.contrib.auth import logout
   
def auth_logout(request):
    logout(request)  #注销
    return HttpResponse('注销成功')

is_authenticated()

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

# 视图类中使用
def auth_home(request):
    #在这直接可以拿到当前登录用户
    # 如果用户没登录,是匿名用户:AnonymousUser
    # 如果用户登录了(调用了login),可以直接拿到当前登录用户
    print(request.user.username)
    print(request.user.id)
​
    #判断用户是否登录
    if request.user.is_authenticated:
        print('用户登录了')
    else:
        print('用户没有登录')
    
#模板中使用
{% if request.user.is_authenticated %}
    {{ request.user.username }} 欢迎你
{% else %}
    <a href="/auth_login/">请去登录</a>
{% endif %}

login_requierd()

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

from django.contrib.auth.decorators import login_required
      
@login_required(login_url='/auth_login/')
# @login_required()
def auth_order(request):
    # 必须登录才能访问
    return HttpResponse('我是order,必须登录才看的')

#也可以在配置文件中配置
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。

ok = user.check_password('密码')

set_password(password)

auth 提供的一个修改密码的方法,接收 要设置的新密码 作为参数。
注意:设置完一定要调用用户对象的save方法!!!

request.user.set_password(password='')
request.user.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 request.user.check_password(old_password):
            if not new_password:
                err_msg = '新密码不能为空'
            elif new_password != repeat_password:
                err_msg = '两次密码不一致'
            else:
               request.user.set_password(new_password)
               request.user.save()
                return redirect("/login/")
        else:
            err_msg = '原密码输入错误'
    content = {
        'err_msg': err_msg,
    }
    return render(request, 'set_password.html', content)

User对象的属性

User对象属性:username, password
is_staff : 用户是否拥有网站的管理权限.
is_active : 是否允许用户登录, 设置为 False,可以在不删除用户的前提下禁止用户登录。

扩展默认的auth_user表

这内置的认证系统这么好用,但是auth_user表字段都是固定的那几个,我在项目中没法拿来直接使用啊!
比如,我想要加一个存储用户手机号的字段,怎么办?
聪明的你可能会想到新建另外一张表然后通过一对一和内置的auth_user表关联,这样虽然能满足要求但是有没有更好的实现方式呢?
方法:

# 第一种方案:创建一对一关联表
    
from django.contrib.auth.models import User 
class user_detail(models.Model):
    user=models.OneToOneField(to=User)
    phone=models.CharField(max_length=32)

我们还可以通过继承内置的 AbstractUser 类,来定义一个自己的Model类。
这样既能根据项目需求灵活的设计用户表,又能使用Django强大的认证系统了。

# 第二种方案,继承AbstractUser类来扩写
    class Meta:
        abstract = True  #这个表是个抽象表,只用来继承,不会在数据库生成表
        
​
# 使用步骤 
"""
大前提是auth_user表没有创建之前干*******
    写一个类,继承AbstractUser
    在类中扩写字段(可以重写原来有的字段)
​
"""
from django.contrib.auth.models import AbstractUser
class UserInfo(AbstractUser):
    username=models.CharField(max_length=12)
    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表了。

# 如果auth_user表已经有了,还想扩写
    -删库
    -清空项目中所有migration的记录
    -清空源码中admin,auth俩app的migration的记录
posted @ 2021-12-06 10:29  沈忻凯  阅读(62)  评论(0)    收藏  举报