DRF03--视图、视图集、路由

程序员文章站 2022-07-12 11:11:48

...

1. 视图

1.View

这是django的父类视图 , 需要自己构建字典返回。下面是增删改查的示例:

# REST API  JSON
class BooksAPIView(View):
    def get(self, request):
        # GET   /books/   获取所有图书信息
        books = BookInfo.objects.all()

        # 转换格式
        books_list = []
        for book in books:
            books_list.append({
                'id': book.id,
                'btitle': book.btitle,
                'bpub_date': book.bpub_date.strftime('%Y-%m-%d'),
                'bread': book.bread,
                'bcomment': book.bcomment,
                'logo': book.logo.url if book.logo else ''
            })

        return JsonResponse(books_list, safe=False)

    def post(self, request):
        # POST  /books/   新增图书
        json_bytes = request.body
        json_str = json_bytes.decode()
        req_data = json.loads(json_str)

        # 省略校验参数

        book = BookInfo.objects.create(
            btitle=req_data.get('btitle'),
            bpub_date=datetime.strptime(req_data.get('bpub_date'), '%Y-%m-%d').date()
        )

        # 转换
        book_dict = {
            'id': book.id,
            'btitle': book.btitle,
            'bpub_date': book.bpub_date.strftime('%Y-%m-%d'),
            'bread': book.bread,
            'bcomment': book.bcomment,
            'logo': book.logo.url if book.logo else ''
        }

        return JsonResponse(book_dict, status=201)


class BookAPIView(View):
    def get(self, request, pk):
        # GET   /books/<pk>/   获取单一图书
        try:
            book = BookInfo.objects.get(pk=pk)
        except BookInfo.DoesNotExist:
            return HttpResponse(status=404)

        # 转换
        book_dict = {
            'id': book.id,
            'btitle': book.btitle,
            'bpub_date': book.bpub_date.strftime('%Y-%m-%d'),
            'bread': book.bread,
            'bcomment': book.bcomment,
            'logo': book.logo.url if book.logo else ''
        }

        return JsonResponse(book_dict)

    def put(self, request, pk):
        # PUT   /books/<pk>/   更新图书
        try:
            book = BookInfo.objects.get(pk=pk)
        except BookInfo.DoesNotExist:
            return HttpResponse(status=404)

        json_bytes = request.body
        json_str = json_bytes.decode()
        req_data = json.loads(json_str)

        # 省略校验参数
        book.btitle = req_data.get('btitle')
        book.bpub_date = datetime.strptime(req_data.get('bpub_date'), '%Y-%m-%d').date()
        book.save()

        # 转换
        book_dict = {
            'id': book.id,
            'btitle': book.btitle,
            'bpub_date': book.bpub_date.strftime('%Y-%m-%d'),
            'bread': book.bread,
            'bcomment': book.bcomment,
            'logo': book.logo.url if book.logo else ''
        }

        return JsonResponse(book_dict, status=201)

    def delete(self, request, pk):
        # DELETE  /books/<pk>/   删除图书
        try:
            book = BookInfo.objects.get(pk=pk)
        except BookInfo.DoesNotExist:
            return HttpResponse(status=404)

        book.delete()

        return HttpResponse(status=204)

2. APIView

继承自rest_framework.views.APIView , 是REST framework提供的所有视图的基类，继承自Django的View父类。

APIView与View的不同之处在于：

传入到视图方法中的是REST framework的Request对象，而不是Django的HttpRequeset对象；
视图方法可以返回REST framework的Response对象，视图会为响应数据设置（render）符合前端要求的格式；
任何APIException异常都会被捕获到，并且处理成合适的响应信息；
在进行dispatch()分发前，会对请求进行身份认证、权限检查、流量控制。

1.支持定义的属性：

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() #books即指明了queryset
        #构建序列化器对象,进行序列化操作
        serializer = BookInfoSerializer(books, many=True)
        # 返回数据,默认状态码200
        return Response(serializer.data)

3. GenericAPIView

继承自rest_framework.generics.GenericAPIView

继承自APIVIew，增加了对于列表视图和详情视图可能用到的通用支持方法。通常使用时，可搭配一个或多个Mixin扩展类。

