drf基础:视图 | django |《python学习之路》| python 技术论坛-380玩彩网官网入口

视图概览

简介

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

视图的继承关系

视图的方法与属性

视图说明

两个基类

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

举例：

from rest_framework.views import apiview
from rest_framework.response import response
# ),
class booklistview(apiview):
    def get(self, request):
        books = bookinfo.objects.all()
        serializer = bookinfoserializer(books, many=true)
        return response(serializer.data)

genericapiview

简介

rest_framework.generics.genericapiview

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

支持定义的属性

• 列表视图与详情视图通用：
  • queryset 列表视图的查询集
  • serializer_class 视图使用的序列化器
• 列表视图使用：
  • pagination_class 分页控制类
  • filter_backends 过滤控制后端
• 详情页视图使用：
  • lookup_field 查询单一数据库对象时使用的条件字段，默认为’pk‘
  • lookup_url_kwarg 查询单一数据时url中的参数关键字名称，默认与look_field相同

提供的方法

• 列表视图与详情视图通用：

  • get_queryset(self)

    返回视图使用的查询集，是列表视图与详情视图获取数据的基础，默认返回queryset属性，可以重写，例如：

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

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

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

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

• 详情视图使用：

  • get_object(self) 返回详情视图所需的模型类数据对象，默认使用lookup_field参数来过滤queryset。 在试图中可以调用该方法获取详情信息的模型类对象。

    若详情访问的模型类对象不存在，会返回404。

    该方法会默认使用apiview提供的check_object_permissions方法检查当前对象是否有权限被访问。

五个扩展类

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)

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

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)

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)

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

几个可用子类视图

createapiview

说明

提供 post 方法，继承自： genericapiview、createmodelmixin

listapiview

提供 get 方法，继承自：genericapiview、listmodelmixin

retireveapiview

提供 get 方法，继承自: genericapiview、retrievemodelmixin

destoryapiview

提供 delete 方法，继承自：genericapiview、destorymodelmixin

updateapiview

提供 put 和 patch 方法，继承自：genericapiview、updatemodelmixin

retrieveupdateapiview

提供 get、put、patch方法，继承自： genericapiview、retrievemodelmixin、updatemodelmixin

retrieveupdatedestoryapiview

提供 get、put、patch、delete方法，继承自：genericapiview、retrievemodelmixin、updatemodelmixin、destorymodelmixin

视图集viewset

简介

使用视图集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\d )/$', bookinfoviewset.as_view({'get': 'retrieve'})
]

action属性

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

例如：

def get_serializer_class(self):
    if self.action == 'create':
        return ordercommitserializer
    else:
        return orderdataserializer

常用视图集父类

viewset

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

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

genericviewset

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

modelviewset

继承自genericapiview，同时包括了listmodelmixin、retrievemodelmixin、createmodelmixin、updatemodelmixin、destorymodelmixin。

readonlymodelviewset

继承自genericapiview，同时包括了listmodelmixin、retrievemodelmixin。

视图集中定义附加action动作

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

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

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

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

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

• detail

  : 表示是action中要处理的是否是视图资源的对象（即是否通过url路径获取主键）

  • true 表示使用通过url获取的主键对应的数据对象
  • false 表示不使用url获取主键

路由routers

简介

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

rest framework提供了两个router

• simplerouter
• defaultrouter

使用方法

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

  from rest_framework import routers
  router = routers.simplerouter()
  router.register(r'books', bookinfoviewset, base_name='book')

  register(prefix, viewset, base_name)

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

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

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

• 添加路由数据，可以有两种方式：

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

  或

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

视图集中包含附加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

路由router形成url的方式

1） simplerouter

2）defaultrouter

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

request

简介

rest framework 传入视图的request对象不再是django默认的httprequest对象，而是rest framework提供的扩展了httprequest类的request类的对象。

rest framework 提供了parser解析器，在接收到请求后会自动根据content-type指明的请求数据类型（如json、表单等）将请求数据进行parse解析，解析为类字典对象保存到request对象中。

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

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

常用属性

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

  • 包含了解析之后的文件和非文件数据
  • 包含了对post、put、patch请求方式解析后的数据
  • 利用了rest framework的parsers解析器，不仅支持表单类型数据，也支持json数据

• .query_params：request.query_params与django标准的request.get相同，只是更换了更正确的名称而已。

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渲染器
    )
}

构造方式

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会根据前端所需类型数据来设置该参数。

常用属性

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

• .status_code：状态码的数字

• .content：经过render处理后的响应数据

状态码

简介

为了方便设置状态码，rest framewrok在rest_framework.status模块中提供了常用状态码常量。

常见状态码

信息告知

http_100_continue
http_101_switching_protocols

成功

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

重定向

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

客户端错误

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

服务器错误

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