Panduan Langkah demi Langkah untuk Pengesahan Pengguna dengan Django, Djoser dan JWT: Bahagian I

Pengesahan dan pengurusan pengguna ialah ciri asas apabila memulakan projek baharu. Oleh kerana tugasan ini sering diulang, pelbagai pakej telah dibangunkan untuk menyelaraskan proses, membolehkan pembangun menumpukan pada aspek lain projek mereka. Satu pakej sedemikian ialah Djoser, yang menyepadukan dengan lancar dengan Rangka Kerja Django REST (DRF) untuk mengendalikan pengesahan dan pengurusan pengguna. Dalam panduan ini, saya akan membimbing anda membina sistem pengesahan pengguna penuh menggunakan Djoser, termasuk menyediakan fungsi e-mel dan templat e-mel tersuai.

Menyediakan Projek

Mulakan dengan mencipta direktori untuk projek anda:

mkdir userauth

Navigasi ke direktori baharu dalam IDE pilihan anda, sediakan persekitaran maya dan aktifkannya

python venv .venv
source .venv/bin/activate

Seterusnya, pasang pakej yang diperlukan:

pip install django djangorestframework djoser djangorestframework_simplejwt social-auth-app-django drf-yasg

Nota: Sesetengah kebergantungan, seperti social-auth-app-django, mungkin dipasang secara automatik dengan Djoser. Jika ya, anda boleh melangkau menambahkannya secara eksplisit

Setelah dipasang, jana fail requirements.txt untuk menjejak kebergantungan anda:

pip freeze > requirements.txt

Anda seharusnya melihat semua pakej yang dipasang disenaraikan dalam fail requirements.txt, termasuk sebarang kebergantungan.

Buat Projek Django dan jalankan pelayan

django-admin startapp userauth . 

Ini akan mencipta projek django. Kami kemudiannya perlu mencipta apl dalam projek kami

python manage.py startapp accounts

Direktori projek anda kini sepatutnya mengandungi perkara berikut:

• .venv (persekitaran maya)

• akaun/ (apl pengesahan)

• userauth/ (folder projek utama)

• urus.py

• keperluan.txt

Mengkonfigurasi Projek

Tambahkan pakej dan apl yang diperlukan pada bahagian INSTALLED_APPS dalam tetapan.py:

INSTALLED_APPS = [
    'django.contrib.admin',
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.messages',
    'django.contrib.staticfiles',

     # Third Party Apps
    'rest_framework',
    'djoser',
    'rest_framework_simplejwt',
    'drf_yasg',

    # Local Apps
    'accounts',
]

Kemas kini settings.py anda untuk memasukkan konfigurasi untuk Rangka Kerja Django REST dan SimpleJWT:

REST_FRAMEWORK = {
    'DEFAULT_AUTHENTICATION_CLASSES': (
        'rest_framework_simplejwt.authentication.JWTAuthentication',
    ),
}

Mari kita cipta model pengguna tersuai kami sejak
buat fail managers.py dalam folder akaun
accounts/managers.py

from django.contrib.auth.models import BaseUserManager


class CustomUserManager(BaseUserManager):

    def create_user(self, email, username, password=None, **extra_fields) -> None:

        if not username:
            raise ValueError("Username is required")

        if not email:
            raise ValueError("Email is required")


        email = self.normalize_email(email)
        user = self.model(email=email, username=username, **extra_fields)
        user.set_password(password)
        user.save()
        return user


    def create_superuser(self, email, username, password, **extra_fields):
        """
        Create and save a SuperUser with the given email and password.
        """
        extra_fields.setdefault("is_staff", True)
        extra_fields.setdefault("is_superuser", True)
        extra_fields.setdefault("is_active", True)

        if extra_fields.get("is_staff") is not True:
            raise ValueError("Superuser must have is_staff=True.")

        if extra_fields.get("is_superuser") is not True:
            raise ValueError("Superuser must have is_superuser=True.")

        return self.create_user(email, username, password, **extra_fields)

akaun/model.py

from django.db import models
from django.contrib.auth.models import AbstractUser
from accounts.managers import CustomUserManager



class CustomUser(AbstractUser):
    username = None
    email = models.EmailField(unique=True)
    is_verified = models.BooleanField(default=False)


    USERNAME_FIELD = 'email'
    REQUIRED_FIELDS = []

    objects = CustomUserManager()


    def __str__(self):
        return self.email

Tambah baris ini dalam fail settings.py anda

AUTH_USER_MODEL = 'accounts.CustomUser'

Kami boleh meneruskan untuk melakukan migrasi kami kemudian menjalankan pelayan pembangunan tempatan

python manage.py makemigrations
python manage.py migrate
python manage.py runserver

Sepatutnya tiada isu setakat ini.

Mengkonfigurasi URL Djoser

Sertakan URL yang disediakan oleh Djoser dalam corak URL projek anda, bersama-sama dengan Swagger untuk dokumentasi API:

userauth/urls.py

from django.contrib import admin
from django.urls import include, path
from rest_framework import permissions
from drf_yasg.views import get_schema_view
from drf_yasg import openapi


