DRF框架（五）——context傳參，二次封裝Response類，兩個視圖基類(APIView/GenericAPIView)，視圖擴展類（mixins），子類視圖（工具視圖），視圖集（viewsets）,工具視圖集

復習

1.整體修改與局部修改

# 序列化get （給前端傳遞參數）  #查詢
ser_obj = ModelSerializer(model_obj)   #只傳遞一個參數，默認是instance的參數，查詢數據
# 反序列化post  save() => create()（數據保存到數據庫中）  #添加
ser_obj = ModelSerializer(data=model_data)  #傳遞data參數，保存數據
#反序列化put   save() => update()  #修改（需要傳入instance和data參數）
ser_obj = ModelSerializer(instance=model_obj,data=model_data)  #默認partial參數是False,整體修改
#反序列化patch   partial=True => 匹配字段required=True校驗條件
ser_obj = ModelSerializer(instance=model_obj,data=model_data,partial=True)  #局部修改

2.群改ListSerializer

ser_obj = ModelSerializer(instance=model_obj,data=model_data,partial=True,many=True)
    
    # 實現群改功能，反序列化情況下的create、update就不再調用ModelSerializer的
    # 而是調用 ModelSerializer.Meta.list_serializer_class 指向的 ListSerializer 類的create、update
    # ListSerializer默認只實現了群增的create，要實現群改，必須重寫update
    
　　#自定義序列化類，重寫update方法
    class MyListSerializer(ListSerializer):
        def update(self, instance, validated_data):
            # print(instance)  # 要更新的對象們: [obj1, obj2, ...]
            # print(validated_data)  # 更新的對象對應的數據們: [{}, {}, ...]
            # print(self.child)  # 服務的模型序列化類 - V2BookModelSerializer
            for index, obj in enumerate(instance):
                self.child.update(obj, validated_data[index])
            return instance
            
     class MyModelSerializer(ModelSerializer):
         class Meta:
             list_serializer_class = MyListSerializer
     
     將兩者類建立關聯，在MyListSerializer中就可以用self.child拿到MyModelSerializer，進而使用MyModelSerializer中封裝好的方法
     cls.Meta.list_serializer_class.child = cls

視圖類views.py使用context傳遞參數給序列化類serializers.py

1）在視圖類中實例化序列化對象時，可以設置context內容
2）在序列化類中的局部鈎子、全局鈎子、create、update方法中，都可以用self.context訪問視圖類傳遞過來的內容

需求：
# 1) 在視圖類views中，可以通過request得到登陸用戶request.user
# 2) 在序列化類中，要完成數據庫數據的校驗與入庫操作，可能會需要知道當前的登陸用戶，但序列化類無法訪問request
# 3) 在視圖類中實例化序列化對象時，將request對象傳遞進去

視圖層:views.py  (使用context傳遞參數到序列化類中)

class Book(APIView):
    def post(self, request, *args, **kwargs):
        book_ser = serializers.BookModelSerializer(data=request_data,context={'request':request})   #視圖層context傳遞參數
        book_ser.is_valid(raise_exception=True)
        book_result = book_ser.save()
        return Response({
            'status': 0,
            'msg': 'ok',
            'results': serializers.BookModelSerializer(book_result).data
        })

序列化層：serializers.py

class BookModelSerializer(ModelSerializer):
    class Meta:
        model = models.Book
        fields = ('name', 'price')
    def validate_name(self, value):
        print(self.context.get('request').method)  #序列化層接收參數
        return value

二次封裝Response類便於以后每次使用Response

自定義APIResponse

from rest_framework.response import Response

class APIResponse(Response):
    def __init__(self, data_status=0, data_msg='ok', results=None, http_status=None, headers=None, exception=False, **kwargs):
        # data的初始狀態：狀態碼與狀態信息
        data = {
            'status': data_status,
            'msg': data_msg,
        }
        # data的響應數據體
        # results可能是False、0等數據，這些數據某些情況下也會作為合法數據返回
        if results is not None:
            data['results'] = results
        # data響應的其他內容
        # if kwargs is not None:
        #     for k, v in kwargs.items():
        #         setattr(data, k, v)
        data.update(kwargs)

        super().__init__(data=data, status=http_status, headers=headers, exception=exception)   #重寫父類Response的__init__方法

視圖家族

views：視圖
generics：工具視圖
mixins：視圖工具集
viewsets：視圖集


學習曲線
APIView => GenericAPIView => mixins的五大工具類 => generics中的工具視圖 => viewsets中的視圖集

兩個視圖基類   APIView和GenericAPIView

1）AIPView

