drf基本使用(4)_视图路由相关

视图

Django REST framwork 提供的视图的主要作用：

控制序列化器的执行（检验、保存、转换数据）
控制数据库查询的执行
调用请求类和响应类[这两个类也是由drf帮我们再次扩展了一些功能类。]

REST framework 提供了众多的通用视图基类与扩展类，以简化视图的编写。

Response

REST framework提供了一个响应类Response，使用该类构造响应对象时，响应的具体数据内容会被转换（render渲染）成符合前端需求的类型

from rest_framework.views import APIView
from rest_framework.response import Response # 引入
from game.serializer import GameModelSerializer
from . import models


class GameAPIView(APIView):
    def get(self, request):
        print(request.query_params)
        games = models.Game.objects.all()
        serializer = GameModelSerializer(instance=games, many=True)
        return Response(serializer.data) # 返回不是字典类型的数据时就不需要指定safe=False了

而且在浏览器就行访问看到的是一个页面效果

http://127.0.0.1:8000/game/store/ -- 看到的是页面效果
        
http://127.0.0.1:8000/game/store/?format=json  -- 看到是json数据

我们后端如果通过Response来想用数据时，通过postman发送get请求获取数据，你会发现得到的是纯json数据，但是通过浏览器访问时会的到一个页面。这是为什么呢？drf的APIView在响应内容的时候会自动通过请求头中的浏览器信息来进行数据的回复(Response)，如果是浏览器，那么返回的就是个页面(当然我们也可以不让他返回页面，可设置的，后面说）如果不是浏览器，给你返回的就是纯json数据。这是由drf中配置的两个不同的响应类产生的效果，看下面的配置。

REST framework提供了Renderer 渲染器，用来根据请求头中的Accept（客户端希望接收的数据类型声明）来自动转换响应数据到对应格式。如果前端请求中未进行Accept声明，则会采用默认方式处理响应数据，我们可以通过配置来修改默认响应格式。

REST_FRAMEWORK = {
    'DEFAULT_RENDERER_CLASSES': (  # 默认响应渲染类
        'rest_framework.renderers.JSONRenderer',  # json渲染器
        'rest_framework.renderers.BrowsableAPIRenderer',  # 浏览器API渲染器
    )
}

#通过from rest_framework import settings查看一下settings文件，可以找到这个默认配置

而APIView中就默认指定了这个渲染器

构造方式

Response(data, status=None, template_name=None, headers=None, content_type=None)

data不能是复杂结构的数据，如Django的模型类对象，对于这样的数据我们可以使用Serializer序列化器序列化处理后（转为了Python字典类型）再传递给data参数。

data: 为响应准备的序列化处理后的数据；
status: 状态码，默认200；

return Response({'msg': 'ok'},status=204) #直接写数字形式的
204等等这些数字代表什么，其实在drf中有文本形式的写法，在下面的文件中可以看到
from rest_framework import status  #点击查看status就能看到了
return Response({'msg': 'ok'},status=status.HTTP_204_NO_CONTENT) #这样写也可以,文本形式的

template_name: 模板名称，如果使用HTMLRenderer 时需指明；就是有些人觉得Response返回的那个页面丑，那么就可以通过这个模板自行定制。
headers: 用于存放响应头信息的字典；比如放一些cookie啊或者一些自定制的响应头啊都可以，例如：return Response({'msg': 'ok'},status=204,headers={'xx':'oo'})
content_type: 响应数据的Content-Type，通常此参数无需传递，REST framework会根据前端所需类型数据(accept请求头)来设置该参数。

2个视图基类

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() 或者其他请求方式的方法。

举例：比如我们创建一个game的应用，然后我们写下面5个接口

通过postman进行测试

GET POST

# urls
urlpatterns = [
    path('store/', views.GameAPIView.as_view()),
]

from rest_framework.views import APIView
from rest_framework.response import Response
from game.serializer import GameModelSerializer
from . import models
from rest_framework import status


class GameAPIView(APIView):
    # 获取所有数据
    def get(self, request):
        games = models.Game.objects.all()
        serializer = GameModelSerializer(instance=games, many=True)
        return Response(serializer.data, status=status.HTTP_200_OK)

    # 添加单条数据
    def post(self, request):
        serializer = GameModelSerializer(data=request.data)
        if not serializer.is_valid():
            return Response({'error': '添加失败'}, status=status.HTTP_400_BAD_REQUEST)

        instance = serializer.save()  # 自动触发ModelSerializer中的create方法保存数据
        serializer = GameModelSerializer(instance=instance)
        return Response(serializer.data)

GET PUT DELETE

因为一个类中只能有一个get方法,所以我们新建一个视图类用来进行单条数据的查询和删除修改

# urls
urlpatterns = [
    re_path(r'store/(?P<pk>\d+)/', views.GameAPIView2.as_view())
]

class GameAPIView2(APIView):
    # 获取单条数据
    def get(self, request, pk):
        game = models.Game.objects.get(pk=pk)
        serializer = GameModelSerializer(instance=game)
        return Response(serializer.data, status=status.HTTP_200_OK)

    # 更新单条数据
    def put(self, request, pk):
        instance = models.Game.objects.get(pk=pk)
        serializer = GameModelSerializer(data=request.data, partial=True, instance=instance)  # partial只序列化传过来的字段
        if serializer.is_valid():
            instance = serializer.save()  # 自动触发ModelSerializer 的update方法
            new_serializer = GameModelSerializer(instance=instance)
            return Response(new_serializer.data, status=status.HTTP_202_ACCEPTED)
        else:
            return Response({'error': "检验失败"})

    # 删除单条数据
    def delete(self, request, pk):
        models.Game.objects.get(pk=pk).delete()
        return Response({'message': '删除成功'}, status=status.HTTP_204_NO_CONTENT)

常用属性

1).data

