基于Django实现 RESTful API 之RestFramework框架2-阿里云开发者社区

开发者社区> 开发与运维> 正文

基于Django实现 RESTful API 之RestFramework框架2

简介: 前言:上一篇关于RestFramework框架的文章介绍了APIView、解析器和序列化三个很重要的组件,这三个组件的源码执行流程可以说是RestFramework框架的核心部分,要是你完全吃透了,那先恭喜您了,接下来的组件对您来说就很简单了,顺着之前的源码思路很快就融会贯通了。

前言:上一篇关于RestFramework框架的文章介绍了APIView、解析器和序列化三个很重要的组件,这三个组件的源码执行流程可以说是RestFramework框架的核心部分,要是你完全吃透了,那先恭喜您了,接下来的组件对您来说就很简单了,顺着之前的源码思路很快就融会贯通了。好了,废话不多说,接下来继续后半成知识的学习!!!

视图组件(mixins混合继承):

1.0 - 按照我们正常的思路写视图类时应该在试图类下按照restful规范(增删改查查)写5个处理方法,如下:

url.py
    url(r'booklist/$',views.Booklist.as_view()),
    url(r'booklist/(\d+)/$',views.SBooklist.as_view())
view.py
from rest_framework.views import APIView
from app001 import models
# rest_framework重装的response
from rest_framework.response import Response
# 序列化组件的导入
from rest_framework import serializers

//book表的ModelSerializer类
class BooklistSerializer(serializers.ModelSerializer):
    class Meta:
        model = models.Book
        fields = "__all__"


//book表的查所有和post视图类
class Booklist(APIView):

    def get(self, request):
        book_obj = models.Book.objects.all()
        bs = BooklistSerializer(book_obj, many=True)
        data = bs.data  # 序列化接口
        return Response(data)

    def post(self, request):
        print(request.data)  # 静态方法:解析数据工作
        bs = BooklistSerializer(data=request.data, many=False)
        if bs.is_valid():  # 校验
            bs.save()  # create操作
            return Response(bs.data)  # 序列化数据
        else:
            return Response(bs.errors)  # 序列化错误信息

//book表的删除、修改、查单条数据的视图类
class SBooklist(APIView):

    def delete(self, request, id):
        models.Book.objects.get(pk=id).delete()
        return Response("")

    def put(self, request, id):
        book_obj = models.Book.objects.get(pk=id)
        bs = BooklistSerializer(data=request.data, instance=book_obj)
        if bs.is_valid():
            bs.save()
            return Response(bs.data)
        else:
            return Response(bs.errors)

    def get(self, request, id):
        edit_obj = models.Book.objects.get(pk=id)
        bs = BooklistSerializer(edit_obj, many=False)
        return Response(bs.data)

这样我们就写完了book表的增删改查查所有的视图处理,那看看有什么问题???看了半天发现除了代码多点之外没什么问题。。。。
这就对了,逻辑上是没有错误,但是代码多才是它的真正的问题,你想一想,现在我们实现的只是book表的操作,假如有10张20张表的话,那么我们的工作量就太大了,而且明显可以发现重复的代码太多了,这可是编程中的禁忌。
那么我们就想了,怎样简化一下我们的代码呢???

2.0 - rest_framework中的mixins的使用

我们想到的问题rest_framework的开发者早已经帮我们想到并解决了。rest_framework中的mixins已经封装好了增删改查查这5中类方法:如下:

from app001 import models

//序列化组件的导入
from rest_framework import serializers
//重装的APIView
from rest_framework.generics import GenericAPIView
from rest_framework.mixins import ListModelMixin, CreateModelMixin, UpdateModelMixin, DestroyModelMixin, \
    RetrieveModelMixin

class BooklistSerializer(serializers.ModelSerializer):
    class Meta:
        model = models.Book
        fields = "__all__"


class Booklist(ListModelMixin, CreateModelMixin, GenericAPIView):
    queryset = models.Book.objects.all()
    serializer_class = BooklistSerializer

    def get(self, request, *args, **kwargs):
        return self.list(request, *args, **kwargs)

    def post(self, request, *args, **kwargs):
        return self.create(request, *args, **kwargs)


class SBooklist(UpdateModelMixin, DestroyModelMixin, RetrieveModelMixin, GenericAPIView):
    queryset = models.Book.objects.all()
    serializer_class = BooklistSerializer

    def get(self, request, *args, **kwargs):
        return self.retrieve(request, *args, **kwargs)

    def put(self, request, *args, **kwargs):
        return self.update(request, *args, **kwargs)

    def delete(self, request, *args, **kwargs):
        return self.destroy(request, *args, **kwargs)

