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

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

相关文章
|
6月前
|
缓存 安全 API
RESTful与GraphQL:电商API接口设计的技术细节与适用场景
本文对比了RESTful与GraphQL这两种主流电商API接口设计方案。RESTful通过资源与HTTP方法定义操作,简单直观但可能引发过度或欠获取数据问题;GraphQL允许客户端精确指定所需字段,提高灵活性和传输效率,但面临深度查询攻击等安全挑战。从性能、灵活性、安全性及适用场景多维度分析,RESTful适合资源导向场景,GraphQL则适用于复杂数据需求。实际开发中需根据业务特点选择合适方案,或结合两者优势,以优化用户体验与系统性能。
|
6月前
|
JSON 编解码 API
Go语言网络编程:使用 net/http 构建 RESTful API
本章介绍如何使用 Go 语言的 `net/http` 标准库构建 RESTful API。内容涵盖 RESTful API 的基本概念及规范,包括 GET、POST、PUT 和 DELETE 方法的实现。通过定义用户数据结构和模拟数据库,逐步实现获取用户列表、创建用户、更新用户、删除用户的 HTTP 路由处理函数。同时提供辅助函数用于路径参数解析,并展示如何设置路由器启动服务。最后通过 curl 或 Postman 测试接口功能。章节总结了路由分发、JSON 编解码、方法区分、并发安全管理和路径参数解析等关键点,为更复杂需求推荐第三方框架如 Gin、Echo 和 Chi。
|
监控 安全 测试技术
Django框架的表单验证和过滤机制是否可以应对复杂的安全场景?
综上所述,Django 框架的表单验证和过滤机制在一定程度上可以应对复杂的安全场景,但需要综合运用多种手段来进一步提升安全性,以适应不断变化的安全挑战。
383 159
|
数据采集 中间件 Python
如何在Django框架中进行输入验证和过滤?
通过综合运用这些方法,可以在 Django 框架中有效地进行输入验证和过滤,提高应用的安全性和数据质量。同时,还可以根据具体的业务需求进一步扩展和定制验证逻辑。
459 158
|
11月前
|
存储 SQL 数据采集
Django框架的表单验证和过滤机制的原理是什么?
Django框架的表单验证和过滤机制的原理是什么?
255 73
|
9月前
|
XML JSON API
Understanding RESTful API and Web Services: Key Differences and Use Cases
在现代软件开发中,RESTful API和Web服务均用于实现系统间通信,但各有特点。RESTful API遵循REST原则,主要使用HTTP/HTTPS协议,数据格式多为JSON或XML,适用于无状态通信;而Web服务包括SOAP和REST,常用于基于网络的API,采用标准化方法如WSDL或OpenAPI。理解两者区别有助于选择适合应用需求的解决方案,构建高效、可扩展的应用程序。
|
9月前
|
机器学习/深度学习 设计模式 API
Python 高级编程与实战:构建 RESTful API
本文深入探讨了使用 Python 构建 RESTful API 的方法,涵盖 Flask、Django REST Framework 和 FastAPI 三个主流框架。通过实战项目示例,详细讲解了如何处理 GET、POST 请求,并返回相应数据。学习这些技术将帮助你掌握构建高效、可靠的 Web API。
|
开发框架 搜索推荐 数据可视化
Django框架适合开发哪种类型的Web应用程序?
Django 框架凭借其强大的功能、稳定性和可扩展性,几乎可以适应各种类型的 Web 应用程序开发需求。无论是简单的网站还是复杂的企业级系统,Django 都能提供可靠的支持,帮助开发者快速构建高质量的应用。同时,其活跃的社区和丰富的资源也为开发者在项目实施过程中提供了有力的保障。
555 67
|
搜索推荐 API 开发者
Django框架和Flask框架的适用场景分别是什么?
总体而言,Django 更适合需要全面功能和大规模开发的场景,而 Flask 则更适合灵活性要求高、小型项目或特定需求的开发。当然,具体的选择还应根据项目的具体情况、团队的技术能力和偏好等因素来综合考虑。在实际应用中,开发者可以根据项目的特点和需求,灵活选择使用这两个框架,或者结合它们的优势来构建更强大的 Web 应用程序。
458 64
|
JSON 缓存 JavaScript
深入浅出:使用Node.js构建RESTful API
在这个数字时代,API已成为软件开发的基石之一。本文旨在引导初学者通过Node.js和Express框架快速搭建一个功能完备的RESTful API。我们将从零开始,逐步深入,不仅涉及代码编写,还包括设计原则、最佳实践及调试技巧。无论你是初探后端开发,还是希望扩展你的技术栈,这篇文章都将是你的理想指南。