1. 程式人生 > >auth認證元件 auth

auth認證元件 auth

學習部落格地址:https://www.cnblogs.com/liwenzhou/p/9030211.html

Django自帶的使用者認證

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

Django作為一個完美主義者的終極框架,當然也會想到使用者的這些痛點。它內建了強大的使用者認證系統--auth,它預設使用 auth_user 表來儲存使用者資料。

auth_user建立超級使用者的命令:python manage.py createsuperuser

auth模組

from django.contrib import auth

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

authenticate()   

提供了使用者認證功能,即驗證使用者名稱以及密碼是否正確,一般需要username 、password兩個關鍵字引數。

如果認證成功(使用者名稱和密碼正確有效),便會返回一個 User 物件。

authenticate()會在該 User 物件上設定一個屬性來標識後端已經認證了該使用者,且該資訊在後續的登入過程中是需要的。

用法:

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

login(HttpRequest, user)  

該函式接受一個HttpRequest物件,以及一個經過認證的User物件。

該函式實現一個使用者登入的功能。它本質上會在後端為該使用者生成相關session資料。

用法:

複製程式碼
from django.contrib.auth import authenticate, login
   
def my_view(request):
  username = request.POST['username']
  password = request.POST['password']
  user = authenticate(username=username, password=password)
  if user is not None:
    login(request, user)
    # Redirect to a success page.
    ...
  else:
    # Return an 'invalid login' error message.
    ...
複製程式碼

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 = User.objects.create_superuser(username='使用者名稱',password='密碼',email='郵箱',...)

check_password(password)

auth 提供的一個檢查密碼是否正確的方法,需要提供當前請求使用者的密碼。

密碼正確返回True,否則返回False。

用法:

ok = user.check_password('密碼')

set_password(password)

auth 提供的一個修改密碼的方法,接收 要設定的新密碼 作為引數。

注意:設定完一定要呼叫使用者物件的save方法!!!

用法:

user.set_password(password='')
user.save()

一個修改密碼功能的簡單示例

  修改密碼示例

User物件的屬性

User物件屬性: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表了。

Django自帶的使用者認證

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

Django作為一個完美主義者的終極框架,當然也會想到使用者的這些痛點。它內建了強大的使用者認證系統--auth,它預設使用 auth_user 表來儲存使用者資料。

auth_user建立超級使用者的命令:python manage.py createsuperuser

auth模組

from django.contrib import auth

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

authenticate()   

提供了使用者認證功能,即驗證使用者名稱以及密碼是否正確,一般需要username 、password兩個關鍵字引數。

如果認證成功(使用者名稱和密碼正確有效),便會返回一個 User 物件。

authenticate()會在該 User 物件上設定一個屬性來標識後端已經認證了該使用者,且該資訊在後續的登入過程中是需要的。

用法:

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

login(HttpRequest, user)  

該函式接受一個HttpRequest物件,以及一個經過認證的User物件。

該函式實現一個使用者登入的功能。它本質上會在後端為該使用者生成相關session資料。

用法:

複製程式碼
from django.contrib.auth import authenticate, login
   
def my_view(request):
  username = request.POST['username']
  password = request.POST['password']
  user = authenticate(username=username, password=password)
  if user is not None:
    login(request, user)
    # Redirect to a success page.
    ...
  else:
    # Return an 'invalid login' error message.
    ...
複製程式碼

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 = User.objects.create_superuser(username='使用者名稱',password='密碼',email='郵箱',...)

check_password(password)

auth 提供的一個檢查密碼是否正確的方法,需要提供當前請求使用者的密碼。

密碼正確返回True,否則返回False。

用法:

ok = user.check_password('密碼')

set_password(password)

auth 提供的一個修改密碼的方法,接收 要設定的新密碼 作為引數。

注意:設定完一定要呼叫使用者物件的save方法!!!

用法:

user.set_password(password='')
user.save()

一個修改密碼功能的簡單示例

  修改密碼示例

User物件的屬性

User物件屬性: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表了。