auth元件
auth元件介紹
我們在開發一個專案的時候,無可避免的需要設計實現一個網站的使用者系統,實現包括使用者註冊、使用者登入、使用者認證、登出、修改密碼等等的功能,所以Django為了提升開發效率,它內建了一個模組,即auth模組(使用者認證系統),它預設使用 auth_user 表來儲存使用者資料
auth模組方法介紹
使用之前需要先匯入auth模組
from django.contrib import auth
先建立一個superuser
python manage.py createsuperuser
也就是在 auth_user 這個表中插入了一條資料(密碼是加密的,所以不能手動插入)
authenticate()
- 使用者驗證
即驗證使用者名稱以及密碼是否正確,一般需要username 、password兩個關鍵字引數。
如果認證成功(使用者名稱和密碼正確有效),便會返回一個 User 物件。
authenticate()會在該 User 物件上設定一個屬性來標識後端已經認證了該使用者,且該資訊在後續的登入過程中是需要的。
- 用法
user = auth.authenticate(request, username=name, password=pwd)
相當於執行查詢語句:user = models.User.objects.filter(name=name,pwd=pwd).first()
login(request, user)
- 使用者登入
該函式接受一個HttpRequest物件,和一個經過認證的 User 物件。它本質上會在後端為該使用者生成相關的 session 資料。
def login(request): if request.method == 'GET': return render(request, 'login.html') elif request.method == 'POST': name = request.POST.get('name') pwd = request.POST.get('pwd') # 校驗 user = auth.authenticate(request, username=name, password=pwd) if user: # 登入,本質是把使用者資訊放到 session auth.login(request, user) # 同 request.session['name']=name return HttpResponse('登入成功') else: return HttpResponse('使用者名稱或密碼錯誤')
注意點:只要使用login(request, user_obj)之後,request.user就能拿到當前登入的使用者物件。否則request.user得到的是一個匿名使用者物件(AnonymousUser Object)
logout(request)
- 使用者登出
該函式接受一個HttpRequest物件,無返回值。當呼叫該函式時,當前請求的session資訊會全部清除。該使用者即使沒有登入,使用該函式也不會報錯
def logout(request): auth.logout(request) return redirect('/login/')
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 test(request): print(type(request)) user = request.user.password print(user) return render(request, 'test.html')
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。
user = user_obj.check_password('密碼')
或者直接針對當前請求的user物件校驗原密碼是否正確:
user = request.user.check_password(raw_password='原密碼')
set_password(raw_password)
- 密碼重置
接收要設定的新密碼作為引數。
注意:設定完一定要呼叫使用者物件的save方法!!
用法:
user_obj.set_password('新密碼') user_obj.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)View Code
auth_user表擴充套件
當用戶自己想要再新增一個使用者手機號或者其他的欄位時,該如何解決??
- 方法一
可以通過繼承內建的 AbstractUser 類,來定義一個自己的Model類
from django.contrib.auth.models import AbstractUser class UserInfo(AbstractUser): # username,password...都有 phone=models.CharField(max_length=32) sex=models.BooleanField()
注意點:按上面的方式擴充套件了內建的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 表建立一對一的關聯
class UserDetail(models.Model): phone=models.CharField(max_length=32) # 一對一跟auth_user表做關聯 # 如果是從外部引入的表模型,是不能加引號的 # 如果加引號,只是在當前model找 user=models.OneToOneField(to=User)