欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

Django REST framework视图的用法

程序员文章站 2023-11-13 19:21:22
前言 在了解了rest farmwork封装的视图类之后,我对python的面向对象有了更深刻的理解。 django resr framework框架内置的视图类充...

前言

在了解了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

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

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