django组件之Auth组件

Auth模块是什么

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

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

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

使用

# 导入Auth模块
from django.contrib import auth

authenticate()

提供了用户认证功能，即验证用户名以及密码是否正确，一般需要username 、password两个关键字参数(会将password参数转为密文与auth_user表中的密码校验)。

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

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

user_obj = auth.authenticate(username=username,password=password)
# 必须要用auth.authenticate 因为数据库中的密码字段是密文的 而你获取的用户输入的是明文
print(user_obj)  #  返回的就是用户对象
print(user_obj.username)  # 用户名
print(user_obj.password)  # 密文密码

login(HttpRequest, user)

该函数接受一个HttpRequest对象，以及一个经过authenticate认证的User对象。

将用户状态记录到session中,并返回到前端浏览器中(将用户状态记录到session中,并返回到前端浏览器中)

auth.login(request,user_obj)  # 将用户状态记录到session中
# 类似 request.session['user'] = user_obj
"""
只要执行了这一句话,你就可以在前后端任意位置通过request.user获取到当前用户对象
"""

补充 匿名用户:

def foo(request):
    print(request.user)  # AnonymousUser 如果没有执行auth.login那么拿到的是匿名用户
    return HttpResponse('foo')

案例

logout(request)

该函数接受一个HttpRequest对象，无返回值。

当调用该函数时，当前请求的session信息会全部清除。该用户即使没有登录，使用该函数也不会报错。

def logout(request):
    auth.logout(request)
    # 类似 request.session.flush()
    return HttpResponse('logout')

is_authenticated()

判断是否登录方法

def my_view(request):
  if not request.user.is_authenticated(): # 判断用户是否登录,返回bool值,只有执行了auth.login才为True
    return redirect('%s?next=%s' % (settings.LOGIN_URL, request.path))

login_requierd()

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

• 局部配置

@login_required(login_url='/login/')  # login_url参数 从定向到login页面(若用户没有登录测重定向到 /login/ )
def func(request):
    return HttpResponse('func')

• 全局配置

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() 与 create_superuser()

auth 提供的一个创建新的普通用户和超级用户的方法，需要提供必要参数（username、password）等。

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

check_password(password)

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

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

# 获取用户密码自动加密,去数据库校验当前用户的密码是否一致
is_right = request.user.check_password(password)  # 返回bool值

set_password(password)

auth 提供的一个修改密码的方法，接收 要设置的新密码 作为参数。

注意：设置完一定要调用用户对象的save方法！！！

request.user.set_password(new_password)
request.user.save()  # 修改密码的一定要save方法保存,否则无效

User对象的属性

User对象属性：username， password

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

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

扩展默认的auth_user表

这内置的认证系统这么好用，但是auth_user表字段都是固定的那几个，我在项目中没法拿来直接使用啊！

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

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

答案是当然有了。

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

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

• 1.在models.py文件中创建自定义表

from django.contrib.auth.models import  AbstractUser
​
# 扩展anth_user表的方法 使用类的继承
class Userinfo(AbstractUser):
    # 新增加的字段不要和原来的auth_user表中的字段冲突
    phone = models.BigIntegerField()
    avatar = models.CharField(max_length=32)

• 2.在settings.py文件中

# 告诉django  orm不再使用auth默认的表  而是使用你自定义的表
AUTH_USER_MODEL = 'app01.Userinfo'  # '应用名.类名'

• 3.配置MySQL数据库, 执行数据库迁移命令

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