Django自帶的auth登入認證

前言：我們在開發一個網站的時候，無可避免的需要設計實作網站的使用者系統。此時我們需要實作包括使用者注冊、使用者登入、使用者認證、登出、修改密碼等功能，這還真是個麻煩的事情呢。Django作為一個完美主義者的終極架構，當然也會想到使用者的這些痛點。它内置了強大的使用者認證系統--auth，它預設使用 auth_user 表來存儲使用者資料。

一、auth子產品的方法介紹：

- 建立使用者

python manage.py createsuperuser
python manage.py createuser
           

- 子產品的導入：

from django.contrib import auth
           

- auth中提供的實用方法:

1. authenticate()

提供了使用者認證功能，即驗證使用者名以及密碼是否正确，一般需要username 、password兩個關鍵字參數。如果認證成功（使用者名和密碼正确有效），便會傳回一個 User 對象。authenticate()會在該 User 對象上設定一個屬性來辨別後端已經認證了該使用者，且該資訊在後續的登入過程中是需要的。

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

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)
    if user is not None:
        login(request, user)
        # Redirect to a success page.
        ...
    else:
    # Return an 'invalid login' error message.
        ...
           

3.logout(request)

該函數接受一個HttpRequest對象，無傳回值。當調用該函數時，目前請求的session資訊會全部清除。該使用者即使沒有登入，使用該函數也不會報錯。

from django.contrib.auth import logout

def logout_view(request):
    logout(request)
    # 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 給我們提供的一個裝飾器工具，用來快捷的給某個FBV視圖添加登入校驗。

from django.contrib.auth.decorators import login_required

@login_required
def my_view(request):
    ...
           

6.auth 給我們提供的一個裝飾器工具，用來快捷的給某個CBV視圖添加登入校驗。

from django.contrib.auth.decorators import login_required
from django.utils.decorators import method_decorator

class Home(views.View):

    @method_decorator(login_required)
    def get(self, request):
        return render(request, 'home.html')
           

若使用者沒有登入，則會跳轉到django預設的 登入URL '/accounts/login/ ' 并傳遞目前通路url的絕對路徑 (登陸成功後，會重定向到該路徑)。如果需要自定義登入的URL，則需要在settings.py檔案中通過LOGIN_URL進行修改。 LOGIN_URL = '/login/' # 這裡配置成你項目登入頁面的路由

7.create_user()

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

from django.contrib.auth.models import User

user = User.objects.create_user(username = '使用者名', password = '密碼', email = '郵箱', ...)
create_superuser()
           

8.create_superuser()

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

from django.contrib.auth.models import User

user = User.objects.create_superuser(username = '使用者名', password = '密碼', email = '郵箱', ...)
check_password(password)
           

9.check_password(password)

auth 提供的一個檢查密碼是否正确的方法，需要提供目前請求使用者的密碼。密碼正确傳回True，否則傳回False。

ret = user.check_password('密碼')
           

10.set_password(password)

auth 提供的一個修改密碼的方法，接收 要設定的新密碼 作為參數。注意：設定完一定要調用使用者對象的save方法！！！

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

二、User對象的屬性

• username，
• password
• is_staff ： 使用者是否擁有網站的管理權限.
• is_active ： 是否允許使用者登入, 設定為 False，可以在不删除使用者的前提下禁止使用者登入。

三、擴充預設的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表了。

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

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

五、通過繼承内置的 AbstractUser 類，來定義一個自己的Model類

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