DRF主要分为三部分(视图、路由、序列化器)
一、视图
常用的是一级视图APIview、三级视图、视图集
三级视图可进行细分:
1) CreateAPIView
提供 post 方法
继承自: GenericAPIView、CreateModelMixin
2)ListAPIView
提供 get 方法
继承自:GenericAPIView、ListModelMixin
3)RetireveAPIView
提供 get 方法
继承自: GenericAPIView、RetrieveModelMixin
4)DestoryAPIView
提供 delete 方法
继承自:GenericAPIView、DestoryModelMixin
5)UpdateAPIView
提供 put 和 patch 方法
继承自:GenericAPIView、UpdateModelMixin
视图集名称 | 父类 |
---|---|
ViewSet | ViewSetMixin,APIView |
ReadOnlyModelViewSet | GenericViewSet, 2mixin |
ModelViewSet | GenericViewSet, 5mixin |
父类 | 功能 |
---|---|
ViewSetMixin,APIView | 路由要映射编写 |
GenericViewSet, 2mixin | 获取单个或所有数据 |
GenericViewSet, 5mixin | 增删改查全部功能 |
有时候系统提供的方法不能满足我们的需求,我们可重写以下方法。
列表视图与详情视图通用:
①get_queryset(self)
返回视图使用的查询集,是列表视图与详情视图获取数据的基础,默认返回queryset属性,可以重写,例如:
def get_queryset(self):
user = self.request.user
return user.accounts.all()
②get_serializer_class(self)
返回序列化器类,默认返回serializer_class,可以重写,例如:
def get_serializer_class(self):
if self.request.user.is_staff:
return FullAccountSerializer
return BasicAccountSerializer
get_serializer(self, args, *kwargs)
返回序列化器对象,被其他视图或扩展类使用,如果我们在视图中想要获取序列化器对象,可以直接调用此方法。
注意,在提供序列化器对象的时候,REST framework会向对象的context属性补充三个数据:request、format、view,这三个数据对象可以在定义序列化器时使用。
详情视图使用:
get_object(self) 返回详情视图所需的模型类数据对象,默认使用lookup_field参数来过滤queryset。 在试图中可以调用该方法获取详情信息的模型类对象。
若详情访问的模型类对象不存在,会返回404。
该方法会默认使用APIView提供的check_object_permissions方法检查当前对象是否有权限被访问。
那什么时候用哪个视图呢?
个人总结:
1、如果要返回的数据不需要使用序列化器,且需要高自由度,首先考虑APIview;
2、反之,使用序列化器,优先考虑三级或视图集,用哪个具体要看代码需要返回什么数据,例如:返回一个列表数据,应该考虑ListAPiView。
如果返回的结果可能增删改查都有涉及,应该考虑视图集ModelViewSet。
3、返回数据可以使用from rest_framework.response import Response
4、可以在视图设置功能(分页、认证、限流、过滤、排序、权限等等)
====================================================
二、路由
对应上文
如果使用APIView或三级视图,路由写法参考django的路由
例:
url(r'^statistical/month_increment/$',views.UserMonthIncrementView.as_view()),
如果使用视图集,路由使用router
例:
router = DefaultRouter() router.register("goods",BookInfoViewSet,base_name="goods") urlpatterns += router.urls
goods 该视图集的路由前缀
BookInfoViewSet 视图集
base_name 路由名称的前缀
====================================================
三、序列化器
序列化器的写法大同小异
通用写法:
class SKUSerializers(serializers.ModelSerializer):
class Meta:
model = SKU
fields = "__all__"
model 指明参照哪个模型类
fields 指明为模型类的哪些字段生成,如果不是全部字段,格式应该为fields = ["id","username"]
注意:序列化器重写性高,可以高度配合代码要求,可重写序列化器字段、序列化器方法。
有时候某些字段还需要进行约束,我们可以在序列化器class Meta中添加属性
# 给password增加额外的约束选项,不进行返回
extra_kwargs = {
"password":{
'write_only':True
}
}
序列化器和视图都可以对方法进行重写,但是返回的对象不同。前端数据会先走视图,再走序列化器,所以重写方法要写在哪里,应该根据数据来判断,如果数据需要在走序列化器之前就修改,那就应该在视图重写!
本文仅个人见解,还会进行后续的补充,文中很多细节没有细写。