Django Auth組件
Auth組件
Author組件是Django自帶的認證系統,包括登錄校驗,用戶信息數據庫表,以及修改用戶權限,用戶註銷。給用戶增加sesion等一切認證功能
導入auth模塊
from django.contrib import auth
用戶信息
在django項目創建開時,運行python manage.py migrations 和 python manage.py mirate 兩個命令後django會自動創建django本身需要的數據庫表和你自定義創建的數據庫表,而Auth組件中的auth_user表就是用來存放用戶信息的表:
命令行創建用戶方法:
- 在命令行中運行python manage.py createsuperuser(必須在項目目錄下運行)
- 輸入要創建的用戶名
- 輸入郵箱可以為空
- 輸入兩次密碼以便確認
數據創建成功數據庫中可以看多了一條數據,就是你創建的數據信息
Auth組件常用方法
1、auth.authenticate()
authenticate英文翻譯是鑒定校驗的意思,該方法是用來將前端傳過來的用戶賬號和密碼和數據庫中的信息進行對比,校驗通過返回一個通過校驗的數據對象(通常叫做user)裏面包含很多信息,否則返回None:
常見用法:user = auth.authenticate(username=‘‘, password=‘‘)
def login(request): if request.method==‘POST‘: #獲取前端登錄請求的用戶和密碼 name = request.POST.get(‘name‘) pwd = request.POST.get(‘pwd‘) #使用auth自帶的方法校驗賬號密碼 user = auth.authenticate(username=name, password=pwd)
2、auth.login(Httprequest,user)
該函數接受一個HttpRequest對象,以及一個經過認證的User對象。
該函數實現一個用戶登錄的功能。它本質上會在後端為該用戶生成相關session數據,這樣這個用戶在登錄後就可以直接訪問其要驗證用戶是否登錄的頁面, 結合上面校驗用戶賬號密碼得到的對象
,用法:
def login(request): if request.method==‘POST‘: #獲取登錄請求的用戶和密碼 name = request.POST.get(‘name‘) pwd = request.POST.get(‘pwd‘) #使用auth自帶的方法校驗賬號密碼 user = auth.authenticate(username=name, password=pwd) if user: #使用auth.login方法加上sessioncookie auth.login(request,user) #這段代碼看不懂先往下面看 # 如果校驗通過則進去下一個頁面,獲取不到則默認跳轉index的url nexturl = request.GET.get(‘next‘,reverse(‘index‘)) return redirect(nexturl)
3、logout(Httprequest)
該方法用來清除請求客戶端報存的session,這樣該客戶端就失去了訪問我需要驗證才能訪問頁面的資格,通常我們常見的註銷按鈕就是這樣實現的。
步驟:
- 在前端頁面放置一個a標簽點擊跳轉url觸發django的視圖函數。
- 在視圖函數中運行logout方法,本質是將客戶端的session給清除掉
- 清除session後通常我們重定向回登錄頁面
def loginout(request):
#使用logout方法註銷清除sessioncookie
auth.logout(request)
#返回login頁面
return redirect(reverse(‘login‘))
4、is_authenticated()
該方法是判斷request請求中user屬性中是否被驗證,前面我們是對校驗通過(authenticate)的user加上session並將對應的key給request.user(login(request,user))。
用法:
def my_view(request):
#對訪問請求的user進行session檢查如果不通過則將當前訪問的目錄拼接到login地址,並重定向去login頁面
if not request.user.is_authenticated():
return redirect(‘%s?next=%s‘ % (settings.LOGIN_URL, request.path))
這樣我們可以在視圖函數裏面加上這樣的代碼,這樣沒登錄就無法通過校驗也就無法直接訪問頁面,必須是登錄後的用戶才能進行訪問。這樣還是很麻煩並且重復代碼多,所以auth還提供了專門的裝飾器方法給我們,原理就是和上面說的一樣。
5、login_requierd
auth 給我們提供的一個裝飾器工具,用來快捷的給某個視圖添加登錄校驗。
用法:
from django.contrib.auth.decorators import login_required
@login_required
def my_view(request):
...
若用戶沒有登錄,則會跳轉到django默認的 登錄URL ‘/accounts/login/ ‘ 並傳遞當前訪問url的絕對路徑 (登陸成功後,會重定向到該路徑)。
如果需要自定義登錄的URL,則需要在django中的settings.py文件中通過LOGIN_URL進行修改。
LOGIN_URL = ‘/login/‘ # 這裏配置成你項目登錄頁面的路由
Auth組件針對user表的用法
現在大家都知道用戶的信息是存在服務端的數據庫裏,也就是auth_user表,怎麽操作這張表,auth組件也提供了相應的方法我們。
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。
用法:
ok = user_obj.check_password(‘密碼‘)
或者直接針對當前請求的user對象校驗原密碼是否正確:
ok = request.user.check_password(raw_password=‘原密碼‘)
set_password(raw_password)
auth 提供的一個修改密碼的方法,接收 要設置的新密碼 作為參數。
==註意:設置完一定要調用用戶對象的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)
用戶對象的屬性
user_obj能夠拿到認證所用用戶表的數據屬性,比如username, password等。
其他常用屬性含義如下:
is_staff : 用戶是否擁有網站的管理權限.
is_active : 是否允許用戶登錄, 設置為 False,可以在不刪除用戶的前提下禁止用戶登錄。
Django Auth組件