Django之auth模塊

Auth簡介

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

咱們在開發一個網站的時候, 無可避免的須要設計網站的用戶系統, 此時咱們西藥實現包括用戶註冊、用戶登陸、用戶認證、註銷、修改密碼等功能, Django它內置了強大的用戶認證系統auth, 是默認使用auth_user表來存儲用戶數據

User模型

User模型是這個框架的核心部分, 他的完整路徑是在 django.contrib.auth.User 

User模型字段

1. username: 用戶名. 150個字符之內, 能夠包含數字和英文字符, 以及_、@、+、.和-字符. 不能爲空且必須惟一

2. first_name: 在30個字符之內, 能夠用爲空

3. last_name: 在150個字符之內, 能夠爲空

4. email: 郵箱, 能夠爲空

5. password: 密碼, 通過哈希事後的密碼

6. groups: 分組, 一個用戶能夠屬於多個分組, 一個分組能夠擁有多個用戶. groups這個字段跟Group的一個多對多的關係

7. user_permissions: 權限, 一個用戶能夠擁有多個權限, 一個權限能夠被多個用戶所用和permission屬於一種多對多的關係

8. is_staff: 是否能夠進入到admin的站點, 表明是不是員工

9. is_active: 是否可用的, 對於一些想要閃出帳號的數據, 咱們設置這個值爲False就能夠了, 而不是真正的從數據可中刪除

10. is_superuser: 是不是超級管理員, 若是是超級管理員, 那麼擁有整個網站的全部權限

11. last_login: 上次登陸的時間

12. data_joined: 帳號建立的時間

Auth模塊經常使用方法

from django.contrib import auth

authenticate()

提供了用戶認證功能, 即驗證用戶名以及密碼是否正確, 通常須要使用username、password兩個關鍵字參數, 若是認證成功(用戶名和密碼正確有效), 便會返回一個User對象

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

用法:

from django.contrib.auth import authenticate


def login(request):
    username = request.POST.get('username')
    password = request.POST.get('password')
    print(username, password)  # yyf yyf123456789
    user = authenticate(username=username, password=password)
    if user:
        print(user)  # yyf
        print(type(user))  # <class 'django.contrib.auth.models.User'>
        print(user.username)  # yyf
        return HttpResponse('ok')

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)

loginout(request)

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

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

用法:

from django.contrib.auth import logout

def logout_view(request):
    logout(request)

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'/acounts/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

res = user.check_password('密碼')

set_password(password)

auth提供的一個修改密碼的方法, 接收要設置的新密碼做爲參數

注意: 設置完必定要調用用戶對象的save方法

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

@login_required
def set_password(request):
    back_dic = {'code': 200, 'msg': '', 'data': None}
    user = request.user
    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:
                back_dic['msg'] = '新密碼不能爲空'
            elif new_password != repeat_password:
                back_dic['msg'] = '兩次密碼不一致'
            else:
                user.set_password(new_password)
                user.save()
                return redirect('/login/')
        else:
            back_dic['msg'] = '原密碼輸入錯誤'
    return render(request, 'set_password.html', local())

User對象的屬性

User對象屬性: username, password

is_staff: 用戶是否擁有網站的管理權限

is_actice: 是否容許用戶登陸, 設置爲False, 能夠在不刪除用戶的前提下禁止用戶登陸

 

給密碼加密的方法

django.contrib.auth.hashers.make_password

from django.contrib.auth.hashers import make_password

password = make_passwork(password)

 

自定義User表

若是須要添加字段, 就須要繼承內置的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

自定義auth_user表以後, 必定要在settings.py中告訴Django, 咱們使用新的UserInfo表來認證用戶

# 引用Django自帶的User表, 繼承使用時須要設置
AUTH_USER_MODEL = 'app名.UserInfo'

一旦咱們指定了新的認證系統所使用的表, 咱們就須要從新在數據庫中建立該表, 而不能使用原來默認的auth_user表