Django REST Framework中的序列化器类和视图类

张春  金牌会员 | 2025-3-15 07:22:46 | 显示全部楼层 | 阅读模式
打印 上一主题 下一主题

主题 989|帖子 989|积分 2967

序列化器类

一、Serializer序列化类

Serializer是DRF的序列化器基类,提供基本功能,使用Serializer类需要本身定义字段名称和类型。
  1. BookSerializer(Serializer):
  2.         name = serializers.CharField()
  3.         price = serlializers.IntegerField()
  4.         date = serlializers.DateField()
复制代码
Serializer序列化器类初始化的时候的几个参数阐明:
instance这个指从数据库中读取的记载对应的对象,用于表现大概编辑中的现有
many如果是true,则指通报了多个对象
data用于收集通过post传上来的字典,用于新增大概编辑中的更新
Serializer序列化器提供了一个.save()接口用于生存数据,这个函数里面通过判断instance是否有值来确定是新增还是更新,如果有值则调用self.update(),如果没有值则调用self.create(),这两个方法需要本身实现,以满意用户的新增大概修改的逻辑。
  1. self.create(self, validated_data)
  2. self.update(self, instance, validated_data)
复制代码
实现了这两个方法后,在客户类里面需要新增大概生存的时候,只需统一的调用serializer.save()就可以了。
二、ModelSerializer类

使用ModelSerializer类,就不用再本身定义字段名称和类型了,直接给出模型名称,指出需要序列化的字段即可。
  1. BookSerializer(ModelSerlizer):
  2.         class Meta:
  3.                 model        = Book
  4.                 fields        = [“name”, “date”] # 这里可以自己定义需要的字段,__all__表示所有字段,也可以自己定义字段名称
复制代码
使用ModelSerlializer类也不需要再本身定义create()和update()方法了,ModelSerlializer类已经实现了这两个函数的定义。
视图类

django里面的视图实际上是业务逻辑存放的地方,也就是“功能”,并不是页面样式。
而业务的功能无非就是这5种:增、删、改、查(列表)、查(详情)
DRF里面提供了三大类的类:API、mixin、ViewSet,API类的类提供接口(get、post、put、update、delete),mixin提供功能,ViewSet负责包装。
一、CBV视图,基于类的视图

django的原生视图是基于函数的,也就是FBV。CBV是基于类的,继承自View类。View类中有两个紧张的函数:
  1. View.dispatch()
  2. View.as_view()
复制代码
在View.as_view()函数中,又定义了一个子函数view(),as_view()会返回这个函数。在基于函数(FBV)的视图模式中,urls.py文件中指向的就是函数,而在基于类的视图(CBV)中,urls.py文件中指向的是类的as_view()函数,注意这里是加了括号的,就是说是要直接执行这个函数的,而这个函数的执行效果,是里面的子函数vews()。子view()函数会调用View.dispatch()函数,用于通过反射,指向在客户类中定义的get(),post(),put(),delete()等http方法的函数。
提示:CBV相对于FBV,改变了函数的组织形式,FBV是本身定义函数,通过路径找到该函数。CBV是统一使用http的method,用过method名称(get、post、put、update、delete),找到以该名称定义的函数,实现增删改查查。这也就是RESTFul。
二、APIView

APIView(View)类中也定义了以下两个函数:
  1. APIView.dispatch()
  2. APIView.as_view()
复制代码
其中,as_view()函数调用了csrf_exempt()函数用来处理跨域哀求
使用APIView类也需要本身定义:get(),post(),put(),delete()等http方法函数。
相比django原生的CBV,这里的dispatch()函数包装了request,提供了一个用于API的强大的request。另外还初始化了三个底子功能:认证、权限、限流
提示:相对于基本CBV,APIView定制了request,专门用于API应用。另外还调用了三个底子功能:认证、权限、限流。
三、通用视图类GenericAPIView

通用视图类GenericAPIView(APIView)
引入了两个变量:
queryset表示数据集
serializer_class 表示序列化器类
get、post、put、delete等函数还需要有
提示:
1、这个类需要配合其他类,通过多继承的方式使用。
2、有了数据集和序列化器类,我们还需要操纵这些数据的方法:get、post、put…,下面的mixin系类分别定义了这些方法。以便根据本身的需求组合使用。
四、mixin混合类