from rest_framework.views import APIView

APIView是REST framework提供的所有視圖的基類，繼承自Django的View父類。

APIView與View的不同之處在於：

1.傳入到視圖方法中的是REST framework的Request對象，而不是Django的HttpRequeset對象；
2.視圖方法可以返回REST framework的Response對象，視圖會為響應數據設置（render）符合前端要求的格式；
3.任何APIException異常都會被捕獲到，並且處理成合適的響應信息；
4.在進行dispatch()分發前，會對請求進行身份認證、權限檢查、流量控制。

支持定義的屬性：
authentication_classes 列表或元祖，身份認證類
permissoin_classes 列表或元祖，權限檢查類
throttle_classes 列表或元祖，流量控制類

在APIView中仍有get(),post()等其他請求方式的方法

from rest_framework.views import APIView
from rest_framework.response import Response
 
# url(r'^books/$', views.BookListView.as_view()),
class BookListView(APIView):
    def get(self, request):
        books = BookInfo.objects.all()
        serializer = BookInfoSerializer(books, many=True)
        return Response(serializer.data)

2）GenericAPIView通用視圖類

GenericAPIView是繼承APIView的，使用完全兼容APIView，主要增加了操作序列化器和數據庫查詢的方法，作用是為下面Mixin擴展類的執行提供方法支持。通常在使用時，可以配合一個或多個Mixin擴展類
重點：GenericAPIView在APIView基礎上完成了哪些事
 1）get_queryset()：從類屬性queryset中獲得model的queryset數據                                群操作就走get_queryset()方法(包括群查，群增等)
 2）get_object()：從類屬性queryset中獲得model的queryset數據，再通過有名分組pk確定唯一操作對象     單操作就走get_object()方法（包括單查，單增等）
 3）get_serializer()：從類屬性serializer_class中獲得serializer的序列化類

支持的屬性：

• 列表視圖與詳情視圖通過：（重點******）
  1. queryset  指明視圖需要的數據（model查詢數據）
  2. serializer_class  指明視圖使用的序列化器　
• 列表視圖使用：

1. 1. pagination_class 分頁控制類　
   2. filter_backends  過濾控制后端　　　　　　

• 詳情頁視圖使用：

1. 1. lookup_field  自定義主鍵 有名分組的查詢，默認是'pk'
   2. lookup_url_kwarg 查詢單一數據時url中的參數關鍵字名稱，默認與look_field相同　　

提供的方法：(******)

　　1.get_queryset()    從類屬性queryset中獲得model的queryset數據　　

　　2.get_object()   從類屬性queryset中獲得model的queryset數據，再通過有名分組pk來確定唯一操作對象。

　　3.get_serializer()  從類屬性serializer_class中獲得serializer的序列化類，主要用來提供給Mixin擴展類使用。

get_serializer源碼：

舉例：

視圖層：views.py

from rest_framework.generics import GenericAPIView
class BookGenericAPIView(GenericAPIView):
    queryset = models.Book.objects.filter(is_delete=False)
    serializer_class = serializers.BookModelSerializer
    lookup_field = 'pk'     #先定義好，單查可以使用，默認是pk  自定義主鍵的有名分組，如果路由有名分組不是pk,這個屬性就要自己設置了
    # 群取
    def get(self, request, *args, **kwargs):
        book_query = self.get_queryset()       #獲取queryset數據（model查詢數據）
        book_ser = self.get_serializer(book_query, many=True)
        book_data = book_ser.data
        return APIResponse(results=book_data)

    # 單取
    def get(self, request, *args, **kwargs):
        book_query = self.get_object()
        book_ser = self.get_serializer(book_query)
        book_data = book_ser.data
        return APIResponse(results=book_data)

路由層：urls.py

urlpatterns = [
    url(r'^v2/books/$', views.BookGenericAPIView.as_view()),
    url(r'^v2/books/(?P<pk>.*)/$', views.BookGenericAPIView.as_view()),
]

五個視圖擴展類  mixins視圖工具集-輔助GenericAPIView

作用：提供了幾種后端視圖（對數據資源的增刪改查）處理流程的實現，如果需要編寫的視圖屬於這五種，則視圖可以通過繼承相應的擴展類來復用代碼，減少自己編寫的代碼量。

1）mixins有五個工具類文件，一共提供了五個工具類，六個工具方法：單查、群查、單增、單刪、單整體改、單局部改
2）繼承工具類可以簡化請求函數的實現體，但是必須繼承GenericAPIView，需要GenericAPIView類提供序列化器與數據庫查詢的方法(見上方GenericAPIView基類知識點)
3）工具類的工具方法返回值都是Response類型對象，如果要格式化數據格式再返回給前台，可以通過 response.data 拿到工具方法返回的Response類型對象的響應數據

