7.9.7视图
Django REST framwork 提供的视图的主要作用:
- 控制序列化器的执行(检验、保存、转换数据)
- 控制数据库查询的执行
(1)Request
1)介绍
request对象的数据是自动根据前端发送数据的格式进行解析之后的结果
2)属性
①.data返回解析
request.data返回解析之后的请求体数据。类似于django中标准的request.POST和request.FILES属性,但提供如下特征:
- 包含了解析之后的文件和非文件数据
- 包含了对POST、PUT、PATCH请求方式解析后的数据
- 利用了REST framework的parsers解析器,不仅支持表单类型数据,也支持JSON数据
②.query_params
request.query_params与Django标准的request.GET相同,只是更换了更正确的名称而已
(2)Response
1)介绍
rest_framework.response.Response
REST framework提供了一个响应类Response,使用该类构造响应对象时,响应的具体数据内容会被转换(render渲染)成符合前端需求的类型。
2)渲染器
①REST framework提供了Renderer渲染器,用来根据请求头中的Accept(接收数据类型声明)来自动转换响应数据到对应格式
②如果前端请求中为进行Accept声明,则会采用默认方式处理响应数据,可以通过配置来修改默认响应格式
③
REST_FRAMEWORK = {
'DEFAULT_RENDERER_CLASSES': ( # 默认响应渲染类
'rest_framework.renderers.JSONRenderer', # json渲染器
'rest_framework.renderers.BrowsableAPIRenderer', # 浏览API渲染器
)
}
3)构造方法
Response(data, status=None, template_name=None, headers=None, content_type=None)
参数说明:
- data: 为响应准备的序列化处理后的数据;
- status: 状态码,默认200;
- template_name: 模板名称,如果使用HTMLRenderer 时需指明;
- headers: 用于存放响应头信息的字典;
- content_type: 响应数据的Content-Type,通常此参数无需传递,REST framework会根据前端所需类型数据来设置该参数
4)属性
1).data
传给response对象的序列化后,但尚未render处理的数据
2).status_code
状态码的数字
3).content
经过render处理后的响应数据
5)状态码
为了方便设置状态码,REST framewrok在rest_framework.status模块中提供了常用状态码常量。
(3)使用APIView基类视图
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() 或者其他请求方式的方法。
2)后端接口实现
①视图
class BookListView(APIView):
"""使用APIView实现获取所有图书信息接口"""
def get(self,request):
"""
提供所有图书信息
:param request: Request类型的对象
:return: Json
"""
# 获取图书信息的查询集
qs = BookInfo.objects.all()
# 序列化模型数据做输出
serializer = BookInfoSerializer(qs,many=True)
#响应json数据
return Response(serializer.data)
②路由
url(r'^books/$',views.BookListView.as_view()),
(4)使用GenericAPIView基类视图
1)GenericAPIView基类视图介绍
①rest_framework.generics.GenericAPIView
继承自APIVIew,主要增加了操作序列化器和数据库查询的方法,作用是为下面Mixin扩展类的执行提供方法支持。通常在使用时,可搭配一个或多个Mixin扩展类。
②提供的关于序列化器使用的属性与方法
- 属性:
- serializer_class 指明视图使用的序列化器
- 方法:
- get_serializer_class(self)
返回序列化器类,默认返回serializer_class,可以重写
- get_serializer(self, args, *kwargs)
返回序列化器对象,主要用来提供给Mixin扩展类使用,如果在视图中想要获取序列化器对象,也可以直接调用此方法。
注意,该方法在提供序列化器对象的时候,会向序列化器对象的context属性补充三个数据:request、format、view,这三个数据对象可以在定义序列化器时使用。
- request 当前视图的请求对象
- view 当前请求的类视图对象
- format 当前请求期望返回的数据格式
③提供的关于数据库查询的属性与方法
- 属性:
- queryset 指明使用的数据查询集
- 方法:
- get_queryset(self)
返回视图使用的查询集,主要用来提供给Mixin扩展类使用,是列表视图与详情视图获取数据的基础,默认返回queryset属性,可以重写
- get_object(self)
返回详情视图所需的模型类数据对象,主要用来提供给Mixin扩展类使用。
在视图中可以调用该方法获取详情信息的模型类对象。
若详情访问的模型类对象不存在,会返回404。
该方法会默认使用APIView提供的check_object_permissions方法检查当前对象是否有权限被访问。
2)实现'获取所有图书信息'接口
①视图
class BookListView(GenericAPIView):
# 指定查询集
queryset = BookInfo.objects.all()
# 指定序列化器
serializer_class = BookInfoSerializer
def get(self,request):
"""
GET /books/
:param request: Request类型的对象
:return: Json
"""
# 查询数据库
qs = self.get_queryset()
# 实现序列化
serializer = self.get_serializer(qs,many=True)
# 响应序列化结果
return Response(serializer.data)
②路由
url(r'^books/$',views.BookListView.as_view()),
3)实现‘获取单一图书信息’接口
①视图
class BookDetailView(GenericAPIView):
# 指定查询集
queryset = BookInfo.objects.all()
# 指定序列化器
serializer_class = BookInfoSerializer
def get(self, request,pk):
"""
GET /books/<pk>/
:param request:Request类型的对象
:param pk: 要访问的数据库记录
:return: Json
"""
# 查询数据库:默认根据pk查询数据库单一结果
book = self.get_object()
# 实现序列化
serializer = self.get_serializer(book)
# 响应序列化结果
return Response(serializer.data)
②路由
url(r'^books/(?P<pk>\d+)/$',views.BookDetailView.as_view())
(5)使用Mixin扩展类
1)Mixin扩展类介绍
这五个扩展类需要搭配GenericAPIView父类,因为五个扩展类的实现需要调用GenericAPIView提供的序列化器与数据库查询的方法
①ListModelMixin
列表视图扩展类,提供list(request, *args, **kwargs)方法快速实现列表视图,返回200状态码。该Mixin的list方法会对数据进行过滤和分页。
②CreateModelMixin
创建视图扩展类,提供create(request, *args, **kwargs)方法快速实现创建资源的视图,成功返回201状态码。如果序列化器对前端发送的数据验证失败,返回400错误。
③RetrieveModelMixin
详情视图扩展类,提供retrieve(request, *args, **kwargs)方法,可以快速实现返回一个存在的数据对象。如果存在,返回200, 否则返回404。
④UpdateModelMixin
更新视图扩展类,提供update(request, *args, **kwargs)方法,可以快速实现更新一个存在的数据对象。同时也提供partial_update(request, *args, **kwargs)方法,可以实现局部更新。成功返回200,序列化器校验数据失败时,返回400错误。
⑤DestroyModelMixin
删除视图扩展类,提供destroy(request, *args, **kwargs)方法,可以快速实现删除一个存在的数据对象。成功返回204,不存在返回404。
2)使用Mixin扩展类搭配GenericAPIView基类视图,实现'获取所有图书信息'接口
class BookListView(mixins.ListModelMixin,GenericAPIView):
# 指定查询集
queryset = BookInfo.objects.all()
# 指定序列化器
serializer_class = BookInfoSerializer
def get(self,request):
"""
GET /books/
:param request:Request类型的对象
:return: Json
"""
return self.list(request)
(6)几个可用子类视图
1)子类视图介绍
① CreateAPIView
提供 post 方法
继承自: GenericAPIView、CreateModelMixin
②ListAPIView
提供 get 方法
继承自:GenericAPIView、ListModelMixin
③RetrieveAPIView
提供 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
2)使用GenericAPIView子类视图,实现'获取所有图书信息'接口
class BookListView(ListAPIView):
# 指定查询集
queryset = BookInfo.objects.all()
# 指定序列化器
serializer_class = BookInfoSerializer