mixins 是一种代码复用机制,允许我们将多个组件共享的逻辑提取到一个独立的对象中,从而提高代码的可维护性和重用性。
这里新增了以下几个类:CreateModelMixin、ListModelMixin、RetrieveModelMixin、UpdateModelMixin、DestroyModelMixin,每一个类里面只实现了类名称种的方法。注意这里的5个方法和增删改查查中的5个方法名称差别等,需要在定义一下增删改查查方法,然后只需要在详细方法内返回对应的mixin方法即可。
比方,CreateModelMixin类实现了create方法,可以实现对数据库的增长操纵
ListModelMixin类实现了list方法,可以实现对数据库的查询操纵
RetrieveModelMixin类实现了retrieve方法,可以实现对数据库的查询操纵
UpdateModelMixin类实现了update方法,可以实现对数据库的修改操纵
DestroyModelMixin类实现了destroy方法,可以实现对数据库的删除操纵
使用方法:在视图类中继承GenericAPIView类和以上几个类,然后在视图类中定义queryset和serializer_class属性
最后在urls.py中设置路径
比方:
urls.py
  1. urlpatterns = [
  2.         path('houseku/', HouseKuList.as_view()),
  3. ]
复制代码
views.py
  1. class HouseKuList(generics.ListCreateAPIView, generics.GenericAPIView):
  2.         queryset = HouseKu.objects.all()
  3.         serializer_class = HouseKuSerializer
  4.         # 这里还要写get、post、delete等函数,用于对应Mixin里面的list、create等
  5.         def get(self, request):
  6.                 return self.list(request)
  7.         def post(self, request):
  8.                 return self.create(request)
复制代码
提示:GenericAPIView提供了queryset、serializer_class,mixin混合类提供了方法(但这些方法不对应的method名称)这两个组合在一起,就实现了相应的功能。
五、Mixin再封装,优化后的APIView

Mixin里面实现了list、create等方法,但是并没有对应http的method,DRF实现了进一步封装,创造了以下类:
ListCreateAPIView、RetrieveUpdateDestroyAPIView、ListAPIView、CreateAPIView、RetrieveAPIView、UpdateAPIView、DestroyAPIView
注意这里面没有mixin,而有API,通过继承这些类,可以实现对应的http方法:get、post、put、delete等,到这里,我们的客户类就不需要再写get、post、put、delete等方法了
  1. class HouseKuViewSet(generics.ListCreateAPIView, generics.GenericAPIView):
  2.    queryset = HouseKu.objects.all()
  3.    serializer_class = HouseKuSerializer
复制代码
提示:这里,***APIView已经封装了method对应名称的方法,组合起来,再配合GenericAPIView,只要提供queryset和serializer_class,就实现了所有的功能。
六、ViewSet