- ListModelMixin, CreateModelMixin, UpdateModelMixin, DestroyModelMixin, RetrieveModelMixin是restFramework封装好的增删改查查视图处理类,不用我们自己写了,直接继承过来调用就好了,

- GenericAPIView是restFramework重装的APIView类,可以很清楚的猜到它继承了APIView的同时又封装了一些新功能,新功能就是找到对应视图类下的数据变量queryset 和serializer_class,所以类下面的这两个变量的名字是固定的,不能被修改为其他!!!

看到这,有人可能就又有疑问了,这种方式看起来也不比上面的简单多少啊!!!的确,这种方式也不是很好的方式。
那我们可以想一下,用什么方式再简化代码呢?从代码中可以看到,重复性的代码还有很多,要想简化,肯定是要再次进行类的封装和继承,此处可以考虑半小时。。。。。。。。。。。

接下来我们来看看rest_framework给我们提供的很精妙的封装方法吧!!!

3.0 - rest_framework中的generics使用

generics中的ListCreateAPIView和RetrieveUpdateDestroyAPIView类将增删改查查类封装在了一起

  • url.py
url(r'booklist/$',views.Booklist.as_view()),
url(r'booklist/(?P<pk>\d+)/$',views.SBooklist.as_view())
  • view.py
from app001 import models
# 序列化组件的导入
from rest_framework import serializers
# 重装了APIView
from rest_framework import generics


class BooklistSerializer(serializers.ModelSerializer):
    class Meta:
        model = models.Book
        fields = "__all__"

class Booklist(generics.ListCreateAPIView):
    queryset = models.Book.objects.all()
    serializer_class = BooklistSerializer

class SBooklist(generics.RetrieveUpdateDestroyAPIView):
    queryset = models.Book.objects.all()
    serializer_class = BooklistSerializer

这次是不是简化了好多代码!!!它将对应的处理请求的类方法封装在了一个类中,这样当调用对应的视图处理方法时就去对应的父类中找,视图类中仅仅包含queryset和serializer_class两个各自类特有的属性。这样做就将类的共用代码通过类的继承来实现了想要的功能,提高了代码的重用性。。。。

我告诉你代码还能简化您信吗???不信看下面↓↓↓

4.0 - rest_framework中的ModelViewSet使用

  • url.py
url(r'booklist/$',views.Booklist.as_view({"get":"list","post":"create"})),
url(r'booklist/(?P<pk>\d+)/$',views.Booklist.as_view({"get":"retrieve","delete":"destroy","put":"update"}))
  • view.py
from app001 import models
# 序列化组件的导入
from rest_framework import serializers
# 重装了APIView
from rest_framework.viewsets import ModelViewSet

class BooklistSerializer(serializers.ModelSerializer):
    class Meta:
        model = models.Book
        fields = "__all__"

class Booklist(ModelViewSet):
    queryset = models.Book.objects.all()
    serializer_class = BooklistSerializer
只要这几行代码,上面的功能就都能实现了,可以说这是我见过的最绝妙的封装了!!!

但是,代码的高封装也有他的缺点,那就是代码的灵活性会越来越差,所有最简单的不一定是最适合的,根据自己的需求可以选择最合适的封装方式

接下来我们一起看看ModelViewSet类是如何实现的:


img_b7751f9f42da5691458d7f95d86c71c3.jpe
ModelViewSet.jpg

接下来一起看一下ModelViewSet源码的执行流程图:


img_5696a43bd034b1865d6fb15efcba204a.jpe
ModelViewSet.jpg

附带一张Django REST Framework View的图谱:

img_962b7061d063bd9e63c3c7b7551de59c.png
restframework的view图谱.png

到这,视图组件就完美收官了!!!

版权声明:本文内容由阿里云实名注册用户自发贡献,版权归原作者所有,阿里云开发者社区不拥有其著作权,亦不承担相应法律责任。具体规则请查看《阿里云开发者社区用户服务协议》和《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容,填写侵权投诉表单进行举报,一经查实,本社区将立刻删除涉嫌侵权内容。

分享:
开发与运维
使用钉钉扫一扫加入圈子
+ 订阅

集结各类场景实战经验,助你开发运维畅行无忧

其他文章