1. 支持定义的属性：

列表视图与详情视图通用：
- queryset 列表视图的查询集
- serializer_class 视图使用的序列化器
列表视图使用：
- pagination_class 分页控制类
- filter_backends 过滤控制后端
详情页视图使用：
- lookup_field 查询单一数据库对象时使用的条件字段，默认为’pk’
- lookup_url_kwarg 查询单一数据时URL中的参数关键字名称，默认与look_field相同
  lookup_field和lookup_url_kwarg是啥意思呢?回顾一下上面的View的示例,我们看到第二个get方法,他的url里面是有pk的参数,我们将其取出,然后在凭借这个pk去查询数据库中的pk,第一个pk就是lookup_url_kwarg,第二个pk就是lookup_field

2. 提供的方法：

列表视图与详情视图通用：
- get_queryset(self)
  
  返回视图使用的查询集，是列表视图与详情视图获取数据的基础，默认返回queryset属性，可以重写，例如：
```
def get_queryset(self):
    user = self.request.user
    return user.accounts.all()
```
- get_serializer_class(self)
  
  返回序列化器类，默认返回serializer_class，可以重写，重写该方法,就是指明在调用self.get_serializer的时候,使用的是哪个序列化器,也不需要在上面指明serializer_class,就需要重写该方法。例如：
```
def get_serializer_class(self):
    if self.request.user.is_staff:
        return FullAccountSerializer
    return BasicAccountSerializer
```

#views.py
class BookInfoViewSet(mixins.ListModelMixin, mixins.RetrieveModelMixin, GenericViewSet):
    """
    list:
    返回所有图书信息
    retrieve:
    返回图书数据
    latest:
    返回最新的图书信息
    read:
    修改图书的阅读量数据
    """
    queryset = BookInfo.objects.all()
    # serializer_class = BookInfoSerializer #因为在下面重写了get_serializer_class,所以在这里就不需要指明
    permission_classes = [MyPermission]
    filter_fields = ('btitle', 'bread')
    pagination_class = StandardPageNumberPagination

    def get_serializer_class(self):
            # 重写，提供不同的序列化器
            if self.action == 'read':
                return BookReadSerializer
            else:
                return BookInfoSerializer

    @action(methods=['get'], detail=False)
    def latest(self, request):

        raise DatabaseError()
        book = BookInfo.objects.latest('id')
        serializer = self.get_serializer(book)
        return Response(serializer.data)

    # detail为True，表示要处理具体与pk主键对应的BookInfo对象
    @action(methods=['put'], detail=True)
    def read(self, request, pk):
        book = self.get_object()
        # book.bread = request.data.get('read')
        serializer = self.get_serializer(instance=book, data=request.data)
        serializer.is_valid(raise_exception=True)
        serializer.save()
        return Response(serializer.data)

#serializers.py
class BookReadSerializer(serializers.ModelSerializer):
    class Meta:
        model = BookInfo
        fields = ('bread', )
        extra_kwargs = {
            'bread': {
                'required': True,
                'min_value': 0,
            }
        }
# 该方法是用于保存更改校验之后的bread参数
    def update(self, instance, validated_data):
        instance.bread = validated_data['bread']
        instance.save()
        return instance

get_serializer(self, *args, **kwargs)

返回序列化器对象，被其他视图或扩展类使用，如果我们在视图中想要获取序列化器对象，可以直接调用此方法。

注意，在提供序列化器对象的时候，REST framework会向对象的context属性补充三个数据：request(当前请求的对象是谁)、format(这一次的请求数据的类型格式)、view(当前是哪个视图正在使用序列化器)，这三个数据对象可以在定义序列化器时使用。
详情视图使用：
- get_object(self) 返回详情视图所需的模型类数据对象，默认使用lookup_field参数来过滤queryset。在试图中可以调用该方法获取详情信息的模型类对象。
  说人话,get_object(self)的意思就是,当你不需要查询整个数据库all()时,使用它,就会自动根据url里面的参数去查询数据库里对应的pk,若详情访问的模型类对象不存在，会返回404。比如View的示例根据pk查询图书
  
  该方法会默认使用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()
        serializer = self.get_serializer(book)
        return Response(serializer.data)

