Day -29 - auth - Django內建的超好用註冊和登入 - iT 邦幫忙::一起幫忙解決難題，拯救 IT 人的一天

2022 iThome 鐵人賽

DAY 29

自我挑戰組

從0 到 50 初探如何使用Django 架構出一個網站系列第 29 篇

Day -29 - auth - Django內建的超好用註冊和登入

14th鐵人賽 python python3 django django系列文章

Yusinz

2022-10-14 21:19:50

2528 瀏覽

分享至

前言

昨天介紹完Class Based View ，今天快馬加鞭的繼續介紹註冊和登入的功能，也會帶到一點網頁的建置，希望能在最後一天如預期地可以部署網頁!

auth

事前確認

settings.py

首先我們要打開 INSTALLED_APPS 確認 django.contrib.auth 和 django.contrib.contenttypes，是否有填入，
通常這會是預設的。

INSTALLED_APPS = [
    ...
    'django.contrib.auth',
    'django.contrib.contenttypes',

MIDDLEWARE 也是，要確認下方兩個是否存在

MIDDLEWARE = [
    ...
    'django.contrib.sessions.middleware.SessionMiddleware',
    'django.contrib.auth.middleware.AuthenticationMiddleware',    
]

註冊

views.py

首先我們到views.py裡面，創建一個CreateView，接著import UserCreationForm 進來，這是一個Django預設好的ModelForm 用來建立新的使用者。
若沒有客製化的話，主要會有三個欄位:

username :帳號
password1 :密碼
password2 :確認密碼

這裡有一個success_url，我們先隨便建立一個login的html，等等講登入登出會用到，我們讓註冊完成後會導向login

...
from django.contrib.auth.forms import UserCreationForm

class SignUpView(CreateView):
    form_class = UserCreationForm
    success_url = reverse_lazy('login')
    template_name = 'sign_up.html'

urls.py


from django.contrib import admin
from django.urls import path, include
from . import views

urlpatterns = [
    ...
    path('sign_up/', views.SignUpView.as_view(), name = "sign_up")
]

sign_up.html

<h1>註冊頁面<h1>
<form method = "POST">
    {% csrf_token %}
    {{form.as_p}}
    <input type= "submit", value = "註冊">
</form>

註冊畫面

完成之後進到頁面就會如下圖

他會有一些預設的限制，如果密碼強度不符合會請你再重新填寫，成功之後就會跳轉回登入畫面囉!
這時候我們打開後台就能看到剛剛註冊的user囉
在裡面你還可以看到許多內建的欄位，是可以進行客製化的，如果有機會之後會再補上，這邊就先講基本的註冊
有興趣的人也可以去看官方文件的解說唷

登入和登出

做完註冊之後接著要來建立登入和登出的頁面

views.py

首先我們要先在views.py裡建立三個view，分別為:

login:登入的views，並在views裡面進行邏輯的驗證，將接收到的username 和 password 進行驗證若驗證成功則跳轉到main_page
若失敗則回到 login.html
log_out:利用auth的logout達到登出的動作
main_page:登入成功或失敗會進入的頁面

...
from django.shortcuts import render
from django.http import HttpResponse, HttpResponseRedirect
from django.views.generic import TemplateView, CreateView
from django.urls import reverse, reverse_lazy
from django.shortcuts import render
from django.contrib import auth
...

def login(request):
    if request.user.is_authenticated:
        return HttpResponseRedirect('/main_page')
    username = request.POST.get('username')
    password = request.POST.get('password')
    user = auth.authenticate(username=username, password=password)
    if user is not None and user.is_active:
        auth.login(request, user)
        return HttpResponseRedirect('/main_page')
    else:
        return render(request, 'login.html', locals())

def main_page(request):
    return render(request, 'main_page.html')

def log_out(request):
    auth.logout(request)
    return HttpResponseRedirect('/main_page')

...

可以看到HttpRequest中包含了一個user屬性，代表了當前的使用者
如果用戶已經登入，則HttpRequest.user是一個User物件，也就是具名用戶
如果使用者尚未登入，HttpRequest.user是一個AnonymousUser物件，也就是匿名用戶
我們可以用is_authenticated來判斷使用者是否為具名用戶
is_anonymous 則是判斷使用者是否為匿名用戶

Request中還有POST和GET的屬性，可以去獲取利用POST和GET傳送的表單資料。
除此之外，官方文件裡也有把Request的所有屬性和功能做說明，有興趣的人可以再去閱讀
首先我們先建立一個登入的Template
我命名為login.html

Templates

login.html

我們要建立一個form
要記得在form裡面加上 CSRF_token ，否則會被擋住
接著建立兩個欄位帳號和密碼
以及登入、註冊和訪客登入

<html>
<title>登入</title>
</head>
<body>
  <h1>實驗預約系統</h1><br>

<div><form method="post" class="center">
      {% csrf_token %}
      <div><table class="center">
        <tr>
          <td width="16%" align="right">帳號:</td>
          <td width="84%"><input type="text" name="username" id="username"></td>
        </tr>
        <tr>
          <td width="16%" align="right">密碼:</td>
          <td width="84%"><input type="password" name="password" id = "password" ></td>
        </tr>
        <tr>
          <div><td><p><input type="submit" name="login" value="登入"></p></td></div>
          <div><td>
            <p>
              <button type="button">
                <a href= "{% url 'main_page' %}">訪客登入</a>
              </button>
            </p>
          </td></div>
          <div><td><a href="{% url 'sign_up' %}">註冊</a></td></div>  
          
        </tr>
      </table></div>   
  </form></div>

</html>

log_out.html

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta http-equiv="X-UA-Compatible" content="IE=edge">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>Document</title>
</head>
<body>
    <p>你已經登出囉!</p>
    <a href= "{% url 'login' %}">回到登入頁面</a>
    
</body>
</html>

main_page.html

在main_page裡面可以用if else來驗證user帳密是否正確，若正確則會顯示他已經登入並顯示登出鍵
若使用訪客登入或驗證失敗還進到這個頁面則會告知他還沒登入，並顯示一個登入的連結

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta http-equiv="X-UA-Compatible" content="IE=edge">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>Document</title>
</head>
<body>
    <h1>歡迎來到實驗預約系統!</h1>
    {% if request.user.is_authenticated %}
        <p>Hi~ {{request.user}} 您已經登入囉~!</p>
        <a href= "{% url 'log_out' %}">登出</a>
    {% else %}
        <p>您尚未登入唷~</p>
        <a href= "{% url 'login' %}">回到登入頁面</a>
    {% endif %}  
</body>
</html>