DRF之视图和router

1. 视图

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

控制序列化器的执行（检验、保存、转换数据）
控制数据库查询的执行

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）request.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. 请求与响应

1.1.1 Request

REST framework 传入视图的request对象不再是Django默认的HttpRequest对象，而是REST framework提供的扩展了HttpRequest类的Request类的对象。

Request对象的数据是自动根据前端发送数据的格式进行解析之后的结果。

无论前端发送的哪种格式的数据，我们都可以以统一的方式读取数据。

1.1.2 Response

rest_framework.response.Response

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

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

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

View Code

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

View Code

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

View Code

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

View Code

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

View Code

使用request和respond的示例;

# from django.views import View  # 视图基类
from rest_framework.views import APIView  # django的View视图基类的子类
# from django.http import JsonResponse
from rest_framework.response import Response
class BookInfoView(APIView):
    def post(self,request):
        # 用于接受客户端请求
        print(request)
        # 接受客户端发送过来的请求体数据[例如表单\json]
        print(request.data)
        # 接收地址栏上的查询字符串参数
        print(request.query_params)

        # 上面两个request的子属性的返回值是QueryDict对象,这个对象可以保存数据,但是我们如果要获取数据值,
        # 可以通过一下两个方法获取
        # QueryDict.get("变量名")   # 获取指定变量名的一个值
        print( request.data.get("btitle") )
        print( request.query_params.get("password") )

        # QueryDict.getlist("变量名")   # 获取指定变量名的多个值
        print( request.query_params.getlist("love") )

        return Response({"method":"post"})

#################################################################################################################
# 响应类
#################################################################################################################
from rest_framework.views import APIView  # django的View视图基类的子类
# from django.http import JsonResponse
from rest_framework.response import Response
from rest_framework import status
class BookInfo2View(APIView):
    def get(self,request):

        # 参数1: data 响应给客户端的数据
        # 参数2: status 自定义http状态码，默认是200,开发的时候配合 rest_framework.status文件来声明
        # 参数3: headers 自定义响应头
        # 参数4: content_type 自定义响应内容格式
        return Response(data={"messsage":"ok"},status=status.HTTP_200_OK,headers={
            "token":"3f22-de21-gre2-wqsa-3232",
            "company":"hahaha",
        },content_type="application/json")

View Code

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

API view 使用示例:

apiview.views:

"""APIView的操作,和以前在django里面使用类视图一样的操作"""
from rest_framework.response import Response
from rest_framework.views import APIView

from booktest.models import BookInfo
from .serializers import BookInfoModelSerializer


class BookInfoAPIView(APIView):
    def get(self,request):
        # 1. 操作数据库
        books = BookInfo.objects.all()
        # 2. 序列化
        serializer = BookInfoModelSerializer(instance=books,many=True)
        # 3 响应数据
        return Response(serializer.data)

    def post(self,request):
        # 1. 接受数据
        data = request.data
        # 2. 反序列化[验证和保存数据]
        serializer = BookInfoModelSerializer(data=data)
        print(serializer)
        ret = serializer.is_valid(raise_exception=True)
        instance = serializer.save()

        # 3. 把新创建的模型对象序列化提供给客户端
        serializer = BookInfoModelSerializer(instance=instance)
        # 3. 响应数据
        return Response(serializer.data)

class BookInfo2APIView(APIView):
    def get(self,request,pk):
        """获取一条数据"""
        # 1. 操作数据库
        book = BookInfo.objects.get(pk=pk)
        # 2. 序列化
        serializer = BookInfoModelSerializer(instance=book)
        # 3. 响应数据
        return Response(serializer.data)

View Code

serlizaer:

# 3 模型序列化器
# 1. 可以帮我们自动完成字段的声明[主要是从模型中的字段声明里面提取过来]
# 2. 模型序列化器也可以帮我们声明了create和update方法的代码
###############################################################################################################################
from rest_framework import serializers
from booktest.models import BookInfo
class BookInfoModelSerializer(serializers.ModelSerializer):
    # 模型序列化器也可以自定义验证字段[当某些数据不存在于数据库时,但是需要前端提交过来的,可以进行自定义,
    # 例如,验证码,确认密码]

    class Meta:
        model=BookInfo
        fields = "__all__"
        # 可以给模型序列化器里面指定的字段设置限制选项
        extra_kwargs = {
            "bread":{"min_value":0,"required":True},
        }

