Django drf使用Django自帶的使用者系統的註冊功能

2023-02-14 06:01:55

1.閱讀Django自帶使用者系統原始碼

1.1 閱讀User類原始碼

系統自帶的使用者系統的models檔案的位置site-packagesdjangocontribauthmodels.py,開啟這個檔案發現User類繼承的是一個AbstractUser類,因此我們想要使用系統自帶的使用者系統,只要在models中重新寫一個User類,也繼承AbstractUser就可以了.

1.2 閱讀AbstractUser類

閱讀AbstractUser類,發現了其中的對username欄位做的幾個處理,第一個就是他新增了一個驗證器validators,第二個增加了error_messages,當在我們往資料庫中新增使用者資訊的時候,系統就會自動驗證是否符合要求,如果不符合要求,就會返回一個字典,將對應欄位的錯誤返回,這就是我想到的與其他博主所做的不同之處.

2.建立自己的User類

我想我的使用者類中有mobile,username,email,password四個欄位,我的需求:

mobile,username,email都是不能重複

驗證這幾個欄位的格式

返回的errormessage為中文
因此我就想到了模仿系統自帶的AbstractUser的寫法:

2.1 建立驗證器

這個驗證器是其中主要是驗證電話號碼和郵箱的格式正誤,因為其他的類也可能需要用到驗證器,因此我就在專案的utils目錄下建立了一個validator.py檔案,用於專門存取驗證器.
專案根目錄utilsvalidator.py程式碼:

# 驗證電話號碼是否有誤
import re
from django.core.exceptions import ValidationError

# 對手機格式進行驗證
class UnicodMobileValidator:
    def __call__(self, value):
        if not re.match(r"^1[3-9]d{9}$", value):
             raise ValidationError("對不起,手機格式有誤!")

# 對郵箱格式進行驗證
class UnicodEmailValidator:
    def __call__(self, value):
        if not re.match(r"^[a-zA-Z0-9_.-]+@[a-zA-Z0-9-]+(.[a-zA-Z0-9-]+)*.[a-zA-Z0-9]{2,6}$", value):
             raise ValidationError("對不起,郵箱格式有誤!")

2.2 建立User類

這裡我繼承了AbstractUser類,並且重寫了其中的方法和屬性.
usermodels.py程式碼:

from datetime import timezone

from django.contrib.auth.validators import UnicodeUsernameValidator
from django.db import models
from django.contrib.auth.models import AbstractBaseUser, PermissionsMixin, AbstractUser

from qianxingtong_main.utils.validator import UnicodMobileValidator, UnicodEmailValidator


class User(AbstractUser):
    username_validator = UnicodeUsernameValidator()

    username = models.CharField(
        ("username"),
        max_length=150,
        unique=True,
        help_text=(
            "Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only."
        ),
        validators=[username_validator],
        error_messages={
            "unique": ("該使用者名稱已經存在"),
        },
    )

    email = models.EmailField(("email address"), unique=True, validators=[UnicodEmailValidator()],error_messages={"unique": ("郵箱已經存在"),})
    mobile = models.CharField(max_length=15, unique=True, validators=[UnicodMobileValidator()],
                              error_messages={"unique": ("電話號碼已經存在")}, verbose_name="手機號碼")

    class Meta:
        db_table = "drf_user"
        verbose_name = "使用者資訊"
        verbose_name_plural = verbose_name

這裡在遷移資料的時候可能會出現錯誤,其中錯誤的解決方法參考我寫的筆記:https://www.jb51.net/article/275133.htm 的第三步

3.建立序列化類

userserializers程式碼:

from django.contrib.auth.hashers import make_password
from rest_framework import serializers
from user.models import User
class UserSerializer(serializers.ModelSerializer):
    rpassword = serializers.CharField(required=True, write_only=True, help_text="確認密碼")
    token = serializers.CharField(max_length=1024, read_only=True, help_text="token認證字串")
    class Meta:
        model = User
        fields = ["id", "username", "email", "mobile", "password", "token", "rpassword"]
        # write_only:只寫入資料庫,
        extra_kwargs = {
            "mobile": {
                "write_only": True,
            },
            "email": {
                "write_only": True,
            },
            "id": {
                "read_only": True,
            },

        }

    def validate(self, attrs):
        """校驗資訊"""
        password = attrs.get("password")
        rpassword = attrs.get("rpassword")
        if password != rpassword:
            # 驗證手機號碼是否已經被註冊
            raise serializers.ValidationError("對不起,確認密碼與密碼不一致!")
        return attrs

    def create(self, validated_data):
        """儲存使用者資訊"""
        mobile = validated_data.get("mobile")
        username = validated_data.get("username")
        email = validated_data.get("email")

        validated_data.pop("rpassword")  # 移除不需要的資料
        # 對密碼進行加密
        raw_password = validated_data.get("password")
        hash_password = make_password(raw_password)
        # 呼叫序列化器提供的create方法
        user = User.objects.create(
            mobile=mobile,
            username=username,
            password=hash_password,
            email=email
        )
        return user

這個程式碼就是我與其他的博主不同的地方,我看網上的up主就是把驗證的程式碼寫在validate中,但是這裡存在的一個問題就是所有的錯誤都是統一一起打包返回,無法在前端中做對應欄位的錯誤提示.

4.建立views類

userviews程式碼:

from rest_framework.generics import CreateAPIView
from user.models import User
from user.serializers import UserSerializer

# Create your views here.
class UserViewSets(CreateAPIView):
    queryset = User.objects.all()
    serializer_class = UserSerializer