Auth模塊

本文目錄

回到目錄

1 Auth模塊是什麼

Auth模塊是Django自帶的用戶認證模塊：

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

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

回到目錄

2 auth模塊經常使用方法

from django.contrib import auth

authenticate()

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

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

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

用法：

user = authenticate(username='usernamer',password='password')

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

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

Django：forms局部函數、cookie、sesion、auth模塊