首页 > 其他分享 >drf-序列化器、反序列化、反序列化校验

drf-序列化器、反序列化、反序列化校验

时间:2023-02-01 21:46:56浏览次数:338  
标签:return ser self request 校验 book 序列化 data drf

1.APIView执行流程

1.之前我们是基于django原生的View编写接口,drf提供给咱们的一个类APIView,以后使用drf写视图类,都是继承这个类及其子类,APIView本身就是继承了Django原生的View。

1.1 基于APIView+JsonResponse编写接口:

views中代码:
from .models import Book
from rest_framework.views import APIView
from django.http import JsonResponse

class BookView(APIView):
    def get(self,request):
        book_queryset = Book.objects.all()
        book_list = []
        for book_obj in book_queryset:
            book_list.append({'name':book_obj.name,'price':book_obj.price,'publish':book_obj.publish})
        return JsonResponse(book_list,safe=False)

1.2 基于APIView+Response写接口

Response可以序列化字典和列表,并且不需要加参数:
from rest_framework.response import Response
from .models import Book
from rest_framework.views import APIView
class BookView(APIView):
    def get(self, request):
        book_queryset = Book.objects.all()
        book_list = []
        for book_obj in book_queryset:
            book_list.append({'name':book_obj.name,'price':book_obj.price,'publish':book_obj.publish})
        return Response(book_list)
以上两种效果一致,都可以拿到所有的图书信息:

2.APIView的执行流程

1.路由层中:path('books/', views.BookView.as_view()),找到的as_view()是APIView中的as_view(),虽然APIView也继承View但是APIView中本身就有as_view()。
    
2.源码分析:
    @classmethod
    def as_view(cls, **initkwargs):
        
        view = super().as_view(**initkwargs)
"""
父类view中as_view()的返回值还是view,把django原生View的as_view方法中的闭包函数中的view拿出来了。
"""
        return csrf_exempt(view)
"""
相当于在所有的方法上面加了csrf_exempt装饰器,所以此后我们不需要注掉settings中的csrf。
"""

路由匹配成功,执行csrf_exempt(view)(request)>>>View的as_view中的闭包函数view>>>self.dispatch>>>self是视图类对象,在APIView中找到了dispatch:
    def dispatch(self, request, *args, **kwargs):
"""
此时的request是django原生的request,老的request
"""
        request = self.initialize_request(request, *args, **kwargs)
"""
把老的request包装成了新的request,这个是drf提供的Request类的对象。到此以后,这个request就是新的了。老的requestrequest._request。
"""
        self.request = request
        try:
        # 执行了三大认证【认证,频率,权限】,使用新的request,不读
            self.initial(request, *args, **kwargs)

            # Get the appropriate handler method
            if request.method.lower() in self.http_method_names:
                handler = getattr(self, request.method.lower(),
                                  self.http_method_not_allowed)
            else:
                handler = self.http_method_not_allowed
"""
把新的request传入了,视图类的方法中get的request也是新的
"""
            response = handler(request, *args, **kwargs)

        except Exception as exc:
            response = self.handle_exception(exc)

        self.response = self.finalize_response(request, response, *args, **kwargs)
        return self.response
总结:
	1.去除了所有方法的csrf认证
	2.包装了新的request,以后在视图类中用的request是新的request,是Request类的对象,不是原生的了
	3.在执行视图类的方法之前,执行了3大认证
	4.如果在3大认证或视图函数方法执行过程中出了错,会有异常捕获----》全局异常捕获
	5.以后视图类方法中的request都是新的了

3.Request对象源码分析(了解)

# 新的Request---》区别于老的
# 老的:django.core.handlers.wsgi.WSGIRequest  
# 新的:from rest_framework.request import Request
	-新的 request._request  是老的
    
    
