auth认证组件

向右看齐 2022-01-07 01:23 273阅读 0赞

# Django自带的用户认证 #

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

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

## auth模块 ##

from django.contrib import auth

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

### **authenticate()**  ###

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

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

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

用法：

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

### **login(HttpRequest, user)　　** ###

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

该函数实现一个用户登录的功能。它本质上会在后端为该用户生成相关session数据。

用法：

![复制代码][copycode.gif]

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.
        ...

![复制代码][copycode.gif]

**注意：**

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

详细原理请查看 AuthenticationMiddleware 中间件源码。

### **logout(request)**  ###

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

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

用法：

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

### 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 my_view(request):
      ...

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

如果需要自定义登录的URL，则需要在settings.py文件中通过LOGIN\_URL进行修改。

示例：

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

### 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。

用法：

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

**一个修改密码功能的简单示例**

![ContractedBlock.gif][] ![ExpandedBlockStart.gif][]

@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)

修改密码示例

### 用户对象的属性 ###

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

其他常用属性含义如下：

is\_staff ： 用户是否拥有网站的管理权限.

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

## 扩展默认的auth\_user表 ##

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

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

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

答案是当然有了。

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

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

![复制代码][copycode.gif]

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

![复制代码][copycode.gif]

注意：

按上面的方式扩展了内置的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表了。

auth实例

![ContractedBlock.gif][] ![ExpandedBlockStart.gif][]

rom django.contrib import auth
    from django.contrib.auth.models import User
    def auth_login(request):
        if request.method == 'POST':
            username = request.POST.get('username')
            password = request.POST.get('password')
            # models.User.objects.filter(username=username,password=password).first()
            user_obj = auth.authenticate(request,username=username,password=password)
            if user_obj:
                # 记录用户状态
                # request.session['name'] = 'jason'
                auth.login(request,user_obj)  # 一旦记录了，可以在任意的地方通过request.user获取到当前登录对象
                return HttpResponse('ok')
    
        return render(request,'auth_login.html')
    
    
    def auth_index(request):
        print(request.user.is_authenticated())  # 判断当前用户是否已经登录
        print(request.user,type(request.user))  # 获取当前登录用户对象
        return HttpResponse('ok')
    
    
    def auth_logout(request):
        auth.logout(request)  # request.session.flush()
        return HttpResponse('ok')
    
    
    def auth_register(request):
        if request.method == 'POST':
            username = request.POST.get('username')
            password = request.POST.get('password')
            user_obj = auth.authenticate(request,username=username)
            if user_obj:
                return HttpResponse('当前用户已存在')
            # models.User.objects.create(username=username,password=password)
            # User.objects.create(username=username,password=password)  # 不能再用create创建
            # User.objects.create_user(username=username,password=password)  # 创建普通用户
            User.objects.create_superuser(username=username,password=password,email='123@163.com')  # 创建超级用户
        return render(request,'auth_register.html')
    
    def auth_password(request):
        print(request.user.password)
        is_res = request.user.check_password('jason123')  # 校验密码是否一致
        if is_res:
            request.user.set_password('666')  # 设置新密码
            request.user.save()  # 修改密码必须save保存  不然无效
        return HttpResponse('ok')
    
    
    from django.contrib.auth.decorators import login_required
    # @login_required(login_url='/auth_login/')  # 局部配置
    @login_required
    def auth_home(request):
        return HttpResponse('home必须登录才能访问')
    
    
    @login_required
    def auth_xxx(request):
        return HttpResponse('xxx必须登录才能访问')

转载于:https://www.cnblogs.com/wangtenghui/p/11046720.html

[copycode.gif]: /images/20211227/0b734d16e0cb45e2bd253e7349d43160.png
[ContractedBlock.gif]: https://images.cnblogs.com/OutliningIndicators/ContractedBlock.gif
[ExpandedBlockStart.gif]: /images/20211227/2f753ba137334340a78d2cf850169775.png