request.data 返回解析之后的请求体数据。类似于Django中标准的request.POST和 request.FILES属性，但提供如下特性：

包含了解析之后的文件和非文件数据

request.data # 获取请求中的数据

包含了对POST、PUT、PATCH请求方式解析后的数据
利用了REST framework的parsers解析器，不仅支持表单类型数据(urlencoded,form-data)，也支持JSON数据(application/json)

2）.query_params

request.query_params与Django标准的request.GET相同，只是更换了更正确的名称而已。我们的GET方法同样也能使用

        print(request.query_params)  # <QueryDict: {'a': ['1'], 'b': ['2', '3']}>
        print(request.GET)  # <QueryDict: {'a': ['1'], 'b': ['2', '3']}>

注意: 如果我们这里发送的b是多选的数据

我们通过request.query_params获取一下请求的数据,可以通过request.query_params.getlist('b')获取

class GameAPIView(APIView):
    # 获取所有数据
    def get(self, request):
        print(request.query_params)  # <QueryDict: {'a': ['1'], 'b': ['2', '3']}>
        print(request.query_params.getlist('b'))  # ['2', '3']
        games = models.Game.objects.all()
        serializer = GameModelSerializer(instance=games, many=True)
        return Response(serializer.data, status=status.HTTP_200_OK)

下面我们来看一下rest_framework提供的其他功能，如何来简化我们的代码

GenericAPIView[通用视图类]

from rest_framework.generics import GenericAPIView

继承自APIVIew，主要增加了操作序列化器和数据库查询的方法，作用是为下面Mixin扩展类的执行提供方法支持。通常在使用时，可搭配一个或多个Mixin扩展类。

提供的关于序列化器使用的属性与方法

属性：
- serializer_class 指明视图使用的序列化器
```
serializer_class = GameModelSerializer
```

方法：

get_serializer_class(self)

当出现一个视图类中调用多个序列化器时,那么可以通过条件判断在get_serializer_class方法中通过返回不同的序列化器类名就可以让视图方法执行不同的序列化器对象了。

返回序列化器类，默认返回serializer_class，可以重写，例如：

    #一个视图中使用多个序列化类的方法，目前的例子是：get请求获取数据时，我们只给他两个字段数据，其他方法时我们给他所有字段数据，定义了这个get_serializer_class方法之后(其实是对父类的方法进行了重写)，其实上面的serializer_class就可以不用写了

serializer.py

# 定义两个序列化器 
from rest_framework import serializers
from game import models


class GameModelSerializer(serializers.ModelSerializer):
    class Meta:
        model = models.Game
        fields = '__all__'