#  GET  /books/
class BookListAPIView(GenericAPIView):
    queryset = BookInfo.objects.all()
    serializer_class = BookInfoSerializer

    def get(self, request):
        # 数据库查询,使用self.get_queryset()就会自动将上面指定的queryset查询集返回给我们
        qs = self.get_queryset()

        # 构建序列化器对象，进行序列化操作,在上面指明了serializer_class之后就不需要再指明该属性
        # serializer = BookInfoSerializer(queryset, many=True) 
          
        #在上面指明了serializer_class之后,调用get_serializer方法,将查询集传进去,可以根据上面指明的序列化器构建数据返回给我们
        serializer = self.get_serializer(qs, many=True)  

        # serializer.data

        return Response(serializer.data)

# # GET  /books/<pk>/
class BookDetailAPIView(GenericAPIView):
    queryset = BookInfo.objects.all()
    serializer_class = BookInfoSerializer

    def get(self, request, pk):
    	#自动根据url的参数查询数据库中的数据
        book = self.get_object() 
		#调用上面指明的序列化器,将查询的数据传进去进行校验
        serializer = self.get_serializer(book)
		#返回给前端校验之后的数据
        return Response(serializer.data)

4. 五个ModelMixin

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)

from rest_framework import mixins
#使用ListModelMixin就可以替代下面的注释的lists
class BookListAPIView(mixins.ListModelMixin, GenericAPIView):
    queryset = BookInfo.objects.all()
    serializer_class = BookInfoSerializer
    
    def get(self, request):
        return self.list(request)

#以下方法被上面的list方法替换
#class BookListAPIView(GenericAPIView):
#    queryset = BookInfo.objects.all()
#    serializer_class = BookInfoSerializer

#    def get(self, request):
#        qs = self.get_queryset()
#        serializer = self.get_serializer(qs, many=True)  
#        return Response(serializer.data)

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()

5. 几个APIView

1. CreateAPIView

提供 post 方法

继承自： GenericAPIView、CreateModelMixin

2. ListAPIView

提供 get 方法

继承自：GenericAPIView、ListModelMixin
代码示例:

from rest_framework.generics import ListAPIView

class BookListAPIView(ListAPIView):
# 只需要指明这两个属性,连get方法都不用写,就是这么省
    queryset = BookInfo.objects.all()
    serializer_class = BookInfoSerializer

3. RetireveAPIView

提供 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

2. 视图集

使用视图集ViewSet，可以将一系列逻辑相关的动作放到一个类中：

list() 提供一组数据
retrieve() 提供单个数据
create() 创建数据
update() 保存数据
destory() 删除数据

ViewSet视图集类不再实现get()、post()等方法，而是实现动作 action 如 list() 、create() 等。

视图集只在使用as_view()方法的时候，才会将action动作与具体请求方式对应上。如：

class BookInfoViewSet(viewsets.ViewSet):

    def list(self, request):
        ...

    def retrieve(self, request, pk=None):
        ...

在设置路由时，我们可以如下操作

urlpatterns = [
    url(r'^books/$', BookInfoViewSet.as_view({'get':'list'})),
    url(r'^books/(?P<pk>\d+)/$', BookInfoViewSet.as_view({'get':'retrieve'}))
]

1. action属性

在视图集中，我们可以通过action对象属性来获取当前请求视图集时的action动作是哪个。

例如：

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

2. ViewSet

继承自APIView，作用也与APIView基本类似，提供了身份认证、权限校验、流量管理等。

在ViewSet中，没有提供任何动作action方法，需要我们自己实现action方法。

3. GenericViewSet

继承自GenericAPIView，作用也与GenericAPIVIew类似，提供了get_object、get_queryset等方法便于列表视图与详情信息视图的开发。

4. ModelViewSet

继承自GenericAPIVIew，同时包括了ListModelMixin、RetrieveModelMixin、CreateModelMixin、UpdateModelMixin、DestoryModelMixin。

5. ReadOnlyModelViewSet

继承自GenericAPIVIew，同时包括了ListModelMixin、RetrieveModelMixin。

6. 自定义action动作

添加自定义动作需要使用rest_framework.decorators.action装饰器。