View Code

apiview.urls:

from django.urls import path, re_path
from . import views
urlpatterns = [
    path("books/",views.BookInfoAPIView.as_view()),
    re_path("books/(?P<pk>\d+)/",views.BookInfo2APIView.as_view()),
]

View Code

1.2.1.2 GenericAPIView[通用视图类]

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)

View Code

其他可以设置的属性

pagination_class 指明分页控制类
filter_backends 指明过滤控制后端

GenericAPIView 使用示例demo:

view:

"""GenericAPIView的操作,在APIView的基础，针对序列化器对象和获取模型数据进行了简化代码以及功能扩展"""
from rest_framework.generics import GenericAPIView
from booktest.models import BookInfo
from .serializers import BookInfoModelSerializer

class BookInfoGenericAPIView(GenericAPIView):
    # 必须声明当前视图类中操作的模型数据是什么
    queryset = BookInfo.objects.all()
    # 可以声明当前视图类中要调用的序列化器是什么
    serializer_class = BookInfoModelSerializer
    def get(self,request):
        """获取所有数据"""
        # 1. 数据库操作
        # self.get_queryset() 是GenericAPIView提供的，用于获取多条数据
        data_list = self.get_queryset()
        # 2. 序列化
        serializer = self.get_serializer(instance=data_list,many=True)
        # 3. 响应数据
        return Response(serializer.data)

    def post(self,request):
        """添加数据"""
        # 1. 接受客户端提交的数据
        data = request.data
        # 2. 反序列化[验证和保存数据]
        # self.user = "小明",此处content是将self传入到序列化器中
        serializer = self.get_serializer(data=data,context={"view":self})
        serializer.is_valid(raise_exception=True)
        instance = serializer.save()
        # 3. 序列化
        serializer = self.get_serializer(instance=instance)
        # 4. 响应数据
        return Response(serializer.data)

class BookInfo2GenericAPIView(GenericAPIView):
    queryset = BookInfo.objects.all()
    serializer_class = BookInfoModelSerializer
    def get(self,request,pk):
        # 1. 根据id获取一条数据[使用self.get_object的前提是路由中必须声明一个pk的路由参数,如果没有这个参数，则报错]
        book = self.get_object()
        # 2. 序列化
        serializer = self.get_serializer(instance=book)
        # 3. 响应数据
        return Response(serializer.data)

View Code

urls:

from django.urls import path, re_path
from . import views
urlpatterns = [
    path("books2/",views.BookInfoGenericAPIView.as_view()),
    re_path("books2/(?P<pk>\d+)/",views.BookInfo2GenericAPIView.as_view())
,]

View Code

序列化器:

###############################################################################################################################
# 3 模型序列化器
# 1. 可以帮我们自动完成字段的声明[主要是从模型中的字段声明里面提取过来]
# 2. 模型序列化器也可以帮我们声明了create和update方法的代码
###############################################################################################################################
from rest_framework import serializers
from booktest.models import BookInfo
class BookInfoModelSerializer(serializers.ModelSerializer):
    # 模型序列化器也可以自定义验证字段[当某些数据不存在于数据库时,但是需要前端提交过来的,可以进行自定义,
    # 例如,验证码,确认密码]

    class Meta:
        model=BookInfo
        fields = "__all__"
        # 可以给模型序列化器里面指定的字段设置限制选项
        extra_kwargs = {
            "bread":{"min_value":0,"required":True},
        }

    # 自定义验证方法[验证单个字段,可以有多个方法]
    # def validate_<字段名>(self,data): # data当前字段对应的值
    def validate_btitle(self,data):

        print(self.context.get("view"))
        # 可以通过视图类附带一些数据到序列化器里面直接使用 view.py的69行代码
        # print(self.context.get("view").user)

        # 例如,图书名不能是红楼梦
        if data=="红楼梦":
            # 抛出错误
            raise serializers.ValidationError("红楼梦是禁书~")
        # 验证方法中,把数据值必须返回给字段,否则字段值为空
        return data

    # 自定义验证方法[验证多个或者所有字段,只能出现一次]
    def validate(self,data): # data 这个是所有字段的内容,字典类型
        bread = data.get("bread")
        bcomment = data.get("bcomment")
        if bread>=bcomment:
            return data
        raise serializers.ValidationError("阅读量小于评论量,数据太假了")

