余晖落尽暮晚霞,黄昏迟暮远山寻
本站
当前位置:网站首页 > 编程知识 > 正文

Django REST framework学习笔记(3)-请求和响应

xiyangw 2022-11-24 16:38 68 浏览 0 评论

Django REST framework在Django原有的基础上,新增了一个request对象继承了APIView视图类,并在原有的HttpResponse响应类的基础上实现了一个子类Response响应类,这2个类,都是基于内容协商来完成数据的格式转换的。

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

REST framework提供了Parser解析器,在接收到请求后会自动根据Content-Type指明的请求数据类型(如JSON、表单等)将请求数据进行parse解析,解析为类字典[QueryDict]对象保存到Request对象中。

request -> parser ->识别客户端请求头中的Content-Type来完成数据转换成->类字典(QueryDict,字典的子类)

Response -> renderer ->识别客户端请求头的Accept来提取客户期望的返回数据格式,转换成客户端的期望格式数据

Request

REST framework引入了一个扩展常规HttpRequestRequest对象,并提供了更灵活的请求解析。允许你使用JSON data或 其他media types像通常处理表单数据一样处理请求。

常用属性

1 request.data返回请求主题的解析内容。这跟标准的request.POSTrequest.FILES类似,并且还具有以下特点:

  • 包括所有解析的内容,文件(file) 和 非文件(non-file inputs)。
  • 支持解析POST以外的HTTP method , 比如 PUTPATCH
  • 更加灵活,不仅仅支持表单数据,传入同样的JSON数据一样可以正确解析,并且不用做额外的处理(意思是前端不管提交的是表单数据,还是JSON数据,.data都能够正确解析)。
 request.POST  # 只处理表单数据 只适用于'POST'方法
 request.data  # 处理任意数据 适用于'POST','PUT'和'PATCH'方法

2 request.query_params等同于request.GET,不过其名字更加容易理解。为了代码更加清晰可读,推荐使用request.query_params ,而不是Django中的request.GET,这样能够让你的代码更加明显的体现出任何HTTP method类型都可能包含查询参数(query parameters),而不仅仅只是GET请求。

3 request._request获取django封装的Request对象

由于REST framework的Request扩展于Django的HttpRequest,所有其他标准属性和方法也可用。例如request.META和 request.session字典都可以正常使用。

 #基本使用
 from rest_framework.views import APIView
 #from rest_framework.request import Request
 from rest_framework.response import Response
 
 class StuAPIView(APIView):
     def post(self, request):
         """获取请求体数据"""
         print(f"drf.request.data={request.data}")  # 接受的数据会解析成字典
         # json: drf.request.data={'name': 'you1', 'desc': 'hello world'}
         # form表单: drf.request.data=<QueryDict: {'name': ['fan'], 'desc': ['hello']}>
 
         """获取查询参数"""
         print(f"drf.request.query_params={request.query_params}")
         # <QueryDict: {'name': ['fan']}>
         return Response({"msg": "ok"})

Response

REST框架还引入了一个Response对象,使用该类构造响应对象时,响应的具体数据内容会被转换(render渲染)成符合前端需求的类型。

REST framework提供了renderer渲染器,用来根据请求头中的Accept(接收数据类型声明)来自动转换响应数据到对应格式,如果前端请求中未声明Accept,则采用Content-Type方式处理响应数据。

 # 由于是默认的配置,所以settings配置文件中可以不配置以下选项
 REST_FRAMEWORK = {
     'DEFAULT_RENDERER_CLASSES': [ #默认响应渲染类
         'rest_framework.renderers.JSONRenderer', #json渲染器
         'rest_framework.renderers.BrowsableAPIRenderer', #浏览器渲染器,有调试界面
    ]
 }
 #构造方法
 Response(data, status=None, template_name=None, headers=None, content_type=None)
 #参数:
 data: 响应的序列化数据。
 status: 响应的状态代码。默认为200。
 template_name: 选择 HTMLRenderer 时使用的模板名称。
 headers: 设置 HTTP header,字典类型。
 content_type: 响应的内容类型,通常渲染器会根据内容协商的结果自动设置,但有些时候需要手动指定。
 
 #比较完整的使用
 response={'code':100,'msg':'查询成功','result':ser.data}
 return Response(response,status=status.HTTP_201_CREATED,headers={'xxx':"xxx"})

