rest-framework(三)

三流简单介绍

import sys
# 标准输出流
sys.stdout.write('123\n')
sys.stdout.write('456\n')

# 标准输入流
res = sys.stdin.readline()
print(res)

# 标准错误流
sys.stderr.write('opq\n')
sys.stderr.write('xyz\n')

创建User模型表

#1. 在models文件中创建模型表
class User(models.Model):
    SEX_CHOICE = (
        (0,'男'),
        (1,'女'),
    )
    username = models.CharField(max_length=64, verbose_name='用户名', blank=True, unique=True)
    password = models.CharField(max_length=64, verbose_name='密码')
    sex = models.IntegerField(choices=SEX_CHOICES, default=0, verbose_name='性别')
    img = models.ImageField(upload_to='img', default='img/default.png', verbose_name='头像')
    # 开发中,数据不会直接删除,通过字段控制
    is_delete = models.BooleanField(default=False, verbose_name='是否注销')
    # 数据库数据入库,一般都会记录该数据第一次入库时间,有时候还会记录最后一次更新时间
    created_time = models.DateTimeField(auto_now_add=True, verbose_name='创建时间')

    class Meta:#配置类,给所属类提供配置信息
        db_table = 'my_user'
        verbose_name_plural = '用户表'

    def __str__(self):
        return self.username

class UserDetail(models.Model):
    phone = models.CharField(max_length=64)
    user = models.OneToOneField(to=User)
    def __str__(self):
        return '%s的详情' %self.user.username
    
#2.django  超级用户注册
'''    python manage.py createsurperuser
        在admin.py中注册模型表'''
from . import models

admin.site.register(models.User)

#3.主路由中设置路由分发
from django.views.static import serve
from django.conf import settings
    urlpatterns = [
        # url(r'^admin/', admin.site.urls),
        url(r'^app01/(?P<path>.*)',serve,{'document_root':settings.MEDIA_ROOT})
    ]

自定义序列化过程

# 一、自定义序列化过程
from rest_framework.views import APIView
from rest_framework.response import Response
from django.conf import settings
from . import models

class UserV1APIView(APIView):
    # 单查群查
    def get(self, request, *args, **kwargs):
        pk = kwargs.get('pk')
        if pk:
            user_dic = models.User.objects.filter(is_delete=False, pk=pk).values('username', 'sex', 'img').first()
            if not user_dic:
                return Response({
                    'status': 1,
                    'msg': 'pk error',
                }, status=400)

            user_dic['img'] = '%s%s%s' % (settings.BASE_URL, settings.MEDIA_URL, user_dic.get('img'))
            return Response({
                'status': 0,
                'msg': 'ok',
                'results': user_dic
            })
        else:
            user_query = models.User.objects.filter(is_delete=False).values('username', 'sex', 'img').all()
            for user_dic in user_query:
                user_dic['img'] = '%s%s%s' % (settings.BASE_URL, settings.MEDIA_URL, user_dic.get('img'))
            user_list = list(user_query)
            return Response({
                'status': 0,
                'msg': 'ok',
                'results': user_list
            })

drf序列化过程

视图类序列化过程:

  1. ORM操作得到数据

    1. 将数据序列化成可以返回给前台的数据
    2. 返回数据给前台
#该字段需要与数据库中的字段名对应
username = serializers.CharField()

#可以通过SerializerMethodField自定义序列化字段,采用方法序列化
#字段名和自定义的方法名对应
gender = serializers.SerializerMethodField()
def get_gender(self,obj):
    return '123'

视图类序列化

视图文件

# 二、drf序列化过程
# 视图类序列化过程
# 1)ORM操作得到数据
# 2)将数据序列化成可以返回给前台的数据
# 3)返回数据给前台
from . import serilizers
class UserV2APIView(APIView):
    # 单查群查
    def get(self, request, *args, **kwargs):
        pk = kwargs.get('pk')
        if pk:
            user_obj = models.User.objects.filter(is_delete=False, pk=pk).first()
            if not user_obj:
                return Response({
                    'status':1,
                    'msg':'pk error',
                },status=400)
            user_ser = serilizers.UserSerilizer(user_obj, many=False)
            user_list_data = user_ser.data

            return Response({
                'status': 0,
                'msg': 'ok',
                'results': user_list_data
            })
        else:
            #将对象对外提供的字段,以及整个序列化过程封装,形成序列化类
            user_query = models.User.objects.filter(is_delete=False).all()

            user_ser = serilizers.UserSerilizer(user_query,many=True)
            user_list_data = user_ser.data

            return Response({
                'status': 0,
                'msg': 'ok',
                'results': user_list_data
            })

