Django 自带认证功能auth模块和User对象的基本操作

Posted 2020-11-20 wcwnina

一、auth模块

from django.contrib import auth

django.contrib.auth中提供了许多方法，这里主要介绍其中的三个：

authenticate()   

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

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

user = auth.authenticate(username=username, password=pwd)
if user:
# 内置的login方法
# 生成Session数据，存一下user_id 然后把sessionid写入Cookie
# 后续每一次请求来的时候，AuthenticationMiddleware中的process_request方法中
# 会取到user_id，进而取到user对象,然后添加到request.user属性中 --> request.user = user
# 后续我们都可以通过request.user拿到当前的登陆用户对象

重写（自定义）登录验证后端authenticate()

例：实现用户名或邮箱登录验证。

from django.contrib.auth.backends import ModelBackend
from django.db.models import Q

class CustomBackend(ModelBackend):      # 继承ModelBackend类，重写authenticate()方法
    """
    自定义用户验证后端：支持用户名或邮箱登录。
    """

    def authenticate(self, request, username=None, password=None, **kwargs):        # 参数username实际是用户输入的登录账号
        try:
            user = UserProfile.objects.get(Q(username=username) | Q(email=username))
            if user.check_password(password):
                return user
        except Exception as e:
            return None

然后别忘了在settings.py中配置该验证后端：

AUTHENTICATION_BACKENDS = [‘yourfilepath.CustomBackend‘, ]    # yourfilepath是该类的目录

login(HttpRequest, user)　　

登录验证。该函数接受一个HttpRequest对象，以及一个认证了的User对象。

此函数使用django的session框架给某个已认证的用户附加上session id等信息。

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)

登录注销用户。　

from django.contrib.auth import logout
   
def logout_view(request):
  logout(request)
  # 调用auth内置的注销方法

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

二、User对象

User对象属性：username，password（必填项）password用哈希算法保存到数据库

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

is_active ： 是否允许用户登录, 设置为"False"，可以不用删除用户来禁止用户登录

is_authenticated()

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

这个方法很重要, 在后台用request.user.is_authenticated()判断用户是否已经登录，如果true则可以向前台展示request.user.name。

场景：

1. 用户登陆后才能访问某些页面，
2. 如果用户没有登录就访问该页面的话直接跳到登录页面
3. 用户在跳转的登陆界面中完成登陆后，自动访问跳转到之前访问的地址

方法1:

def my_view(request):
  if not request.user.is_authenticated():
    return redirect(‘%s?next=%s‘ % (settings.LOGIN_URL, request.path))

方法2:

django已经为我们设计好了一个用于此种情况的装饰器：login_requierd(function=None, redirect_field_name=REDIRECT_FIELD_NAME, login_url=None)

from django.contrib.auth.decorators import login_required
      
@login_required
def my_view(request):
  ...

若用户没有登录，则会跳转到django默认的 登录URL ‘/accounts/login/ ‘ (这个值可以在settings.py文件中通过LOGIN_URL进行修改)。

并传递  当前访问url的绝对路径 (登陆成功后，会重定向到该路径)。

创建用户

使用 create_user 辅助函数创建用户:

from django.contrib.auth.models import User
user = User.objects.create_user（username=‘‘,password=‘‘,email=‘‘）

密码检查

check_password(password)

用户需要修改密码的时候，首先要让其输入原来的密码 ，如果给定的值通过了密码检查，返回 True

修改密码

使用 auth.hashers.make_password(password) 来修改密码

user = User.objects.get(username=‘‘)
user.password = auth.hashers.make_password(password=‘123‘)　　# 修改密码，auth模块自动将明文转成密文
user.save()　　# 修改密码一定要保存 

修改密码简单示例

from django.contrib.auth import hashers

@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.password = hashers.make_password(new_password)
                user.save()
                return redirect("/login/")
        else:
            err_msg = ‘原密码输入错误‘
    content = {
        ‘err_msg‘: err_msg,
    }
    return render(request, ‘set_password.html‘, content)

三、认证进阶：自定义auth User模型

这内置的auth_user表这么好用，但是我在项目中没法直接使用啊！比如，我想要加一个存储用户手机号的字段，怎么办？

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

答案是当然有了。 

我们可以通过继承内置的auth_user表的对应的类，来定义一个自己的ORM类：

from django.contrib.auth.models import AbstractUser
class UserInfo(AbstractUser):　　　　# 继承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"

如何设置默认的登录页面是什么？

LOGIN_URL= "默认的页面url"

 

　　至此。转载请注明出处。