auth模塊用法

Auth模塊：

如果你想用auth模塊   那么你就用全套

createsuperuser  創建超級用戶 這個超級用戶就可以擁有登陸django admin后台管理的權限

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

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

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

 

auth模塊的功能

#查詢用戶
from django.contrib import auth
user_obj = auth.authenticate(username=username,password=password) # 必須要用 因為數據庫中的密碼字段是密文的 而你獲取的用戶輸入的是明文
#記錄用戶狀態
auth.login(request,user_obj) # 將用戶狀態記錄到session中
#判斷用戶是否登錄
print(request.user.is_authenticated) # 判斷用戶是否登錄 如果是你們用戶會返回False
#用戶登錄之后 獲取用戶對象
print(request.user) # 如果沒有執行auth.login那么拿到的是匿名用戶
#校驗用戶是否登錄
from django.contrib.auth.decorators import login_required
@login_required(login_url='/xxx/') # 局部配置
def index(request):
pass

# 全局配置 settings文件中
LOGIN_URL = '/xxx/'
#驗證密碼是否正確
request.user.check_password(old_password)
#修改密碼    
request.user.set_password(new_password)
request.user.save() # 修改密碼的時候 一定要save保存 否則無法生效
#退出登陸
auth.logout(request) # request.session.flush()
#注冊用戶
# User.objects.create(username =username,password=password) # 創建用戶名的時候 千萬不要再使用create 了
# User.objects.create_user(username =username,password=password) # 創建普通用戶
User.objects.create_superuser(username =username,password=password,email='[e-mail]') # 創建超級用戶 郵箱必填

 

 

 

Auth模塊常用方法

from django.contrib import auth

authenticate()

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

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

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

用法：

from django.contrib import auth user_obj = auth.authenticate(username=username,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): ...

from django.contrib.auth.decorators import login_required 
@login_required(login_url='/xxx/')  # 局部配置
def index(request): pass    

 

若用戶沒有登錄，則會跳轉到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，可以在不刪除用戶的前提下禁止用戶登錄。

 

3 擴展默認的auth_user表

這內置的認證系統這么好用，但是auth_user表字段都是固定的那幾個，我在項目中沒法拿來直接使用啊！

比如，我想要加一個存儲用戶手機號的字段，怎么辦？

聰明的你可能會想到新建另外一張表然后通過一對一和內置的auth_user表關聯，這樣雖然能滿足要求但是有沒有更好的實現方式呢？

答案是當然有了。

我們可以通過繼承內置的 AbstractUser 類，來定義一個自己的Model類。

這樣既能根據項目需求靈活的設計用戶表，又能使用Django強大的認證系統了。

            from django.contrib.auth.models import AbstractUser
            # Create your models here.
            # 第一種 使用一對一關系  不考慮

            # 第二種方式   使用類的繼承
            class Userinfo(AbstractUser):
                # 千萬不要跟原來表中的字段重復 只能創新
                phone = models.BigIntegerField()
                avatar = models.CharField(max_length=32)
            
            # 一定要在配置文件中 告訴django
            # 告訴django  orm不再使用auth默認的表  而是使用你自定義的表
            AUTH_USER_MODEL = 'app01.Userinfo'  # '應用名.類名'

 

注意：

按上面的方式擴展了內置的auth_user表之后，一定要在settings.py中告訴Django，我現在使用我新定義的UserInfo表來做用戶認證。寫法如下：

# 引用Django自帶的User表，繼承使用時需要設置
AUTH_USER_MODEL = "app名.UserInfo"

再次注意：

一旦我們指定了新的認證系統所使用的表，我們就需要重新在數據庫中創建該表，而不能繼續使用原來默認的auth_user表了。