drf 视图说明属性和方法
程序员文章站
2022-07-12 11:20:00
...
GenericAPIView
rest_framework.generics.GenericAPIView
继承自APIVIew
,增加了对于列表视图和详情视图可能用到的通用支持方法。通常使用时,可搭配一个或多个Mixin扩展类。
支持定义的属性:
- 列表视图与详情视图通用:
- queryset 列表视图的查询集
- serializer_class 视图使用的序列化器
- 列表视图使用:
- pagination_class 分页控制类
- filter_backends 过滤控制后端
- 详情页视图使用:
-
lookup_field 查询单一数据库对象时使用的条件字段,默认为'
pk
' - lookup_url_kwarg 查询单一数据时URL中的参数关键字名称,默认与look_field相同
-
lookup_field 查询单一数据库对象时使用的条件字段,默认为'
-
提供的方法:
-
列表视图与详情视图通用:
-
get_queryset(self)
返回视图使用的查询集,是列表视图与详情视图获取数据的基础,默认返回
queryset
属性,可以重写,例如:class AreaViewSet(CacheResponseMixin,ReadOnlyModelViewSet): """行政区划""" pagination_class = None # 区划信息不分页[当设置全局分页时不会干扰到这里] def get_serializer_class(self): if self.action == "list": return serializers.AreasSerializer else: return serializers.AreaSerializer # 重写 def get_queryset(self): # action 请求动作 if self.action == "list": # 列表页只查询省份 return Area.objects.filter(parent=None) else: # 详情页是所有数据 return Area.objects.all()
get_serializer_class(self)
返回序列化器类,默认返回
serializer_class
,可以重写,例如: -
def get_serializer_class(self): if self.request.user.is_staff: return FullAccountSerializer return BasicAccountSerializer
注意 当url上有参数可以通过以下方法获取参数
-
-
urlpatterns = [ url("categories/(?P<category_id>\d+)/skus/",views.SKUListView.as_view()), ] class SKUListView(ListAPIView): """商品列表""" serializer_class = serializers.SKUSerializer # 引入字段排序功能 filter_backends = (OrderingFilter,) # 允许以哪些字段进行排序 ordering_fields = ('create_time', 'price', 'sales') def get_queryset(self): # 获取参数的方式 category_id = self.kwargs["category_id"] return SKU.objects.filter(category_id=category_id,is_launched=True)
-
-
get_serializer(self, args, *kwargs)
返回序列化器对象,被其他视图或扩展类使用,如果我们在视图中想要获取序列化器对象,可以直接调用此方法。
注意,在提供序列化器对象的时候,REST framework会向对象的context属性补充三个数据:request、format、view,这三个数据对象可以在定义序列化器时使用。
-
-
详情视图使用:
-
get_object(self) 返回详情视图所需的模型类数据对象,默认使用
lookup_field
参数来过滤queryset。 在试图中可以调用该方法获取详情信息的模型类对象。若详情访问的模型类对象不存在,会返回404。
该方法会默认使用APIView提供的check_object_permissions方法检查当前对象是否有权限被访问。
# url(r'^books/(?P<pk>\d+)/$', views.BookDetailView.as_view()), class BookDetailView(GenericAPIView): queryset = BookInfo.objects.all() serializer_class = BookInfoSerializer def get(self, request, pk): book = self.get_object() serializer = self.get_serializer(book) return Response(serializer.data)
-
上一篇: 获取所有公众号用户的信息
下一篇: DRF视图