View Code

1.2.2 5个视图扩展类

作用：

提供了几种后端视图（对数据资源进行曾删改查）处理流程的实现，如果需要编写的视图属于这五种，则视图可以通过继承相应的扩展类来复用代码，减少自己编写的代码量。

这五个扩展类需要搭配GenericAPIView父类，因为五个扩展类的实现需要调用GenericAPIView提供的序列化器与数据库查询的方法。

五个扩展类:

1）ListModelMixin　列表视图扩展类，提供`list(request, *args, **kwargs)`方法快速实现列表视图。该Mixin的list方法会对数据进行过滤和分页。

2）CreateModelMixin 　　创建视图扩展类，提供`create(request, *args, **kwargs)`方法快速实现创建资源的视图，成功返回201状态码。

3） RetrieveModelMixin 　详情视图扩展类，提供`retrieve(request, *args, **kwargs)`方法，可以快速实现返回一个存在的数据对象。

4）UpdateModelMixin 　　更新视图扩展类，提供`update(request, *args, **kwargs)`方法，可以快速实现更新一个存在的数据对象。

5）DestroyModelMixin 　　删除视图扩展类，提供`destroy(request, *args, **kwargs)`方法，可以快速实现删除一个存在的数据对象。

使用demo:

views:

"""GenericAPIView视图类可以结合视图扩展类,快速实现大量简化视图方法的代码"""
from rest_framework.generics import GenericAPIView
from rest_framework import mixins
from demo1.models import BookInfo
from .serializers import BookInfoModelSerializer

class BookMixinAPIView(GenericAPIView,mixins.ListModelMixin,mixins.CreateModelMixin):
    queryset = BookInfo.objects.all()
    serializer_class = BookInfoModelSerializer
    def get(self, request):
        """获取所有数据"""
        return self.list(request)
    def post(self, request):
        """添加数据"""
        return self.create(request)

class Book2MixinAPIView(GenericAPIView,mixins.RetrieveModelMixin,mixins.DestroyModelMixin,mixins.UpdateModelMixin):
    queryset = BookInfo.objects.all()
    serializer_class = BookInfoModelSerializer
    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)

View Code

urls:

    path('books2/', BookMixinAPIView.as_view()),
    re_path('books2/(?P<pk>\d+)/', Book2MixinAPIView.as_view()),

View Code

1.2.3 几个子类视图

　　几个子类视图在drf开发接口中，使用GenericAPIView和视图扩展类结合起来完成接口功能是一件很常见的事情，所以，drf的作者帮我们提前把 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

demo使用示例:

"""在drf开发接口中，使用GenericAPIView和视图扩展类结合起来完成接口功能是一件很常见的事情，
所以，drf的作者帮我们提前把  GenericAPIView和视图扩展类结合子类也声明了出来
视图子类中还帮我们定义对应接口的视图方法代码，所以我们无需在视图中重复编写对用的视图方法了。
"""
from rest_framework.generics import ListAPIView,CreateAPIView # ListAPIView是 GernericAPIView和ListModelMixin的组合子类
class BookInfoSonAPIView(ListAPIView,CreateAPIView):
    queryset = BookInfo.objects.all()
    serializer_class = BookInfoModelSerializer

# from rest_framework.generics import RetrieveAPIView,UpdateAPIView,DestroyAPIView
from rest_framework.generics import RetrieveUpdateDestroyAPIView # 等同于上面同时引入的三个视图子类
class BookInfo2SonAPIView(RetrieveUpdateDestroyAPIView):
    queryset = BookInfo.objects.all()
    serializer_class = BookInfoModelSerializer

View Code

1.3 视图集ViewSet

　　上面的demo中,我们在需要用到详细信息时,总是要创建两个类, 视图集ViewSet类属性重复，如果把两个视图类集中成一个视图类，那么就要解决原来一个视图类中只能出现一个http请求方法的情况,为了解决这个问题 drf中提供了视图集帮我们通过改变路由和视图方法的绑定关系这种方式来解决

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

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

ViewSet视图集类不再实现get()、post()等方法，而是实现动作 action 如 list() 、create() 等。视图集只在使用as_view()方法的时候，才会将action动作与具体请求方式对应上

