Django REST framework視圖的用法

更新時間：2019年01月16日 08:18:44 作者：REST_清風(fēng)

這篇文章主要介紹了Django REST framework 視圖，小編覺得挺不錯的，現(xiàn)在分享給大家，也給大家做個參考。一起跟隨小編過來看看吧

前言

在了解了REST farmwork封裝的視圖類之后，我對python的面向?qū)ο笥辛烁羁痰睦斫狻?/p>

Django RESR framework框架內(nèi)置的視圖類充分發(fā)揮了面向?qū)ο蠓庋b與繼承的特性。

自己寫一個類似于DRF內(nèi)置視圖類的功能

實現(xiàn)一個圖書出版社的增、刪、改、查、查功能，兩個查一個是查所有出版社，一個是查具體的某一個出版社。

首先是一個簡略的表結(jié)構(gòu)設(shè)計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的路由業(yè)務(wù)區(qū)分開

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查詢具體某一條數(shù)據(jù)
  re_path(r'publishers/(?P<pk>\d+)/$', views.PublisherDetailView.as_view()), # 出版社詳情
]

再到序列化類，自創(chuàng)建的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


##################### 面向?qū)ο?，手動實現(xiàn)REST framework視圖功能##################
class GenericView(APIView):
  '''公用類'''
  queryset = None
  serializer_class = None

  def get_queryset(self):
    # 讓每一次請求來的時候都現(xiàn)查一次數(shù)據(jù)
    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方法區(qū)分'''
    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

這樣寫就實現(xiàn)了簡單的增刪改查查功能，而且用對象封裝，如果要添加其他表的查詢，只需要簡單的6行代碼就可以實現(xiàn)；

比如：實現(xiàn)作者的增刪改查查

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


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

利用面向?qū)ο蟮姆庋b與繼承極大地簡化了代碼，減少了代碼冗余。

但我們自己寫的功能不夠全面，不夠嚴謹，Django REST framework 給我們封裝了內(nèi)置的視圖類ModelViewSet。

Django REST framework 視圖組件

視圖組件是用來優(yōu)化接口邏輯的

首先看看ModelViewSet

就是繼承了5個混合類和一個公共類。

mixins.py中就是那五個類，封裝了增刪改查查 5個方法，還有其他嚴謹功能的方法，結(jié)構(gòu)與上面實現(xiàn)的類似

而使用這個視圖類就更簡單了，一張表只需要一個類

from rest_framework.viewsets import ModelViewSet
class AuthorViewSet(ModelViewSet):
  """
    內(nèi)部封裝了這五個方法
    list()
    create()
    retrieve()
    update()
    destroy()

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

因內(nèi)置類中封裝的方法與請求方式的名并不一樣

list() 對應(yīng)查詢所有對象的get方法

create() 對應(yīng)添加的post方法

retrieve() 對應(yīng)查詢具體對像的get方法

update() 對應(yīng)更新對象的put方法

destroy() 對應(yīng)刪除delete 方法

所以url要設(shè)置 actions 讓它們一一對應(yīng)

urlpatterns = [
  path('admin/', admin.site.urls),
  # 查所有對象，與添加對象
  re_path(r'publishers/$', views.PublisherView.as_view()),
  # 帶pk查詢具體某一條數(shù)據(jù)
  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還封裝了路由類，上面關(guān)于authors的路由還可以這樣寫

from rest_framework.routers import DefaultRouter

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

urlpatterns += router.urls

不過這樣寫路由，業(yè)務(wù)關(guān)系不清晰，一般用的少。

以上就是本文的全部內(nèi)容，希望對大家的學(xué)習(xí)有所幫助，也希望大家多多支持腳本之家。

您可能感興趣的文章: