72 auth 模块

主要内容:

https://www.cnblogs.com/maple-shaw/articles/9537320.html

auth模块简介

auth模块是对登录认证方法的一种封装，之前我们获取用户输入的用户名及密码后需要自己从user表里查询有没有用户名和密码符合的对象，

而有了auth模块之后就可以很轻松的去验证用户的登录信息是否存在于数据库中。

除此之外，auth还对session做了一些封装，方便我们校验用户是否已登录

auth里的方法

如果想使用auth模块的方法，必须要先导入auth模块

1	`from` `django.contrib` `import` `auth`

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

1 、authenticate()

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

如果认证信息有效，会返回一个 User 对象。authenticate()会在User 对象上设置一个属性标识那种认证后端认证了该用户，且该信息在后面的登录过程中是需要的。当我们试图登陆一个从数据库中直接取出来不经过authenticate()的User对象会报错的！！

1	`user` `=` `authenticate(username='someone',password='somepassword')`

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

3 、logout(request) 注销用户　　

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

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

4 、user对象的 is_authenticated()

要求：

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

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

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

方法1:

直接用auth的is_authenticated()方法验证

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

方法2:

根据request.user.username来验证，如果为空，则说明没有登录

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

方法3:

django已经为我们设计好了一个用于此种情况的装饰器：login_requierd()

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

若用户没有登录，则会跳转到django默认的登录URL '/accounts/login/ ' (这个值可以在settings文件中通过LOGIN_URL进行修改)。并传递当前访问url的绝对路径 (登陆成功后，会重定向到该路径)。

user对象

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

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

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

2.1 、is_authenticated()

如果是真正的 User 对象，返回值恒为 True 。用于检查用户是否已经通过了认证。
通过认证并不意味着用户拥有任何权限，甚至也不检查该用户是否处于激活状态，这只是表明用户成功的通过了认证。这个方法很重要, 在后台用request.user.is_authenticated()判断用户是否已经登录，如果true则可以向前台展示request.user.name

2.2 、创建用户

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

1 2	`from` `django.contrib.auth.models` `import` `User` `user` `=` `User.objects.create_user（username='',password='',email=''）`

2.3 、check_password(passwd)

user = User.objects.get(username=' ')
if user.check_password(passwd):
    ......

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

使用 set_password() 来修改密码

user = User.objects.get(username='')
user.set_password(password='')
user.save　

2.5 、简单示例

注册：

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)　　

修改密码：

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

自己创建User表

需要注意的是，以上的所有操作，都是针对django自动创建的auth_user表的，我们可以看一下这张表的结构

这是django给我们自动创建的一张user表，而如果要用auth模块，就必须要使用（或继承）这张表。

继承表的好处是我们可以增加一些自己需要的字段，并且同时可以使用auth模块提供的接口、方法

下面就讲一下继承auth的方法：

1、导入AbstractUser类，并且写一个自定义的类，继承AbstractUser类，如下：

from django.contrib.auth.models import AbstractUser
 
class UserInfo(AbstractUser):
    """
    用户信息
    """
    nid = models.AutoField(primary_key=True)
    telephone = models.CharField(max_length=11, null=True, unique=True)
   ......

需要注意的是，UserInfo表里就不需要有auth_user里重复的字段了，比如说username以及password等，但是还是可以直接使用这些字段的，并且django会自动将password进行加密

2、这样写完之后，还需要在setting.py文件里配置：

1	`AUTH_USER_MODEL` `=` `'blog.UserInfo'`

这样，django就知道从blog项目下的models去查找UserInfo这张表了

补充，给类里的方法加装饰器

由于类里的方法都有一个self参数，所以给类加装饰器的与普通函数不太一样，需要调用一个模块的方法，如下：

from django.utils.decorators import method_decorator
 
class Admin(View):
        
    @method_decorator(login_required)
     def get(request):
            pass