以action装饰器装饰的方法名会作为action动作名，与list、retrieve等同。

action装饰器可以接收两个参数：

methods: 该action支持的请求方式，列表传递
detail

表示是action中要处理的是否是视图资源的对象（即是否通过url路径获取主键）
- True 表示使用通过URL获取的主键对应的数据对象
- False 表示不使用URL获取主键

举例：

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 = BookInfo.objects.all()
    serializer_class = BookInfoSerializer

    # detail为False 表示不需要处理具体的BookInfo对象
    @action(methods=['get'], detail=False)
    def latest(self, request):
        """
        返回最新的图书信息
        """
        #latest是数据库默认提供的字段,将某个字段倒序之后取第一个
        book = BookInfo.objects.latest('id')
        serializer = self.get_serializer(book)
        return Response(serializer.data)

    # detail为True，表示要处理具体与pk主键对应的BookInfo对象
    @action(methods=['put'], detail=True)
    def read(self, request, pk):
        """
        修改图书的阅读量数据
        """
        book = self.get_object()
        book.bread = request.data.get('read')
        book.save()
        serializer = self.get_serializer(book)
        return Response(serializer.data)

url的定义

urlpatterns = [
    url(r'^books/$', views.BookInfoViewSet.as_view({'get': 'list'})),
    url(r'^books/latest/$', views.BookInfoViewSet.as_view({'get': 'latest'})),
    url(r'^books/(?P<pk>\d+)/$', views.BookInfoViewSet.as_view({'get': 'retrieve'})),
    url(r'^books/(?P<pk>\d+)/read/$', views.BookInfoViewSet.as_view({'put': 'read'})),
]

3. 路由

REST framework提供了两个router

SimpleRouter
DefaultRouter

1. 使用方法

1）创建router对象，并注册视图集，例如

from rest_framework import routers

router = routers.SimpleRouter()
router.register(r'books', BookInfoViewSet, base_name='book')

prefix 该视图集的路由前缀
viewset 视图集
base_name 路由名称的前缀

如上述代码会形成的路由如下：

^books/$    name: book-list
^books/{pk}/$   name: book-detail

2）添加路由数据

可以有两种方式：

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

或

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

2. 视图集中包含附加action的

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

    @action(methods=['get'], detail=False)
    def latest(self, request):
        ...

    @action(methods=['put'], detail=True)
    def read(self, request, pk):
        ...

此视图集会形成的路由：

^books/latest/$    name: book-latest
^books/{pk}/read/$  name: book-read

3. 路由router形成URL的方式

DefaultRouter与SimpleRouter的区别是，DefaultRouter会多附带一个默认的API根视图，返回一个包含所有列表视图的超链接响应数据。

from rest_framework.routers import DefaultRouter
from . import views

urlpatterns = [
]

router = DefaultRouter()
router.register('areas', views.AreasViewSet, base_name='areas')

urlpatterns += router.urls

上一篇： Django DRF routers路由使用

下一篇： python __爬虫__线程池的应用。

DRF03--视图、视图集、路由

1. 视图

1.View

2. APIView

1.支持定义的属性：

3. GenericAPIView

1. 支持定义的属性：

2. 提供的方法：

get_serializer(self, *args, **kwargs)

4. 五个ModelMixin

1.ListModelMixin

2. CreateModelMixin

3. RetrieveModelMixin

4. UpdateModelMixin

5. DestroyModelMixin

5. 几个APIView

1. CreateAPIView

2. ListAPIView

3. RetireveAPIView

4. DestoryAPIView

5. UpdateAPIView

6. RetrieveUpdateAPIView

7. RetrieveUpdateDestoryAPIView

2. 视图集

1. action属性

2. ViewSet

3. GenericViewSet

4. ModelViewSet

5. ReadOnlyModelViewSet

6. 自定义action动作

3. 路由

1. 使用方法

2. 视图集中包含附加action的

3. 路由router形成URL的方式

drf-03-2个视图基类（APIView，GenericAPIView）、5个视图扩展类、GenericAPIView的视图子类、视图集基类ViewSet、常用视图集父类、路由Routers

DRF03--视图、视图集、路由

DRF(八):视图集和路由

DRF 框架总结 - 视图集&路由 Routers