Django Auth认证模块

1、Auth模块概述

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

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

2、Auth模块常用方法

首先要导入auth模块：

from django.contrib import auth

authenticate()

#提供了用户认证功能，即验证用户名以及密码是否正确，一般需要username 、password两个关键字参数。
#如果认证成功（用户名和密码正确有效），便会返回一个 User 对象。
#authenticate()会在该 User 对象上设置一个属性来标识后端已经认证了该用户，且该信息在后续的登录过程中是需要的。


#用法：
user = authenticate(username='usernamer',password='password')    #用户名和密码验证成功返回一个user对象

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 = authenticate(username=username, password=password)#拿到用户名和密码通过authenticate()拿到用户对象
  if user is not None:#当拿到的用户对象存在是说明认证成功，返回的是一个用户对象，认证失败则返回一个none
    login(request, user) #将登陆成功的返回的user对象传入，这样就可以记录下用户的登录状态(一旦记录了，可在任意地方用request.user获取到当前登录对象)
    # Redirect to a success page.
    ...
  else:#
    # Return an 'invalid login' error message.
    ...

logout(request)

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

#用法：
from django.contrib.auth import logout
   
def logout_view(request):
  logout(request)  #注销登录状态，其实就是把session信息删掉
  # 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_required

#auth 给我们提供的一个装饰器工具，用来快捷的给某个视图添加登录校验；
#login_requierd有一个参数，login_url当我们没有登录可以让他跳到我们指定的url。

#用法：
from django.contrib.auth.decorators import login_required
      
@login_required #添加一个登录校验的装饰器，登录成功才会走到下面，否则会跳转到django默认的登录
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 = User.objects.create_superuser（username='用户名',password='密码',email='邮箱',...）#这三个参数是表中必须有的

check_password()

#auth 提供的一个检查密码是否正确的方法，需要提供当前请求用户的密码。

#密码正确返回True，否则返回False。

#用法：
ok = user.check_password('密码')  #检查密码是否正确，返回一个true或false

set_password()

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

#用法：
user.set_password(password='') #重新设置密码
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 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对象的属性：

User对象属性：username， password

is_staff ： 用户是否拥有网站的管理权限.
is_active ： 是否允许用户登录,；设置为 False，可以在不删除用户的前提下禁止用户登录

3、扩展默认的auth_user表

auth_user表字段都是固定的那几个，实际项目中可能会有其他的一些字段；

比如，我想要加一个存储用户手机号的字段，怎么办？

你可能会想到新建另外一张表然后通过一对一和内置的auth_user表关联，这样虽然能满足要求但是有没有更好的实现方式呢？

答案是当然有了。

我们可以通过继承内置的 AbstractUser 类，来定义一个自己的Model类。

这样既能根据项目需求灵活的设计用户表，又能使用Django强大的认证系统了。

使用：

# 导入模块
from django.contrib.auth.models import AbstractUser

class UserInfo(AbstractUser): #继承AbstractUser
    """
    用户信息表
    """
    nid = models.AutoField(primary_key=True) #这样就相当于在自己的类中可以派生出新的字段，并且auth_user表的字段也都在
    phone = models.CharField(max_length=11, null=True, unique=True)#
    
    def __str__(self):
        return self.username #字符串原样输出

注意事项：

#一旦指定了新的认证系统所使用的表，我们就需要重新在数据库中生成该表，而不能继续使用原来默认的auth_user表了。

#扩展了内置的auth_user表之后，一定要在settings.py中告诉Django，我现在使用我新定义的UserInfo表来做用户认证。写法如下：
AUTH_USER_MODEL = "app名.UserInfo"