auth组件

Posted 2021-01-22 rongge95500

auth组件介绍

我们在开发一个项目的时候，无可避免的需要设计实现一个网站的用户系统，实现包括用户注册、用户登录、用户认证、注销、修改密码等等的功能，所以Django为了提升开发效率，它内置了一个模块，即auth模块（用户认证系统），它默认使用 auth_user 表来存储用户数据

auth模块方法介绍

使用之前需要先导入auth模块

from django.contrib import auth

先创建一个superuser

python manage.py createsuperuser

也就是在 auth_user 这个表中插入了一条数据(密码是加密的,所以不能手动插入)

authenticate()

• 用户验证

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

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

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

• 用法

user = auth.authenticate(request, username=name, password=pwd)

相当于执行查询语句：user = models.User.objects.filter(name=name,pwd=pwd).first()

login(request, user)

• 用户登录

该函数接受一个HttpRequest对象，和一个经过认证的 User 对象。它本质上会在后端为该用户生成相关的 session 数据。

def login(request):
    if request.method == ‘GET‘:

        return render(request, ‘login.html‘)
    elif request.method == ‘POST‘:
        name = request.POST.get(‘name‘)
        pwd = request.POST.get(‘pwd‘)
        # 校验
        user = auth.authenticate(request, username=name, password=pwd)
        if user:
            # 登录,本质是把用户信息放到 session
            auth.login(request, user)
            # 同 request.session[‘name‘]=name
            return HttpResponse(‘登录成功‘)
        else:
            return HttpResponse(‘用户名或密码错误‘)

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

logout(request)

• 用户注销

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

def logout(request):
    auth.logout(request)
    return redirect(‘/login/‘)

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 test(request):
    print(type(request))
    user = request.user.password
    print(user)
    return render(request, ‘test.html‘)

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_obj = User.objects.create_superuser（username=‘用户名‘,password=‘密码‘,email=‘邮箱‘,...）

check_password(raw_password)

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

user = user_obj.check_password(‘密码‘)

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

user = request.user.check_password(raw_password=‘原密码‘)

set_password(raw_password)

• 密码重置

接收要设置的新密码作为参数。

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

用法：

user_obj.set_password(‘新密码‘)
user_obj.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)

View Code

auth_user表扩展

当用户自己想要再添加一个用户手机号或者其他的字段时，该如何解决？？

• 方法一

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

from django.contrib.auth.models import AbstractUser
class UserInfo(AbstractUser):
    # username,password...都有
    phone=models.CharField(max_length=32)
    sex=models.BooleanField()

注意点：按上面的方式扩展了内置的auth_user表之后，一定要在settings.py中告诉Django，现在使用新定义的UserInfo表来做用户认证。写法如下：

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

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

创建普通用户：

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

创建超级用户：

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

• 方法二

定义一张单独的表，与 auth_user 表建立一对一的关联

class UserDetail(models.Model):
	phone=models.CharField(max_length=32)
	# 一对一跟auth_user表做关联
	# 如果是从外部引入的表模型,是不能加引号的
	# 如果加引号,只是在当前model找
	user=models.OneToOneField(to=User)