经验总结

  1. 首页 > 生活 > >

46.drf过滤、搜索、排序

生活百科

DRF的过滤类drf过滤器在filters模块中，主要有四个类

  1. BaseFilterBackend:过滤基类，留好占位方法待后续继承
  2. SearchFilter:继承BaseFilterBackend
  3. OrderingFilter:继承BaseFilterBackend
  4. DjangoObjectPermissionsFilter:继承BaseFilterBackend，3.9版本之后废除
 过滤的使用DRF通用列表视图的默认行为是返回一个模型的全部queryset比如说模型存储了1W条数据，默认会将1W条全部取出,如果不想一次性取出，只需要其中的一部分，需要对查询的结果进行过滤如果继承了GenericAPIView及以上的视图类，有派生出的 get_queryset方法只需在视图中重写.get_queryset()方法示例1-根据模型字段进行过滤# 继承的ModelViewSetclass GetInfoLIst(ModelViewSet):queryset = UserInfo.objects.all()serializer_class = UserSerializer# 重写过滤方法def get_queryset(self):# 获取当前用户usernameusername = self.request.user.username# 过滤出与当前用户username一致的信息return UserInfo.objects.filter(username=username)示例2-根据url路径进行过滤#路由path('user/<str:username>/', UserList.as_view()), # views# url示例： 127.0.0.1:8000/user/username/class UserList(ListAPIView):serializer_class = UserSerializerdef get_queryset(self):# 获取请求路由中的usernameusername = self.kwargs['username']return UserInfo.objects.filter(username=username)示例3-根据url携带参数进行过滤#url 示例：127.0.0.1:8000/user/?username=xxxx# 继承的ModelViewSetclass GetInfoLIst(ModelViewSet):queryset = UserInfo.objects.all()serializer_class = UserSerializer# 重写过滤方法def get_queryset(self):#从url参数中获取username，如果没有则是None# query_params.get是从url获取参数的方法username = self.request.query_params.get('username',None)if username is None:return UserInfo.object.all()else:return UserInfo.objects.filter(username=username) DRF三种过滤的工具DjangoFilterBackend#安装pip3.9 install django-filter#注册INSTALLED_APPS = ['django_filters',]过滤配置-全局与权限配置一样，过滤也分全局过滤配置和局部过滤配置REST_FRAMEWORK = {# 全局过滤配置'DEFAULT_FILTER_BACKENDS':# 值是元组，将django_filters配置上，进行全局性的过滤('django_filters.rest_framework.DjangoFilterBackend',)}过滤配置-局部from django_filters.rest_framework import DjangoFilterBackend #导包class UserList(ListAPIView):# 视图级别过滤filter_backends = (DjangoFilterBackend,)# 指定后端字段过滤from django_filters.rest_framework import DjangoFilterBackend #导包class UserList(ListAPIView):filter_backends = (DjangoFilterBackend,) # 指定后端filterset_fields = ('username','id') #要过滤的字段'''将为指定的字段自动创建一个 FilterSet 类可以发送类似请求： http://xxxx/api/xxx?username=xxxx&id=xxxxDjango-filter模块的默认模式是完全匹配模式，需要自定义匹配模式参考https://django-filter.readthedocs.io/en/latest/index.html''' SearchFilter搜索过滤SearchFilter 类是DRF自带的过滤器，支持基于简单的单个查询参数的搜索，并且基于Django admin的搜索功能from rest_framework import filtersclass UserList(ListAPIView):filter_backends = (DjangoFilterBackend,filters.SearchFilter)# 指定后端# 视图中设置了 search_fields 属性时，才会应用 SearchFilter 类# search_fields只支持文本类型字段，例如 CharField 或 TextFieldsearch_fields = ('username',)'''在url中默认的搜索参数是searchurl示例 - http://xxxx/api/users?search=木子会过滤出username=木子的信息'''修改url中的搜索参数# 上述默认以及search字段进行搜索，如果想要修改默认的search字段REST_FRAMEWORK = {# 全局过滤配置'DEFAULT_FILTER_BACKENDS':# 值是元组，将django_filters配置上，进行全局性的过滤('django_filters.rest_framework.DjangoFilterBackend',)# 修改search_fields链接搜索时的字段"SEARCH_PARAM":"find"}"""url示例 - http://xxxx/api/users?find=木子"""

经验总结扩展阅读


上一篇：1 Java安全之反序列化

下一篇：11月下旬开门红升迁有喜 好事停不下来的3大星座