Django學習筆記11

auth用戶認證系統

Django自帶的用戶認證

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

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

普通版本用戶認證寫法：

from app01 import models
from functools import wraps

def check_login(f):
    @wraps(f)
    def inner(request, *args, **kwargs):
        if request.session.get("is_login") == "1":
            return f(request, *args, **kwargs)
        else:
            return redirect("/login/")
    return inner


def login(request):
    if request.method == "POST":
        username = request.POST.get("username")
        password = request.POST.get("password")

        user = models.User.objects.filter(username=username, password=password)  # [User Obj, ]
        if user:
            # 登錄成功
            request.session["is_login"] = "1"
            # request.session["username"] = username
            request.session["user_id"] = user[0].id
            # 1. 生成特殊的字符串
            # 2. 特殊字符串當成key,在數據庫的session表中對應一個session value
            # 3. 在響應中向瀏覽器寫了一個Cookie Cookie的值就是 特殊的字符串

            return redirect("/index/")

    return render(request, "login.html")


@check_login
def index(request):
    user_id = request.session.get("user_id")
    # 根據id去數據庫中查找用戶
    user_obj = models.User.objects.filter(id=user_id)
    if user_obj:
        return render(request, "index.html", {"user": user_obj[0]})
    else:
        return render(request, "index.html", {"user": "匿名用戶"})

在使用Django自帶的models時，在mysql數據庫中會建立auth_user表，存放用戶信息

auth模塊

from django.contrib import auth

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

authenticate()

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

根據用戶名和密碼去auth_user表中查驗，若是認證成功（用戶名和密碼正確有效），便會返回一個 User 對象。

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

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

這裏有個注意點，authenticate()會自動過濾掉is_active爲False的用戶（用戶名和密碼正確也會返回None）由於有有以下默認配置：

# 會檢測用戶是不是活躍狀態（is_active）,不活躍則返回None（默認配置）
AUTHENTICATION_BACKENDS = ['django.contrib.auth.backends.ModelBackend']

若是想不讓authenticate關聯is_active，能夠在 settings.py 文件里加上下面的配置就行

# 不會檢測用戶的活躍狀態
AUTHENTICATION_BACKENDS = ['django.contrib.auth.backends.AllowAllUsersModelBackend']

login(HttpRequest, user)

該函數接受一個HttpRequest對象，以及一個通過認證的User對象，該函數實現一個用戶登陸的功能。它本質上會在後端爲該用戶生成相關session數據，使用user中間件（依賴session中間件）。

login(request, user)

　　這個函數能夠簡單將user綁定request中，可使用request.user.xxx進行調用

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 is not None:
    login(request, user_obj)  # 後面便可使用request.user.xxx調用，注意後面使用時是request.user不是request.user_obj
    # Redirect to a success page.
    ...
  else:
    # Return an 'invalid login' error message.
    ...

　　用戶登陸完成後下次訪問會攜帶session，session攜帶userid，經過user中間件經過userid查找用戶對象，而後把用戶對象綁定給request

logout(request) 

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

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

from django.contrib.auth import logout
   
def logout_view(request):
  logout(request)
  # Redirect to a success page.

# 至關於request.session.flush()

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的絕對路徑放到查詢字符串中 (登錄成功後，會重定向到該路徑)。如/accounts/login/?next=polls/3

若是須要自定義登陸的URL，則須要在settings.py文件中經過LOGIN_URL進行修改。示例以下：

LOGIN_URL = '/login/'  # 這裏配置成你項目登陸頁面的路由

以上是FBV的login_requried的使用方式，下面介紹CBV的使用方式：

當使用CBV時，能夠經過使用LoginRequireMixin和login_rwquired來實現相同的行爲，這個mixin必定要寫在繼承的最左邊（優先繼承）

若是視圖使用了LoginRequireMixin，那全部的匿名請求都會被重定向到設置的login page或者403錯誤，這取決於你的raise_exception參數的設置

你能夠設置一些參數來操做對匿名用戶的設置：

from django.contrib.auth.mixins import LoginRequiredMixin

class MyView(LoginRequiredMixin, View):
    login_url = '/login/'
    redirect_field_name = 'redirect_to'

　　這樣繼承後同樣能夠達到上面那種FBV的效果

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

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

@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對象的屬性

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表了。