Django之auth组件及自定义中间表(中介模型)

1、auth组件

1.1、定义

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

1.2、内置属性方法

必须数据迁移以后才能使用

1.2.1、authenticate用户认证

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

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

# 在视图函数中使用
from django.contrib import auth
def login(request):
    if request.method == 'GET':
        return render(request,'login.html')
    else:
        name = request.POST.get('name')
        password=request.POST.get('password') # 明文
        # 该方案行不通，密码是密文的，永远匹配不成功
        # user = User.objects.filter(username=name,password=password)
        
        # 使用此方案
        # 第一个参数必须是request对象
        # username和password
        user=auth.authenticate(request,username=name,password=password)
        if user:
            return HttpResponse('登录成功')
        else:
            return HttpResponse('用户名或密码错误')

1.2.2、login

表示用户登录了
1、存储了session
2、以后所有的视图函数，都可以使用request.user,它就是当前登录用户
该函数接受一个HttpRequest对象，以及一个经过认证的User对象
该函数实现一个用户登录的功能，它本质上会在后端为该用户生成相关session数据

from django.contrib.auth import authenticate, login
   
def my_view(request):
  name = request.POST.get('name')
  password=request.POST.get('password')
  user = authenticate(username=name, password=password)
  if user is not None:
    login(request, user)
    # Redirect to a success page
  else:
    # Return an 'invalid login' error message

1.2.3、logout

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

from django.contrib.auth import logout

def logout_view(request):
  	# 后续再访问视图函数，就没有当前登录用户了request.user(匿名用户AnonymousUser)
    auth.logout(request)
    # Redirect to a success page

1.2.4、is_authenticated()

is_authenticated 返回True或者False，判断用户是否登录

# 用在视图中
if request.user.is_authenticated:
    print('用户登录了')
else:
    print('用户没有登录，匿名用户')

# 用在模板中
{% if request.user.is_authenticated %}
	{{ request.user.username }} 登录了
{% else %}
    <a href="/login/">登录</a>
{% endif %}

1.2.5、login_requierd()

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

装饰器，装饰在视图函数上，只要没有登录，就进不来
# 必须登录后才能访问
from django.contrib.auth.decorators import login_required
@login_required(login_url='/login/')

若用户没有登录，则会跳转到django默认的 登录URL '/accounts/login/ ' 并传递当前访问url的绝对路径 (登陆成功后，会重定向到该路径)

如果需要自定义登录的URL，则需要在settings.py文件中通过LOGIN_URL进行修改
LOGIN_URL = '/login/'  # 这里配置成项目登录页面的路由

1、如果局部和全局都有，那么 局部 > 全局
2、局部和全局总结
   全局的好处在于无需重复写代码，但是跳转的页面却很单一
   局部的好处在于不同的视图函数在用户没有登录的情况下可以跳转到不同的页面

1.2.6、create_user()

auth 提供的一个创建新用户的方法，需要提供必要参数(username、password)等

from django.contrib.auth.models import User
user = User.objects.create_user（username='用户名',password='密码',email='邮箱',...）

1.2.7、create_superuser()

auth 提供的一个创建新的超级用户的方法，需要提供必要参数(username、password、email)等
使用代码创建超级用户，邮箱是必填的，而用命令创建则可以不填

from django.contrib.auth.models import User
user = User.objects.create_superuser（username='用户名',password='密码',email='邮箱',...）

1.2.8、check_password(password)

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

# 有了用户，然后校验密码是否正确
# 先获取到用户对象
user = User.objects.filter(username=name).first()
flag = user.check_password('密码')

1.2.9、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)

1.3、User对象的属性

User对象属性: username， password
is_staff: 用户是否拥有网站的管理权限
is_superuser: 是否是超级管理员(如果is_staff=1，可以任意增删查改任何表数据)
is_active: 是否允许用户登录，设置为False，可以在不删除用户的前提下禁止用户登录

1.4、扩展默认的auth_user表

内置的auth_user表，如果要加字段是加不了的，需要扩展该表

方式一(不推荐):
新建另外一张表然后通过一对一和内置的auth_user表关联
from django.db import models
from django.contrib.auth.models import User,AbstractUser

class UserDetail(models.Model):
    phone = models.BigIntegerField()
    user = models.OneToOneField(to='User')

方式二:
通过继承内置的AbstractUser类，来定义一个自己的Model类(一定要在setting中配置)
如果继承了AbstractUser，那么在执行数据库迁移命令的时候auth_user表就不会再创建出来了，而UserInfo表中会出现auth_user所有的字段外加自己扩展的字段，这么做的好处在于能够直接点击自己的表更加快速的完成操作及扩展

前提:
1、在继承之前没有执行过数据库迁移命令
   auth_user没有被创建，如果当前库已经创建了那么你就重新换一个数据库
2、继承的类里面不要覆盖AbstractUser里面的字段名
   表里面有的字段都不要修改，只扩展额外字段即可
3、需要在配置文件中告诉django要用UserInfo替代auth_user
   AUTH_USER_MODEL = 'app01.UserInfo'
   
你如果自己写表替代了auth_user，那么auth模块的功能还是照常使用，参考的表页由原来的auth_user变成了UserInfo

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中配置，要以我们新定义的UserInfo表来做用户认证

# 引用Django自带的User表，继承使用时需要设置
AUTH_USER_MODEL = "app名.UserInfo"

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

1.5、项目一开始没有扩展auth_user表，后期想扩展的操作步骤

1、备份数据--->删数据库库--->重新创建出数据库
2、所有app的数据迁移记录删除，migrations下除了__init__.py都删除
3、去源码中删除auth和admin这俩app的migrations下除了__init__.py都删除
4、数据迁移，同步到数据库
5、备份数据，恢复回去

2、自定义中间表(中介模型)

2.1、方式一(利用orm自动帮我们创建第三张关系表)

class Book(models.Model):
    name = models.CharField(max_length=32)
    authors = models.ManyToManyField(to='Author')
    
class Author(models.Model):
    name = models.CharField(max_length=32)

优点: 代码不需要额外写，非常的方便，还支持orm提供操作第三张关系表的方法
缺点: 第三张关系表的扩展性极差(没有办法额外添加字段)

2.2、方式二(中间表自己定义自己维护)

class Book(models.Model):
    name = models.CharField(max_length=32)
    
class Author(models.Model):
    name = models.CharField(max_length=32)
  
class Book2Author(models.Model):
    book_id = models.ForeignKey(to='Book')
    author_id = models.ForeignKey(to='Author')

优点: 第三张表完全取决于自己进行额外的扩展
缺点: 需要写的代码较多，不能够再使用orm提供的简单方法

2.3、方式三(使用中介模型,既手动创建第三张表,又要使用提供的查询方法)

class Book(models.Model):
    name = models.CharField(max_length=32)
    authors = models.ManyToManyField(to='Author',
                                     through='Book2Author',
                                     through_fields=('book','author')
                                     )
class Author(models.Model):
    name = models.CharField(max_length=32)
    # books = models.ManyToManyField(to='Book',
    #                                  through='Book2Author',
    #                                  through_fields=('author','book')
    #                                  )
class Book2Author(models.Model):
    book = models.ForeignKey(to='Book')
    author = models.ForeignKey(to='Author')

through_fields字段先后顺序
    判断的本质:
        通过第三张表查询对应的表，需要用到哪个字段就把哪个字段写在前面
    也可以简化判断
        当前表是谁，就把对应的关联字段放前面
        
说明: 该方法可以使用orm的正反向查询，但是没法使用add,set,remove,clear这四个方法