五個工具類：CreateModelMixin（增加）,DestroyModelMixin（刪除）,ListModelMixin（查詢,查queryset）,RetrieveModelMixin（查詢，查對象，針對於存在"pk"）,UpdateModelMixin（修改）

1.ListModelMixin（群查）

列表視圖擴展類，提供 list 方法快速實現查詢視圖，返回200狀態碼。除了查詢，該list方法會對數據進行過濾和分頁

2.CreateModelMixin（單增）         #注意：沒有群增的方法，需要自己手動寫（******）

創建視圖擴展類，提供create方法快速創建資源的視圖，成功返回201的狀態碼

3.RetrieveModelMixin(單查)

詳情視圖擴展類，提供retrieve方法，可以快速實現返回一個存在的數據對象。

4.UpdateModelMixin(更新，修改)          #只有單整體改和單局部改，沒有群整體改和群局部改

更新視圖擴展類，提供update方法，可以快速實現更新一個存在的數據對象，同時也提供partial_update方法，可以實現局部更新。

5.DestoryModelMixin(刪除)  一般不怎么用到

刪除視圖擴展類，提供destory方法，可以快速實現刪除一個存在數據對象。

代碼示例：

視圖層：views.py

from rest_framework.mixins import ListModelMixin, CreateModelMixin, RetrieveModelMixin, UpdateModelMixin
class BookMixinGenericAPIView(ListModelMixin, CreateModelMixin, RetrieveModelMixin, UpdateModelMixin, GenericAPIView):
　　#GenericAPIView提供的序列化器和查詢的數據
    queryset = models.Book.objects.filter(is_delete=False) serializer_class = serializers.BookModelSerializer
　　
　　#單查和群查
    def get(self, request, *args, **kwargs):
        if 'pk' in kwargs:
            response = self.retrieve(request, *args, **kwargs)   #單查  RetrieveModelMixin方法
        else:
            # mixins提供的list方法的響應對象是Response，將該對象格式化為自定義的APIResponse
            response = self.list(request, *args, **kwargs)   #群查 ListModelMixin
        # response的數據都存放在response.data中
        return APIResponse(results=response.data)    
　　#單增
    def post(self, request, *args, **kwargs):
        response = self.create(request, *args, **kwargs)   #CreateModelMixin方法
        return APIResponse(results=response.data)
　　#單整體修改
    def put(self, request, *args, **kwargs):
        response = self.update(request, *args, **kwargs)   #UpdateModelMixin
        return APIResponse(results=response.data)
　　#單局部修改
    def patch(self, request, *args, **kwargs):
        response = self.partial_update(request, *args, **kwargs)
        return APIResponse(results=response.data)

路由層：urls.py

urlpatterns = [
       url(r'^v3/books/$', views.BookMixinGenericAPIView.as_view()),
    url(r'^v3/books/(?P<pk>.*)/$', views.BookMixinGenericAPIView.as_view()),
]

常用功能子類視圖   工具視圖(繼承了GenericAPIView和各種Mixins工具類)

 1）工具視圖都是GenericAPIView的子類，且不同的子類繼承了不同的工具類
 2）工具視圖的功能可以滿足需求，只需要繼承工具視圖，並且提供queryset與serializer_class即可

 

視圖	作用	可使用方法	父類
ListAPIView	查詢多條數據	get	GenericAPIView  ListModelMixin
CreateAPIView	新增一條數據	post	GenericAPIView  CreateModelMixin
RetrieveAPIView	查詢一條數據	get	GenericAPIView  RetrieveModelMixin
UpdateAPIView	修改一條數據	put，patch	GenericAPIView  UpdateModelMixin
DestroyAPIView	刪除一條數據	delete	GenericAPIView  DestroyModelMixin
RetrieveUpdateAPIView	單查，更新一條數據	get，put，patch	GenericAPIView  RetrieveModelMixin UpdateModelMixin
RetrieveUpdateDestroyAPIView	單查，更新，刪除一條數據	get，put，patch，delete	GenericAPIView  RetrieveModelMixin UpdateModelMixin DestroyModelMixin

　　　　　　　　　  ListCreateAPIView              群查，更新一條       get,post                     

視圖層：views.py

from rest_framework.generics import ListCreateAPIView, UpdateAPIView
class BookListCreatePIView(ListCreateAPIView, UpdateAPIView):
    queryset = models.Book.objects.filter(is_delete=False)
    serializer_class = serializers.BookModelSerializer

路由層：urls.py

urlpatterns = [
       url(r'^v4/books/$', views.BookListCreatePIView.as_view()),
    url(r'^v4/books/(?P<pk>.*)/$', views.BookListCreatePIView.as_view()),
]

視圖集 viewsetmixin  （注意路由設置）

1.常用視圖集父類
　　ViewSet
　　繼承自APIView和ViewSetMixin,沒有提供任何方法，需要自己寫
　　GenericViewSet
　　繼承GenericAPIView和ViewSetMixin,其中GenericAPIView提供了基礎方法，可以直接搭配Mixin擴展類使用，所以我們選這個
　　ModelViewSet　　
　　繼承GenericViewset,但同時也包括ListModelMixin、CreateModelMixin等mixin擴展類
1）視圖集都是默認優先繼承ViewSetMixin類，再繼承一個視圖類（GenericAPIView或APIView） 
 2）ViewSetMixin提供了重寫的as_view()方法，繼承視圖集的視圖類，配置路由時調用as_view()必須傳入 請求名-函數名 映射關系字典
       eg: url(r'^v5/books/$', views.BookGenericViewSet.as_view({'get': 'my_get_list'})),
       表示get請求會交給my_get_list視圖函數處理

路由層：urls.py

urlpatterns = [
       # View的as_view()：將get請求映射到視圖類的get方法
    # ViewSet的as_view({'get': 'my_get_list'})：將get請求映射到視圖類的my_get_list方法
    url(r'^v5/books/$', views.BookGenericViewSet.as_view({'get': 'my_get_list'})),
    url(r'^v5/books/(?P<pk>.*)/$', views.BookGenericViewSet.as_view({'get': 'my_get_obj'})),
]

視圖層：views.py

from rest_framework.viewsets import GenericViewSet
from rest_framework import mixins  #工具集 可以使用list,retrieve等方法
class BookGenericViewSet(mixins.RetrieveModelMixin, mixins.ListModelMixin, GenericViewSet):
    queryset = models.Book.objects.filter(is_delete=False)
    serializer_class = serializers.BookModelSerializer

    def my_get_list(self, request, *args, **kwargs):
        return self.list(request, *args, **kwargs)

    def my_get_obj(self, request, *args, **kwargs):
        return self.retrieve(request, *args, **kwargs)

GenericAPIView與APIView兩大繼承視圖的區別

1）GenericViewSet和ViewSet都繼承了ViewSetMixin，as_view都可以配置 請求-函數 映射
2）GenericViewSet繼承的是GenericAPIView視圖類，用來完成標准的 model 類操作接口
3）ViewSet繼承的是APIView視圖類，用來完成不需要 model 類參與，或是非標准的 model 類操作接口
      post請求在標准的 model 類操作下就是新增接口，登陸的post不滿足
      post請求驗證碼的接口，不需要 model 類的參與
案例：登陸的post請求，並不是完成數據的新增，只是用post提交數據，得到的結果也不是登陸的用戶信息，而是登陸的認證信息

工具視圖集  （工具集和視圖集的混合使用）

路由層：urls.py

urlpatterns = [
       url(r'^v6/books/$', views.BookModelViewSet.as_view({'get': 'list', 'post': 'create'})),
    url(r'^v6/books/(?P<pk>.*)/$', views.BookModelViewSet.as_view({'get': 'retrieve', 'put': 'update', 'patch': 'partial_update', 'delete': 'destroy'})),
]

視圖層：views.py

from rest_framework.viewsets import ModelViewSet
class BookModelViewSet(ModelViewSet):
    queryset = models.Book.objects.filter(is_delete=False)
    serializer_class = serializers.BookModelSerializer

    # 刪不是數據庫，而是該記錄中的刪除字段
    def destroy(self, request, *args, **kwargs):
        instance = self.get_object()  # type: models.Book
        if not instance:
            return APIResponse(1, '刪除失敗')  # 實際操作，在此之前就做了判斷
        instance.is_delete = True
        instance.save()
        return APIResponse(0, '刪除成功')

路由組件（了解）

from django.conf.urls import include
from rest_framework.routers import SimpleRouter
router = SimpleRouter()
# 所有路由與ViewSet視圖類的都可以注冊，會產生 '^v6/books/$' 和 '^v6/books/(?P<pk>[^/.]+)/$'
router.register('v6/books', views.BookModelViewSet)

urlpatterns = [
    # 第一種添加子列表方式
    url(r'^', include(router.urls)),
]
# 第二種添加子列表方式
# urlpatterns.extend(router.urls)