Python筆記19(Django中auth模塊的用法)

1、auth模塊簡介

Django自帶的用戶認證javascript

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

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

2、auth模塊經常使用方法

auth中提供了許多實用方法,使用方法是須要導入auth模塊:數據庫

from django.contrib import auth

一、authenticate()  

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

若是認證成功(用戶名和密碼正確有效),便會返回一個 User 對象。後端

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

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

二、login(HttpRequest, user)

該函數接受一個HttpRequest對象,以及一個通過認證的User對象。session

該函數實現一個用戶登陸的功能。它本質上會在後端爲該用戶生成相關session數據。app

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>登錄</title>
</head>
<body>

<h1>登錄</h1>
<a href="/reg/">註冊</a>
<form action="" method="post">
    {% csrf_token %}
    <p>
        <input type="text" name="username">
    </p>
    <p>
        <input type="password" name="password">
    </p>
    <p>
        <input type="submit">
        <span>{{ error_msg }}</span>
    </p>
</form>
</body>
</html>
login.html
from django.contrib import auth
class LoginView(views.View):

    def get(self, request):
        return render(request, "login.html")

    def post(self, request):
        next_url = request.GET.get("next")
        print(request.POST)
        username = request.POST.get("username")
        pwd = request.POST.get("password")
        user_obj = auth.authenticate(request, username=username, password=pwd)
        if user_obj:
            # 用戶名和密碼正確
            auth.login(request, user_obj)  # 給該次請求設置了session數據,並在響應中回寫cookie
            if next_url:
                return redirect(next_url)
            else:
                return redirect("/book_list/")
        else:
            # 用戶名或密碼錯誤
            return render(request, "login.html", {"error_msg": "用戶名或密碼錯誤"})
views.py

三、logout(request) 

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

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

用法:

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

四、is_authenticated()

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

登陸認證的相關中間件:

MIDDLEWARE = [

    # 從請求中拿到Cookie值,去數據庫的session表裏找該次請求是否通過認證,
    # 通過認證的請求會拿到user_id,進而拿到user對象 --> user_obj
    # request.user = user_obj
    # 沒有登錄的用戶 request.user = 內置的匿名用戶對象(無論對他取什麼屬性都返回None)
    'django.contrib.auth.middleware.AuthenticationMiddleware',

]

用法:

def book_list(request):
    print(request.user.username, type(request.user))
    print("=" * 120)
    data = models.Book.objects.all()
    # return render(request, "book_list.html", {"data": data})
    # locals()以字典的形式把當前做用域的變量表示出來
    return render(request, "book_list.html", locals())

五、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='郵箱',...)

示例:

from django.contrib.auth.models import User
class RegView(views.View):
    def get(self, request):
        return render(request, "reg.html")

    def post(self, request):
        username = request.POST.get("username")
        pwd = request.POST.get("password")
        # 去數據庫中建立用戶
        # User.objects.create()  --> 直接在數據庫建立用戶,密碼是存的明文的
        user_obj = User.objects.create_user(username=username, password=pwd)
        # User.objects.create_superuser()
        return redirect("/login/")
views.py

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

3、擴展默認的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表了。

相關文章
相關標籤/搜索