Django高级之Auth模块

1 Auth模块是什么

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

我们在开发一个网站的时候，无可避免的需要设计实现网站的用户系统。此时我们需要实现包括用户注册、用户登录、用户认证、注销、修改密码等功能，这还真是个麻烦的事情呢。

Django作为一个完美主义者的终极框架，当然也会想到用户的这些痛点。它内置了强大的用户认证系统–auth，它默认使用 auth_user 表来存储用户数据。

1 django提供的用户认证，创建，修改密码。。。用户相关操作
2 不需要创建用户表了，默认带了
3 插入数据（创建用户）：
    python3 manage.py createsuperuser

2 auth模块常用方法

from django.contrib import auth

authenticate()

提供了用户认证功能，即验证用户名以及密码是否正确，一般需要username 、password两个关键字参数。

如果认证成功（用户名和密码正确有效），便会返回一个 User 对象。

authenticate()会在该 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，必须登录才看的')

若用户没有登录，则会跳转到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 = 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)

3 User对象的属性

User对象属性：username， password

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

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

4 扩展默认的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的记录

总代码

拓展：（融入了所有的auth方法，推荐联合使用）

1 基于auth继承AbstractUser类，加一个phone字段，实现用户的注册登录，登录成功，在home页面显示用户名，未登录，显示登录注册

2 实现修改密码功能 3 超级管理员能够禁用户登录

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>主页</title>
    <script src="https://cdn.bootcdn.net/ajax/libs/jquery/3.4.1/jquery.min.js"></script>
    <link href="https://cdn.bootcdn.net/ajax/libs/twitter-bootstrap/3.4.1/css/bootstrap.min.css" rel="stylesheet">
    <script src="https://cdn.bootcdn.net/ajax/libs/twitter-bootstrap/3.4.1/js/bootstrap.min.js"></script>
</head>
<body>
<nav class="navbar navbar-inverse">
    <div class="container-fluid">
        <!-- Brand and toggle get grouped for better mobile display -->
        <div class="navbar-header">
            <button type="button" class="navbar-toggle collapsed" data-toggle="collapse"
                    data-target="#bs-example-navbar-collapse-1" aria-expanded="false">
                <span class="sr-only">Toggle navigation</span>
                <span class="icon-bar"></span>
                <span class="icon-bar"></span>
                <span class="icon-bar"></span>
            </button>
            <a class="navbar-brand" href="#">用户管理系统</a>
        </div>

        <!-- Collect the nav links, forms, and other content for toggling -->
        <div class="collapse navbar-collapse" id="bs-example-navbar-collapse-1">
            <ul class="nav navbar-nav">
                <li class="active"><a href="/auth_superuser/">管理员注册<span class="sr-only">(current)</span></a></li>
            </ul>
            <ul class="nav navbar-nav">
                <li class="active"><a href="/all_user/">管理员权限<span class="sr-only">(current)</span></a></li>
            </ul>
            <ul class="nav navbar-nav navbar-right">
                <li><a href="#">欢迎</a></li>
                <li class="dropdown">
                    <a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-haspopup="true"
                       aria-expanded="false">登录设置<span class="caret"></span></a>
                    <ul class="dropdown-menu">
                        <li><a href="/login/">登录</a></li>
                        <li><a href="#">注册</a></li>
                        <li><a href="#">切换用户</a></li>
                        <li role="separator" class="divider"></li>
                        <li><a href="#">退出登录</a></li>
                    </ul>
                </li>
            </ul>
        </div><!-- /.navbar-collapse -->
    </div><!-- /.container-fluid -->
</nav>
<div class="body">
    <div class="container-fluid">
        <div class="row">
            <div class="col-md-6">
                <div class="list-group">
                    <a href="/" class="list-group-item active index">主页</a>
                    <a href="/auth_login/" class="list-group-item books">用户登录</a>
                    <a href="/auth_change_password/" class="list-group-item books">修改密码</a>
                    <a href="/auth_register/" class="list-group-item books">用户注册</a>
                    <a href="/auth_logout/" class="list-group-item books">用户注销</a>
                    <a href="/auth_home/" class="list-group-item author">访问home</a>
                    <a href="/auth_order/" class="list-group-item publish">访问order</a>
                </div>
            </div>
            <div class="col-md-6">

            </div>

        </div>
    </div>
