13. Django Auth组件

Django 用户认证（Auth）组件

版权声明：本博客来自路飞学城Python全栈开发培训课件，仅用于学习之用，严禁用于商业用途。
欢迎访问路飞学城官网：https://www.luffycity.com/

本节重点

• auth模块
• Auth组件实例
• Auth组件扩展

1. 引子

我们在开发一个网站的时候不可避免的需要涉及实现网站的用户系统，需要实现包括用户注册、用户登录、用户认证、注销、修改密码等功能，很明显这是一个重复繁琐的过程。

还好Django内置了用户认证（Auth）组件，该组件一般用在用户的登录注册上，用于判断当前的用户是否合法，并跳转到登陆成功或失败页面。

2. auth模块

用户认证（Auth）组件默认使用 auth_user 表来存储用户数据。

使用前需要导入 auth 模块:

# 认证模块
from django.contrib import auth

# 对应数据库
from django.contrib.auth.models import User

2.1 auth中的方法

auth中提供了许多实用方法：

• 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、email）等。

  用法：

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

• authenticate()

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

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

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

  用法：

  user = authenticate(username='theuser',password='thepassword')
  

• 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_obj = authenticate(username=username, password=password)
    if user_obj:
      login(request, user_obj)
      # Redirect to a success page.
      ...
    else:
      # Return an 'invalid login' error message.
      ...
  

  注意：

  只要使用login(request, user_obj)之后，request.user就能拿到当前登录的用户对象。否则request.user得到的是一个匿名用户对象（AnonymousUser Object）。

• logout(request)

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

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

  用法：

  from django.contrib.auth import logout
     
  def logout_view(request):
    logout(request)
    # Redirect to a success page.
  

• is_authenticated()

  用来判断当前请求是否通过了认证。

  如果是真正的 User 对象，返回值恒为 True 。 用于检查用户是否已经通过了认证。
  通过认证并不意味着用户拥有任何权限，甚至也不检查该用户是否处于激活状态，这只是表明用户成功的通过了认证。

  应用场景：

  • 用户登陆后才能访问某些页面，

  • 如果用户没有登录就访问该页面的话直接跳到登录页面

  • 用户在跳转的登陆界面中完成登陆后，自动访问跳转到之前访问的地址

  用法：

  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进行修改。

  示例：

  # settings.py
  LOGIN_URL = '/login/'  # 这里配置成你项目登录页面的路由
  

• check_password(raw_password)

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

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

  用法：

  ok = user_obj.check_password('密码')
  

  或者直接针对当前请求的user对象校验原密码是否正确：

  ok = request.user.check_password(raw_password='原密码')
  

• set_password(raw_password)

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

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

  用法：

  user_obj.set_password('新密码')
  user_obj.save()
  

2.2 User对象

user_obj能够拿到认证所用用户表的数据属性，比如username， password等。

其他常用属性含义如下：

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

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

2.3 页面跳转设置

设置从哪个页面访问，登录成功后就返回哪个页面。

django 在用户访问页面时，如果用户是未登录的状态，就给用户返回登录页面。

此时，该登录页面的 URL 后面有参数：next=用户访问的页面的 URL。

因此，设置在用户登录成功后重定向的 URL 为 next 参数的值。

但是，若用户一开始就输入登录页面 logi，request.GET.get(“next”) 就取不到值，所以在后面加 or，可以设置自定义返回的页面。

用法：

# 如果直接输入 login、get() 就取不到值，path 可以自定义设置返回的页面
path = request.GET.get("next") or "/index/"
return redirect(path)

3. Auth组件实例

3.1 注册

def sign_up(request):
 
    state = None
    if request.method == 'POST':
 
        password = request.POST.get('password', '')
        repeat_password = request.POST.get('repeat_password', '')
        email=request.POST.get('email', '')
        username = request.POST.get('username', '')
        if User.objects.filter(username=username):
                state = 'user_exist'
        else:
                new_user = User.objects.create_user(username=username, password=password,email=email)
                new_user.save()
 
                return redirect('/book/')
    content = {
        'state': state,
        'user': None,
    }
    return render(request, 'sign_up.html', content)　　

3.2 登录

def login(request):
    if request.method == "GET":
        return render(request, "login.html")
    username = request.POST.get("username")
    password = request.POST.get("pwd")
    valid_num = request.POST.get("valid_num")
    keep_str = request.session.get("keep_str")
    if keep_str.upper() == valid_num.upper():
        user_obj = auth.authenticate(username=username, password=password)
        print(user_obj.username)
        if not user_obj:
            return redirect("/login/")
        else:

            auth.login(request, user_obj)
            path = request.GET.get("next") or "/index/"
            print(path)
            return redirect(path)
    else:
        return redirect("/login/")

3.3 修改密码

@login_required
def set_password(request):
    user = request.user
    state = None
    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:
                state = 'empty'
            elif new_password != repeat_password:
                state = 'repeat_error'
            else:
                user.set_password(new_password)
                user.save()
                return redirect("/log_in/")
        else:
            state = 'password_error'
    content = {
        'user': user,
        'state': state,
    }
    return render(request, 'set_password.html', content)

3.4 跳转主页

from django.contrib.auth.decorators import login_required 

@login_required
def index(request):
  return HttpResponse("index页面。。。")

3.5 注销

def logout(request):
    ppp = auth.logout(request)
    print(ppp) # None
    return redirect("/login/")

4. Auth组件扩展

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

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

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

答案是当然有了。

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

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

4.1 自定义UserInfo模型

model.py文件：

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

4.2 设置AUTH_USER_MODEL

按上面的方式扩展了内置的auth_user表之后，一定要在settings.py中告诉Django，使用我新定义的UserInfo表来做用户认证。

写法如下：

settings.py文件：

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

4.3 使用UserInfo表

自定义认证系统默认使用的数据表之后，我们就可以像使用默认的auth_user表那样使用我们的UserInfo表了。比如：

创建普通用户：

UserInfo.objects.create_user(username='用户名', password='密码')

创建超级用户：

UserInfo.objects.create_superuser(username='用户名', password='密码')

注意事项：

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