Django重要组件之Auth模块介绍
一、auth模块介绍
Auth模块是Django自带的用户认证模块:
我们在开发一个网站的时候,无可避免的需要设计实现网站的用户系统。此时我们需要实现包括用户注册、用户登录、用户认证、注销、修改密码等功能,这还真是个麻烦的事情呢。
Django作为一个完美主义者的终极框架,当然也会想到用户的这些痛点。它内置了强大的用户认证系统–auth,它默认使用 auth_user 表来存储用户数据。
二、auth模块常用方法
from django.contrib import auth
## create_superuser()
auth 提供的一个创建新的超级用户的方法,需要提供必要参数(username、password)等。
用法:
from django.contrib.auth.models import User user = User.objects.create_superuser(username='用户名',password='密码',email='邮箱',...)
还可以在菜单栏tool中Run manage.py Task下进行命令行创建超级用户:createsuperuser然后根据提示创建即可
## create_user()
auth 提供的一个创建新用户的方法,需要提供必要参数(username、password)等,该方法和创建超级用户一样,只不过用户权限会有差别
用法:
from django.contrib.auth.models import User user = User.objects.create_user(username='用户名',password='密码',email='邮箱',...)
tip:Run manage.py Task下无法创建普通用户
## authenticate()
提供了用户认证功能,即验证用户名以及密码是否正确,一般需要username 、password两个关键字参数。
如果认证成功(用户名和密码正确有效),便会返回一个 User 对象。
authenticate()会在该 User 对象上设置一个属性来标识后端已经认证了该用户,且该信息在后续的登录过程中是需要的。
用法:
user = authenticate(username='usernamer',password='password') # 用户名和密码都要传才行
## login(HttpRequest, user)
该函数接受一个HttpResponse对象,以及一个经过认证的User对象。
该函数实现一个用户登录的功能,本质上会在后端为该用户生成相关的session数据。
用法:
urls.py url(r'^login/', views.my_login), views.py from django.contrib.auth import authenticate,login def my_login(request): if request.method == 'POST': # 获取前端账号密码 username = request.POST['username'] password = request.POST['password'] # 用户认证 user = authenticate(username=username, password=password) # 用户认证成功 if user: # 实现用户登录功能,为该用户创建生成session数据 login(request, user) # 这里只要执行了login(request, user),在后端任何地方都可以通过request.user 拿到当前登录的用户对象 return render(request, 'index.html') # 认证不成功,说明用户名密码错误 else: return HttpResponse('用户名或密码错误,登录失败') return render(request, 'login.html') login.html <!DOCTYPE html> <html> <head> <meta charset="UTF-8"> <title>登录</title> </head> <body> <form action="" method="post"> {% csrf_token %} <p>用户名:<input type="text" name="username"></p> <p>密码:<input type="password" name="password"></p> <p><input type="submit"></p> </form> </body> </html> index.html <!DOCTYPE html> <html> <head> <meta charset="UTF-8"> <title>主页面</title> </head> <body> <h1>我是登录后才能看到的页面</h1> </body> </html>
相关推荐:《Python相关教程》
## logout(request)
该函数接受一个HttpRequest对象,无返回值。
当调用该函数时,当前请求的session信息会全部清除。该用户即使没有登录,使用该函数也不会报错。
用法:
from django.contrib.auth import logout def my_logout(request): logout(request) return redirect('/home/') def my_home(request): return render(request, 'home.html')
## 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_required(login_url='/auth_login/') # 全局配置 # auth自动跳转 LOGIN_URL = '/auth_login/' # settings.py配置
实例:
# 导入用户认证模块和login函数 from django.contrib.auth import authenticate,login def my_login(request): if request.method == 'POST': # 获取前端账号密码 username = request.POST['username'] password = request.POST['password'] next_url = request.GET.get('next') # 获取到跳转过来的原页面的url # 用户认证 user = authenticate(username=username, password=password) # 用户认证成功 if user: # 实现用户登录功能,为该用户创建生成session数据 login(request, user) return redirect(next_url) # 登录成功自动跳转到原来的页面 # 认证不成功,说明用户名密码错误 else: return HttpResponse('用户名或密码错误,登录失败') return render(request, 'login.html') from django.contrib.auth.decorators import login_required # Django登录验证装饰器在跳转到登陆页面时候会自动在页面末尾拼接一个?next=当前url @login_required def my_home(request): return render(request, 'home.html')
## 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,可以在不删除用户的前提下禁止用户登录。
来源:PY学习网:原文地址:https://www.py.cn/article.html