# Request源码
	-方法 __getattr__
    	-在视图类的方法中,执行request.method ,新的request是没有method的,就触发了新的Request的__getattr__方法的执行
        def __getattr__(self, attr):
            try:
                # 从老的request中反射出 要取得属性
                return getattr(self._request, attr)
            except AttributeError:
                return self.__getattribute__(attr)
    
    
    -request.data--->这是个方法,包装成了数据属性
    	-以后无论post,put。。放在body中提交的数据,都从request.data中取,取出来就是字典
        -无论是那种编码格式
        
        
    -request.query_params--->这是个方法,包装成了数据属性
    	-get请求携带的参数,以后从这里面取
        -query_params:查询参数--->restful规范请求地址中带查询参数
        
        
    -request.FILES--->这是个方法,包装成了数据属性
    	-前端提交过来的文件,从这里取
    
    
    
    
    

 # Request类总结
	-1  新的request用起来,跟之前一模一样,因为新的取不到,会取老的__getattr__
    -2 request.data  无论什么编码,什么请求方式,只要是body中的数据,就从这里取,字典
    -3 request.query_params 就是原来的request._request.GET
    -4 上传的文件从request.FILES
    
    
    
    
    
# python 中有很多魔法方法,在类中,某种情况下触发,会自动执行
	-__str__:打印对象会调用
    -__init__:类() 会调用
    -__call__: 对象() 会调用
    -__new__:
	-__getattr__:对象.属性,如果属性不存在,会触发它的执行

4.序列化器介绍和快速使用

4.1 序列化多条数据

1.在写接口时,需要序列化,需要反序列化,而且反序列化的过程中要做数据校验---》drf直接提供了固定的写法,只要按照固定写法使用,就能完成上面的三个需求。

2.drf提供了两个类:Serializer,ModelSerializer。以后只需要写自己的类,继承drf提供的序列化类,使用其中的某些方法,就能完成上面的操作。
    
3.代码:
serializer.py:
from rest_framework import serializers

class BookSerializer(serializers.Serializer):
    name = serializers.CharField()
    publish = serializers.CharField()
    
views.py:
class BookView(APIView):
    def get(self,request):
        book_queryset = Book.objects.all()
        ser = BookSerializer(instance=book_queryset,many=True)
# ser.data是一个OrderDict:[OrderedDict([('name', '北方出版社'), ('location', '北京'), ('phone', '111')]), OrderedDict([('name', '南方出版社'), ('location', '南京'), ('phone', '222')])]
        return Response(ser.data)
    
urls.py:
urlpatterns = [
    path('admin/', admin.site.urls),
    path('books/',views.BookView.as_view()),
]

4.2序列化单条数据

序列化多条数据需要在类BookSerializer中传入参数many=True,序列化单条数据不需要上传。                                                                 
1.代码:
serializer.py:
from rest_framework import serializers

class BookSerializer(serializers.Serializer):
    name = serializers.CharField()
    publish = serializers.CharField()

views.py:
class BookDetailView(APIView):
    def get(self,request,*args,**kwargs):
        book_obj = Book.objects.filter(pk=kwargs.get('pk')).first()
"""
instance后面既可以跟queryset也可以跟obj。如果是一个queryset需要跟参数:many=True
"""
        ser = BookSerializer(instance=book_obj)
        return Response(ser.data)
    
urls.py:
urlpatterns = [
    path('admin/', admin.site.urls),
    path('book/<int:pk>/',views.BookDetailView.as_view()),
]

5.反序列化

5.1反序列化新增

从源码可得知:更新需要上传instance参数,新增不需要上传instance参数。
serializer.py:
from rest_framework import serializers
from .models import Book

class BookSerializer(serializers.Serializer):
    name = serializers.CharField()
    price = serializers.CharField()
    publish = serializers.CharField()
	
    # 需要自己构造create方法保存
    def create(self, validated_data):
        # validdated_data:{'name': '茶花女', 'price': '66', 'publish': '东京出版社'}
        book_obj = Book.objects.create(**validated_data)
        return book_obj