1.3.1 常用视图集父类

1） ViewSet

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

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

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

demo实现:

views:

"""上面可以看到类属性重复，如果把两个视图类集中成一个视图类，那么就要解决原来一个视图类中只能出现一个http请求方法的情况
drf中提供了视图集帮我们通过改变路由和视图方法的绑定关系这种方式来解决。
"""
from rest_framework.viewsets import ViewSet
from demo1.models import BookInfo
from .serializers import BookInfoModelSerializer
from rest_framework.response import Response
class BookAPIViewSet(ViewSet):
    def get_list(self,request):
        """获取所有数据"""
        # 1. 操作数据库
        books = BookInfo.objects.all()
        # 2. 序列化
        serializer = BookInfoModelSerializer(instance=books,many=True)
        # 3, 响应数据
        return Response(serializer.data)

    def get_one(self,request,pk):
        """获取一条数据"""
        # 根据ID获取一条数据
        book = BookInfo.objects.get(pk=pk)
        # 2. 序列化
        serializer = BookInfoModelSerializer(instance=book)
        # 3, 响应数据
        return Response(serializer.data)

    def get_top_5(self,request):
        """获取评论值最多的5条数据"""
        # 操作数据库
        books = BookInfo.objects.order_by("-bread")[:5]
        # 序列化
        serializer = BookInfoModelSerializer(instance=books,many=True)
        # 3, 响应数据
        return Response(serializer.data)

View Code

urls:

    path('books4/', BookAPIViewSet.as_view({"get":"get_list"})),
    path("books4/top5/",BookAPIViewSet.as_view({"get":"get_top_5"})),
    re_path('books4/(?P<pk>\d+)/', BookAPIViewSet.as_view({"get":"get_one"})),

View Code

　　注意:虽然通过viewset,我们将视图类变成一个,但是代码又回到了最初的APIView时代(重复代码多,不简洁),所以我们可以使用GenericViewSet来简化

2）GenericViewSet

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

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

demo:

views:

"""上面的代码又回到了最初的APIView时代,所以我们可以使用GenericViewSet来简化"""
from rest_framework.viewsets import GenericViewSet
from demo1.models import BookInfo
from .serializers import BookInfoModelSerializer
from rest_framework.response import Response
from rest_framework.mixins import ListModelMixin,RetrieveModelMixin
class BookGenericViewSet(GenericViewSet,ListModelMixin,RetrieveModelMixin):
    queryset = BookInfo.objects.all()
    serializer_class = BookInfoModelSerializer
    def get_list(self,request):
        """获取所有数据"""
        return self.list(request)

    def get_one(self,request,pk):
        """获取一条数据"""
        return self.retrieve(request,pk)

View Code

urls:

    path("books6/", views.BookGenericViewSet.as_view({"get": "get_list"})),
    re_path("books6/(?P<pk>\d+)/", views.BookGenericViewSet.as_view({"get": "get_one"})),

View Code

3）ModelViewSet

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

demo:

view:

"""对于上面虽然虽然已经简化了很多代码,但是drf中针对常用的5个接口,事实上有提供了预设类给我们直接使用"""
from rest_framework.viewsets import ModelViewSet,ReadOnlyModelViewSet
from demo1.models import BookInfo
from .serializers import BookInfoModelSerializer
from rest_framework.response import Response
class BookInfoModelViewSet(ModelViewSet):
    queryset = BookInfo.objects.all()
    serializer_class = BookInfoModelSerializer

    def get_top_5(self, request):
        """获取评论值最多的5条数据"""
        # 操作数据库
        print(self.action)  # 获取本次请求的视图方法名
        books = BookInfo.objects.order_by("-bread")[:5]
        # 序列化
        serializer = BookInfoModelSerializer(instance=books, many=True)
        # 3, 响应数据
        return Response(serializer.data)

View Code

