Django REST framework视图的用法


Posted in Python onJanuary 16, 2019

前言

在了解了REST farmwork封装的视图类之后,我对python的面向对象有了更深刻的理解。

Django RESR framework框架内置的视图类充分发挥了面向对象封装与继承的特性。

自己写一个类似于DRF内置视图类的功能

实现一个图书出版社的增、删、改、查、查功能,两个查一个是查所有出版社,一个是查具体的某一个出版社。

首先是一个简略的表结构设计models.py:

from django.db import models

class Publisher(models.Model):
  name = models.CharField(max_length=16)

  def __str__(self):
    return self.name


class Author(models.Model):
  name = models.CharField(max_length=16)

  def __str__(self):
    return self.name


class Book(models.Model):
  title = models.CharField(max_length=32)
  CHOICES = ((1, 'Python'), (2, 'Go'), (3, 'Linux'))
  category = models.IntegerField(choices=CHOICES)
  pub_date = models.DateField()
  publisher = models.ForeignKey(to='Publisher', on_delete=models.CASCADE)
  authors = models.ManyToManyField(to='Author')

  def __str__(self):
    return self.title

然后是路由url:

将用到pk,与不用到pk的路由业务区分开

from django.contrib import admin
from django.urls import path, re_path
from bms import views

urlpatterns = [
  path('admin/', admin.site.urls),
  # 查所有对象,与添加对象
  re_path(r'publishers/$', views.PublisherView.as_view()),
  # 带pk查询具体某一条数据
  re_path(r'publishers/(?P<pk>\d+)/$', views.PublisherDetailView.as_view()), # 出版社详情
]

再到序列化类,自创建的serializers.py

这里我省略了新增需要重写的create方法和更新需要重写的update方法。

from bms import models
from rest_framework import serializers


class PublisherModelSerializer(serializers.ModelSerializer):
  class Meta:
    model = models.Publisher
    fields = "__all__"


class AuthorModelSerializer(serializers.ModelSerializer):
  class Meta:
    model = models.Author
    fields = "__all__"

最后视图views.py

from bms import models
from rest_framework.views import APIView
from rest_framework.response import Response
from bms.serializers import PublisherModelSerializer


##################### 面向对象,手动实现REST framework视图功能##################
class GenericView(APIView):
  '''公用类'''
  queryset = None
  serializer_class = None

  def get_queryset(self):
    # 让每一次请求来的时候都现查一次数据
    print('GeneriView------',self)
    return self.queryset.all()

  def get_object(self, request, pk):
    # 获取具体queryset
    return self.get_queryset().filter(pk=pk)

class ListMixin(object):
  # mixi.n 混合类,不能单独使用,利用python支持多继承
  def get(self, request):
    print('ListMixin------------', self)
    queryset = self.get_queryset()
    ser_obj = self.serializer_class(queryset, many=True)
    return Response(ser_obj.data)


class CreateMixin(object):
  def post(self, request):
    ser_obj = self.serializer_class(data=request.data)
    if ser_obj.is_valid():
      ser_obj.save()
      return Response("ok")
    else:
      return Response(ser_obj.errors)


class RetrieveMixin(object):
  """ 获取具体某一条记录"""
  def retrieve(self, request, pk):
    '''将此get方法与ListMixin中的get方法区分'''
    obj = self.get_object(request, pk).first()
    if obj:
      ser_obj = self.serializer_class(obj)
      return Response(ser_obj.data)
    else:
      return Response("无效的id")


class UpdateMixin(object):
  def put(self, request, pk):
    obj = self.get_object(request, pk).first()
    if obj:
      ser_obj = self.serializer_class(instance=obj, data=request.data, partial=True)
      if ser_obj.is_valid():
        ser_obj.save()
        return Response(ser_obj.data)
      else:
        return Response(ser_obj.errors)
    else:
      return Response("无效的id")


class DestroyMixin(object):
  def delete(self, request, pk):
    obj = self.get_object(request, pk)
    if obj:
      obj.delete()
      return Response("删除成功")
    else:
      return Response("无效的id")


class RetrieveView(GenericView, RetrieveMixin):
  '''因两个get方法相冲图,在此曲线访问查询具体对象的get方法'''
  def get(self, request, pk):
    return self.retrieve(request, pk)


# 出版社
class PublisherView(GenericView, ListMixin, CreateMixin):
  '''查所有出版社,增加出版社'''
  # 只用写配置项
  queryset = models.Publisher.objects.all()
  serializer_class = PublisherModelSerializer


class PublisherDetailView(RetrieveView, UpdateMixin, DestroyMixin):
  '''查询具体某一出版社,编辑,删除'''
  queryset = models.Publisher.objects.all()
  serializer_class = PublisherModelSerializer

这样写就实现了简单的增删改查查功能,而且用对象封装,如果要添加其他表的查询,只需要简单的6行代码就可以实现;

比如:实现作者的增删改查查

# 作者
class AuthorListView(ListCreateAPIView):
  queryset = models.Author.objects.all()
  serializer_class = AuthorModelSerializer


class AuthorDetailView(RetrieveUpdateDestroyAPIView):
  queryset = models.Author.objects.all()
  serializer_class = AuthorModelSerializer

利用面向对象的封装与继承极大地简化了代码,减少了代码冗余。

但我们自己写的功能不够全面,不够严谨,Django REST framework 给我们封装了内置的视图类ModelViewSet。

Django REST framework 视图组件

视图组件是用来优化接口逻辑的

首先看看ModelViewSet

Django REST framework视图的用法

就是继承了5个混合类和一个公共类。

mixins.py中就是那五个类,封装了增删改查查 5个方法,还有其他严谨功能的方法,结构与上面实现的类似