常用属性

  1. .data:还没有渲染,但已经序列化的响应数据。
  2. .status_code:状态码
  3. .content:将会返回的响应内容,必须先调用 .render() 方法,才能访问 .content
  4. .template_name:只有在 response 的渲染器是 HTMLRenderer 或其他自定义模板渲染器时才需要提供
  5. .accepted_renderer:用于将会返回的响应内容的渲染器实例从视图返回响应之前由 APIView 或 @api_view 自动设置。
  6. .accepted_media_type:内容协商阶段选择的媒体类型从视图返回响应之前由 APIView 或 @api_view 自动设置。
  7. .renderer_context:将传递给渲染器的 .render() 方法的附加的上下文信息字典从视图返回响应之前由 APIView 或 @api_view 自动设置。

状态码

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

 from rest_framework import status
 
 #1.信息告知 - 1xx
 HTTP_100_CONTINUE
 HTTP_101_SWITCHING_PROTOCOLS
 
 #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
 
 #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
 
 #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
 
 #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

封装Response

参考链接:https://www.jianshu.com/p/c0be24752584

 #1.response.py
 from rest_framework.response import Response
 class APIResponse(Response):
     def __init__(self, code=100, msg='成功', data=None, status=None, headers=None, exception=False, content_type=None, **kwargs):
         dic = {'code': code, 'msg': msg}
         if data: #如果data有值,说明要往里面放东西
             dic['data'] =  data
         if kwargs: #自定义传的参数会添加到字典里
         dic.update(kwargs)
         super().__init__(data=dic, status=status, headers=headers, exception=exception, content_type=content_type)
 
 #2.在视图中使用
 from .response import APIResponse
 return APIResponse(data={'name': 'fana', 'age': 19})

解析器

REST framework 包含许多内置的解析器类,允许接受各种媒体类型(media types)的请求。还支持自定义解析器,这使你可以灵活地设计 API 接受的媒体类型。

 #1.settings.py #查看默认解析器
 from rest_framework import settings
 
 REST_FRAMEWORK = {
     'DEFAULT_RENDERER_CLASSES': [ #渲染器
         'rest_framework.renderers.JSONRenderer',
         'rest_framework.renderers.TemplateHTMLRenderer',
    ],
     'DEFAULT_PARSER_CLASSES': [ #解析器
         'rest_framework.parsers.JSONParser',
         'rest_framework.parsers.FormParser',
         'rest_framework.parsers.MultiPartParser',
    ],
 }

YAML

GitHub:https://jpadilla.github.io/django-rest-framework-yaml

REST framework YAML提供YAML解析和渲染支持。它以前直接包含在REST framework包中,现在作为第三方包

 #1.安装模块
 pip install djangorestframework-yaml
 
 #2.settings.py
 REST_FRAMEWORK = {
     'DEFAULT_PARSER_CLASSES': (
         'rest_framework_yaml.parsers.YAMLParser',
    ),
     'DEFAULT_RENDERER_CLASSES': (
         'rest_framework_yaml.renderers.YAMLRenderer',
    ),
 }

XML

GitHub:https://jpadilla.github.io/django-rest-framework-xml/

REST Framework XML提供了一种简单的非正式XML格式。它以前直接包含在REST framework包中,现在作为第三方包。

 #1.安装模块
 pip install djangorestframework-xml
 
 #2.settings.py
 REST_FRAMEWORK = {
     'DEFAULT_PARSER_CLASSES': (
         'rest_framework_xml.parsers.XMLParser',
    ),
     'DEFAULT_RENDERER_CLASSES': (
         'rest_framework_xml.renderers.XMLRenderer',
    ),
 }

相关推荐

数控系统常见术语详解,机加工人士必备资料
数控系统常见术语详解,机加工人士必备资料

增量编码器(Incrementpulsecoder)回转式位置测量元件,装于电动机轴或滚珠丝杠上,回转时发出等间隔脉冲表示位移量。由于没有记忆元件,故不能准...

2023-09-24 17:42 xiyangw

功、功率、扭矩的关系

功=功率×时间work=power×timeW=P×T功=力×距离work=force×lengthW=F×LP×T=F×LP=F×L/T=F×V(velocity)具体到电机输出轴上,圆...