urls:

 # 针对ModelViewSet提供的5个视图方法,路由以下:
    path("books7/", views.BookInfoModelViewSet.as_view({"get": "list"})),
    path("books7/", views.BookInfoModelViewSet.as_view({"post": "create"})),
    path("books7/top5/", views.BookInfoModelViewSet.as_view({"get": "get_top_5"})),
    re_path("books7/(?P<pk>\d+)/", views.BookInfoModelViewSet.as_view({"get": "retrieve"})),
    re_path("books7/(?P<pk>\d+)/", views.BookInfoModelViewSet.as_view({"put": "update"})),
    re_path("books7/(?P<pk>\d+)/", views.BookInfoModelViewSet.as_view({"delete": "destroy"})),
]

View Code

4）ReadOnlyModelViewSet

　　继承自GenericViewSet，同时包括了ListModelMixin、RetrieveModelMixin。使用方法和前面大致相同,此处不一一举例

1.3.3 action属性

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

例如：

from rest_framework.viewsets import ModelViewSet,ReadOnlyModelViewSet
from booktest.models import BookInfo
from .serializers import BookInfoModelSerializer
from rest_framework.response import Response
class BookInfoModelViewSet(ModelViewSet):
    queryset = BookInfo.objects.all()
    serializer_class = BookInfoModelSerializer

    def get_top_5(self,request):
        """获取评论值最多的5条数据"""
        # 操作数据库
        print(self.action) # 获取本次请求的视图方法名
        
        
通过路由访问到当前方法中.可以看到本次的action就是请求的方法名

View Code

2. 路由Routers

　　前面的视图中,我们虽然已经把视图简化到极致了,但是路由却还要生成很多个,于是我们必须对路由进行处理.

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

REST framework提供了两个router

SimpleRouter
DefaultRouter

2.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))
]

使用demo示例:

views:

from django.shortcuts import render
from rest_framework.decorators import action
from rest_framework.viewsets import ModelViewSet,ReadOnlyModelViewSet
from demo1.models import BookInfo,HeroInfo
from .serializers import BookInfoSerializer,HeroInfoSerializer
from rest_framework.response import Response
class BookInfoModelViewSet(ModelViewSet):
    queryset = BookInfo.objects.all()
    serializer_class = BookInfoSerializer

    @action(methods=[ "get"], detail=False)
    def get_top_5(self, request):
        """获取评论值最多的5条数据"""
        # 操作数据库
        print(self.action)  # 获取本次请求的视图方法名
        books = BookInfo.objects.order_by("-bread")[:5]
        # 序列化
        serializer = BookInfoSerializer(instance=books, many=True)
        # 3, 响应数据
        return Response(serializer.data)
        
        
    # action是drf提供的路由和视图方法绑定关系的装饰器
    # from rest_framework.decorators import action
    # 参数1: methods 列表，设置视图方法允许哪些http请求访问进来
    # 参数2: detail  当前是否方法是否属于详情页视图，
    #        False，系统不会自动增加pk在生成的路由地址中
    #        True  则系统会自动增加pk在生成的路由地址中
    @action(methods=["post", "get"], detail=True)
    def get_one_title(self, request, pk):
        book = BookInfo.objects.get(pk=pk)
        return Response(book.btitle)

class HeroInfoModelViewSet(ModelViewSet):
    queryset = HeroInfo.objects.all()
    serializer_class = HeroInfoSerializer

View Code

urls:

from django.urls import path, re_path
from . import views
# urlpatterns = [
    # 针对ModelViewSet提供的5个视图方法,路由以下:
    # path("books7/", views.BookInfoModelViewSet.as_view({"get":"list"})),
    # path("books7/", views.BookInfoModelViewSet.as_view({"post":"create"})),
    # re_path("books7/(?P<pk>\d+)/", views.BookInfoModelViewSet.as_view({"get":"retrieve"})),
    # re_path("books7/(?P<pk>\d+)/", views.BookInfoModelViewSet.as_view({"put":"update"})),
    # re_path("books7/(?P<pk>\d+)/", views.BookInfoModelViewSet.as_view({"delete":"destroy"})),
# ]
##上面是原本要写的路由,通过下面方法简化
urlpatterns=[]
from rest_framework.routers import SimpleRouter,DefaultRouter
router = DefaultRouter()

# router.register("路由地址的前缀","视图集类")
router.register("books8",views.BookInfoModelViewSet)
router.register("heros",views.HeroInfoModelViewSet)

print(router.urls)

urlpatterns += router.urls

View Code

serializers:

from rest_framework import serializers
from demo1.models import BookInfo,HeroInfo

