03 drf-请求与响应 - 图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).data

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

  • 包含了解析之后的文件和非文件数据
  • 包含了对POST、PUT、PATCH请求方式解析后的数据
  • 利用了REST framework的parsers解析器,不仅支持表单类型数据,也支持JSON数据
    2).query_params
    request.query_params与Django标准的request.GET相同,只是更换了更正确的名称而已。

    1.2 Response

    1. rest_framework.response.Response
    REST framework提供了一个响应类Response,使用该类构造响应对象时,响应的具体数据内容会被转换(render渲染)成符合前端需求的类型。
    REST framework提供了Renderer 渲染器,用来根据请求头中的Accept(接收数据类型声明)来自动转换响应数据到对应格式。如果前端请求中未进行Accept声明,则会采用默认方式处理响应数据,我们可以通过配置来修改默认响应格式。
    可以在rest_framework.settings查找所有的drf默认配置项
    1. REST_FRAMEWORK = {
    2. 'DEFAULT_RENDERER_CLASSES': ( # 默认响应渲染类
    3. 'rest_framework.renderers.JSONRenderer', # json渲染器
    4. 'rest_framework.renderers.BrowsableAPIRenderer', # 浏览API渲染器
    5. )
    6. }

    1.1.2.1 构造方式


  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 常用属性


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

1)信息告知 - 1xx
  1. HTTP_100_CONTINUE
  2. HTTP_101_SWITCHING_PROTOCOLS

2)成功 - 2xx
  1. HTTP_200_OK
  2. HTTP_201_CREATED
  3. HTTP_202_ACCEPTED
  4. HTTP_203_NON_AUTHORITATIVE_INFORMATION
  5. HTTP_204_NO_CONTENT
  6. HTTP_205_RESET_CONTENT
  7. HTTP_206_PARTIAL_CONTENT
  8. HTTP_207_MULTI_STATUS

3)重定向 - 3xx
  1. HTTP_300_MULTIPLE_CHOICES
  2. HTTP_301_MOVED_PERMANENTLY
  3. HTTP_302_FOUND
  4. HTTP_303_SEE_OTHER
  5. HTTP_304_NOT_MODIFIED
  6. HTTP_305_USE_PROXY
  7. HTTP_306_RESERVED
  8. HTTP_307_TEMPORARY_REDIRECT

4)客户端错误 - 4xx
  1. HTTP_400_BAD_REQUEST
  2. HTTP_401_UNAUTHORIZED
  3. HTTP_402_PAYMENT_REQUIRED
  4. HTTP_403_FORBIDDEN
  5. HTTP_404_NOT_FOUND
  6. HTTP_405_METHOD_NOT_ALLOWED
  7. HTTP_406_NOT_ACCEPTABLE
  8. HTTP_407_PROXY_AUTHENTICATION_REQUIRED
  9. HTTP_408_REQUEST_TIMEOUT
  10. HTTP_409_CONFLICT
  11. HTTP_410_GONE
  12. HTTP_411_LENGTH_REQUIRED
  13. HTTP_412_PRECONDITION_FAILED
  14. HTTP_413_REQUEST_ENTITY_TOO_LARGE
  15. HTTP_414_REQUEST_URI_TOO_LONG
  16. HTTP_415_UNSUPPORTED_MEDIA_TYPE
  17. HTTP_416_REQUESTED_RANGE_NOT_SATISFIABLE
  18. HTTP_417_EXPECTATION_FAILED
  19. HTTP_422_UNPROCESSABLE_ENTITY
  20. HTTP_423_LOCKED
  21. HTTP_424_FAILED_DEPENDENCY
  22. HTTP_428_PRECONDITION_REQUIRED
  23. HTTP_429_TOO_MANY_REQUESTS
  24. HTTP_431_REQUEST_HEADER_FIELDS_TOO_LARGE
  25. HTTP_451_UNAVAILABLE_FOR_LEGAL_REASONS

5)服务器错误 - 5xx
  1. HTTP_500_INTERNAL_SERVER_ERROR
  2. HTTP_501_NOT_IMPLEMENTED
  3. HTTP_502_BAD_GATEWAY
  4. HTTP_503_SERVICE_UNAVAILABLE
  5. HTTP_504_GATEWAY_TIMEOUT
  6. HTTP_505_HTTP_VERSION_NOT_SUPPORTED
  7. HTTP_507_INSUFFICIENT_STORAGE
  8. HTTP_511_NETWORK_AUTHENTICATION_REQUIRED