Schritt-für-Schritt-Anleitung zur Benutzerauthentifizierung mit Django, Djoser und JWT: Teil I

Benutzerauthentifizierung und -verwaltung sind grundlegende Funktionen beim Starten eines neuen Projekts. Da sich diese Aufgaben häufig wiederholen, wurden verschiedene Pakete entwickelt, um den Prozess zu optimieren und es Entwicklern zu ermöglichen, sich auf andere Aspekte ihrer Projekte zu konzentrieren. Ein solches Paket ist Djoser, das sich nahtlos in das Django REST Framework (DRF) integrieren lässt, um die Authentifizierung und Benutzerverwaltung zu übernehmen. In diesem Leitfaden werde ich Sie durch den Aufbau eines vollständigen Benutzerauthentifizierungssystems mit Djoser führen, einschließlich der Einrichtung von E-Mail-Funktionen und benutzerdefinierten E-Mail-Vorlagen.

Einrichten des Projekts

Erstellen Sie zunächst ein Verzeichnis für Ihr Projekt:

mkdir userauth

Navigieren Sie zum neuen Verzeichnis in Ihrer bevorzugten IDE, richten Sie eine virtuelle Umgebung ein und aktivieren Sie sie

python venv .venv
source .venv/bin/activate

Als nächstes installieren Sie die erforderlichen Pakete:

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

Hinweis: Einige Abhängigkeiten, wie z. B. social-auth-app-django, werden möglicherweise automatisch mit Djoser installiert. Wenn ja, können Sie das explizite Hinzufügen überspringen

Generieren Sie nach der Installation eine Datei „requirements.txt“, um Ihre Abhängigkeiten zu verfolgen:

pip freeze > requirements.txt

Sie sollten alle installierten Pakete in der Datei „requirements.txt“ aufgelistet sehen, einschließlich etwaiger Abhängigkeiten.

Erstellen Sie das Django-Projekt und bringen Sie den Server zum Laufen

django-admin startapp userauth . 

Dadurch wird das Django-Projekt erstellt. Anschließend müssen wir innerhalb unseres Projekts eine App erstellen

python manage.py startapp accounts

Ihr Projektverzeichnis sollte nun Folgendes enthalten:

• .venv (virtuelle Umgebung)

• Konten/ (Authentifizierungs-App)

• userauth/ (Hauptprojektordner)

• manage.py

• requirements.txt

Konfigurieren des Projekts

Fügen Sie die erforderlichen Pakete und Apps zum Abschnitt INSTALLED_APPS in Settings.py hinzu:

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',
]

Aktualisieren Sie Ihre Settings.py, um Konfigurationen für Django REST Framework und SimpleJWT einzuschließen:

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

Lassen Sie uns unser benutzerdefiniertes Benutzermodell erstellen
Erstellen Sie die Datei manager.py im Kontenordner
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)

accounts/models.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

Fügen Sie diese Zeile in Ihre Datei „settings.py“ ein

AUTH_USER_MODEL = 'accounts.CustomUser'

Wir können unsere Migrationen durchführen und dann den lokalen Entwicklungsserver ausführen

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

Bis jetzt sollte es keine Probleme geben.

Konfigurieren von Djoser-URLs

Fügen Sie die von Djoser bereitgestellten URLs zusammen mit Swagger für die API-Dokumentation in die URL-Muster Ihres Projekts ein:

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'))
]

Gehen Sie in Ihrem Browser zu http://127.0.0.1:8000/api/docs/, um die API-Dokumentation anzuzeigen.

Konfigurieren der Djoser-Einstellungen

Alle Einstellungen, die für Djoser konfiguriert werden können, finden Sie hier Djoser-Einstellungen

userauth/settings.py

mkdir userauth

Hier verlangen wir, dass Benutzer eine Aktivierungs-E-Mail erhalten. Die Aktivierungs-URL ist der Link, der an die E-Mail-Adresse des Benutzers gesendet wird, damit dieser darauf klicken kann. Das Token und die UID müssen extrahiert und eine Post-Anfrage als Text an die Aktivierungsroute in Ihrem Projekt gesendet werden

E-Mail-Versand konfigurieren

Zuletzt müssen wir den E-Mail-Versand konfigurieren. Ich werde Mailtrap zum E-Mail-Versand verwenden. Sie können wählen, ob Sie die E-Mail an die Konsole oder an einen anderen E-Mail-Dienst Ihrer Wahl senden möchten.

Zum Senden der E-Mail an Ihre Konsole

python venv .venv
source .venv/bin/activate

Verwendung eines externen Postdienstes

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

Ersetzen Sie die Platzhalter durch die richtigen Anmeldeinformationen

Um dies zu testen, verwenden wir Postman, um es auszuprobieren.

Neuen Benutzer erstellen

Dann wird die Aktivierungs-E-Mail an den Benutzer gesendet

Anpassen von E-Mail-Vorlagen

Lassen Sie uns die E-Mail-Vorlage ein wenig anpassen
Erstellen Sie einen Vorlagenordner im Kontenverzeichnis, erstellen Sie dann einen E-Mail-Ordner und erstellen Sie dort einen Vorlagenordner

accounts/templates/email/activation_email.py
Wir passen die Standard-E-Mail an, die mit djoser geliefert wird

pip freeze > requirements.txt

Um den Site-Namen in der Vorlage anzupassen, fügen Sie diese Zeile zur Djoser-Einstellung hinzu

django-admin startapp userauth . 

Die E-Mail-Vorlage sieht jetzt so aus

Aktivierungsansicht erweitern

Lassen Sie uns im letzten Teil dieses Artikels an der E-Mail-Verifizierung arbeiten.
Wir beginnen mit der Anpassung der Aktivierungsansicht in Accounts/views.py:

accounts/views.py

python manage.py startapp accounts

Wir erweitern die Aktivierungsansicht auf Djoser, um sie anzupassen und setzen das Feld is_verified in unserem Benutzermodell auf true

accounts/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',
]

URLs-Datei auf Projektebene
userauth/urls.py

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

Um dies zu testen, erstellen Sie einen neuen Testbenutzer und klicken Sie auf die Aktivierungs-URL, die an die E-Mail gesendet wurde.
Sie gelangen auf diese Seite, da die URL in unserem Projekt nicht existiert

Extrahieren Sie aus der URL die UID und das Token und stellen Sie eine Post-Anfrage an die Aktivierungsroute, die Sie in Ihrer Datei „accounts/urls.py“ definiert haben

aus dem Screenshot geht hervor, dass meine Route ;
ist

mkdir userauth

Die UID ist MTY
Der Token ist cil456-aaf8331efb885f0b4412f35ce544648c

Verwenden der Parameter, um eine Post-Anfrage an den Aktivierungsendpunkt zu stellen

Damit ist das Tutorial zum Einrichten der Benutzerauthentifizierung mit Djoser abgeschlossen. Sie verfügen jetzt über ein funktionierendes Authentifizierungssystem mit E-Mail-Aktivierung und anpassbaren Vorlagen. Im zweiten Teil dieser Serie befassen wir uns mit der sozialen Authentifizierung, die es Benutzern ermöglicht, sich über Drittanbieterdienste wie Google, Facebook und GitHub anzumelden und anzumelden. Bleiben Sie dran für mehr!

Wenn Sie Fragen oder Feedback haben, können Sie gerne einen Kommentar hinterlassen.

Das obige ist der detaillierte Inhalt vonSchritt-für-Schritt-Anleitung zur Benutzerauthentifizierung mit Django, Djoser und JWT: Teil I. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!