django rest framework中对于APIView、GenericAPIView、ModelViewSet、mixins扩展类的分析。
APIView
示例
根据实际程序来分析:
urls.py
urlpatterns = [
re_path('users', UserAPIView.as_view())
]
views.py
class UserAPIView(APIView):
def get(self, request):
users = User.objects.filter().all()
ser = UserSerializer(instance=users, many=True)
return CommonResponse(status=status.HTTP_200_OK, data=ser.data)
源码分析
首先,UserAPIView
继承了APIView
,而APIView
继承了View
。
![DRF视图的使用及源码流程分析-小白菜博客](https://blog.xiaobaicai.fun/wp-content/uploads/2022/11/33d32e467ada9145cbec638797e6318b.png)
原生
View
里面定义了允许的http访问方式。
urls.py
中,UserAPIView.as_view()
这条语句其实执行的是APIView
中的as_view()
方法,而APIView
中的as_view()
方法执行父类View
的as_view()
方法。
APIView中的as_view()
![DRF视图的使用及源码流程分析-小白菜博客](https://blog.xiaobaicai.fun/wp-content/uploads/2022/11/72cbb8080990ee8793215fcfb758e34d.png)
View中的as_view()
![DRF视图的使用及源码流程分析-小白菜博客](https://blog.xiaobaicai.fun/wp-content/uploads/2022/11/74ebebe58d4fb97cbf18c81b193300de.png)
其中关键的方法为dispatch
方法,根据UserAPIView-->APIView-->View
的继承顺序,该方法执行的是APIView
中的dispatch
方法。看下图。
![DRF视图的使用及源码流程分析-小白菜博客](https://blog.xiaobaicai.fun/wp-content/uploads/2022/11/a743c6580d6b4538c76d659138dedf60.png)
dispatch
方法会获取请求方式,判断是否是http允许的请求方式,如果是的话,则分发执行UserAPIView
中对应的同名方法。
其实我们也可以在UserAPIView
中自定义dispatch
方法,如下:
def dispatch(self, request, *args, **kwargs):
func = getattr(self,request.method.lower())
return func(request,*args,**kwargs)
总结:CBV基于反射实现根据请求方式不同,执行不同的方法。
View与APIView的执行流程
View:
as_view()
是入口,得到view函数- 请求来了调用
view
函数,内部调用dispatch
函数完成请求分发 dispatch
函数将请求方式映射为视图类的同名方法,得到相应结果
APIView:
as_view()
是入口,通过执行父类中的as_view
方法得到view函数,然后在返回view
函数的时候免除csrf验证。- 请求来了调用
view
函数,内部调用(APIView类中的)dispatch
方法完成请求分发。 - 在
dispatch
方法中,将会二次封装request,完成三大验证(认证、授权、节流),再将请求方式映射为视图类的同名方法,完成请求的处理。
GenericAPIView
执行流程
首先看看GenericAPIView的源码。
![DRF视图的使用及源码流程分析-小白菜博客](https://blog.xiaobaicai.fun/wp-content/uploads/2022/11/c5844c02fa2f2283b0f036e9c8dbd34a.png)
可以看出,GenericAPIView
继承了APIView
。然后还有几个比较重要的类属性,稍后用到再讲。
再往下看它对外暴露的方法:
![DRF视图的使用及源码流程分析-小白菜博客](https://blog.xiaobaicai.fun/wp-content/uploads/2022/11/49524efb18ade9d8617927d506f492d7.png)
其实是比较少的,而且大多是get_xxx
之类的方法,也就是说,它的as_view()
、dispatch
等方法,其实都是按照APIView
的流程处理的。
重要方法
首先我们看get_queryset()
,它的意思是批量查找数据库的数据:
![DRF视图的使用及源码流程分析-小白菜博客](https://blog.xiaobaicai.fun/wp-content/uploads/2022/11/a03522a9d98fb4a8f3e79d944cfbe03d.png)
- 可以看到,queryset属性必须进行赋值,按照继承顺序,我们直接在自己定义的视图类中声明queryset属性并进行赋值。
- 在if判断中,如果queryset是一个QuerySet对象,就获取全部,得到一个QuerySetDict对象,否则原样返回。
QuerySetDict类型如下:
接下来看get_object()
,它的意思是从数据库中获取单个对象:
![DRF视图的使用及源码流程分析-小白菜博客](https://blog.xiaobaicai.fun/wp-content/uploads/2022/11/ae312d0730fdfd5cc4c680effe48dc08.png)
filter_kwargs
封装查找条件,get_object_or_404
负责在queryset中查找符合条件的对象(object)。- 看到这里就发现了,默认查询条件是用
pk
,也就是说你的url
中必须要用pk
这个形参名进行分组捕获。否则就需要声明lookup_url_kwarg
,如果url中的参数为name
,那么lokup_url_kwarg="name"
,然后进行替换组建filter_kwargs
。当然如果你的查询条件不是用的pk
,就需要修改lookup_field
为字段名,如我不是按照pk
进行查询,而是按照name
,就修改lookup_field
为name
。 - 同时也会检查用户是否有权限查看该对象。
check_object_permissions
主要的就是以上两个,get_serializer()
会调用get_serializer_class
获取序列化类,返回序列化类的执行结果。
![DRF视图的使用及源码流程分析-小白菜博客](https://blog.xiaobaicai.fun/wp-content/uploads/2022/11/8936004df547f48b4c91d9f57cef0a03.png)
示例
class UserAPIView(GenericAPIView):
queryset = User.objects
serializer_class = UserSerializer
def get(self, request):
users = self.get_queryset()
ser = self.get_serializer(instance=users, many=True)
return CommonResponse(status=status.HTTP_200_OK, data=ser.data)
mixins扩展类
- 在
rest_framework.mixins
中,有五个扩展类,分别是:ListModelMixin
:该类主要负责查询所有记录RetrieveModelMixin
:该类主要负责查询单条记录CreateModelMixin
:该类主要负责创建记录UpdateModelMixin
:该类主要负责对记录做更新操作DestroyModelMixin
:该类主要负责删除记录
- 这五个类都继承于
object
,是独立的子类。 - 针对
GenericAPIView
更高级的封装,配合GenericAPIView
使用有奇效。
类 | 方法 | 描述 |
---|---|---|
ListModelMixin | list() | 查询所有,并返回Response对象 |
RetrieveModelMixin | retrieve() | 查询单条,并返回Response对象 |
CreateModelMixin | create() | 创建记录,并返回Response对象 |
UpdateModelMixin | update() | 更新记录,并返回Response对象 |
DestroyModelMixin | destroy() | 删除记录,并返回Response对象 |
示例
class UserAPIView(GenericAPIView, ListModelMixin):
queryset = User.objects
serializer_class = UserSerializer
def get(self, request):
return CommonResponse(status=status.HTTP_200_OK, data=self.list(request).data)
ModelViewSet
如果继承所有的mixins类,则视图类就会写的非常冗长,可读性较差。
同时,每次都要在视图中return,那我们会考虑能不能简化这步操作。
首先导入ModelViewSet
from rest_framework.viewsets import ModelViewSet
查看它的源码:
![DRF视图的使用及源码流程分析-小白菜博客](https://blog.xiaobaicai.fun/wp-content/uploads/2022/11/fce640bdb41f6c9bb514583d426f5cd5.png)
再看GenericViewSet
:
![DRF视图的使用及源码流程分析-小白菜博客](https://blog.xiaobaicai.fun/wp-content/uploads/2022/11/9219e1801b78c0a946691af0004c6a65.png)
再看ViewSetMixin
:
![DRF视图的使用及源码流程分析-小白菜博客](https://blog.xiaobaicai.fun/wp-content/uploads/2022/11/c1423f33fc909215f19bca8d515afd22.png)
注释的意思是说,它重写了as_view()
方法,绑定了http方法与视图函数中的方法,这让它必须接收一个actions
参数,actions
参数设置为一个字典。
示例
urls.py
urlpatterns = [
re_path('users', UserAPIView.as_view(actions={"get": 'list'}))
]
views.py
class UserAPIView(ModelViewSet):
queryset = User.objects
serializer_class = UserSerializer
generics扩展类
至于generics扩展类,提供了以下几个功能:
![DRF视图的使用及源码流程分析-小白菜博客](https://blog.xiaobaicai.fun/wp-content/uploads/2022/11/a052676770f5d55d1c7f6e2f726ed08f.png)
类 | 功能 |
---|---|
CreateAPIView | 创建记录 |
DestroyAPIView | 删除记录 |
UpdateAPIView | 更新单条记录 |
ListAPIView | 查询所有记录 |
RetrieveAPIView | 查询单条记录 |
ListCreateAPIView | 创建以及查询所有记录 |
RetrieveUpdateAPIView | 更新以及查询单条记录 |
RetrieveDestroyAPIView | 删除以及查询单条记录 |
RetrieveUpdateDestroyAPIView | 删除、更新、查询单条记录 |
他们的实现也很简单,以`RetrieveDestroyAPIView`类举例:
![DRF视图的使用及源码流程分析-小白菜博客](https://blog.xiaobaicai.fun/wp-content/uploads/2022/11/ebb6ed874b914c148c05b6e7dfa22afd.png)
由此可见,generics
中的扩展类都是结合了mixins扩展类
和GenericAPIView
,并且提供了标准的http方法同名方法,这些方法又都分别执行对应的mixins扩展类
中的方法。这和我们mixins扩展类
部分中的示例
大体一致。
示例
urls.py
urlpatterns = [
re_path('users', UserAPIView.as_view(actions={"get": 'list'}))
]
Views.py
class UserAPIView(ViewSetMixin, ListAPIView):
queryset = User.objects
serializer_class = UserSerializer
注:UserAPIView的as_view方法要接收actions参数,而我们要使用的就是ViewSetMixin中重写的as_view方法,因此为了不和ListAPIView中的as_view产生冲突,继承时要把ViewSetMixin放在前面。
看完上面的内容,下面再看这张图片,希望可以帮助梳理本篇文章的内容:
![DRF视图的使用及源码流程分析-小白菜博客](https://blog.xiaobaicai.fun/wp-content/uploads/2022/11/37ed55600a01adc80eff172549faeb42.png)