沈阳网站推广￥做下拉去118cr,外贸英文网站制作,南京浦口住房与城乡建设局网站,店铺设计软件Python学习之路-DRF基础:视图
视图概览
简介
REST framework 提供了众多的通用视图基类与扩展类#xff0c;以简化视图的编写。
视图的继承关系 视图的方法与属性 视图说明
两个基类
APIView
简介
rest_framework.views.APIView
APIView是REST framework提供的所有视…Python学习之路-DRF基础:视图
视图概览
简介
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# url(r^books/$, views.BookListView.as_view()),
class BookListView(APIView):def get(self, request):books BookInfo.objects.all()serializer BookInfoSerializer(books, manyTrue)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.userreturn user.accounts.all()get_serializer_class(self) 返回序列化器类默认返回serializer_class可以重写例如 def get_serializer_class(self):if self.request.user.is_staff:return FullAccountSerializerreturn BasicAccountSerializerget_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, manyTrue)return self.get_paginated_response(serializer.data)# 序列化serializer self.get_serializer(queryset, manyTrue)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(datarequest.data)# 验证serializer.is_valid(raise_exceptionTrue)# 保存self.perform_create(serializer)headers self.get_success_headers(serializer.data)return Response(serializer.data, statusstatus.HTTP_201_CREATED, headersheaders)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, datarequest.data, partialpartial)serializer.is_valid(raise_exceptionTrue)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] Truereturn 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(statusstatus.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, pkNone):...在设置路由时我们可以如下操作
urlpatterns [url(r^books/$, BookInfoViewSet.as_view({get:list}),url(r^books/(?Ppk\d)/$, BookInfoViewSet.as_view({get: retrieve})
]action属性
在视图集中我们可以通过action对象属性来获取当前请求视图集时的action动作是哪个。
例如
def get_serializer_class(self):if self.action create:return OrderCommitSerializerelse: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
SimpleRouterDefaultRouter
使用方法 创建router对象并注册视图集例如 from rest_framework import routersrouter routers.SimpleRouter()
router.register(rbooks, BookInfoViewSet, base_namebook)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 BookInfoSerializeraction(methods[get], detailFalse)def latest(self, request):...action(methods[put], detailTrue)def read(self, request, pk):...此视图集会形成的路由
^books/latest/$ name: book-latest
^books/{pk}/read/$ name: book-read路由router形成URL的方式
1 SimpleRouter 2DefaultRouter DefaultRouter与SimpleRouter的区别是DefaultRouter会多附带一个默认的API根视图返回一个包含所有列表视图的超链接响应数据。
Request
简介
REST framework 传入视图的request对象不再是Django默认的HttpRequest对象而是REST framework提供的扩展了HttpRequest类的Request类的对象。
REST framework 提供了Parser解析器在接收到请求后会自动根据Content-Type指明的请求数据类型如JSON、表单等将请求数据进行parse解析解析为类字典对象保存到Request对象中。
Request对象的数据是自动根据前端发送数据的格式进行解析之后的结果。
无论前端发送的哪种格式的数据我们都可以以统一的方式读取数据。
常用属性 .datarequest.data 返回解析之后的请求体数据。类似于Django中标准的request.POST和 request.FILES属性但提供如下特性 包含了解析之后的文件和非文件数据包含了对POST、PUT、PATCH请求方式解析后的数据利用了REST framework的parsers解析器不仅支持表单类型数据也支持JSON数据 .query_paramsrequest.query_params与Django标准的request.GET相同只是更换了更正确的名称而已。
Response
简介
rest_framework.response.ResponseREST 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, statusNone, template_nameNone, headersNone, content_typeNone)data数据不要是render处理之后的数据只需传递python的内建类型数据即可REST framework会使用renderer渲染器处理data。
data不能是复杂结构的数据如Django的模型类对象对于这样的数据我们可以使用Serializer序列化器序列化处理后转为了Python字典类型再传递给data参数。
参数说明
data: 为响应准备的序列化处理后的数据status: 状态码默认200template_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