Wi-Fi协议(802.11 )常见专业术语汇总
Wi-Fi协议(802.11 )常见专业术语汇总

Wi-Fi协议(802.11)常见专业术语汇总AP(Accesspoint的简称,即访问点,接入点):是一个无线网络中的特殊节点,通过这个节点,无线网络中的...

2023-09-24 17:41 xiyangw

不需要策略模式也能避免满屏if/else
不需要策略模式也能避免满屏if/else

满屏if/elsejava复制代码publicstaticvoidmain(String[]args){inta=1;if...

2023-09-24 17:41 xiyangw

喜极而泣,我终于干掉了该死的 if-else
喜极而泣,我终于干掉了该死的 if-else

推荐阅读:面试淘宝被Tomcat面到“自闭”,学习这份文档之后“吊打”面试官刷完spring+redis+负载均衡+netty+kafka面试题,再去面试BAT...

2023-09-24 17:40 xiyangw

Python中使用三元运算符简化if-else语句
Python中使用三元运算符简化if-else语句

Python是一种极简主义的编程语言,相比其他编程语言,在多个地方简化了代码的写法,可以让我们用更少的时间更简洁地完成工作。以赋值运算符为例:a=a+b简化...

2023-09-24 17:40 xiyangw

雅思课堂 | 雅思口语写作句型第二讲
雅思课堂 | 雅思口语写作句型第二讲

纯干货,无废话用最少的时间学最制胜的内容!泡图书馆泡不过学霸?碎片时间也能弯道超车!向着雅思8分行动起来吧!雅思口语写作句型1.Ipreferseeing...

2023-09-24 17:39 xiyangw

设计模式(三)——简单的状态模式代替if-else
设计模式(三)——简单的状态模式代替if-else

博主将会针对Java面试题写一组文章,包括J2ee,SQL,主流Web框架,中间件等面试过程中面试官经常问的问题,欢迎大家关注。一起学习,一起成长。前言大多数开...

2023-09-24 17:38 xiyangw

如何优化代码中大量的if/else,switch/case?

前言随着项目的迭代,代码中存在的分支判断可能会越来越多,当里面涉及到的逻辑比较复杂或者分支数量实在是多的难以维护的时候,我们就要考虑下,有办法能让这些代码变得更优雅吗?正文使用枚举这里我们简单的定义一...

优秀程序员早就学会用“状态模式”代替if-else了
优秀程序员早就学会用“状态模式”代替if-else了

2020年已经进入倒计时了,大家立好的flag完成了吗?2020实“鼠”不易,希望2021可以“牛”转乾坤。简介状态模式是行为型设计模式的一种。其设计理念是当对...

2023-09-24 17:37 xiyangw

用Select Case语句对执行多条件进行控制
用Select Case语句对执行多条件进行控制

今日的内容是"VBA之EXCEL应用"的第六章"条件判断语句(If...Then...Else)在VBA中的利用"。这讲是第三节...

2023-09-24 17:37 xiyangw

c#入门教程(四)条件判断if else

条件判断,是编程里常用的判断语句,比如某个代码如果满足条件就执行a代码块否则就执行b代码块。案例1:inti=2*5;if(a>0){执行a代码块}elseif(a<0){执行b代码块...

每日学编程之JAVA(十一)—条件语句(if……else)

一个if语句包含一个布尔表达式和一条或多条语句。如果布尔表达式的值为true,则执行if语句中的代码块,否则执行if语句块后面的代码。if语句后面可以跟else语句,当if语句...

不需要策略模式也能避免满屏if/else

除了使用策略模式以外,还可以使用其他设计模式来避免满屏if/else的问题。以下是一些可能的解决方案:工厂模式:将if/else语句移到工厂类中,由工厂类负责创建对象。这样可以将if/else语句从客...

围绕ifelse与业务逻辑的那些梗
围绕ifelse与业务逻辑的那些梗

ifelse很重要,几乎是程序员编程核心,业务逻辑与规则也通过ifelse体现出来,语句简单但是背后文章很大,先看几则幽默图:1.也许默认使用returnf...

2023-09-24 17:36 xiyangw

取消回复欢迎 发表评论: