詳解視圖與路由

大家是否好奇，客戶端在訪問 RESTful Web API 時，所訪問的路徑是在哪里定義的呢？為什么訪問不同的路徑，就可以獲取不同的資源呢？這一節(jié)，就帶大家揭開這樣的疑惑。

在設計接口時，90% 以上都是完成增刪改查操作，Django Rest framework 為我們做了大量的工作簡化視圖的編寫，在了解視圖之前，我們先看看 Django Rest framework 中各類視圖都有什么關(guān)系。

下圖是視圖的繼承關(guān)系，大家可以簡單了解，在學習完本節(jié)后續(xù)內(nèi)容，再返回頭看，就會更容易理解它們之間的關(guān)系：

視圖的方法與屬性：

1. 視圖的兩個基類

1.1 APIView

rest_framework.views.APIView

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

支持定義的屬性：

• authentication_classes ：列表或元祖，身份認證類；
• permissoin_classes ：列表或元祖，權(quán)限檢查類；
• throttle_classes： 列表或元祖，流量控制類。

在APIView中仍以常規(guī)的類視圖定義方法來實現(xiàn) get() 、post() 或者其他請求方式的方法。

舉例：

from rest_framework.views import APIView
from rest_framework.response import Response

class StudentsListView(APIView):
    '''
    學生信息視圖
    '''
    def get(self, request):
        students = StudentsModel.objects.all()  # 指定要處理的學生信息數(shù)據(jù)集
        serializer = StudentsSerializer(students, many=True) # 指定要使用的序列化器，many=True表明允許同時序列化多條數(shù)據(jù)
        return Response(serializer.data) # 返回經(jīng)過處理的數(shù)據(jù)

1.2 GenericAPIView

rest_framework.generics.GenericAPIView

繼承自APIVIew，主要增加了操作序列化器和數(shù)據(jù)庫查詢的方法，作用是為下面Mixin擴展類的執(zhí)行提供方法支持。通常在使用時，可搭配一個或多個Mixin擴展類。

1.2.1 提供的關(guān)于序列化器使用的屬性與方法

屬性：serializer_class 指明視圖使用的序列化器。

• get_serializer_class(self)

返回序列化器類，默認返回serializer_class，可以重寫，例如：

def get_serializer_class(self):
    if self.request.user.is_staff:
        return FullAccountSerializer
    return BasicAccountSerializer

• get_serializer(self, *args, **kwargs)

返回序列化器對象，主要用來提供給 Mixin 擴展類使用，如果我們在視圖中想要獲取序列化器對象，也可以直接調(diào)用此方法。

注意，該方法在提供序列化器對象的時候，會向序列化器對象的context屬性補充三個數(shù)據(jù)：request、format、view，這三個數(shù)據(jù)對象可以在定義序列化器時使用。

• request 當前視圖的請求對象

• view 當前請求的類視圖對象

• format 當前請求期望返回的數(shù)據(jù)格式

1.2.2 提供的關(guān)于數(shù)據(jù)庫查詢的屬性與方法

• 屬性：queryset 指明使用的數(shù)據(jù)查詢集

get_queryset(self)

返回視圖使用的查詢集，主要用來提供給Mixin擴展類使用，是列表視圖與詳情視圖獲取數(shù)據(jù)的基礎，默認返回queryset屬性，可以重寫，例如：

def get_queryset(self):
  user = self.request.user
  return user.accounts.all()

get_object(self)

返回詳情視圖所需的模型類數(shù)據(jù)對象，主要用來提供給Mixin擴展類使用。在試圖中可以調(diào)用該方法獲取詳情信息的模型類對象。若詳情訪問的模型類對象不存在，會返回404。該方法會默認使用APIView提供的 check_object_permissions 方法檢查當前對象是否有權(quán)限被訪問。舉例：

class StudentDetailView(GenericAPIView):
  queryset = StudentsModel.objects.all()
  serializer_class = BookInfoSerializer

  def get(self, request, pk):
      student = self.get_object() 
      serializer = self.get_serializer(student)
      return Response(serializer.data)

1.2.3 其他可以設置的屬性

• pagination_class 指明分頁控制類；
• filter_backends 指明過濾控制后端。

2. 五個擴展類

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

這五個擴展類需要搭配 GenericAPIView 父類，因為五個擴展類的實現(xiàn)需要調(diào)用 GenericAPIView 提供的序列化器與數(shù)據(jù)庫查詢的方法。

2.1 ListModelMixin

列表視圖擴展類，提供list(request, *args, **kwargs)方法快速實現(xiàn)列表視圖，返回 200 狀態(tài)碼。

該 Mixin 的 list 方法會對數(shù)據(jù)進行過濾和分頁。

源代碼：

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 StudentsListView(ListModelMixin, GenericAPIView):
    queryset = StudentsModel.objects.all()
    serializer_class = StudentsSerializer

    def get(self, request):
        return self.list(request)

2.2 CreateModelMixin

創(chuàng)建視圖擴展類，提供create(request, *args, **kwargs)方法快速實現(xiàn)創(chuàng)建資源的視圖，成功返回 201 狀態(tài)碼。

如果序列化器對前端發(fā)送的數(shù)據(jù)驗證失敗，返回 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 {}

2.3 RetrieveModelMixin

詳情視圖擴展類，提供retrieve(request, *args, **kwargs)方法，可以快速實現(xiàn)返回一個存在的數(shù)據(jù)對象。

如果存在，返回200， 否則返回404。

源代碼：

class RetrieveModelMixin(object):
    """
    Retrieve a model instance.
    """
    def retrieve(self, request, *args, **kwargs):
        # 獲取對象，會檢查對象的權(quán)限
        instance = self.get_object()
        # 序列化
        serializer = self.get_serializer(instance)
        return Response(serializer.data)

舉例：

class StudentDetailView(RetrieveModelMixin, GenericAPIView):
    queryset = StudentsModel.objects.all()
    serializer_class = StudentsSerializer

    def get(self, request, pk):
        return self.retrieve(request)

2.4 UpdateModelMixin

更新視圖擴展類，提供update(request, *args, **kwargs)方法，可以快速實現(xiàn)更新一個存在的數(shù)據(jù)對象。

同時也提供partial_update(request, *args, **kwargs)方法，可以實現(xiàn)局部更新。

成功返回200，序列化器校驗數(shù)據(jù)失敗時，返回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):
            # 如果 'prefetch_related' 應用在一個數(shù)據(jù)集合，那么每次查詢該集合, 都須使緩存數(shù)據(jù)強制失效，用新查詢的數(shù)據(jù)代替
            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)

2.5 DestroyModelMixin

刪除視圖擴展類，提供destroy(request, *args, **kwargs)方法，可以快速實現(xiàn)刪除一個存在的數(shù)據(jù)對象。

成功返回 204，不存在返回 404。

源代碼如下：

class DestroyModelMixin(object):
    """
    刪除數(shù)據(jù)
    """
    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()

3. 幾個可用子類視圖

3.1 CreateAPIView

提供 post 方法。

繼承自： GenericAPIView、CreateModelMixin。

3.2 ListAPIView

提供 get 方法。

繼承自：GenericAPIView、ListModelMixin。

3.3 RetrieveAPIView

提供 get 方法。

繼承自: GenericAPIView、RetrieveModelMixin。

3.4 DestoryAPIView

提供 delete 方法。

繼承自：GenericAPIView、DestoryModelMixin。

3.5 UpdateAPIView

提供 put 和 patch 方法。

繼承自：GenericAPIView、UpdateModelMixin。

3.6 RetrieveUpdateAPIView

提供 get、put、patch方法。

繼承自： GenericAPIView、RetrieveModelMixin、UpdateModelMixin。

3.7 RetrieveUpdateDestoryAPIView

提供 get、put、patch、delete方法。

繼承自：GenericAPIView、RetrieveModelMixin、UpdateModelMixin、DestoryModelMixin。

4.視圖集ViewSet

使用視圖集ViewSet，可以將一系列邏輯相關(guān)的動作放到一個類中：

• list() 提供一組數(shù)據(jù)；
• retrieve() 提供單個數(shù)據(jù)；
• create() 創(chuàng)建數(shù)據(jù)；
• update() 保存數(shù)據(jù)；
• destory() 刪除數(shù)據(jù)。

ViewSet 視圖集類不再實現(xiàn) get()、post() 等方法，而是實現(xiàn)動作 action 如 list() 、create() 等。

視圖集只在使用 as_view() 方法的時候，才會將 action 動作與具體請求方式對應上。如：

class StudentsViewSet(viewsets.ViewSet):

    def list(self, request):
      	'''
      	列出符合條件的多條（所有）記錄
      	'''
        students = StudentsModel.objects.all() # 查詢所有數(shù)據(jù)集
        serializer = StudentsSerializer(students, many=True)
        return Response(serializer.data)

    def retrieve(self, request, pk=None):
      	'''
      	列出符合條件的單條記錄
      	'''
        # 此處使用try...except，如果數(shù)據(jù)不存在，就可捕獲異常，返回404（查詢的資源不存在）
        try:
            students = StudentsModel.objects.get(id=pk) # 查詢id=pk參數(shù)的數(shù)據(jù)，因為id不可重復，因而查到的數(shù)據(jù)必定是單條數(shù)據(jù)
        except StudentsModel.DoesNotExist:
            return Response(status=status.HTTP_404_NOT_FOUND)
        serializer = StudentsSerializer(students)
        return Response(serializer.data)

在設置路由時，我們可以如下操作：

urlpatterns = [
    paht('books/', StudentsViewSet.as_view({'get':'list'}),
    path('books/<pk:int>/', StudentsViewSet.as_view({'get': 'retrieve'})
]

5. 常用視圖集父類

5.1 ViewSet

繼承自APIView與ViewSetMixin，作用也與APIView基本類似，提供了身份認證、權(quán)限校驗、流量管理等。ViewSet 主要通過繼承 ViewSetMixin 來實現(xiàn)在調(diào)用as_view()時傳入字典（如{'get':'list'}）的映射處理工作。在 ViewSet 中，沒有提供任何動作 action 方法，需要我們自己實現(xiàn) action 方法。

5.2 GenericViewSet

使用 ViewSet 通常并不方便，因為 list、retrieve、create、update、destory 等方法都需要自己編寫，而這些方法與前面講過的 Mixin 擴展類提供的方法同名，所以我們可以通過繼承 Mixin 擴展類來復用這些方法而無需自己編寫。但是 Mixin 擴展類依賴于GenericAPIView，所以還需要繼承GenericAPIView。

GenericViewSet 就幫助我們完成了這樣的繼承工作，繼承自GenericAPIView與ViewSetMixin，在實現(xiàn)了調(diào)用 as_view() 時傳入字典（如{'get':'list'}）的映射處理工作的同時，還提供了GenericAPIView 提供的基礎方法，可以直接搭配 Mixin 擴展類使用。

舉例：

from rest_framework import mixins
from rest_framework.viewsets import GenericViewSet
from rest_framework.decorators import action

class StudentsViewSet(mixins.ListModelMixin, mixins.RetrieveModelMixin, GenericViewSet):
    queryset = StudentsModel.objects.all()
    serializer_class = StudentsSerializer

路由定義：

urlpatterns = [
    paht('books/', StudentsViewSet.as_view({'get':'list'}),
    path('books/<pk:int>/', StudentsViewSet.as_view({'get': 'retrieve'})
]

5.3 ModelViewSet

繼承自GenericViewSet，同時包括了 ListModelMixin、RetrieveModelMixin、CreateModelMixin、UpdateModelMixin、DestoryModelMixin。

5.4 ReadOnlyModelViewSet

繼承自GenericViewSet，同時包括了ListModelMixin、RetrieveModelMixin。

6. 視圖集中定義附加 action 動作

在視圖集中，除了上述默認的方法動作外，還可以添加自定義動作。

舉例：

from rest_framework import mixins
from rest_framework.viewsets import GenericViewSet
from rest_framework.decorators import action

class BookInfoViewSet(mixins.ListModelMixin, mixins.RetrieveModelMixin, GenericViewSet):
    queryset = StudentsModel.objects.all()
    serializer_class = StudentsSerializer

    def latest(self, request):
        """
        返回最新的學生信息
        """
        students = StudentsModel.objects.latest('id')
        serializer = self.get_serializer(students)
        return Response(serializer.data)

    def edit(self, request, pk):
        """
        修改學生的年齡
        """
        student = self.get_object()
        student.s_age = request.data.get('age')
        student.save()
        serializer = self.get_serializer(student)
        return Response(serializer.data)

路由的定義：

urlpatterns = [
    path('studens/', views.StudentsViewSet.as_view({'get': 'list'})),
   	path('studens/latest/', views.StudentsViewSet.as_view({'get': 'latest'})),
    path('studens/(<pk:int>)/', views.StudentsViewSet.as_view({'get': 'retrieve'})),
    path('studens/(<pk:int>)/edit/', views.StudentsViewSet.as_view({'put': 'edit'})),
]

7. action屬性

在視圖集中，我們可以通過 action 對象屬性來獲取當前請求視圖集時的 action 動作是哪個。

例如：

def get_serializer_class(self):
    if self.action == 'create':
        return OrderCommitSerializer
    else:
        return OrderDataSerializer

8. 視圖集的繼承關(guān)系

9. 路由

對于視圖集 ViewSet，我們除了可以自己手動指明請求方式與動作 action 之間的對應關(guān)系外，還可以使用Routers 來幫助我們快速實現(xiàn)路由信息。

REST framework 提供了兩個 router：

• SimpleRouter
• DefaultRouter

下面來看下這兩個路由的具體使用方法：

10. 路由的使用方法

10.1 創(chuàng)建router對象，并注冊視圖集，例如

from rest_framework import routers

router = routers.SimpleRouter()
router.register(r'students', StudentsViewSet, base_name='students')

register(prefix, viewset, base_name)

• prefix 該視圖集的路由前綴
• viewset 視圖集
• base_name 路由名稱的前綴

如上述代碼會形成的路由如下：

^students/$    name: students-list
^students/{pk}/$   name: students-detail

10.2 添加路由數(shù)據(jù)

可以有兩種方式：

urlpatterns = [
    ...
]
urlpatterns += router.urls

或

urlpatterns = [
    ...
    url(r'^', include(router.urls))
]

11. 視圖集中附加 action 的聲明

在視圖集中，如果想要讓 Router 自動幫助我們?yōu)樽远x的動作生成路由信息，需要使用rest_framework.decorators.action裝飾器。

以 action 裝飾器裝飾的方法名會作為 action 動作名，與 list、retrieve 等同。action 裝飾器可以接收兩個參數(shù)：

• methods: 聲明該 action 對應的請求方式，列表傳遞

• detail：聲明該action的路徑是否與單一資源對應，及是否是

  xxx/<pk>/action方法名/
  

  • True 表示路徑格式是xxx//action方法名/
  • False 表示路徑格式是xxx/action方法名/

舉例：

from rest_framework import mixins
from rest_framework.viewsets import GenericViewSet
from rest_framework.decorators import action

class StudentsViewSet(mixins.ListModelMixin, mixins.RetrieveModelMixin, GenericViewSet):
    queryset = StudentsModel.objects.all()
    serializer_class = StudentsSerializer

    # detail為False 表示路徑名格式應該為 students/latest/
    @action(methods=['get'], detail=False)
    def latest(self, request):
        """
        返回最新的學生信息
        """
        ...

    # detail為True，表示路徑名格式應該為 students/{pk}/edit/
    @action(methods=['put'], detail=True)
    def read(self, request, pk):
        """
        修改學生的年齡
        """
        ...

由路由器自動為此視圖集自定義 action 方法形成的路由會是如下內(nèi)容：

^students/latest/$    name: students-latest
^students/{pk}/edit/$  name: students-edit

12. 兩種路由器對比

12.1 SimpleRouter

12.2 DefaultRouter

DefaultRouter 與 SimpleRouter 的區(qū)別是，DefaultRouter 會多附帶一個默認的 API 根視圖，返回一個包含所有列表視圖的超鏈接響應數(shù)據(jù)。

13.小結(jié)

本節(jié)介紹了構(gòu)建視圖的兩個基類 APIView 和 GenericAPIView，通過基類可以按照自己的需求，個性化定制視圖功能。為了簡化視圖的構(gòu)建，避免重復造輪子，Django Rest Framework 還為我們提供了五個擴展類和視圖集合，可以通過簡單的代碼，實現(xiàn)常用的增刪改查功能。最后，向大家介紹了路由的使用方法，并對比了SimpleRouter 和 DefaultRouter 的區(qū)別，大家在使用時可以根據(jù)不同的需求具體選擇。