</div>


</body>
</html>

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>跳转页面</title>
    <script src="https://cdn.bootcdn.net/ajax/libs/jquery/3.4.1/jquery.min.js"></script>
    <link href="https://cdn.bootcdn.net/ajax/libs/twitter-bootstrap/3.4.1/css/bootstrap.min.css" rel="stylesheet">
    <script src="https://cdn.bootcdn.net/ajax/libs/twitter-bootstrap/3.4.1/js/bootstrap.min.js"></script>
</head>
<body>


<div class="jumbotron">
<div class="container">
  <h1>我是auth 的home页面!</h1>
    {% if request.user.is_authenticated %}
  <p>{{ request.user.username }} 欢迎你</p>
    {% else %}
  <p><a class="btn btn-primary btn-lg" href="/auth_login/" role="button">请去登录</a></p>
    {% endif %}
</div>
</div>

</head>
<body>
<div class="col-md-6 col-md-offset-3">
    <div class="panel panel-primary">
        <div class="panel-heading">
        </div>
        <div class="panel-body">
            <h1 class="text-center">登录</h1>
            <form action="" method="post" class="form-horizontal">
                {% csrf_token %}
                <div class="form-group">
                    <label for="name">用户名</label>
                <input type="text" name="name" class="form-control" placeholder="name">
                </div>
                <div class="form-group">
                    <label for="name">密码</label>
                <input type="password" name="password" class="form-control" placeholder="password">
                </div>

                <input type="submit" class="btn btn-primary btn-block">
            </form>
            <h2 style="color: red">{{ error_msg }}</h2>
        </div>
    </div>
</div>
</body>

</html>

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>用户注册页面</title>
    <script src="https://cdn.bootcdn.net/ajax/libs/jquery/3.4.1/jquery.min.js"></script>
    <link href="https://cdn.bootcdn.net/ajax/libs/twitter-bootstrap/3.4.1/css/bootstrap.min.css" rel="stylesheet">
    <script src="https://cdn.bootcdn.net/ajax/libs/twitter-bootstrap/3.4.1/js/bootstrap.min.js"></script>
</head>
<body>
<div class="col-md-6 col-md-offset-3">
    <div class="panel panel-primary">
        <div class="panel-heading">
        </div>
        <div class="panel-body">
            <h1 class="text-center">注册</h1>
            <form action="" method="post">
                {% csrf_token %}
                <p>用户名:<input type="text" name="name" class="form-control"></p>
                <p>密码:<input type="password" name="password" class="form-control"></p>
                <p>确认密码:<input type="password" name="re_password" class="form-control"></p>
                <input type="submit" class="btn btn-primary btn-block">
            </form>
        </div>
    </div>
</div>
</body>
</html>

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>超级用户注册页面</title>
    <script src="https://cdn.bootcdn.net/ajax/libs/jquery/3.4.1/jquery.min.js"></script>
    <link href="https://cdn.bootcdn.net/ajax/libs/twitter-bootstrap/3.4.1/css/bootstrap.min.css" rel="stylesheet">
    <script src="https://cdn.bootcdn.net/ajax/libs/twitter-bootstrap/3.4.1/js/bootstrap.min.js"></script>
</head>
<body >
<div class="col-md-6 col-md-offset-3">
    <div class="panel panel-primary">
        <div class="panel-heading">
        </div>
        <div class="panel-body">
            <h1 class="text-center">管理员注册</h1>
            <form action="" method="post">
                {% csrf_token %}
                <p>超级用户:<input type="text" name="name" class="form-control"></p>
                <p>密码:<input type="password" name="password" class="form-control"></p>
                <p>确认密码:<input type="password" name="re_password" class="form-control"></p>
                <p>邮箱:<input type="email" name="re_password" class="form-control"></p>
                <input type="submit" class="btn btn-primary btn-block">
            </form>
        </div>
    </div>
