Auth模块

Auth模块

首先要讲一点，要用就要用全套，而不是用一部分，然后自己写一部分。

我们在创建表的时候，它会同时创建出很多乱七八糟的表，登录django后台管理的用户就存在这些表中的一个，也就是 auth_user 里面。

如何创建超级用户 用于登录django admin的后台管理
输入createsuperuser
然后按照流程走就是了，创建出来的用户就是超级用户了。权限很多。

在使用auth模块之前，当然要先导入了。

auth 模块并没有什么原理可讲，所以就直接上代码个方法以及用法就好了。

校验用户是否存在
user_obj =auth.authenticate(username=username,password=password)  
# 返回的是数据对象  没有返回None

保存用户登录状态
auth.login(request,user_obj)  # 执行完这一句之后 只要是能够拿到request的地方 都可以通过request.user获取到当前登录用户对象

判断当前用户是否登录
request.user.is_authenticated()

获取当前用户数据对象
request.user

如何给视图函数加上校验用户是否登录的校验
from django.contrib.auth.decorators import login_required
# @login_required(login_url='/xxx/')  # 局部配置，只给单个配上，要指定是哪个函数校验（不推荐）
@login_required  # 全局配置，所有加了这个装饰器的函数都会被校验（推荐）
def home(request):
return HttpResponse('home页面')


            # 当用户没有登录的情况下 跳转的url有两种配置方式
            1.在装饰器括号内通过login_url参数局部指定
            
            2.全局配置  用户没有登录的情况下 所有的视图统一跳转到一个url
            配置文件中
                LOGIN_URL = '/login/'
                
            登录后，会回到自己跳转到login界面之前想要访问的界面。也是由这个装饰器完成的
    
    
    修改密码
        校验原密码是否正确
            is_right = request.user.check_password(old_password)
        设置新密码
            request.user.set_password(new_password)#仅仅只会在内存中产生一个缓存 并不会直接修改数据库
            request.user.save()#一定要点save方法保存 才能真正的操作数据库
    
    
    用户注册
        from django.contrib.auth.models import User
        User.objects.create(username=username,password=password)  # 不用使用create 密码会直接存成明文，不推荐
        User.objects.create_user(username=username,password=password)  # 创建普通用户
        User.objects.create_superuser(username=username,password=password,email='123@qq.com')  # 创建超级用户  邮箱字段必须填写
    
    
    
    扩展auth_user表的字段
        第一种(不好用)
            利用一对一表关系 扩展字段，也就是自己新建一个表，和这张表关联起来。
        
        第二种(继承)
            1.自己写一个默写类 继承原来的auth_user类 然后在settings配置文件中 告诉django使用你新建的类来替代auth_user表
            from django.db import models
            from django.contrib.auth.models import AbstractUser
            # Create your models here.

            class Userinfo(AbstractUser):
                """
                强调 你继承了AbstractUser之后 你自定义的表中 字段不能跟原有的冲突
                """
                phone = models.BigIntegerField()
                avatar = models.FileField()
                register_time = models.DateField(auto_now_add=True)
            2.一定要在settings配置文件中指定
                AUTH_USER_MODEL = 'app01.Userinfo'
                # 固定语法: AUTH_USER_MODEL = '应用名.表名'
            
            """
            通过上面的方式 继承的表 还可以继续使用auth模块所有的功能
            """
        
        温馨提示 当你需要些用户相关的功能的时候可以考虑使用auth模块
from django.shortcuts import render,HttpResponse,redirect,reverse

from django.contrib import auth

from django.contrib.auth.models import User
# Create your views here.
def login(request):
    if request.method == 'POST':
        username = request.POST.get('username')
        password = request.POST.get('password')
        # models.User.objects.filter(username=username,password=password).first()
        # user_obj = auth.authenticate(username=username,password=password)
        # user_obj = auth.authenticate(username=username)
        # is_alive = User.objects.filter(username=username)
        #
        # print(is_alive)
        # print(is_alive.first().password)
        """
        该方法会有一个返回值  当条件存在的情况下 返回就是数据对象本身
        条件不满足 直接返回None
        """
        # if user_obj:
        #     print(user_obj)
        #     print(user_obj.username)
        #     print(user_obj.password)
        #     # 一定要记录用户状态 才算真正的用户登录
        #     # request.session['user'] = user_obj
        #     auth.login(request,user_obj)
        #     """该方法会主动帮你操作session表 并且只要执行了该方法
        #     你就可以在任何位置通过request.user获取到当前登录的用户对象
        #     """
        #     old_path = request.GET.get('next')
        #     if old_path:
        #         return redirect(old_path)
        #     else:
        #         return redirect('/home/')
    return render(request,'login.html')


def index(request):
    print(request.user)  # 直接拿到登录用户的用户对象
    print(request.user.is_authenticated())  # 简单快捷的判断用户是否登录
    return HttpResponse('index')

from django.contrib.auth.decorators import login_required

# @login_required(login_url='/login/')  # 局部配置
@login_required
def set_password(request):
    if request.method == 'POST':
        old_password = request.POST.get('old_password')
        new_password = request.POST.get('new_password')
        # 校验原密码对不对
        is_right = request.user.check_password(old_password)
        # print(is_right)
        if is_right:
            # 修改密码
            request.user.set_password(new_password)  # 仅仅只会在内存中产生一个缓存 并不会直接修改数据库
            request.user.save()  # 一定要点save方法保存 才能真正的操作数据库
            return redirect('/login/')
    return render(request,'set_password.html',locals())

# @login_required(login_url='/xxx/')
@login_required
def home(request):
    return HttpResponse('home页面')

def register(request):
    if request.method == 'POST':
        username = request.POST.get('username')
        password = request.POST.get('password')
        # models.User.objects.create(username=username,password=password)
        # User.objects.create(username=username,password=password)  # 不用使用create 密码会直接存成明文
        # User.objects.create_user(username=username,password=password)  # 创建普通用户
        User.objects.create_superuser(username=username,password=password,email='123@qq.com')  # 创建超级用户  邮箱字段必须填写

    return render(request,'register.html')

Auth模块是什么

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

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

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

auth模块常用方法

from django.contrib import auth

authenticate()

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

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

authenticate()会在该 User 对象上设置一个属性来标识后端已经认证了该用户，且该信息在后续的登录过程中是需要的。

用法：

user = authenticate(username='usernamer',password='password')

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)
  if user is not None:
    login(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)
  # 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 = User.objects.create_superuser（username='用户名',password='密码',email='邮箱',...）

check_password(password)

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

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

用法：

ok = user.check_password('密码')

set_password(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，可以在不删除用户的前提下禁止用户登录。

扩展默认的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表了。