68-Django自带用户认证
1、auth模块
Django内置了auth模块,默认使用auth_user表来存储用户数据。
1.1 authenticate()
authenticate()方法提供了用户认证功能,即验证用户名以及密码是否正确,一般需要username 、password两个关键字参数。如果认证成功(用户名和密码正确有效),便会返回一个User对象。
authenticate()会在该User对象上设置一个属性来标识后端已经认证了该用户,且该信息在后续的登录过程中是需要的。
from django.contrib import auth username = request.POST.get("username") pwd = request.POST.get("password") user_obj = auth.authenticate(username=username, password=pwd)
user_obj能够拿到认证所用用户表的数据属性,比如username, password等。其他常用属性含义如下:
is_staff : 用户是否拥有网站的管理权限.
is_active : 是否允许用户登录, 设置为 False,可以在不删除用户的前提下禁止用户登录。
1.2 login()
该函数接受一个HttpRequest对象,以及一个经过认证的User对象。该函数实现一个用户登录的功能。它本质上会在后端为该用户生成相关session数据。
from django.contrib.auth import authenticate, login def login(request): if request.method == "POST": username = request.POST.get("username") pwd = request.POST.get("password") user_obj = auth.authenticate(username=username, password=pwd) if user_obj: login(request, user_obj) # 将通过认证的用户封装到request.user中 return redirect("/app02/index/") return render(request, "login2.html")
只要使用login(request, user_obj)之后,request.user就能拿到当前登录的用户对象。否则request.user得到的是一个匿名用户对象(AnonymousUser Object)。
1.3 is_authenticated()
is_authenticated()方法用来判断用户是否通过认证(需要通过用户对象,即request.user来判断)。通过认证则返回True,否则返回False。
def index(request): print("用户是否通过认证", request.user.is_authenticated()) return render(request, "index2.html")
1.4 logout()
该函数接受一个HttpRequest对象,无返回值。
当调用该函数时,当前请求的session信息会全部清除(相当于request.session.flush()。将session数据都删除,并且cookie也失效)。该用户即使没有登录,使用该函数也不会报错。
from django.contrib.auth import logout def logout(request): logout(request) # 相当于request.session.flush()。将session数据都删除,并且cookie也失效。 return redirect("/app02/login/")
1.5 login_required()
auth提供的一个装饰器工具,用来快捷的给某个视图添加登录校验。
from django.contrib.auth.decorators import login_required @login_required # 可在setting.py中设置未登录用户跳转的URL。LOGIN_URL = "path" def index(request): return render(request, "index2.html")
在被@login_required装饰后,若用户没有登录直接访问被装饰的视图函数,则会跳转到Django默认的登录URL '/accounts/login/ ' 并传递当前访问url的绝对路径,登录成功后,会重定向到该路径。比如我直接访问上例的index视图函数,因为没有登录,Django会将我重定向至http://127.0.0.1:8000/accounts/login/?next=/app02/index/。
如果需要自定义未登录用户跳转的URL,则需要在settings.py文件中通过LOGIN_URL进行修改。
LOGIN_URL = "/login/"
1.6 create_user()
auth提供的一个创建新用户的方法,需要提供必要参数(username、password)等。创建成功后,会返回一个用户对象。
from django.contrib.auth.models import User reg_user_obj = User.objects.create_user(username="druid", password="druid1234")
from django.contrib.auth.models import User 表示使用默认的auth_user表,如果使用自定义扩展表,那么直接导入自定义扩展表即可。
1.7 create_superuser()
auth 提供的一个创建新的超级用户的方法,需要提供必要参数(username、password、email(email参数字段可以为空,但是创建的时候必须要有该参数))等。创建成功后,会返回一个用户对象。
from django.contrib.auth.models import User sup_user_obj = User.objects.create_superuser(username="druid", password="druid1234", email="")
from django.contrib.auth.models import User 表示使用默认的auth_user表,如果使用自定义扩展表,那么直接导入自定义扩展表即可。
1.8 check_password()
auth提供的一个检查密码是否正确的方法,需要提供当前请求用户的密码。密码正确返回True,否则返回False。
ret = user_obj.check_password('用户密码') # 使用用户对象来判断,如注册成功的用户返回对象和登录成功的用户对象等。
或者直接针对当前请求的user对象校验原密码是否正确:
ret = request.user.check_password(raw_password='用户密码')
1.9 set_password()
auth 提供的一个修改密码的方法,接收要设置的新密码作为参数。
user_obj.set_password('新密码') user_obj.save() # save()为必须步骤
设置完后一定要调用用户对象的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)
2、扩展默认auth_user表
auth_user表默认字段步包含电话号码、地址等字段,如果需要使用这些字段,就需要对该表进行扩展。
2.1 新建一张表与auth_user表一对一关联
from django.contrib.auth.models import User class UserDetail(models.Model): phone = models.CharField(max_length=11) addr = models.CharField(max_length=128) user = models.OneToOneField(to=User) # 建立与auth_user表的一对一关联
2.2 通过继承内置的AbstractUser类
class UserInfo(AbstractUser): """ 使用类的继承时,要在settings.py中配置 AUTH_USER_MODEL = "appname.类名" 来设置默认用户认证使用的表 """ phone = models.CharField(max_length=11) addr = models.CharField(max_length=128)
通过该方法扩展了内置的auth_user表之后,一定要在settings.py中告诉Django,我现在使用我新定义的UserInfo表来做用户认证。写法如下:
AUTH_USER_MODEL = "appname.类名"
然后就可以使用扩展表进行以前auth_user表的所有操作,例如:
sup_user_obj = UserInfo.objects.create_superuser(username="druid", password="druid1234", email="") # 在扩展表UserInfo中创建超级用户 reg_user_obj = UserInfo.objects.create_user(username="druid1", password="druid1123") # 在扩展表UserInfo中创建普通用户
一旦我们指定了新的认证系统所使用的表,我们就需要重新在数据库中创建该表(运行python3 manage.py makemigrations和python3 manage.py migrate这两条命令),而不能继续使用原来默认的auth_user表了。
注意:如果先使用了auth_user表,然后再对该表进行扩展,在执行python3 manage.py makemigrations或migrate时会报错,"django.db.migrations.exceptions.InconsistentMigrationHistory: Migration admin.0001_initial is applied before its dependency app02.0001_initial on database 'default'.",是因为admin和User相互依赖的关系。这时需要删除数据库中所有的表,然后重新执行命令即可。