Auth模块

 

#     -auth组件
#         -auth是什么?
#         -django内置的用户认证系统,可以快速的实现,登录,注销,修改密码....
#         -怎么用?
#             -(1)先创建超级用户:
#                 -python3 manage.py createsuperuser
#                 -输入用户名,邮箱(可以不输入),密码,敲回车,这样就创建出一个超级用户
#                 -也就是在auth_user这个表中插入了一条数据(密码是加密的,所以我不能手动插入)
#             -(2)验证用户:
#                 -from django.contrib import auth
#                 -user = auth.authenticate(request, username=name, password=pwd)
#                 -相当于在查询:user=models.User.objects.filter(name=name,pwd=pwd).first()
#                 -如果校验通过,会返回一个user对象,通过判断user对象,校验是否验证成功
#             -(3)登录
#                 -auth.login(request,user)
#                 -其实就是在session中写了一条数据
#             -(4)一旦登录成功,调了这个函数login(request,user)
#                 -以后再视图类,函数中的request对象中,就有一个user对象,就是当前登录的用户对象
#                 -如果没有登录,request.user=AnonymousUser,匿名用户
#             -(5)注销
#                 -auth.logout(request)
#                 -内部:调用了request.session.flush(),删除了登录状态
#             -(6)登录认证装饰器
#                 -from django.contrib.auth.decorators import login_required
#                 -@login_required(redirect_field_name='eee',login_url='/login/')
#                 -redirect_field_name:修改?后面的key值,
#                 -login_url:如果没有登录,跳转到的页面
#                     -可以局部配置
#                     -可以全局配置(在setting中)
#                         # 全局的配置,如果没有登录,跳到这个路由
#                         LOGIN_URL='/login/'
#             -(7)创建用户:
#                 -from django.contrib.auth.models import User
#                 - 创建超级用户和普通用户
#                     # 不能用create
#                     # user=User.objects.create(username=name,password=pwd)
#                     # 创建超级用户
#                     # user=User.objects.create_superuser(username=name,password=pwd)
#                     # 创建普通用户
#                     user=User.objects.create_user(username=name,password=pwd)
#             -(8)校验密码
#                 -request.user.check_password(pwd)
#                 -先拿到用户(可以是登录用户,可以现查)
#             -(9)修改密码:
#                 -user.set_password(pwd)
#                 -user.save()
#                 -注意:一定要调用save(),否则是不保存的
#             -(10)is_authenticated()
#                 -如果通过验证,是true反之false
#             -(11)其他方法(了解):
#                 -is_active:禁止登录网站(用户还存在,封号)
#                 -is_staff:是否对网站有管理权限(能不能登录admin)
#
#             -(12)删除用户
#                 -orm删除
#         如果想在认证组件上加手机号等其他字段:如何处理
#             -(1) 定义一个表模型,跟User一对一管理
#                 class UserDetail(models.Model):
#                     phone=models.CharField(max_length=32)
#                     # 一对一跟auth_user表做关联
#                     # 如果是从外部引入的表模型,是不能加引号的
#                     # 如果加引号,只是在当前model找
#                     user=models.OneToOneField(to=User)
#             -(2)定义一个表模型,继承(AbstractUser)
#                 -from django.contrib.auth.models import AbstractUser
#                  class UserInfo(AbstractUser):
#                     # username,password...都有
#                     phone=models.CharField(max_length=32)
#                     sex=models.BooleanField()
#                 -在setting中配置:
#                     AUTH_USER_MODEL ='app01.UserInfo'
#                 -做数据库迁移,以后就没有auth_user这个表了,以后认证组件用的表就是UserInfo
#                 -原来auth中的其他操作:
#                     -authentication
#                     -login
#                     -logout
#                     -set_password
#                     ....
#                     ---一样用,完全一样
#                 -不一样的地方:
#                     如果之前用到User这个表模型的地方,都换成UserInfo

一、auth简介及使用

 是什么

#auth是什么?
    jango内置的用户认证系统,可以快速的实现,登录,注销,修改密码....

怎么用

#(1)先创建超级用户:
    -python3 manage.py createsuperuser
    -输入用户名,邮箱(可以不输入),密码,敲回车,这样就创建出一个超级用户
    -也就是在auth_user这个表中插入了一条数据(密码是加密的,所以我不能手动插入)
#(2)验证用户:
    -from django.contrib import auth
    -user = auth.authenticate(request, username=name, password=pwd)
    -相当于在查询:user=models.User.objects.filter(name=name,pwd=pwd).first()
    -如果校验通过,会返回一个user对象,通过判断user对象,校验是否验证成功
#(3)登录
    -auth.login(request,user)
    -其实就是在session中写了一条数据
#(4)一旦登录成功,调了这个函数login(request,user)
    -以后再视图类,函数中的request对象中,就有一个user对象,就是当前登录的用户对象
    -如果没有登录,request.user=AnonymousUser,匿名用户
#(5)注销
    -auth.logout(request)
    -内部:调用了request.session.flush(),删除了登录状态
#(6)登录认证装饰器
    -from django.contrib.auth.decorators import login_required
    -@login_required(redirect_field_name='eee',login_url='/login/')
    -redirect_field_name:修改?后面的key值,
    -login_url:如果没有登录,跳转到的页面
        -可以局部配置
        -可以全局配置(在setting中)
            # 全局的配置,如果没有登录,跳到这个路由
            LOGIN_URL='/login/'
#(7)创建用户:
    -from django.contrib.auth.models import User
    - 创建超级用户和普通用户
        # 不能用create
        # user=User.objects.create(username=name,password=pwd)
        # 创建超级用户
        # user=User.objects.create_superuser(username=name,password=pwd)
        # 创建普通用户
        user=User.objects.create_user(username=name,password=pwd)
#(8)校验密码
    -request.user.check_password(pwd)
    -先拿到用户(可以是登录用户,可以现查)
#(9)修改密码:
    -user.set_password(pwd)
    -user.save()
    -注意:一定要调用save(),否则是不保存的

#(10)is_authenticated()
    判断用户是否通过验证，在模板层，{{request.user.username}}可以拿到当前登陆用户名，与之连用，登陆的情况，显示退出，修改密码，非登陆的显示登陆注册
    -如果通过验证,是true反之false
#(11)其他方法(了解):
    -is_active:禁止登录网站(用户还存在,封号)
    -is_staff:是否对网站有管理权限(能不能登录admin)

#(12)删除用户
    -orm删除

二、Auth组件常用功能

from django.contrib import auth

authenticate()

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

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

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

用法：

#user = authenticate(username='usernamer',password='password')

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

该函数接受一个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()

登陆验证装饰器

#用法：
#from django.contrib.auth.decorators import login_required

#局部配置，    
@login_required（login_url='/login/'）
def my_view(request):
    ...

#全局配置
settings.py
LOGIN_URL = '/login/'     

也需要加装饰器，只不过装饰器不需要参数了
@login_required
def my_view(request):
    ...

 

三、auth_user表常用操作

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

check_password(password)

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

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

用法：

ok = user.check_password('密码')

set_password(password)

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

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

用法：

#user.set_password(password='')
#user.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)

User对象的属性

User对象属性：username， password

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

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

 

3 扩展默认的auth_user表

#有这么一个场景，想要加一个存储用户手机号的字段，怎么办？

#可以新建另外一张表然后通过一对一和内置的auth_user表关联


#也可以通过继承内置的 AbstractUser 类，来定义一个自己的Model类。
#这样既能根据项目需求灵活的设计用户表，又能使用Django强大的认证系统了。

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

注意：

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

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

再次注意：

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