自定义serilizers文件

from rest_framework import serializers
from django.conf import settings

class UserSerilizer(serializers.Serializer):
    #1)字段名与字段类型要与处理的model类类对应
    #2)不提供的字段,就不参与序列化给前台
    #3)可以自定义序列化字段,采用方法序列化,方法固定两个参数,第二个参数就是参与序列化的model对象
    #    (自定义的字段不要与数据库字段名重名,由get_自定义字段名方法的返回提供)
    username = serializers.CharField()
    sex = serializers.IntegerField()

    gender = serializers.SerializerMethodField()
    def get_gender(self,obj):
        return obj.get_sex_display()

    icon = serializers.SerializerMethodField()
    def get_icon(self,obj):
        return '%s%s%s' %(settings.BASE_URL,settings.MEDIA_URL,obj.img)

drf反序列化过程

视图类反序列化过程:

  1. 从请求对象中获取前台提交的数据

  2. 交给序列化类完成反序列化(数据的校验)

  3. 借助序列化类完成数据入库

  4. 反馈给前台处理结果

#在视图函数中定义接收请求函数
        def post(self, request, *args, **kwargs):
        request_data = request.data
        user_ser = serilizers.UserDeSerializer(data=request_data)
        if user_ser.is_valid():
            # 入库  有返回值
            user_obj = user_ser.save()
            return Response({
                'status': 0,
                'msg': 'error',
                'results': serilizers.UserSerilizer(user_obj).data
            })
        else:
            return Response({
                'status': 1,
                'msg': user_ser.errors,
            })
#在serializer文件中定义反序列化方法
class UserDeSerializer(serializers.Serializer):
    username = serializers.CharField(min_length=3,max_length=16,
                                     error_messages={
                                         'min_length':'短了',
                                         'max_length':'长了',
                                     })
    password = serializers.CharField(min_length=3, max_length=16,
                                     error_messages={
                                         'min_length': '短了',
                                         'max_length': '长了',
                                     })
    #设置可以为空
    sex = serializers.BooleanField(required=False)

局部钩子

#局部钩子:方法名validate_校验的字段名(self,校验的字段数据)
    #校验规则:
    #   成功直接返回values,失败返回校验失败信息
    def validate_username(self, value):
        if 'g' in value:
            raise serializers.ValidationError('用户名不能有g')
        return value

全局钩子

#全局钩子
#全局钩子中,如果有要校验自定义字段的(不是表的字段),需要在钩子内删除该字段
    def validate(self, attrs):
        password = attrs.get('password')
        re_password = attrs.pop('re_password')
        if password != re_password:
            raise serializers.ValidationError('密码不一致')
        return attrs

复写create,update方法

# 在视图类中调用序列化的save方法完成入库,
    #   serlializer类能做到增入库走create方法,改入库走update方法
    #   但是Serializer中没有以上两个方法,需要自己复写
    def create(self, validated_data):
        return models.User.objects.create(**validated_data)

    #instance代表要被修改的对象,validated_data代表校验后用来改instance的数据
    def update(self, instance:models.User, validated_data):
        #用户名不能被修改
        validated_data.pop('username')
        models.User.objects.filter(pk=instance.id).update(**validated_data)
        return instance

序列化总结

'''
序列化总结
1)设置序列化字段,字段名与字段类型要与处理的model类属性名对应(只参与序列化的类型不需要设置条件)

2)model类中有的字段,但在序列化中没有对应字段,该类字段不参与序列化

3)自定义序列化字段(方法一),字段类型为SerializerMethodField(),值有 get_自定义字段名(self, model_obj) 方法提供,
        一般值都与参与序列化的model对象(model_obj)有关
'''

反序列化总结