</div>
</body>
</html>

<!DOCTYPE html>
<html class="x-admin-sm">
<head>
    <meta charset="UTF-8">
    <title>欢迎页面-X-admin2.2</title>
    <meta name="renderer" content="webkit">
    <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
    <meta name="viewport"
          content="width=device-width,user-scalable=yes, minimum-scale=0.4, initial-scale=0.8,target-densitydpi=low-dpi"/>
    <link rel="stylesheet" href="/static/css/font.css">
    <link rel="stylesheet" href="/static/css/xadmin.css">
    <script src="/static/lib/layui/layui.js" charset="utf-8"></script>
    <script type="text/javascript" src="/static/js/xadmin.js"></script>
</head>
<body>
<div class="x-nav">
          <span class="layui-breadcrumb">
            <a href="">首页</a>
            <a href="">演示</a>
            <a>
              <cite>导航元素</cite></a>
          </span>
    <a class="layui-btn layui-btn-small" style="line-height:1.6em;margin-top:3px;float:right"
       onclick="location.reload()" title="刷新">
        <i class="layui-icon layui-icon-refresh" style="line-height:30px"></i></a>
</div>
<div class="layui-fluid">
    <div class="layui-row layui-col-space15">
        <div class="layui-col-md12">
            <div class="layui-card">
                {% csrf_token %}
                <div class="layui-card-header">
                    <button class="layui-btn layui-btn-danger" onclick="delAll()"><i class="layui-icon">�</i>批量删除
                    </button>
                    <button class="layui-btn" onclick="xadmin.open('添加用户','./role-add.html',600,400)"><i
                            class="layui-icon">�</i>添加
                    </button>
                </div>
                <div class="layui-card-body ">
                    <table class="layui-table layui-form">
                        <thead>
                        <tr>
                            <th>
                                <input type="checkbox" name="" lay-skin="primary">
                            </th>
                            <th>ID</th>
                            <th>角色名</th>
                            <th>拥有权限规则</th>
                            <th>是否活跃</th>
                            <th>状态</th>
                            <th>操作</th>
                        </thead>
                        <tbody>
                        {% for user in user_list %}
                            <tr>
                                <td>
                                    <input type="checkbox" name="" lay-skin="primary">
                                </td>
                                <td>{{ user.id }}</td>
                                <td>{{ user.username }}</td>
                                <td>{{ user.phone }}</td>
                                <td>{{ user.is_active }}</td>
                                <td class="td-status">
                                    <a href="/disable_user/?id={{ user.id }}"><span
                                            class="layui-btn layui-btn-normal layui-btn-mini">已启用</span></a></td>
                                <td class="td-manage">
                                    <a onclick="member_stop(this,'10001')" href="javascript:;" title="启用">
                                        <i class="layui-icon">&#xe601;</i>
                                    </a>
                                </td>
                            </tr>
                        {% endfor %}


                        </tbody>
                    </table>
                </div>

            </div>
        </div>
    </div>
</div>
</body>
<script>

    /*用户-停用*/
    function member_stop(obj, id) {
        layer.confirm('确认要停用吗？', function (index) {

            if ($(obj).attr('title') == '启用') {

                //发异步把用户状态进行更改
                $(obj).attr('title', '停用')
                $(obj).find('i').html('&#xe62f;');

                $(obj).parents("tr").find(".td-status").find('span').addClass('layui-btn-disabled').html('已停用');
                layer.msg('已停用!', {icon: 5, time: 1000});

            } else {
                $(obj).attr('title', '启用')
                $(obj).find('i').html('&#xe601;');

                $(obj).parents("tr").find(".td-status").find('span').removeClass('layui-btn-disabled').html('已启用');
                layer.msg('已启用!', {icon: 5, time: 1000});
            }

        });
    }