class GameModelSerializer2(serializers.ModelSerializer):
    class Meta:
        model = models.Game
        fields = ['name', 'description']

views.py

from game.serializer import GameModelSerializer, GameModelSerializer2
from rest_framework.generics import GenericAPIView
from rest_framework.response import Response


class GamesGenericAPIView(GenericAPIView):
    queryset = models.Game.objects.all()

    def get_serializer_class(self):
        if self.request.method == 'GET':
            return GameModelSerializer2
        return GameModelSerializer

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

get_serializer(self, args, *kwargs)

返回序列化器对象，主要用来提供给Mixin扩展类使用，如果我们在视图中想要获取序列化器对象，也可以直接调用此方法。

注意，该方法在提供序列化器对象的时候，会向序列化器对象的context属性补充三个数据：request、format、view，这三个数据对象可以在定义序列化器时使用。

比如serializer = self.get_serializer(instance=self.get_object(),context={'pk':pk}),下面的request和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)
```

使用GenericAPIView实现5个接口

# urls 
    path('store/', views.GamesGenericAPIView.as_view()),
    re_path(r'store/(?P<pk>\d+)/', views.GameGenericAPIView.as_view())

"""
    GenericAPIView的使用
    基于GenericAPIView的视图接口 
"""

from rest_framework.generics import GenericAPIView


class GamesGenericAPIView(GenericAPIView):
    queryset = models.Game.objects.all()  # 必须写这个参数, 方法中使用self.get_queryset() 方法自动获取到queryset属性数据
    serializer_class = GameModelSerializer  # 方法中使用self.get_serializer获取serializer_class指定的序列化器

    # 当视图中使用多个序列化器类时, 可以使用该方法来区分
    # def get_serializer_class(self):
    #     if self.request.method == 'GET':
    #         return GameModelSerializer1
    #     else
    #         return GameModelSerializer2

    def get(self, request):
        game = self.get_queryset()
        serializer = self.get_serializer(instance=game, many=True)
        return Response(serializer.data, status=status.HTTP_200_OK)

    # 添加单条数据
    def post(self, request):
        serializer = self.get_serializer(data=request.data)
        if not serializer.is_valid():
            return Response({'error': '添加失败'}, status=status.HTTP_400_BAD_REQUEST)

        instance = serializer.save()  # 自动触发ModelSerializer中的create方法保存数据
        serializer = self.get_serializer(instance=instance)
        return Response(serializer.data)

        #在使用GenericAPIView实现获取操作单个数据时，我们视图方法中的参数变量pk最好是pk名，别叫id什么的，不然还需要进行一些其他的配置，比较麻烦一些了，简单看一下源码就知道了

class GameGenericAPIView(GenericAPIView):
    queryset = models.Game.objects.all()
    serializer_class = GameModelSerializer

    # 获取单条数据
    def get(self, request, pk):
        game = self.get_object()
        print(game)  # Game object (1)
        serializer = self.get_serializer(instance=game)
        return Response(serializer.data)

    # 更新单条数据
    def put(self, request, pk):
        instance = self.get_object()
        serializer = self.get_serializer(data=request.data, partial=True, instance=instance)  # partial只序列化传过来的字段
        if serializer.is_valid():
            instance = serializer.save()  # 自动触发ModelSerializer 的update方法
            new_serializer = self.get_serializer(instance=instance)
            return Response(new_serializer.data, status=status.HTTP_202_ACCEPTED)
        else:
            return Response({'error': "检验失败"})

    # 删除单条数据
    def delete(self, request, pk):
        self.get_object().delete() 
        return Response({'message': '删除成功'}, status=status.HTTP_204_NO_CONTENT)

其实GenericAPIView只是帮我们把数据库查询啊调用序列化器类啊进行了一步封装，目的是为了将一些公共性质的代码挑出去封装一下，其他感觉没啥大用，但其实这个公共性质的代码都不要我们写了，看下面几个扩展类来增强GenericAPIView的作用。

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.generics import GenericAPIView
from rest_framework.mixins import ListModelMixin


class GameListView(GenericAPIView, ListModelMixin):
    queryset = models.Game.objects.all()
    serializer_class = GameModelSerializer

    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 {}

示例：

from rest_framework.generics import GenericAPIView
from rest_framework.mixins import ListModelMixin, CreateModelMixin


class GameListView(GenericAPIView, ListModelMixin, CreateModelMixin):
    queryset = models.Game.objects.all()
    serializer_class = GameModelSerializer

    # 获取所有数据
    def get(self, request):
        return self.list(request)  # 内部自动帮我们返回了序列化后的数据

    # 添加一条数据
    def post(self, request):
        return self.create(request)

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)

举例：

# urls
re_path(r'store/(?P<pk>\d+)/', views.GameView.as_view())
# views
class GameView(GenericAPIView, RetrieveModelMixin):
    queryset = models.Game.objects.all()
    serializer_class = GameModelSerializer

    # 获取单条数据
    def get(self, request, *args, **kwargs):
        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)

示例：

class GameView(GenericAPIView, UpdateModelMixin):
    queryset = models.Game.objects.all()
    serializer_class = GameModelSerializer

    # 更新单条数据
    def put(self, request, pk):
        return self.partial_update(request, pk)

    def patch(self, request, pk):
        return self.update(request, pk, partial=True)  # 必须指定部分字段

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

示例：

from rest_framework.generics import GenericAPIView
from rest_framework.mixins import UpdateModelMixin, DestroyModelMixin


class GameView(GenericAPIView, UpdateModelMixin, DestroyModelMixin):
    queryset = models.Game.objects.all()
    serializer_class = GameModelSerializer

    # 更新单条数据
    def put(self, request, pk):
        return self.partial_update(request, pk)

    def patch(self, request, pk):
        return self.update(request, pk, partial=True)  # 必须指定部分字段

    def delete(self, request, pk):
        return self.destroy(request, pk)

下面还能对我们上面的代码进行简化。视图子类，也叫通用视图子类。

GenericAPIView的视图子类

from rest_framework.generics import ListAPIView...

1）CreateAPIView

提供 post 方法

继承自： GenericAPIView、CreateModelMixin

源码:

class CreateAPIView(mixins.CreateModelMixin,
                    GenericAPIView):
    """
    Concrete view for creating a model instance.
    """
    def post(self, request, *args, **kwargs):
        return self.create(request, *args, **kwargs)

使用:

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

示例：

"""使用GenericAPIView的视图子类进一步简化开发api接口的代码"""
from rest_framework.generics import ListAPIView, CreateAPIView

# 需要注意这里对应的url也是没有参数的
class GameView(ListAPIView, CreateAPIView):
    queryset = models.Game.objects.all()
    serializer_class = GameModelSerializer


from rest_framework.generics import RetrieveAPIView, UpdateAPIView, DestroyAPIView
from rest_framework.generics import RetrieveUpdateDestroyAPIView  # 结合了上面三个子类的功能

class GameView(RetrieveUpdateDestroyAPIView):
    queryset = models.Game.objects.all()
    serializer_class = GameModelSerializer

这样虽然简化了很多,可是我们还是要定义两个类来针对于多条数据和单条数据的查询,有没有办法优化呢

视图集基类ViewSet

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

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

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

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

"""
使用视图集基类 ViewSet合并两个视图类
1. action方法 
2. 只能在 as_views()时使用
"""
from rest_framework.viewsets import ViewSet

class GameViewSet(ViewSet):
    # 获取所有数据
    def get_all(self, request):
        games = models.Game.objects.all()
        serializer = GameModelSerializer(instance=games, many=True)
        return Response(serializer.data)

    # 添加数据
    def add(self, reqeust):
        serializer = GameModelSerializer(data=reqeust.data)
        if serializer.is_valid():
            return Response({'message': '添加成功'})

    # 获取单条数据
    def get_one(self, request, pk):
        instance = models.Game.objects.get(pk=pk)
        serializer = GameModelSerializer(instance=instance)
        return Response(serializer.data)

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

urlpatterns = [
    # 发挥下ViewSet的作用
    path('store/', views.GameViewSet.as_view({'get': 'get_all', 'post': 'add'})),
    re_path(r'store/(?P<pk>\d+)/', views.GameViewSet.as_view({'get': 'get_one'}))
]

再改善一下我们viewset

from rest_framework.viewsets import ViewSet
from rest_framework.generics import ListAPIView, CreateAPIView, RetrieveAPIView

class GameViewSet(ViewSet, ListAPIView, CreateAPIView, RetrieveAPIView):
    queryset = models.Game.objects.all()
    serializer_class = GameModelSerializer
    
    def get_all(self, request):
        return self.list(request)

    def add(self, request):
        return self.create(request)

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

常用视图集父类

1） ViewSet

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

ViewSet主要通过继承ViewSetMixin来实现在调用as_view()时传入字典（如{'get':'list'}）的映射处理工作。

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

from rest_framework.viewsets import ViewSet
from rest_framework.mixins import ListModelMixin, CreateModelMixin, RetrieveModelMixin
from rest_framework.generics import GenericAPIView  # Mixin扩展类依赖于GenericAPIView 

# 必须引入GenericAPIView
class GameViewSet(ViewSet, GenericAPIView, ListModelMixin, CreateModelMixin, RetrieveModelMixin):
    queryset = models.Game.objects.all()
    serializer_class = GameModelSerializer

  # urls
    path('store/', views.GameViewSet.as_view({'get': 'list', 'post': 'create'})),
    re_path(r'store/(?P<pk>\d+)/', views.GameViewSet.as_view({'get': 'retrieve'}))

2）GenericViewSet

使用ViewSet通常并不方便，因为list、retrieve、create、update、destory等方法都需要自己编写，而这些方法与前面讲过的Mixin扩展类提供的方法同名，所以我们可以通过继承Mixin扩展类来复用这些方法而无需自己编写。但是Mixin扩展类依赖于GenericAPIView，所以还需要继承GenericAPIView。

GenericViewSet就帮助我们完成了这样的继承工作，继承自GenericAPIView与ViewSetMixin，在实现了调用as_view()时传入字典（如{'get':'list'}）的映射处理工作的同时，还提供了GenericAPIView提供的基础方法，可以直接搭配Mixin扩展类使用。

url的定义

urlpatterns = [
    path('store/', views.GameViewSet.as_view({'get': 'list', 'post': 'create'})),
    re_path(r'store/(?P<pk>\d+)/', views.GameViewSet.as_view({'get': 'retrieve'}))

]

简化上面的代码

from rest_framework.viewsets import GenericViewSet
from rest_framework.mixins import CreateModelMixin, ListModelMixin, RetrieveModelMixin, UpdateModelMixin, DestroyModelMixin

class GameViewSet(GenericViewSet, CreateModelMixin, ListModelMixin, RetrieveModelMixin):

    queryset = models.Game.objects.all()
    serializer_class = GameModelSerializer

3）ModelViewSet

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

源码:

class ModelViewSet(mixins.CreateModelMixin,
                   mixins.RetrieveModelMixin,
                   mixins.UpdateModelMixin,
                   mixins.DestroyModelMixin,
                   mixins.ListModelMixin,
                   GenericViewSet):
    pass

"""使用ModelViewSet简写上面的继承代码，最终版"""
from rest_framework.viewsets import ModelViewSet

class GameModelViewSet(ModelViewSet):
    queryset = models.Game.objects.all()
    serializer_class = GameModelSerializer

4）ReadOnlyModelViewSet

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

视图集中定义附加action动作

在视图集中，除了上述默认的方法动作外，还可以添加自定义动作，进行扩展。

举例，比如做一个登录方法login：

from rest_framework.viewsets import ModelViewSet

class GameModelViewSet(ModelViewSet):
    queryset = models.Game.objects.all()
    serializer_class = GameModelSerializer

    def login(self, request): # 这个就是自定义的action动作
        if True:
            return Response({'message': '登录成功'})

url的定义

urlpatterns = [
    path('store/', views.GameModelViewSet.as_view({'get': 'list', 'post': 'create'})),
    re_path(r'store/(?P<pk>\d+)/', views.GameModelViewSet.as_view({'get': 'retrieve'})),
   	# 手动在添加一条url路径找到我们定义的方法
    path('login/', views.GameModelViewSet.as_view({'get': 'login'})) 

]

action属性

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

例如：

from rest_framework.viewsets import ModelViewSet

class GameModelViewSet(ModelViewSet):
    queryset = models.Game.objects.all()
    serializer_class = GameModelSerializer

    def login(self, request):  # 这个就是自定义的action动作
        if True:
            print('本次的请求方法', self.action)  # login
            return Response({'message': '登录成功'})
        
        
通过路由访问到当前方法中.可以看到本次的action就是请求的方法名

路由Routers

对于视图集ViewSet，我们除了可以自己手动指明请求方式与动作action之间的对应关系外，还可以使用Routers来帮助我们快速实现路由信息。

REST framework提供了两个router

SimpleRouter
DefaultRouter

1 使用方法

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

# rest_framework 提供的路由
from rest_framework.routers import DefaultRouter
from game.views import GameModelViewSet  # 引入视图集

urlpatterns = []
router = DefaultRouter()

router.register('store', GameModelViewSet)
urlpatterns += router.urls

注意: 这种路由只会帮我们生成那五个简单的接口,我们自定义的login不会帮我们自动生成

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

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

2）添加路由数据

可以有两种方式：

方式1 简单一些

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

或

方式2

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

上面的代码就成功生成了路由地址[增/删/改/查一条/查多条的功能]，但是不会自动帮我们在视图集自定义方法的路由。

所以我们如果也要给自定义方法生成路由，则需要进行action动作的声明。

2 视图集中附加action的声明

在视图集中，如果想要让Router自动帮助我们为自定义的动作生成路由信息，需要使用rest_framework.decorators.action装饰器。

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

如过methods指定了get 方法, 会覆盖原来的get方法

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

methods: 声明该action对应的请求方式，列表传递
detail

声明该action的路径是否与单一资源对应，及是否是
- True 表示请求的单条资源, 比如 delete , update
- False 表示请求全部资源, 比如 get post

举例：

views

from rest_framework.viewsets import ModelViewSet
from rest_framework.decorators import action

class GameModelViewSet(ModelViewSet):
    queryset = models.Game.objects.all()
    serializer_class = GameModelSerializer

    @action(methods=['get'], detail=True)  # 为True针对单条资源
    def login1(self, request, pk):  
        if True:
            print('本次的请求方法', self.action) 
            return Response({'message': '登录成功'})
	
    # 为False当前的请求路径应该为 http://127.0.0.1:8000/game/store/login2/
    @action(methods=['post'], detail=False)
    def login2(self, request):
        if True:
            return Response({'message': '请求成功'})

urls

from rest_framework.routers import DefaultRouter
from game.views import GameModelViewSet  # 引入视图集

urlpatterns = []
router = DefaultRouter()

router.register('store', GameModelViewSet)
urlpatterns += router.urls

3 路由router形成URL的方式

1） SimpleRouter

2）DefaultRouter

DefaultRouter与SimpleRouter的区别是，DefaultRouter会多附带一个默认的API根视图，返回一个包含所有列表视图的超链接响应数据。比如使用DefaultRouter时你访问一下http://127.0.0.1:8001/router_stu/ 会看到一个页面，而SimpleRouter会报错，一般都需要有个查看所有接口的页面，所以我们基本都是用的是DefaultRouter。

posted @ 2020-12-18 17:44 死里学阅读(105) 评论(0) 收藏举报

刷新页面返回顶部

GRLend

drf基本使用(4)_视图路由相关

视图

Response

构造方式

2个视图基类

APIView

常用属性

GenericAPIView[通用视图类]

get_serializer(self, args, *kwargs)

使用GenericAPIView实现5个接口

5个视图扩展类

1）ListModelMixin

2）CreateModelMixin

3）RetrieveModelMixin

4）UpdateModelMixin

5）DestroyModelMixin

GenericAPIView的视图子类

1）CreateAPIView

2）ListAPIView

3）RetrieveAPIView

4）DestoryAPIView

5）UpdateAPIView

6）RetrieveUpdateAPIView

7）RetrieveUpdateDestoryAPIView

视图集基类ViewSet

常用视图集父类

1） ViewSet

2）GenericViewSet

3）ModelViewSet

4）ReadOnlyModelViewSet

视图集中定义附加action动作

action属性

路由Routers

1 使用方法

2 视图集中附加action的声明

3 路由router形成URL的方式

公告