auth模塊用戶認證

一、auth模塊什么

auth模塊時django自帶的用戶認證模塊

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

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

二auth模塊常用方法

首先先導入auth模塊

from django.contrib import auth

1、authenticate()

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

如果認證成功（用戶名和密碼正確有效），便會返回一個 User 對象。

authenticate()會在該 User 對象上設置一個屬性來標識后端已經認證了該用戶，且該信息在后續的登錄過程中是需要的。

用法：

user = authenticate(username='usernamer',password='password')    #用戶名和密碼驗證成功返回一個user對象，

2、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)#拿到用戶名和密碼通過authenticate()拿到用戶對應，
  if user is not None:#當拿到的用戶對象存在是說明認證成功，返回的是一個用戶對象，認證是吧則返回一個none
    login(request, user) #將登陸成功的返回的user對象傳入，這樣就可以記錄下用戶的登錄狀態，(在全局存儲用戶信息，在任何視圖函數都可以取出來)，人家有什么參數就傳什么
    # Redirect to a success page.
    ...
  else:#
    # Return an 'invalid login' error message.
    ...

3、logout(request) 

該函數接受一個HttpRequest對象，無返回值。

當調用該函數時，當前請求的session信息會全部清除。該用戶即使沒有登錄，使用該函數也不會報錯。

用法：

user.set_password(password='')#
user.save()#修改完成密碼一定要保存

 

from django.contrib.auth import logout
   
def logout_view(request):
  logout(request)#注銷登錄狀態，本事就是把session信息刪掉
  # Redirect to a success page.

4、is_authenticated()

用來判斷當前請求是否通過了認證。

用法：

def my_view(request):
  if not request.user.is_authenticated():#判斷當前拿到的用戶對象是否通過認證，判斷用戶登沒登陸
    return redirect('%s?next=%s' % (settings.LOGIN_URL, request.path))#沒有通過用戶認證，那么我們就重定向讓用戶跳轉到登陸頁面在進行重新登陸

5、login_requierd()

auth 給我們提供的一個裝飾器工具，用來快捷的給某個視圖添加登錄校驗，login_requierd有一個參數，login_url當我們沒有登錄可以讓他跳到我們指定的url。

用法：

from django.contrib.auth.decorators import login_required
      
@login_required#添加一個登錄校驗的裝飾器，登錄成功才會走到下面，否則會跳轉到django默認的登錄
def my_view(request):
  ...

若用戶沒有登錄，則會跳轉到django默認的 登錄URL '/accounts/login/ ' 並傳遞當前訪問url的絕對路徑 (登陸成功后，會重定向到該路徑)。

如果需要自定義登錄的URL，則需要在settings.py文件中通過LOGIN_URL進行修改。

示例：

LOGIN_URL = '/login/'  # 這里配置成你項目登錄頁面的路由，全局的

6、create_user()

auth 提供的一個創建新用戶的方法，需要提供必要參數（username、password）等。

用法：

from django.contrib.auth.models import User
user = User.objects.create_user（username='用戶名',password='密碼',email='郵箱',...）#創建普通的用戶
user1=UserInfo.objects.create_superuser(username='lqz1',password='lqz12345',email='[e-mail]')#創建超級用戶，我們可以通過超級用戶名和密碼登陸到管理員后台

7、create_superuser()

auth 提供的一個創建新的超級用戶的方法，需要提供必要參數（username、password）等。

用法：

from django.contrib.auth.models import User
user = User.objects.create_superuser（username='用戶名',password='密碼',email='郵箱',...）#這三個參數是那個表必須有的

8、check_password(password)

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

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

用法：

ok = user.check_password('密碼')#核對密碼是否正確，返回一個true或false

9、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)#如果原密碼輸入失敗，則將失敗的信息渲染到前端頁面告訴用戶原密碼輸入錯誤

10、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):#繼承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表了。