views.py:
class BookView(APIView):
    def get(self,request):
        book_queryset = Book.objects.all()
        ser = BookSerializer(instance=book_queryset,many=True)
        return Response(ser.data)

    def post(self,request):
        ser = BookSerializer(data=request.data)
        if ser.is_valid():
            ser.save()
            # 调用save会触发我们自己写的create,保存起来
            return Response({'code':100,'msg':'新增成功','result':ser.data})
        else:
            return Response({'code': 101, 'msg': ser.errors})

5.2 反序列化的修改

post请求和put请求因为要向后端发送数据,所以后端生成seriialize对象时要上传data=request.data拿到前端上传的数据。
serializer.py:
from rest_framework import serializers
from .models import Book

class BookSerializer(serializers.Serializer):
    name = serializers.CharField()
    price = serializers.CharField()
    publish = serializers.CharField()

    def create(self, validated_data):
        print(validated_data)
        book_obj = Book.objects.create(**validated_data)
        return book_obj

    def update(self, instance, validated_data):
     	# instance是修改的对象
        # validated_data:校验符合的数据
        instance.name = validated_data.get('name')
        instance.price = validated_data.get('price')
        instance.publish = validated_data.get('publish')
        instance.save()
        return instance
    
views.py:
class BookDetailView(APIView):
    def get(self,request,*args,**kwargs):
        book_obj = Book.objects.filter(pk=kwargs.get('pk')).first()
        ser = BookSerializer(instance=book_obj)
        return Response(ser.data)

    def put(self,request,pk):
        book = Book.objects.filter(pk=pk).first()
        print(request.data)
        ser = BookSerializer(data=request.data,instance=book)
        if ser.is_valid():
            ser.save()
            return Response({'code':100,'msg':'修改成功','result':ser.data})
        else:
            return Response({'code':101,'msg':ser.errors})

5.3 删除单条

views.py:
class BookDetailView(APIView):
    def get(self,request,*args,**kwargs):
        book_obj = Book.objects.filter(pk=kwargs.get('pk')).first()
        ser = BookSerializer(instance=book_obj)
        return Response(ser.data)

    def put(self,request,pk):
        book = Book.objects.filter(pk=pk).first()
        print(request.data)
        ser = BookSerializer(data=request.data,instance=book)
        if ser.is_valid():
            ser.save()
            return Response({'code':100,'msg':'修改成功','result':ser.data})
        else:
            return Response({'code':101,'msg':ser.errors})

    def delete(self,request,pk):
        Book.objects.filter(pk=pk).delete()
        return Response({'code':100,'msg':'删除成功'})

6.反序列化的校验

from rest_framework import serializers
from .models import Book
from rest_framework.exceptions import ValidationError

class BookSerializer(serializers.Serializer):
    name = serializers.CharField()
    price = serializers.CharField()
    publish = serializers.CharField()

    def create(self, validated_data):
        print(validated_data)
        book_obj = Book.objects.create(**validated_data)
        return book_obj

    def update(self, instance, validated_data):
        instance.name = validated_data.get('name')
        instance.price = validated_data.get('price')
        instance.publish = validated_data.get('publish')
        instance.save()
        return instance

    def validate_name(self,name):
"""
相当于局部钩子,校验某一个字段
"""
        if name.startswith('s'):
            raise ValidationError('姓名不能以s开头')
        else:
            return name

    def validate(self,attrs):
"""
相当于全局钩子
"""
        # print(attrs) OrderedDict([('name', '孔乙己'), ('price', '66'), ('publish', '上海出版社')])
        if attrs.get('name') == attrs.get('publish'):
       # 假设校验条件是书名和出版社名不能一致
            raise  ValidationError('书名不能和出版社名一致')
        else:
            return attrs

标签:return,ser,self,request,校验,book,序列化,data,drf
From: https://www.cnblogs.com/zkz0206/p/17084206.html

相关文章