schema_view = get_schema_view(
    openapi.Info(
        title="User Accounts API",
        default_version="v1",
        description="REST implementation of Django authentication system using Djoser",
        contact=openapi.Contact(email="contact@snippets.local"),
        license=openapi.License(name="BSD License"),
    ),
    public=True,
    permission_classes=(permissions.AllowAny,),
)

urlpatterns = [
    path('admin/', admin.site.urls),
    path('api/docs', schema_view.with_ui("swagger", cache_timeout=0), name="swagger-ui"),
    path('api/', include('djoser.urls')), 
    path('api/', include('djoser.urls.jwt'))
]

Pergi ke http://127.0.0.1:8000/api/docs/ dalam penyemak imbas anda untuk melihat dokumentasi API.

Mengkonfigurasi Tetapan Djoser

Semua tetapan yang boleh dikonfigurasikan untuk djoser boleh didapati di sini Tetapan Djoser

userauth/settings.py

mkdir userauth

Di sini kami memerlukan pengguna menerima e-mel pengaktifan. Url pengaktifan ialah pautan yang dihantar ke e-mel pengguna untuk mereka klik. Token dan uid perlu diekstrak dan permintaan pos dihantar bersama mereka sebagai badan kepada laluan pengaktifan dalam projek anda

Mengkonfigurasi Penghantaran E-mel

Akhir sekali kita perlu mengkonfigurasi penghantaran e-mel. Saya akan menggunakan perangkap surat untuk menghantar e-mel. Anda boleh memilih untuk menghantar e-mel ke konsol atau apa sahaja perkhidmatan e-mel yang anda pilih.

Untuk menghantar e-mel ke konsol anda

python venv .venv
source .venv/bin/activate

Menggunakan perkhidmatan mel luaran

pip install django djangorestframework djoser djangorestframework_simplejwt social-auth-app-django drf-yasg

Ganti ruang letak dengan kelayakan yang betul

Untuk menguji ini, kami akan menggunakan posmen untuk mengujinya.

Mencipta pengguna baharu

Kemudian e-mel pengaktifan dihantar kepada pengguna

Menyesuaikan Templat E-mel

Jom sesuaikan sedikit templat e-mel
Buat folder templat dalam direktori akaun, kemudian buat folder e-mel dan teruskan buat folder templat di sana

akaun/template/email/activation_email.py
Kami menyesuaikan e-mel lalai yang disertakan dengan djoser

pip freeze > requirements.txt

Untuk menyesuaikan nama tapak dalam templat, tambahkan baris ini pada tetapan djoser

django-admin startapp userauth . 

Templat e-mel kelihatan seperti ini sekarang

Memperluaskan Paparan Pengaktifan

Untuk bahagian terakhir artikel ini, lakukan pengesahan e-mel.
Kami mulakan dengan menyesuaikan paparan pengaktifan dalam accounts/views.py:

akaun/views.py

python manage.py startapp accounts

Kami memanjangkan paparan pengaktifan pada djoser untuk menyesuaikannya dan menetapkan medan is_verified pada model pengguna kami kepada benar

akaun/urls.py

INSTALLED_APPS = [
    'django.contrib.admin',
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.messages',
    'django.contrib.staticfiles',

     # Third Party Apps
    'rest_framework',
    'djoser',
    'rest_framework_simplejwt',
    'drf_yasg',

    # Local Apps
    'accounts',
]

Fail URL dalam peringkat projek
userauth/urls.py

REST_FRAMEWORK = {
    'DEFAULT_AUTHENTICATION_CLASSES': (
        'rest_framework_simplejwt.authentication.JWTAuthentication',
    ),
}

Untuk menguji ini, buat pengguna ujian baharu dan klik url pengaktifan yang dihantar ke e-mel.
Anda sampai ke halaman ini, kerana url itu tidak wujud dalam projek kami

daripada url ekstrak uid dan token dan buat permintaan pos ke laluan pengaktifan yang anda tentukan dalam fail akaun/urls.py anda

daripada tangkapan skrin, laluan saya ialah ;

mkdir userauth

Uid ialah MTY
Tokennya ialah cil456-aaf8331efb885f0b4412f35ce544648c

Menggunakan parameter untuk membuat permintaan siaran ke titik akhir mengaktifkan

Ini menyimpulkan tutorial untuk menyediakan pengesahan pengguna dengan Djoser. Anda kini mempunyai sistem pengesahan berfungsi dengan pengaktifan e-mel dan templat yang boleh disesuaikan. Dalam bahagian kedua siri ini, kami akan meneroka pengesahan sosial, membolehkan pengguna mendaftar dan log masuk menggunakan perkhidmatan pihak ketiga seperti Google, Facebook dan GitHub. Nantikan lebih banyak lagi!

Jika anda mempunyai sebarang soalan atau maklum balas, sila tinggalkan komen.

Atas ialah kandungan terperinci Panduan Langkah demi Langkah untuk Pengesahan Pengguna dengan Django, Djoser dan JWT: Bahagian I. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!