到这里,就不用再写两个(BookView用户列表,BookDetailView用于详细)自定义的类了。可以合二为一,然后在urls.py里面as_view的参数里,把put、post、delete等method自定义的函数关联起来就可以了。
ViewSet(ViewSetMixin, views.APIView)
ViewSetMixin里面的as_view()方法可以加参数,用于指定method方法到自定义方法的映射。
  1. path(“book/”, views.BookView.as_view({“get”:”get_all”, “post”:”add_object”})
  2. path(“book/(?P<pk>\d+)”,views.BookView.as_view({“get”:”get_object”, “delete”:”delete_object”, “put”:”update_object”})
复制代码
七、示例

APIView

urls.py
  1. urlpatterns = [
  2.         path('user/', views.UserView.as_view()),
  3.         path('user/<int:pk>/', views.UserDetailView.as_view()),
  4. ]
复制代码
views.py
  1. from rest_framework.views import APIView
  2. class UserView(APIView):
  3.     def get(self, request):
  4.         users = User.objects.all()
  5.         serializer = UserSerializer(users, many=True)
  6.         return Response(serializer.data)
  7.     def post(self, request):
  8.         serializer = UserSerializer(data=request.data)
  9.         if serializer.is_valid():
  10.             serializer.save()
  11.             return Response(serializer.data, status=201)
  12.         return Response(serializer.errors, status=400)
  13.         
  14. class UserDetailView(APIView):
  15.     def get(self, request, pk):
  16.         user = User.objects.get(pk=pk)
  17.         serializer = UserSerializer(user)
  18.         return Response(serializer.data)
  19.     def put(self, request, pk):
  20.         user = User.objects.get(pk=pk)
  21.         serializer = UserSerializer(user, data=request.data)
  22.         if serializer.is_valid():
  23.             serializer.save()
  24.             return Response(serializer.data)
  25.         return Response(serializer.errors, status=400)
  26.     def delete(self, request, pk):
  27.         user = User.objects.get(pk=pk)
  28.         user.delete()
  29.         return Response(status=204)
复制代码
GenericAPIView

需配合一系列的Mixin来使用
urls.py
  1. urlpatterns = [
  2.         path('mixin/user/', views.UserMixinView.as_view()),
  3.         path('mixin/user/<int:pk>/', views.UserMixinDetailView.as_view()),
  4. ]
复制代码
views.py
  1. class UserMixinView(mixins.ListModelMixin,
  2.                     mixins.CreateModelMixin,
  3.                     generics.GenericAPIView):
  4.     queryset = User.objects.all()
  5.     serializer_class = UserSerializer
  6.     def get(self, request, *args, **kwargs):
  7.         return self.list(request, *args, **kwargs)
  8.     def post(self, request, *args, **kwargs):
  9.         return self.create(request, *args, **kwargs)
  10. class UserMixinDetailView(mixins.RetrieveModelMixin,
  11.                           mixins.UpdateModelMixin,
  12.                           mixins.DestroyModelMixin,
  13.                           generics.GenericAPIView):
  14.     queryset = User.objects.all()
  15.     serializer_class = UserSerializer
  16.     def get(self, request, *args, **kwargs):
  17.         return self.retrieve(request, *args, **kwargs)
  18.     def put(self, request, *args, **kwargs):
  19.         return self.update(request, *args, **kwargs)
  20.     def delete(self, request, *args, **kwargs):
  21.         return self.destroy(request, *args, **kwargs)
复制代码
ListCreateAPIView、RetrieveUpdateDestroyApiView

urls.py
  1. urlpatterns = [
  2.         path('generic/user/', views.UserGenericView.as_view()),
  3.         path('generic/user/<int:pk>/', views.UserGenericDetailView.as_view()),
  4. ]
复制代码
views.py
  1. class UserGenericView(generics.ListCreateAPIView):
  2.     queryset = User.objects.all()
  3.     serializer_class = UserSerializer
  4. class UserGenericDetailView(generics.RetrieveUpdateDestroyAPIView):
  5.     queryset = User.objects.all()
  6.     serializer_class = UserSerializer
复制代码
ViewSet

urls.py
  1. urlpatterns = [
  2.         path('viewset/user/', views.UserViewSet.as_view({'get': 'list', 'post': 'create'})),
  3.         path('viewset/user/<int:pk>/', views.UserViewSet.as_view({'get': 'retrieve', 'put': 'update', 'delete': 'destroy'})),
  4. ]
复制代码
到这里,已经将两个类合二为一了,最简洁,但是也最不灵活,得当用于不添加任何本身逻辑的增删改查查
views.py
  1. class UserViewSet(viewsets.ModelViewSet):
  2.     queryset = User.objects.all()
  3.     serializer_class = UserSerializer
复制代码
免责声明:如果侵犯了您的权益,请联系站长,我们会及时删除侵权内容,谢谢合作!更多信息从访问主页:qidao123.com:ToB企服之家,中国第一个企服评测及商务社交产业平台。
回复

使用道具 举报

0 个回复

倒序浏览

快速回复

您需要登录后才可以回帖 登录 or 立即注册

本版积分规则

张春

金牌会员
这个人很懒什么都没写!
快速回复 返回顶部 返回列表