django之auth認證系統

Django自帶的用戶認證

咱們在開發一個網站的時候,無可避免的須要設計實現網站的用戶系統。此時咱們須要實現包括用戶註冊、用戶登陸、用戶認證、註銷、修改密碼等功能,這還真是個麻煩的事情呢。html

Django做爲一個完美主義者的終極框架,固然也會想到用戶的這些痛點。它內置了強大的用戶認證系統--auth,它默認使用 auth_user 表來存儲用戶數據。python

auth模塊方法

from django.contrib import auth

 auth中提供了許多實用方法:數據庫

authenticate()   

提供了用戶認證功能,即驗證用戶名以及密碼是否正確,通常須要username 、password兩個關鍵字參數。django

若是認證成功(用戶名和密碼正確有效),便會返回一個 User 對象。後端

authenticate()會在該 User 對象上設置一個屬性來標識後端已經認證了該用戶,且該信息在後續的登陸過程當中是須要的。session

用法:app

user = authenticate(username='theuser',password='thepassword')

login(HttpRequest, user)

該函數接受一個HttpRequest對象,以及一個通過認證的User對象。框架

該函數實現一個用戶登陸的功能。它本質上會在後端爲該用戶生成相關session數據。ide

用法:函數

from django.contrib.auth import authenticate, login def my_view(request): username = request.POST['username'] password = request.POST['password'] user_obj = authenticate(username=username, password=password) if user_obj: login(request, user_obj) # Redirect to a success page.
 ... else: # Return an 'invalid login' error message.
    ...

注意:

只要使用login(request, user_obj)以後,request.user就能拿到當前登陸的用戶對象。不然request.user獲得的是一個匿名用戶對象(AnonymousUser Object)。

詳細原理請查看 AuthenticationMiddleware 中間件源碼。

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

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_URL = '/login/'  # 這裏配置成你項目登陸頁面的路由

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) 修改密碼示例

 

複製代碼
@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,能夠在不刪除用戶的前提下禁止用戶登陸。

擴展默認的auth_user表

這內置的認證系統這麼好用,可是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表那樣使用咱們的UserInfo表了。好比:

建立普通用戶:

UserInfo.objects.create_user(username='用戶名', password='密碼')

建立超級用戶:

UserInfo.objects.create_superuser(username='用戶名', password='密碼')

再次注意:

一旦咱們指定了新的認證系統所使用的表,咱們就須要從新在數據庫中建立該表,而不能繼續使用原來默認的auth_user表了。

總結

1. auth - 默認使用的是auth_user - 添加用戶 - python manage.py createsuperuser - auth.authenticate(username=, password=)    --> 校驗用戶名或密碼是否正確 - 若是校驗經過會返回一個user對象 - 不然返回None - user.is_authenticated()                    --> 判斷當前用戶是否通過了認證 - auth.login(request, user)                  --> 登陸成功 - auth.logout(request)                       --> 註銷當前用戶,將當前請求的session數據刪除 - login_required裝飾器 - from django.contrib.auth.decorators import login_required auth.decorators.login_required 默認跳轉的登陸url: /accounts/login/ 在settings.py中 配置 LOGIN_URL = "你的登陸url"
                
            - 建立用戶 from django.contrib.auth.models import User 1. User.objects.create_superuser()   --> 建立超級用戶 2. User.objects.create_user()        --> 建立普通用戶 - 檢查密碼和修改密碼 - 對已經登錄的用戶作操做 - user.check_password(原密碼) - user.set_password(新密碼) - user.save()                            --> 保存到數據庫 2. 擴展默認的auth_user表 1. 爲何要擴展auth_user表? 1. 默認auth_user表的字段比較固定,不能知足項目需求 2. 我還想用Django的auth模塊給我提供的上面那些方法 2. 如何擴展? 1. 在models.py中定義本身的類 from django.contrib.auth.models import AbstractUser class UserInfo(AbstractUser): phone = models.CharField(max_length=11) 2. 在settings.py中告訴Django,使用個人UserInfo表代替默認的auth_user表作認證 AUTH_USER_MODEL='app名字.類名'

 參考連接:http://www.javashuo.com/article/p-hcfistak-u.html

相關文章
相關標籤/搜索