Django REST framework (DRF)框架入門之檢視【四】
Django REST framwork 提供的檢視的主要作用:
- 控制序列化器的執行(檢驗、儲存、轉換資料)
- 控制資料庫查詢的執行
1.2 檢視
REST framework 提供了眾多的通用檢視基類與擴充套件類,以簡化檢視的編寫。
1.2.1 2個檢視基類
1.2.1.1 APIView
rest_framework.views.APIView
APIView
是REST framework提供的所有檢視的基類,繼承自Django的View
父類。
APIView
與View
的不同之處在於:
- 傳入到檢視方法中的是REST framework的
Request
物件,而不是Django的HttpRequeset
- 檢視方法可以返回REST framework的
Response
物件,檢視會為響應資料設定(render)符合前端要求的格式; - 任何
APIException
異常都會被捕獲到,並且處理成合適的響應資訊; - 在進行dispatch()分發前,會對請求進行身份認證、許可權檢查、流量控制。
支援定義的類屬性
- authentication_classes 列表或元祖,身份認證類
- permissoin_classes 列表或元祖,許可權檢查類
- throttle_classes 列表或元祖,流量控制類
在APIView
中仍以常規的類檢視定義方法來實現get() 、post() 或者其他請求方式的方法。
舉例:比如我們建立一個demo的應用,然後我們寫下面5個介面
from django.shortcuts import render from rest_framework.views import APIView # Create your views here. from students import models from .serializers import StudentModelSerializer from rest_framework.response import Response from rest_framework import status class StudentsAPIView(APIView): def get(self,request): """ 獲取所有學生資料 :param request: :return: """ """ 簡單總結: 1 獲取一個數據,傳instance引數 獲取多條資料,傳instance,many=True引數 2 更新資料,傳instance和data引數 部分欄位更新,可以增加partial=True引數 3 新增資料,傳data引數 4 刪除資料,不需要使用序列化器 """ data_list = models.Student.objects.all() serializer = StudentModelSerializer(instance=data_list,many=True) return Response(serializer.data) def post(self,request): """ 新增學生資訊 :param requeset: :return: """ data = request.data serializer = StudentModelSerializer(data=data) serializer.is_valid(raise_exception=True) instance = serializer.save() # 將新增的新的資料返回給客戶端,可以使用我們的序列化元件先序列化一下 serializer = StudentModelSerializer(instance=instance) return Response(serializer.data) class StudentAPIView(APIView): def get(self,request,pk): """獲取單條資料""" instance = models.Student.objects.get(pk=pk) serializer = StudentModelSerializer(instance=instance) return Response(serializer.data) def put(self,request,pk): """更新學生資訊""" #由於更新操作,我們需要找到被更新的是哪條記錄,所以需要客戶端給我們傳一個id過來,並且以後我們會用到獲取一條資料,刪除一條資料,都需要用到一個id值,所以我們把上面的get和post方法寫成一個類,更新、獲取單條資料和刪除資料我們再單獨寫一個類 data = request.data student = models.Student.objects.get(id=pk) #可能提交過來的是部分資料,所以加上一個partial=True引數 serializer = StudentModelSerializer(instance=student,data=data,partial=True) serializer.is_valid(raise_exception=True) instance = serializer.save() # 將修改後的資料返回給客戶端 serializer = StudentModelSerializer(instance=instance) return Response(serializer.data) def delete(self,request,pk): """刪除一條資料,用不到我們的序列化器""" ret = models.Student.objects.get(id=pk).delete() return Response(None,status=status.HTTP_204_NO_CONTENT)
對應的urls.py
from django.urls import path,re_path
from . import views
urlpatterns = [
path(r'students/',views.StudentsAPIView.as_view()),
re_path(r'students/(?P<pk>\d+)/',views.StudentAPIView.as_view()),
]
下面我們來看一下rest_framework提供的其他功能,如何來簡化我們的程式碼
1.2.1.2 GenericAPIView[通用檢視類]
rest_framework.generics.GenericAPIView
繼承自APIVIew
,主要增加了操作序列化器和資料庫查詢的方法,作用是為下面Mixin擴充套件類的執行提供方法支援。通常在使用時,可搭配一個或多個Mixin擴充套件類。
提供的關於序列化器使用的屬性與方法
-
屬性:
- serializer_class 指明檢視使用的序列化器
-
方法:
-
get_serializer_class(self)
當出現一個檢視類中呼叫多個序列化器時,那麼可以通過條件判斷在get_serializer_class方法中通過返回不同的序列化器類名就可以讓檢視方法執行不同的序列化器物件了。
返回序列化器類,預設返回
serializer_class
,可以重寫,例如:def get_serializer_class(self): if self.request.user.is_staff: return FullAccountSerializer return BasicAccountSerializer
-
get_serializer(self, args, *kwargs)
返回序列化器物件,主要用來提供給Mixin擴充套件類使用,如果我們在檢視中想要獲取序列化器物件,也可以直接呼叫此方法。
注意,該方法在提供序列化器物件的時候,會向序列化器物件的context屬性補充三個資料:request、format、view,這三個資料物件可以在定義序列化器時使用。
- request 當前檢視的請求物件
- view 當前請求的類檢視物件
- format 當前請求期望返回的資料格式
-
提供的關於資料庫查詢的屬性與方法
-
屬性:
- queryset 指明使用的資料查詢集
-
方法:
-
get_queryset(self)
返回檢視使用的查詢集,主要用來提供給Mixin擴充套件類使用,是列表檢視與詳情檢視獲取資料的基礎,預設返回
queryset
屬性,可以重寫,例如:def get_queryset(self): user = self.request.user return user.accounts.all()
-
get_object(self)
返回詳情檢視所需的模型類資料物件,主要用來提供給Mixin擴充套件類使用。
在試圖中可以呼叫該方法獲取詳情資訊的模型類物件。
若詳情訪問的模型類物件不存在,會返回404。
該方法會預設使用APIView提供的check_object_permissions方法檢查當前物件是否有許可權被訪問。
舉例:
# url(r'^books/(?P<pk>\d+)/$', views.BookDetailView.as_view()), class BookDetailView(GenericAPIView): queryset = BookInfo.objects.all() serializer_class = BookInfoSerializer def get(self, request, pk): book = self.get_object() # get_object()方法根據pk引數查詢queryset中的資料物件 serializer = self.get_serializer(book) return Response(serializer.data)
-
其他可以設定的屬性
- pagination_class 指明分頁控制類
- filter_backends 指明過濾控制後端
為了方便學習上面的GenericAPIView通用檢視類,我們新建一個子應用。
python manage.py startapp gen
程式碼:
from rest_framework.generics import GenericAPIView
from students.models import Student
from .serializers import StudentModelSerializer, StudentModel2Serializer
from rest_framework.response import Response
class StudentsGenericAPIView(GenericAPIView):
# 本次檢視類中要操作的資料[必填]
queryset = Student.objects.all()
# 本次檢視類中要呼叫的預設序列化器[玄天]
serializer_class = StudentModelSerializer
def get(self, request):
"""獲取所有學生資訊"""
serializer = self.get_serializer(instance=self.get_queryset(), many=True)
return Response(serializer.data)
def post(self,request):
data = request.data
serializer = self.get_serializer(data=data)
serializer.is_valid(raise_exception=True)
instance = serializer.save()
serializer = self.get_serializer(instance=instance)
return Response(serializer.data)
class StudentGenericAPIView(GenericAPIView):
queryset = Student.objects.all()
serializer_class = StudentModelSerializer
def get_serializer_class(self):
"""重寫獲取序列化器類的方法"""
if self.request.method == "GET":
return StudentModel2Serializer
else:
return StudentModelSerializer
# 在使用GenericAPIView檢視獲取或操作單個數據時,檢視方法中的代表主鍵的引數最好是pk
def get(self,request,pk):
"""獲取一條資料"""
serializer = self.get_serializer(instance=self.get_object())
return Response(serializer.data)
def put(self,request,pk):
data = request.data
serializer = self.get_serializer(instance=self.get_object(),data=data)
serializer.is_valid(raise_exception=True)
serializer.save()
serializer = self.get_serializer(instance=self.get_object())
return Response(serializer.data)
序列化器類:
from rest_framework import serializers
from students.models import Student
class StudentModelSerializer(serializers.ModelSerializer):
class Meta:
model= Student
fields = "__all__"
class StudentModel2Serializer(serializers.ModelSerializer):
class Meta:
model= Student
fields = ("name","class_null")
1.2.2 5個檢視擴充套件類
作用:
提供了幾種後端檢視(對資料資源進行曾刪改查)處理流程的實現,如果需要編寫的檢視屬於這五種,則檢視可以通過繼承相應的擴充套件類來複用程式碼,減少自己編寫的程式碼量。
這五個擴充套件類需要搭配GenericAPIView父類,因為五個擴充套件類的實現需要呼叫GenericAPIView提供的序列化器與資料庫查詢的方法。
1)ListModelMixin
列表檢視擴充套件類,提供list(request, *args, **kwargs)
方法快速實現列表檢視,返回200狀態碼。
該Mixin的list方法會對資料進行過濾和分頁。
原始碼:
class ListModelMixin(object):
"""
List a queryset.
"""
def list(self, request, *args, **kwargs):
# 過濾
queryset = self.filter_queryset(self.get_queryset())
# 分頁
page = self.paginate_queryset(queryset)
if page is not None:
serializer = self.get_serializer(page, many=True)
return self.get_paginated_response(serializer.data)
# 序列化
serializer = self.get_serializer(queryset, many=True)
return Response(serializer.data)
舉例:
from rest_framework.mixins import ListModelMixin
class BookListView(ListModelMixin, GenericAPIView):
queryset = BookInfo.objects.all()
serializer_class = BookInfoSerializer
def get(self, request):
return self.list(request)
2)CreateModelMixin
建立檢視擴充套件類,提供create(request, *args, **kwargs)
方法快速實現建立資源的檢視,成功返回201狀態碼。
如果序列化器對前端傳送的資料驗證失敗,返回400錯誤。
原始碼:
class CreateModelMixin(object):
"""
Create a model instance.
"""
def create(self, request, *args, **kwargs):
# 獲取序列化器
serializer = self.get_serializer(data=request.data)
# 驗證
serializer.is_valid(raise_exception=True)
# 儲存
self.perform_create(serializer)
headers = self.get_success_headers(serializer.data)
return Response(serializer.data, status=status.HTTP_201_CREATED, headers=headers)
def perform_create(self, serializer):
serializer.save()
def get_success_headers(self, data):
try:
return {'Location': str(data[api_settings.URL_FIELD_NAME])}
except (TypeError, KeyError):
return {}
3)RetrieveModelMixin
詳情檢視擴充套件類,提供retrieve(request, *args, **kwargs)
方法,可以快速實現返回一個存在的資料物件。
如果存在,返回200, 否則返回404。
原始碼:
class RetrieveModelMixin(object):
"""
Retrieve a model instance.
"""
def retrieve(self, request, *args, **kwargs):
# 獲取物件,會檢查物件的許可權
instance = self.get_object()
# 序列化
serializer = self.get_serializer(instance)
return Response(serializer.data)
舉例:
class BookDetailView(RetrieveModelMixin, GenericAPIView):
queryset = BookInfo.objects.all()
serializer_class = BookInfoSerializer
def get(self, request, pk):
return self.retrieve(request)
4)UpdateModelMixin
更新檢視擴充套件類,提供update(request, *args, **kwargs)
方法,可以快速實現更新一個存在的資料物件。
同時也提供partial_update(request, *args, **kwargs)
方法,可以實現區域性更新。
成功返回200,序列化器校驗資料失敗時,返回400錯誤。
原始碼:
class UpdateModelMixin(object):
"""
Update a model instance.
"""
def update(self, request, *args, **kwargs):
partial = kwargs.pop('partial', False)
instance = self.get_object()
serializer = self.get_serializer(instance, data=request.data, partial=partial)
serializer.is_valid(raise_exception=True)
self.perform_update(serializer)
if getattr(instance, '_prefetched_objects_cache', None):
# If 'prefetch_related' has been applied to a queryset, we need to
# forcibly invalidate the prefetch cache on the instance.
instance._prefetched_objects_cache = {}
return Response(serializer.data)
def perform_update(self, serializer):
serializer.save()
def partial_update(self, request, *args, **kwargs):
kwargs['partial'] = True
return self.update(request, *args, **kwargs)
5)DestroyModelMixin
刪除檢視擴充套件類,提供destroy(request, *args, **kwargs)
方法,可以快速實現刪除一個存在的資料物件。
成功返回204,不存在返回404。
原始碼:
class DestroyModelMixin(object):
"""
Destroy a model instance.
"""
def destroy(self, request, *args, **kwargs):
instance = self.get_object()
self.perform_destroy(instance)
return Response(status=status.HTTP_204_NO_CONTENT)
def perform_destroy(self, instance):
instance.delete()
使用GenericAPIView和檢視擴充套件類,實現api介面,程式碼:
"""GenericAPIView結合檢視擴充套件類實現api介面"""
from rest_framework.mixins import ListModelMixin,CreateModelMixin
class Students2GenericAPIView(GenericAPIView,ListModelMixin,CreateModelMixin):
# 本次檢視類中要操作的資料[必填]
queryset = Student.objects.all()
# 本次檢視類中要呼叫的預設序列化器[玄天]
serializer_class = StudentModelSerializer
def get(self, request):
"""獲取多個學生資訊"""
return self.list(request)
def post(self,request):
"""新增學生資訊"""
return self.create(request)
from rest_framework.mixins import RetrieveModelMixin,UpdateModelMixin,DestroyModelMixin
class Student2GenericAPIView(GenericAPIView,RetrieveModelMixin,UpdateModelMixin,DestroyModelMixin):
queryset = Student.objects.all()
serializer_class = StudentModelSerializer
# 在使用GenericAPIView檢視獲取或操作單個數據時,檢視方法中的代表主鍵的引數最好是pk
def get(self,request,pk):
"""獲取一條資料"""
return self.retrieve(request,pk)
def put(self,request,pk):
"""更新一條資料"""
return self.update(request,pk)
def delete(self,request,pk):
"""刪除一條資料"""
return self.destroy(request,pk)
1.2.3 GenericAPIView的檢視子類
1)CreateAPIView
提供 post 方法
繼承自: GenericAPIView、CreateModelMixin
2)ListAPIView
提供 get 方法
繼承自:GenericAPIView、ListModelMixin
3)RetrieveAPIView
提供 get 方法
繼承自: GenericAPIView、RetrieveModelMixin
4)DestoryAPIView
提供 delete 方法
繼承自:GenericAPIView、DestoryModelMixin
5)UpdateAPIView
提供 put 和 patch 方法
繼承自:GenericAPIView、UpdateModelMixin
6)RetrieveUpdateAPIView
提供 get、put、patch方法
繼承自: GenericAPIView、RetrieveModelMixin、UpdateModelMixin
7)RetrieveUpdateDestoryAPIView
提供 get、put、patch、delete方法
繼承自:GenericAPIView、RetrieveModelMixin、UpdateModelMixin、DestoryModelMixin
1.3 檢視集ViewSet
使用檢視集ViewSet,可以將一系列邏輯相關的動作放到一個類中:
- list() 提供一組資料
- retrieve() 提供單個數據
- create() 建立資料
- update() 儲存資料
- destory() 刪除資料
ViewSet檢視集類不再實現get()、post()等方法,而是實現動作 action 如 list() 、create() 等。
檢視集只在使用as_view()方法的時候,才會將action動作與具體請求方式對應上。如:
class BookInfoViewSet(viewsets.ViewSet):
def list(self, request):
books = BookInfo.objects.all()
serializer = BookInfoSerializer(books, many=True)
return Response(serializer.data)
def retrieve(self, request, pk=None):
try:
books = BookInfo.objects.get(id=pk)
except BookInfo.DoesNotExist:
return Response(status=status.HTTP_404_NOT_FOUND)
serializer = BookInfoSerializer(books)
return Response(serializer.data)
在設定路由時,我們可以如下操作
urlpatterns = [
url(r'^books/$', BookInfoViewSet.as_view({'get':'list'}),
url(r'^books/(?P<pk>\d+)/$', BookInfoViewSet.as_view({'get': 'retrieve'})
]
1.3.1 常用檢視集父類
1) ViewSet
繼承自APIView
與ViewSetMixin
,作用也與APIView基本類似,提供了身份認證、許可權校驗、流量管理等。
ViewSet主要通過繼承ViewSetMixin來實現在呼叫as_view()時傳入字典(如{'get':'list'})的對映處理工作。
在ViewSet中,沒有提供任何動作action方法,需要我們自己實現action方法。
2)GenericViewSet
使用ViewSet通常並不方便,因為list、retrieve、create、update、destory等方法都需要自己編寫,而這些方法與前面講過的Mixin擴充套件類提供的方法同名,所以我們可以通過繼承Mixin擴充套件類來複用這些方法而無需自己編寫。但是Mixin擴充套件類依賴與GenericAPIView
,所以還需要繼承GenericAPIView
。
GenericViewSet就幫助我們完成了這樣的繼承工作,繼承自GenericAPIView
與ViewSetMixin
,在實現了呼叫as_view()時傳入字典(如{'get':'list'}
)的對映處理工作的同時,還提供了GenericAPIView
提供的基礎方法,可以直接搭配Mixin擴充套件類使用。
舉例:
from rest_framework.viewsets import GenericViewSet
from rest_framework.mixins import ListModelMixin,CreateModelMixin,RetrieveModelMixin,UpdateModelMixin,DestroyModelMixin
class Student4ViewSet(GenericViewSet,ListModelMixin,CreateModelMixin,RetrieveModelMixin,UpdateModelMixin,DestroyModelMixin):
queryset = Student.objects.all()
serializer_class = StudentModelSerializer
url的定義
urlpatterns = [
path("students7/", views.Student4ViewSet.as_view({"get": "list", "post": "create"})),
re_path("students7/(?P<pk>\d+)/", views.Student4ViewSet.as_view({"get": "retrieve","put":"update","delete":"destroy"})),
]
3)ModelViewSet
繼承自GenericViewSet
,同時包括了ListModelMixin、RetrieveModelMixin、CreateModelMixin、UpdateModelMixin、DestoryModelMixin。
4)ReadOnlyModelViewSet
繼承自GenericViewSet
,同時包括了ListModelMixin、RetrieveModelMixin。
1.3.2 檢視集中定義附加action動作
在檢視集中,除了上述預設的方法動作外,還可以新增自定義動作。
舉例:
from rest_framework.viewsets import ModelViewSet,ReadOnlyModelViewSet
class StudentModelViewSet(ModelViewSet):
queryset = Student.objects.all()
serializer_class = StudentModelSerializer
def login(self,request):
"""學生登入功能"""
return Response({"message":"登入成功"})
url的定義
urlpatterns = [
path("students8/", views.StudentModelViewSet.as_view({"get": "list", "post": "create"})),
re_path("students8/(?P<pk>\d+)/",
views.StudentModelViewSet.as_view({"get": "retrieve", "put": "update", "delete": "destroy"})),
path("stu/login/",views.StudentModelViewSet.as_view({"get":"login"}))
]
1.3.3 action屬性
在檢視集中,我們可以通過action物件屬性來獲取當前請求檢視集時的action動作是哪個。
例如:
from rest_framework.viewsets import ModelViewSet
from students.models import Student
from .serializers import StudentModelSerializer
from rest_framework.response import Response
class StudentModelViewSet(ModelViewSet):
queryset = Student.objects.all()
serializer_class = StudentModelSerializer
def get_new_5(self,request):
"""獲取最近新增的5個學生資訊"""
# 操作資料庫
print(self.action) # 獲取本次請求的檢視方法名
通過路由訪問到當前方法中.可以看到本次的action就是請求的方法名
2. 路由Routers
對於檢視集ViewSet,我們除了可以自己手動指明請求方式與動作action之間的對應關係外,還可以使用Routers來幫助我們快速實現路由資訊。
REST framework提供了兩個router
- SimpleRouter
- DefaultRouter
2.1 使用方法
1) 建立router物件,並註冊檢視集,例如
from rest_framework import routers
router = routers.DefaultRouter()
router.register(r'router_stu', StudentModelViewSet, base_name='student')
register(prefix, viewset, base_name)
- prefix 該檢視集的路由字首
- viewset 檢視集
- base_name 路由別名的字首
如上述程式碼會形成的路由如下:
^books/$ name: book-list
^books/{pk}/$ name: book-detail
2)新增路由資料
可以有兩種方式:
urlpatterns = [
...
]
urlpatterns += router.urls
或
urlpatterns = [
...
url(r'^', include(router.urls))
]
使用路由類給檢視集生成了路由地址
from rest_framework.viewsets import ModelViewSet,ReadOnlyModelViewSet
class StudentModelViewSet(ModelViewSet):
queryset = Student.objects.all()
serializer_class = StudentModelSerializer
def login(self,request):
"""學生登入功能"""
print(self.action)
return Response({"message":"登入成功"})
路由程式碼:
from django.urls import path, re_path
from . import views
urlpatterns = [
...
]
"""使用drf提供路由類router給檢視集生成路由列表"""
# 例項化路由類
# drf提供一共提供了兩個路由類給我們使用,他們用法一致,功能幾乎一樣
from rest_framework.routers import DefaultRouter
router = DefaultRouter()
# 註冊檢視集
# router.register("路由字首",檢視集類)
router.register("router_stu",views.StudentModelViewSet)
# 把生成的路由列表追加到urlpatterns
print( router.urls )
urlpatterns += router.urls
上面的程式碼就成功生成了路由地址[增/刪/改/查一條/查多條的功能],但是不會自動我們在檢視集自定義方法的路由。
所以我們如果也要給自定義方法生成路由,則需要進行action動作的宣告。
2.2 檢視集中附加action的宣告
在檢視集中,如果想要讓Router自動幫助我們為自定義的動作生成路由資訊,需要使用rest_framework.decorators.action
裝飾器。
以action裝飾器裝飾的方法名會作為action動作名,與list、retrieve等同。
action裝飾器可以接收兩個引數:
-
methods: 宣告該action對應的請求方式,列表傳遞
-
- detail
- 宣告該action的路徑是否與單一資源對應,及是否是
xxx/<pk>/action方法名/
- True 表示路徑格式是
xxx/<pk>/action方法名/
- False 表示路徑格式是
xxx/action方法名/
舉例:
from rest_framework.viewsets import ModelViewSet
from rest_framework.decorators import action
class StudentModelViewSet(ModelViewSet):
queryset = Student.objects.all()
serializer_class = StudentModelSerializer
# methods 設定當前方法允許哪些http請求訪問當前檢視方法
# detail 設定當前檢視方法是否是操作一個數據
# detail為True,表示路徑名格式應該為 router_stu/{pk}/login/
@action(methods=['get'], detail=True)
def login(self, request,pk):
"""登入"""
...
# detail為False 表示路徑名格式應該為 router_stu/get_new_5/
@action(methods=['put'], detail=False)
def get_new_5(self, request):
"""獲取最新新增的5個學生資訊"""
...
由路由器自動為此檢視集自定義action方法形成的路由會是如下內容:
^router_stu/get_new_5/$ name: router_stu-get_new_5
^router_stu/{pk}/login/$ name: router_stu-login
2.3 路由router形成URL的方式
1) SimpleRouter
2)DefaultRouter
DefaultRouter與SimpleRouter的區別是,DefaultRouter會多附帶一個預設的API根檢視,返回一個包含所有列表檢視的超連結響應資料。