在写登录功能的时候看着网上的视频学着做,然后看了源码的时候发现了一些有意思的功能,因此写这一篇笔记分享给大家.
1.阅读Django自带用户系统源码
1.1 阅读User类源码
系统自带的用户系统的models
文件的位置\site-packages\django\contrib\auth\models.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
文件,用于专门存取验证器.
项目根目录\utils\validator.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
类,并且重写了其中的方法和属性.
user\models.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://blog.csdn.net/qq_35653657/article/details/128832687 的第三步
3.创建序列化类
user\serializers
代码:
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类
user\views
代码:
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
5.创建路由
6.测试接口
从测试结果就可以看出,针对不同的字段,会返回对应的错误,而不是一起返回的.