基于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

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

相关文章
|
22天前
|
API 数据库 数据安全/隐私保护
利用Django框架构建高效后端API服务
本文将介绍如何利用Django框架构建高效的后端API服务。通过深入分析Django框架的特性和优势,结合实际案例,探讨了如何利用Django提供的强大功能来构建高性能、可扩展的后端服务。同时,还对Django框架在后端开发中的一些常见问题进行了解决方案的探讨,并提出了一些建设性的建议。
37 3
|
7天前
|
安全 数据库 C++
Python Web框架比较:Django vs Flask vs Pyramid
【4月更文挑战第9天】本文对比了Python三大Web框架Django、Flask和Pyramid。Django功能全面,适合快速开发,但学习曲线较陡;Flask轻量灵活,易于入门,但默认配置简单,需自行添加功能;Pyramid兼顾灵活性和可扩展性,适合不同规模项目,但社区及资源相对较少。选择框架应考虑项目需求和开发者偏好。
|
1天前
|
安全 Java API
RESTful API设计与实现:Java后台开发指南
【4月更文挑战第15天】本文介绍了如何使用Java开发RESTful API,重点是Spring Boot框架和Spring MVC。遵循无状态、统一接口、资源标识和JSON数据格式的设计原则,通过创建控制器处理HTTP请求,如示例中的用户管理操作。此外,文章还提及数据绑定、验证、异常处理和跨域支持。最后,提出了版本控制、安全性、文档测试以及限流和缓存的最佳实践,以确保API的稳定、安全和高效。
|
4天前
|
设计模式 存储 数据库
框架分析(5)-Django
框架分析(5)-Django
|
13天前
|
前端开发 Java API
构建RESTful API:Java中的RESTful服务开发
【4月更文挑战第3天】本文介绍了在Java环境中构建RESTful API的重要性及方法。遵循REST原则,利用HTTP方法处理资源,实现CRUD操作。在Java中,常用框架如Spring MVC简化了RESTful服务开发,包括定义资源、设计表示层、实现CRUD、考虑安全性、文档和测试。通过Spring MVC示例展示了创建RESTful服务的步骤,强调了其在现代Web服务开发中的关键角色,有助于提升互操作性和用户体验。
构建RESTful API:Java中的RESTful服务开发
|
17天前
|
XML JSON 安全
谈谈你对RESTful API设计的理解和实践。
RESTful API是基于HTTP协议的接口设计,通过URI标识资源,利用GET、POST、PUT、DELETE等方法操作资源。设计注重无状态、一致性、分层、错误处理、版本控制、文档、安全和测试,确保易用、可扩展和安全。例如,`/users/{id}`用于用户管理,使用JSON或XML交换数据,提升系统互操作性和可维护性。
14 4
|
26天前
|
缓存 前端开发 API
构建高效可扩展的RESTful API:后端开发的最佳实践
【2月更文挑战第30天】 在现代Web应用和服务端架构中,RESTful API已成为连接前端与后端、实现服务间通信的重要接口。本文将探讨构建一个高效且可扩展的RESTful API的关键步骤和最佳实践,包括设计原则、性能优化、安全性考虑以及错误处理机制。通过这些实践,开发者可以确保API的健壮性、易用性和未来的可维护性。
|
27天前
|
API 开发者 UED
深入探讨RESTful API设计原则及最佳实践
在当今互联网时代,RESTful API已成为各种软件系统之间进行通信的重要方式。本文将从资源定义、URI设计、HTTP方法选择、状态码规范等方面深入探讨RESTful API设计的原则与最佳实践,帮助开发者更好地构建高效、健壮的API。
|
7天前
|
缓存 前端开发 API
API接口封装系列
API(Application Programming Interface)接口封装是将系统内部的功能封装成可复用的程序接口并向外部提供,以便其他系统调用和使用这些功能,通过这种方式实现系统之间的通信和协作。下面将介绍API接口封装的一些关键步骤和注意事项。
|
14天前
|
监控 前端开发 JavaScript
实战篇:商品API接口在跨平台销售中的有效运用与案例解析
随着电子商务的蓬勃发展,企业为了扩大市场覆盖面,经常需要在多个在线平台上展示和销售产品。然而,手工管理多个平台的库存、价格、商品描述等信息既耗时又容易出错。商品API接口在这一背景下显得尤为重要,它能够帮助企业在不同的销售平台之间实现商品信息的高效同步和管理。本文将通过具体的淘宝API接口使用案例,展示如何在跨平台销售中有效利用商品API接口,以及如何通过代码实现数据的统一管理。