'''
反序列化总结
1)系统校验字段与自定义校验字段定义没有区别:字段 = serializers.字段类型(条件)

2)自定义校验字段是不能直接入库的,需要设置入库规则,或将其移除不入库(这类字段就是参与全局校验用的)

3)所有字段都可以设置对应局部钩子进行校验,钩子方法 validate_字段名(self, 字段值value)
    规则:成功直接返回value,失败抛出校验失败信息ValidationError('错误信息')
    
4)一个序列化类存在一个全局钩子可以对所有字段进行全局校验,钩子方法 validate(self, 所有字段值字典attrs)
    规则:成功直接返回attrs,失败抛出校验失败信息ValidationError({'异常字段', '错误信息'})
    
5)重写create方法实现增入库,返回入库成功的对象

6)重写update方法实现改入库,返回入库成功的对象
'''

ModelSerializer序列化

自定义序列化字段

使用该方法时,字段必须在fields中设置(插拔式)

#第一种方式
gender = serializers.SerializerMethodField()
def get_gender(self,obj):
    return obj.get_sex_display()

class Meta:
    model = model.User
    fields = ('username','gender')
'''
通过model = model.User可以拿到User类名称空间中所有的属性,
因此要获取gender的值,可以将该函数写在User类中,在通过fields设置字段,获取到值
'''
# 第二种自定义序列化字段(插拔式,提倡使用)
    @property
    def gender(self):
        return self.get_sex_display()

自定义反序列化

​ 自定义反序列化字段同Serializer类,且规则只能在此声明中设置,或是在钩子中设置,在extra_kwargs中对其设置的无效

: 自定义反序列化字段与系统字段,设置规则一样,所以必须设置write_only

class UserModelSerializer(serializers.ModelSerializer):
    '''
    第一种自定义序列化字段:该字段必须在fields中设置
    gender = serializers.SerializerMehodField()
    def get_gender(self,obj):
        return obj.get_sex_display()

    自定义反序列化字段同Serializer类,且规则只能在此声明中设置,或是在钩子中设置
        在extra_kwargs中对其设置的无效
    注:自定义反序列化字段与系统字段,设置规则一样,所以必须设置write_only
    '''
    re_password = serializers.CharField(min_length=3,max_length=16,write_only=True)

    class Meta:
        model = models.User
        #fields采用插拔式设置所有参与序列化与反序列化字段
        fields = ('username','gender','icon','password','sex','re_password')
        extra_kwargs = {
            'username':{
                #系统字段不设置read_only和write_only,默认都参加
                'min_length':3,
                'max_length':10,
                'error_messages':{
                    'min_length':'短短',
                    'max_length':'长长'
                }
            },
            'gender':{
              #自定义的序列化字段默认就是read_only,且不能修改,可以省略
              'read_only':True,
            },
            'password':{
                'write_only':True,
            },
            'sex':{
                #像sex有默认值的字段,为选填字段('required':True可以将其变为必填字段)
                'write_only':True,
                #'required':True
            }
        }

    #局部全局钩子同Serializer类,是与Meta同缩进的
    def validate_username(self,value):
        if 'g' in value.lower():
            raise serializers.ValidationError('名字中不能有gg')
        return value

    def validate(self, attrs):
        password = attrs.get('password')
        re_password = attrs.pop('re_password')
        if password != re_password:
            raise serializers.ValidationError({'re_password':'密码不一致'})
        return attrs

    #create和update方法不需要再重写,ModelSerializer类已提供,且支持所有关系下的联表操作

ModelSerializer序列化总结

""" 
ModelSerializer类序列化与反序列化总结
1)序列化类继承ModelSerializer,所以需要在配置类Meta中进行配置

2)model配置:绑定序列化相关的Model表

3)fields配置:采用 插拔式 设置所有参与序列化与反序列化字段

4)extra_kwargs配置:
    划分系统字段为三种:只读(read_only)、只写(write_only)、可读可写(不设置)
    字段是否必须:required
    选填字段:在extra_kwargs进行配置,但不设置required,且有默认值
    
5)自定义序列化字段:
    第一种(不提倡):在序列化类中用SerializerMethodField()来实现
    第二种(提倡):在模型类中用@property来实现,可插拔
    
6)自定义反序列化字段:
    同Serializer类,且规则只能在此声明中设置,或是在钩子中设置,在extra_kwargs中对其设置的无效
    自定义反序列化字段与系统字段,设置规则一样,所以必须设置 write_only
    
7)局部钩子,全局钩子同Serializer类

8)不需要重写create和update方法
"""

猜你喜欢

转载自www.cnblogs.com/samoo/p/12104476.html