class BookInfoModelSerializer(serializers.ModelSerializer):
    class Meta:
        model = BookInfo
        fields='__all__'
        # 可以给模型序列化器里面指定的字段设置限制选项
        extra_kwargs = {
            "bread": {"min_value": 0, "required": True},
        }

class HeroInfoModelSerializer(serializers.ModelSerializer):
    class Meta:
        model=HeroInfo
        fields = "__all__"

View Code

2.2 视图集中附加action的声明

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

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

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

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

: 声明该action的路径是否与单一资源对应，及是否是

xxx/<pk>/action方法名/True 表示路径格式是xxx/<pk>/action方法名/

True 表示路径格式是xxx/<pk>/action方法名/
False 表示路径格式是xxx/action方法名/

对应的使用方法:可以参看上一个路由router中的demo

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

posted @ 2019-03-19 22:22 Mixtea 阅读(571) 评论(0) 编辑收藏举报

Mixtea

DRF之视图和router

1. 视图

1.1. 请求与响应

1.1.1 Request

1.1.1.1 常用属性

1）request.data

2）.query_params

1.1. 请求与响应

1.1.1 Request

1.1.2 Response

1.1.2.1 构造方式

1.1.2.2 常用属性

1）.data 传给response对象的序列化后，但尚未render处理的数据

2）.status_code 状态码的数字

3）.content 经过render处理后的响应数据

1.1.2.3 状态码

1）信息告知 - 1xx

2）成功 - 2xx

3）重定向 - 3xx

4）客户端错误 - 4xx

5）服务器错误 - 5xx

1.2 视图

1.2.1 2个视图基类

1.2.1.1 APIView

1.2.1.2 GenericAPIView[通用视图类]

get_serializer(self, args, *kwargs)

1.2.2 5个视图扩展类

五个扩展类:

1）ListModelMixin 列表视图扩展类，提供list(request, *args, **kwargs)方法快速实现列表视图。该Mixin的list方法会对数据进行过滤和分页。

2）CreateModelMixin 创建视图扩展类，提供create(request, *args, **kwargs)方法快速实现创建资源的视图，成功返回201状态码。

3） RetrieveModelMixin 详情视图扩展类，提供retrieve(request, *args, **kwargs)方法，可以快速实现返回一个存在的数据对象。

4）UpdateModelMixin 更新视图扩展类，提供update(request, *args, **kwargs)方法，可以快速实现更新一个存在的数据对象。

5）DestroyModelMixin 删除视图扩展类，提供destroy(request, *args, **kwargs)方法，可以快速实现删除一个存在的数据对象。

1.2.3 几个子类视图

1）CreateAPIView

3）RetrieveAPIView

4）DestoryAPIView

5）UpdateAPIView

6）RetrieveUpdateAPIView

7）RetrieveUpdateDestoryAPIView

1.3 视图集ViewSet

1.3.1 常用视图集父类

1） ViewSet

注意:虽然通过viewset,我们将视图类变成一个,但是代码又回到了最初的APIView时代(重复代码多,不简洁),所以我们可以使用GenericViewSet来简化

2）GenericViewSet

3）ModelViewSet

4）ReadOnlyModelViewSet

1.3.3 action属性

2. 路由Routers

2.1 使用方法

2.2 视图集中附加action的声明

公告

1）ListModelMixin　列表视图扩展类，提供`list(request, *args, **kwargs)`方法快速实现列表视图。该Mixin的list方法会对数据进行过滤和分页。

2）CreateModelMixin 　　创建视图扩展类，提供`create(request, *args, **kwargs)`方法快速实现创建资源的视图，成功返回201状态码。

3） RetrieveModelMixin 　详情视图扩展类，提供`retrieve(request, *args, **kwargs)`方法，可以快速实现返回一个存在的数据对象。

4）UpdateModelMixin 　　更新视图扩展类，提供`update(request, *args, **kwargs)`方法，可以快速实现更新一个存在的数据对象。

5）DestroyModelMixin 　　删除视图扩展类，提供`destroy(request, *args, **kwargs)`方法，可以快速实现删除一个存在的数据对象。

　　注意:虽然通过viewset,我们将视图类变成一个,但是代码又回到了最初的APIView时代(重复代码多,不简洁),所以我们可以使用GenericViewSet来简化