什么時候聲明的序列化器需要繼承序列化器基類Serializer,什么時候繼承模型序列化器類ModelSerializer?
繼承序列化器類Serializer
字段聲明
驗證
添加/保存數據功能
繼承模型序列化器類ModelSerializer
字段聲明[可選,看需要]
Meta聲明
驗證
添加/保存數據功能[可選]
看表字段大小,看使用哪個更加節省代碼了。
1. 視圖相關
drf除了在數據序列化部分簡寫代碼以外,還在視圖中提供了簡寫操作。所以在django原有的django.views.View類基礎上,drf封裝了多個視圖子類出來提供給我們使用。
Django REST framwork 提供的視圖的主要作用:
- 控制序列化器的執行(檢驗、保存、轉換數據)
- 控制數據庫查詢的執行
- 調用請求類和響應類[這兩個類也是由drf幫我們再次擴展了一些功能類。]
為了方便我們學習,所以先創建一個子應用req
python manage.py startapp req
注冊子引用:
INSTALLED_APPS = [
'django.contrib.admin',
'django.contrib.auth',
'django.contrib.contenttypes',
'django.contrib.sessions',
'django.contrib.messages',
'django.contrib.staticfiles',
'rest_framework', # 把drf框架注冊到django項目中
'students', # 注冊子應用
'sers', # 演示序列化
'unsers', # 演示反序列化
'cbv', # 類視圖學習
'mod', # 模型類序列化器
'req', # 請求與響應
]
注冊路由
# 子應用路由
from django.urls import path
from . import views
urlpatterns = [
]
# 總路由
from django.contrib import admin
from django.urls import path,include
# django.urls.path 匹配一個普通字符串的url地址
# django.urls.re_path 匹配一個正則的url地址
# re_path("^/sms/(?P<mobile>\d{11})/$", views.視圖類.as_view()),
urlpatterns = [
path('admin/', admin.site.urls),
path("student/",include("students.urls")),
path("sers/",include("sers.urls")),
path("un/",include("unsers.urls")),
path("cbv/",include("cbv.urls")),
path("mod/",include("mod.urls")),
path("req/",include("req.urls")),
]
1.1. 請求與響應
1.1.1 Request
REST framework 傳入視圖的request對象不再是Django默認的HttpRequest對象,而是REST framework提供的擴展了HttpRequest類的Request類的對象。
REST framework 提供了Parser解析器,在接收到請求后會自動根據Content-Type指明的請求數據類型(如JSON、表單等)將請求數據進行parse解析,解析為類字典[QueryDict]對象保存到Request對象中。
Request對象的數據是自動根據前端發送數據的格式進行解析之后的結果。
無論前端發送的哪種格式的數據,我們都可以以統一的方式讀取數據。
1.1.1.1 常用屬性
1).data
request.data
返回解析之后的請求體數據。類似於Django中標准的request.POST
和 request.FILES
屬性,但提供如下特性:
- 包含了解析之后的文件和非文件數據
- 包含了對POST、PUT、PATCH請求方式解析后的數據
- 利用了REST framework的parsers解析器,不僅支持表單類型數據,也支持JSON數據
2).query_params
request.query_params
與Django標准的request.GET
相同,只是更換了更正確的名稱而已。
1.1.2 Response
rest_framework.response.Response
REST framework提供了一個響應類Response
,使用該類構造響應對象時,響應的具體數據內容會被轉換(render渲染器)成符合前端需求的類型。
REST framework提供了Renderer
渲染器,用來根據請求頭中的Accept
(接收數據類型聲明)來自動轉換響應數據到對應格式。如果前端請求中未進行Accept聲明,則會采用默認方式處理響應數據,我們可以通過配置來修改默認響應格式。
可以在rest_framework.settings查找所有的drf默認配置項
REST_FRAMEWORK = {
'DEFAULT_RENDERER_CLASSES': ( # 默認響應渲染類
'rest_framework.renderers.JSONRenderer', # json渲染器
'rest_framework.renderers.BrowsableAPIRenderer', # 瀏覽器API渲染器
)
}
1.1.2.1 構造方式
Response(data, status=None, template_name=None, headers=None, content_type=None)
data
數據不要是render處理之后的數據,只需傳遞python的內建類型數據即可,REST framework會使用renderer
渲染器處理data
。
data
不能是復雜結構的數據,如Django的模型類對象,對於這樣的數據我們可以使用Serializer
序列化器序列化處理后(轉為了Python字典類型)再傳遞給data
參數。
參數說明:
data
: 為響應准備的序列化處理后的數據;status
: 狀態碼,默認200;template_name
: 模板名稱,如果使用HTMLRenderer
時需指明;headers
: 用於存放響應頭信息的字典;content_type
: 響應數據的Content-Type,通常此參數無需傳遞,REST framework會根據前端所需類型數據來設置該參數。
1.1.2.2 常用屬性
1).data
傳給response對象的序列化后,但尚未render處理的數據
2).status_code
狀態碼的數字
3).content
經過render處理后的響應數據
1.1.2.3 狀態碼
為了方便設置狀態碼,REST framewrok在rest_framework.status
模塊中提供了常用狀態碼常量。
1)信息告知 - 1xx
HTTP_100_CONTINUE
HTTP_101_SWITCHING_PROTOCOLS
2)成功 - 2xx
HTTP_200_OK
HTTP_201_CREATED
HTTP_202_ACCEPTED
HTTP_203_NON_AUTHORITATIVE_INFORMATION
HTTP_204_NO_CONTENT
HTTP_205_RESET_CONTENT
HTTP_206_PARTIAL_CONTENT
HTTP_207_MULTI_STATUS
3)重定向 - 3xx
HTTP_300_MULTIPLE_CHOICES
HTTP_301_MOVED_PERMANENTLY
HTTP_302_FOUND
HTTP_303_SEE_OTHER
HTTP_304_NOT_MODIFIED
HTTP_305_USE_PROXY
HTTP_306_RESERVED
HTTP_307_TEMPORARY_REDIRECT
4)客戶端錯誤 - 4xx
HTTP_400_BAD_REQUEST
HTTP_401_UNAUTHORIZED
HTTP_402_PAYMENT_REQUIRED
HTTP_403_FORBIDDEN
HTTP_404_NOT_FOUND
HTTP_405_METHOD_NOT_ALLOWED
HTTP_406_NOT_ACCEPTABLE
HTTP_407_PROXY_AUTHENTICATION_REQUIRED
HTTP_408_REQUEST_TIMEOUT
HTTP_409_CONFLICT
HTTP_410_GONE
HTTP_411_LENGTH_REQUIRED
HTTP_412_PRECONDITION_FAILED
HTTP_413_REQUEST_ENTITY_TOO_LARGE
HTTP_414_REQUEST_URI_TOO_LONG
HTTP_415_UNSUPPORTED_MEDIA_TYPE
HTTP_416_REQUESTED_RANGE_NOT_SATISFIABLE
HTTP_417_EXPECTATION_FAILED
HTTP_422_UNPROCESSABLE_ENTITY
HTTP_423_LOCKED
HTTP_424_FAILED_DEPENDENCY
HTTP_428_PRECONDITION_REQUIRED
HTTP_429_TOO_MANY_REQUESTS
HTTP_431_REQUEST_HEADER_FIELDS_TOO_LARGE
HTTP_451_UNAVAILABLE_FOR_LEGAL_REASONS
5)服務器錯誤 - 5xx
HTTP_500_INTERNAL_SERVER_ERROR
HTTP_501_NOT_IMPLEMENTED
HTTP_502_BAD_GATEWAY
HTTP_503_SERVICE_UNAVAILABLE
HTTP_504_GATEWAY_TIMEOUT
HTTP_505_HTTP_VERSION_NOT_SUPPORTED
HTTP_507_INSUFFICIENT_STORAGE
HTTP_511_NETWORK_AUTHENTICATION_REQUIRED
為了方便演示,所以視圖里面的內容知識,我們另外創建一個子應用來展示
python manage.py startapp demo
注冊子應用
INSTALLED_APPS = [
'django.contrib.admin',
'django.contrib.auth',
'django.contrib.contenttypes',
'django.contrib.sessions',
'django.contrib.messages',
'django.contrib.staticfiles',
'rest_framework', # 把drf框架注冊到django項目中
'students', # 注冊子應用
'sers', # 演示序列化
'unsers', # 演示反序列化
'cbv', # 類視圖學習
'mod', # 模型類序列化器
'req', # 請求與響應
'demo', # 視圖類的學習
]
注冊路由,
urlpatterns = [
path('admin/', admin.site.urls),
path("student/",include("students.urls")),
path("sers/",include("sers.urls")),
path("un/",include("unsers.urls")),
path("cbv/",include("cbv.urls")),
path("mod/",include("mod.urls")),
path("req/",include("req.urls")),
path("demo/",include("demo.urls")),
]
1. 視圖
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() 或者其他請求方式的方法。
舉例:
# Create your views here.
"""APIView是drf里面提供的所有視圖類的父類
APIView提供的功能/屬性/方法是最少的,所以使用APIView基本類似我們使用django的View
"""
"""
GET /students/ 獲取多個學生信息
POST /students/ 添加一個學生信息
GET /students/<pk>/ 獲取一個學生信息
PUT /students/<pk>/ 修改一個學生信息
DELETE /students/<pk>/ 刪除一個學生信息
"""
from rest_framework.views import APIView
from students.models import Student
from .serializers import StudentModelSerializer
from rest_framework.response import Response
from rest_framework import status
class StudentAPIView(APIView):
def get(self,request):
# 1. 獲取學生信息的數據模型
student_list = Student.objects.all()
# 2. 調用序列化器
serializer = StudentModelSerializer(instance=student_list, many=True)
# 3. 返回數據
return Response(serializer.data)
def post(self,request):
# 1. 調用序列化器對用戶提交的數據進行驗證
serializer = StudentModelSerializer(data=request.data)
serializer.is_valid(raise_exception=True)
# 2. 調用序列化器進行數據庫操作
serializer.save() # save()方法返回的是添加成功以后的模型對象
# 3. 返回新增數據
return Response(serializer.data, status=status.HTTP_201_CREATED)
class Student2APIView(APIView):
def get(self,request,pk):
# 1. 根據pk獲取模型對象
student = Student.objects.get(pk=pk)
# 2. 序列化器轉換數據
serializer = StudentModelSerializer(instance=student)
# 3. 響應數據
return Response(serializer.data)
def put(self,request,pk):
# 1. 通過pk查詢學生信息
student = Student.objects.get(pk=pk)
# 3. 調用序列化器對客戶端發送過來的數據進行驗證
serializer = StudentModelSerializer(instance=student, data=request.data)
serializer.is_valid(raise_exception=True)
# 4. 保存數據
serializer.save()
# 5. 返回結果
return Response(serializer.data, status=status.HTTP_201_CREATED)
def delete(self, request, pk):
# 1. 通過pk查詢學生信息
Student.objects.get(pk=pk).delete()
return Response({"message":"ok"}, status=status.HTTP_204_NO_CONTENT)
1.2.1.2 GenericAPIView[通用視圖類]
通用視圖類主要作用就是把視圖中的獨特的代碼抽取出來,讓視圖方法中的代碼更加通用,方便把通用代碼進行jian'xie
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