</script>

from django.conf.urls import url
from django.contrib import admin
from app01 import views
urlpatterns = [
    url(r'^admin/', admin.site.urls),
    url(r'^$',views.autj_page),
    url(r'^auth_login/',views.auth_login),
    url(r'^auth_home/',views.auth_home),
    url(r'^auth_order/',views.auth_order),
    url(r'^auth_logout/',views.auth_logout),
    url(r'^auth_register/',views.auth_register),
    url(r'^auth_superuser/',views.auth_superuser),
    url(r'^auth_check_password/',views.auth_check_password),
    url(r'^auth_change_password/',views.auth_change_password),
    url(r'^all_user/',views.all_user),
    url(r'^disable_user/',views.disable_user),


]

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

# 主页面
def autj_page(request):
    return render(request, 'auth_page.html')

# 登录功能
def auth_login(request):
    error_msg = ''
    if request.method == 'POST':
        name = request.POST.get('name')
        password = request.POST.get('password')
        print(password)
        # password是加密的需要authenticate认证
        # User.objects.filter(username=name,password=password)
        # 必须用username，因为表中就是username
        user = authenticate(username=name, password=password)
        if user:
            # 一旦用户登陆成功，要调用一下login，表示用户登陆了，一定要写
            login(request,user)
            return redirect('/auth_home/')
        else:
            error_msg='用户名或密码错误!'
    return render(request, 'login.html', {'error_msg':error_msg})


# 跳转页面
def auth_home(request):
    # 在这直接可以拿到当前登录用户
    # 如果用户没登录，是匿名用户：AnonymousUser
    # 如果用户登录了（调用了login），可以直接拿到当前登录用户
    print(request.user.username)
    print(request.user.id)

    # 判断用户是否登录
    if request.user.is_authenticated:
        print('用户登录了')
    else :
        print('用户没有登录')

    return render(request, 'home.html')



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


# 注销登录
def auth_logout(request):
    logout(request)  # 注销
    return HttpResponse('注销成功')
    # return redirect('/login/')


# 注册普通用户
def auth_register(request):
    if request.method == 'GET':
        return render(request,'register.html')
    else:
        name=request.POST.get('name')
        password=request.POST.get('password')
        #密码是密文，这个用不了
        # User.objects.create(username=name,password=password)
        # auth提供了两个创建用户的方法
        # 创建超级用户(超级用户需要传email)
        # User.objects.create_superuser(username=name,password=password,email=None)
        # 创建普通用户
        User.objects.create_user(username=name,password=password)
        return redirect('/auth_login/')


# 注册超级用户
def auth_superuser(request):
    if request.method == 'GET':
        return render(request,'superuser.html')
    else:
        name = request.POST.get('name')
        password = request.POST.get('password')
        email = request.POST.get('email')
        #密码是密文，这个用不了
        # User.objects.create(username=name,password=password)
        # auth提供了两个创建用户的方法
        # 创建超级用户(超级用户需要传email)
        User.objects.create_superuser(username=name,password=password,email=email)
        return redirect('/auth_login/')


# 查看密码
@login_required()
def auth_check_password(request):
    user=User.objects.filter(pk=3).first()
    res=user.check_password('123456')
    print(res)
    return HttpResponse('只供测试')


# 修改密码
@login_required(login_url='/auth_login/')
# @login_required()
def auth_change_password(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:
            res = request.user.check_password(old_password)
            if res:
                request.user.set_password(new_password)
                request.user.save()
        return redirect('/auth_login/')
    return render(request,'modify.html')


# 禁止用户登录
def all_user(request):
    if request.method=='GET':
        if request.user.is_superuser:
            user_list=User.objects.all()
            return render(request, 'users.html', locals())
        else:
            return HttpResponse('您没有权限')


def disable_user(request):
    user=User.objects.filter(pk=request.GET.get('id')).first()
    user.is_active=False
    user.save()
    return redirect('/users/')

以上为视图层views.py