而使用这个视图类就更简单了,一张表只需要一个类

Django REST framework视图的用法

from rest_framework.viewsets import ModelViewSet
class AuthorViewSet(ModelViewSet):
  """
    内部封装了这五个方法
    list()
    create()
    retrieve()
    update()
    destroy()

  """
  queryset = models.Author.objects.all()
  serializer_class = AuthorModelSerializer

因内置类中封装的方法与请求方式的名并不一样

list()   对应查询所有对象的get方法

create()   对应添加的post方法

retrieve()  对应查询具体对像的get方法

update()   对应更新对象的put方法

destroy()   对应删除delete 方法

所以url要设置 actions 让它们一一对应

urlpatterns = [
  path('admin/', admin.site.urls),
  # 查所有对象,与添加对象
  re_path(r'publishers/$', views.PublisherView.as_view()),
  # 带pk查询具体某一条数据
  re_path(r'publishers/(?P<pk>\d+)/$', views.PublisherDetailView.as_view()), # 出版社详情

  re_path(r'authors/$', views.AuthorViewSet.as_view(actions={'get': 'list', 'post': 'create'})), # 作者列表
  re_path(r'authors/(?P<pk>\d+)/$', views.AuthorViewSet.as_view(
    actions={'get': 'retrieve', 'put': 'update', 'delete': 'destroy'})
    ), # 作者详情
]

并且REST framework还封装了路由类,上面关于authors的路由还可以这样写

from rest_framework.routers import DefaultRouter

router = DefaultRouter()
router.register('authors', views.AuthorViewSet)

urlpatterns += router.urls

不过这样写路由,业务关系不清晰,一般用的少。

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持三水点靠木。

Python 相关文章推荐
Python中字典的基本知识初步介绍
May 21 Python
python 对象和json互相转换方法
Mar 22 Python
基于anaconda下强大的conda命令介绍
Jun 11 Python
Python爬虫框架Scrapy基本用法入门教程
Jul 26 Python
Django web框架使用url path name详解
Apr 29 Python
python反转列表的三种方式解析
Nov 08 Python
tensorflow通过模型文件,使用tensorboard查看其模型图Graph方式
Jan 23 Python
运行tensorflow python程序,限制对GPU和CPU的占用操作
Feb 06 Python
python随机模块random使用方法详解
Feb 14 Python
Python数据可视化实现多种图例代码详解
Jul 14 Python
Python实现http接口自动化测试的示例代码
Oct 09 Python
python如何为list实现find方法
May 30 Python
Pycharm+Scrapy安装并且初始化项目的方法
Jan 15 #Python
PyCharm 设置SciView工具窗口的方法
Jan 15 #Python
Python设计模式之抽象工厂模式原理与用法详解
Jan 15 #Python
用Pycharm实现鼠标滚轮控制字体大小的方法
Jan 15 #Python
解决在pycharm中显示额外的 figure 窗口问题
Jan 15 #Python
python调用opencv实现猫脸检测功能
Jan 15 #Python
python可视化实现代码
Jan 15 #Python
You might like
AJAX for PHP简单表数据查询实例
2007/01/02 PHP
PHP语法速查表
2007/01/02 PHP
php 表单验证实现代码
2009/03/10 PHP
PHP学习笔记之字符串编码的转换和判断
2014/05/22 PHP
Chrome Web App开发小结
2014/09/04 PHP
基于jquery实现的一个选择中国大学的弹框 (数据、步骤、代码)
2012/07/26 Javascript
JS中使用mailto实现将用户在网页中输入的内容传递到本地邮件客户端
2016/10/08 Javascript
浅谈js算法和流程控制
2016/12/29 Javascript
jquery实现拖动效果(代码分享)
2017/01/25 Javascript
JS实现的数字格式化功能示例
2017/02/10 Javascript
jquery实现自适应banner焦点图
2017/02/16 Javascript
基于Angular.js实现的触摸滑动动画实例代码
2017/02/19 Javascript
详解Angular调试技巧之报错404(not found)
2018/01/31 Javascript
js获取html页面代码中图片地址的实现代码
2018/03/05 Javascript
Node.js模块全局安装路径配置方法
2018/05/17 Javascript
vue项目打包部署到服务器的方法示例
2018/08/27 Javascript
详解Axios 如何取消已发送的请求
2018/10/20 Javascript
[01:10:48]完美世界DOTA2联赛PWL S2 GXR vs PXG 第一场 11.18
2020/11/18 DOTA
深入理解Python 关于supper 的 用法和原理
2018/02/28 Python
在pandas中一次性删除dataframe的多个列方法
2018/04/10 Python
python画双y轴图像的示例代码
2019/07/07 Python
Python注释、分支结构、循环结构、伪“选择结构”用法实例分析
2020/01/09 Python
Python学习之路安装pycharm的教程详解
2020/06/17 Python
PyTorch的torch.cat用法
2020/06/28 Python
Python3+Flask安装使用教程详解
2021/02/16 Python
切尔西足球俱乐部官方网上商店:Chelsea FC
2019/06/17 全球购物
说出你对remoting 和webservice的理解和应用
2014/06/08 面试题
初中生学习的自我评价
2013/11/14 职场文书
军训 自我鉴定
2014/02/03 职场文书
餐厅感恩节活动策划方案
2014/10/11 职场文书
我的中国梦主题教育活动总结
2015/05/07 职场文书
火烧圆明园的观后感
2015/06/03 职场文书
2016年中学端午节主题活动总结
2016/04/01 职场文书
Python 制作自动化翻译工具
2021/04/25 Python
python实现Nao机器人的单目测距
2021/09/04 Python
Java8 CompletableFuture 异步回调
2022/04/28 Java/Android