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

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

相关文章
|
3天前
|
JSON 前端开发 API
打造高效后端:RESTful API 设计的最佳实践
【9月更文挑战第14天】在数字化时代,后端开发是构建强大、灵活和可维护应用程序的基石。本文将深入探讨如何设计高效的RESTful API,包括清晰的资源定义、合理的HTTP方法使用、URL结构规划、状态码的准确返回以及数据格式的设计。通过这些实践,开发者能够创建出既符合行业标准又易于维护和扩展的API,为前端提供强大的数据支持,确保整个应用的稳定性和性能。
137 74
|
6天前
|
Go API 开发者
深入探讨:使用Go语言构建高性能RESTful API服务
在本文中,我们将探索Go语言在构建高效、可靠的RESTful API服务中的独特优势。通过实际案例分析,我们将展示Go如何通过其并发模型、简洁的语法和内置的http包,成为现代后端服务开发的有力工具。
|
5天前
|
JSON API 数据库
使用Python和Flask构建简单的RESTful API
使用Python和Flask构建简单的RESTful API
13 6
|
8天前
|
设计模式 测试技术 API
Micronaut魔法书:揭秘构建超光速RESTful API的绝密技术!
【9月更文挑战第10天】在现代Web开发中,构建RESTful API至关重要。Micronaut作为一款轻量级框架,能够快速创建高效API。本文探讨使用Micronaut构建RESTful API的最佳设计模式与实践,涵盖注解(如`@Controller`、`@Get`)、代码组织、REST原则、数据验证及测试等方面,帮助开发者构建结构清晰、可维护性强的API服务。示例代码展示了如何使用Micronaut实现用户管理API,强调了良好设计模式的重要性。
22 3
|
12天前
|
XML JSON 缓存
探索后端开发中的RESTful API设计原则
【9月更文挑战第5天】在数字化时代的浪潮中,后端开发扮演着支撑整个互联网世界运行的基石角色。而作为连接前端与后端桥梁的RESTful API,其设计质量直接影响到应用的性能和用户体验。本文将深入探讨RESTful API的设计原则,通过浅显易懂的语言和实际代码示例,引导读者理解如何构建高效、易于维护的API。无论你是初学者还是有经验的开发者,这篇文章都将为你提供新的视角和思考。
|
13天前
|
前端开发 API 数据安全/隐私保护
打造高效后端API:RESTful设计原则与实践
【9月更文挑战第4天】在数字化时代的浪潮中,后端API作为连接数据和前端的桥梁,其设计质量直接影响着应用的性能和扩展性。本文将深入探讨RESTful API的设计哲学、核心原则以及如何在实际开发中应用这些原则来构建一个高效、易于维护的后端系统。我们将通过代码示例,揭示如何将理论转化为实践,从而为开发者提供一条清晰的道路,去创造那些能够在不断变化的技术环境中茁壮成长的API。
|
12天前
|
缓存 Java 应用服务中间件
随着微服务架构的兴起,Spring Boot凭借其快速开发和易部署的特点,成为构建RESTful API的首选框架
【9月更文挑战第6天】随着微服务架构的兴起,Spring Boot凭借其快速开发和易部署的特点,成为构建RESTful API的首选框架。Nginx作为高性能的HTTP反向代理服务器,常用于前端负载均衡,提升应用的可用性和响应速度。本文详细介绍如何通过合理配置实现Spring Boot与Nginx的高效协同工作,包括负载均衡策略、静态资源缓存、数据压缩传输及Spring Boot内部优化(如线程池配置、缓存策略等)。通过这些方法,开发者可以显著提升系统的整体性能,打造高性能、高可用的Web应用。
40 2
|
14天前
|
JSON 算法 安全
探索RESTful API设计的最佳实践
【9月更文挑战第2天】在数字化时代的浪潮中,后端开发如同搭建一座桥梁,连接着用户与数据的无限可能。本文将深入探讨如何打造高效、可维护的RESTful API,从资源命名到状态码的巧妙运用,每一个细节都隐藏着提升用户体验的智慧。你将学会如何在浩瀚的代码海洋中,用简洁明了的设计原则,引领用户安全抵达数据的彼岸。让我们一起启航,探索API设计的奥秘,让后端开发成为艺术与科学的完美结合。
|
2月前
|
机器学习/深度学习 API iOS开发
探索iOS开发中的SwiftUI框架深入理解RESTful API设计原则与最佳实践
【7月更文挑战第30天】本文深入探讨了SwiftUI框架在iOS开发中的应用,分析了其对用户界面构建的简化方法及性能优化。通过比较传统UI构建方式与SwiftUI的差异,揭示了SwiftUI如何提高开发效率和用户体验。文章还讨论了SwiftUI在实际项目中的集成策略,并展望了其未来的发展方向。 【7月更文挑战第30天】在数字时代的浪潮中,RESTful API如同一座桥梁,连接着不同的软件系统。本文将探讨RESTful API的核心设计原则,揭示其背后的哲学思想,并通过实例分析展示如何将这些原则应用于实际开发中。我们将从资源定位、接口一致性到HTTP方法的恰当使用,逐一剖析,旨在为开发者提供
48 1
|
21天前
|
SQL 安全 API
数字堡垒之下:网络安全漏洞、加密技术与安全意识的博弈探索RESTful API设计的最佳实践
【8月更文挑战第27天】在数字化浪潮中,网络安全成为守护个人隐私与企业资产的关键防线。本文深入探讨了网络漏洞的成因与影响,分析了加密技术如何为数据保驾护航,并强调了提升公众的安全意识对于构建坚固的信息防御系统的重要性。文章旨在为读者提供一场思维的盛宴,启发更多关于如何在日益复杂的网络世界中保护自己的思考。