Django filter動態過濾與排序實現過程解析

前期準備

在虛擬開發環境中安裝：

pip install django-filter

在Django的項目配置文件中安裝并配置django_filters應用：

INSTALLED_APPS = [ ... ’django_filters’,]REST_FRAMEWORK = { # 過濾器默認后端 ’DEFAULT_FILTER_BACKENDS’: ( ’django_filters.rest_framework.DjangoFilterBackend’,),}

快速使用

model.py

class User(models.Model): # 模型字段 name = models.CharField(max_length=10, verbose_name='姓名') sex = models.BooleanField(default=1, verbose_name='性別') age = models.IntegerField(verbose_name='年齡') phone = models.CharField(max_length=20, null=True, verbose_name='電話') addr = models.CharField(max_length=100,null=True,verbose_name='地址') class Meta: db_table = 'tb_user' verbose_name = '用戶' verbose_name_plural = verbose_name

新建filter.py：過濾器類

import django_filtersfrom .models import Userclass UserFilter(django_filters.FilterSet): class Meta: model = User fields = ['name', 'age'] #指定動態過濾的字段，默認精準匹配

注意：

Meta字段說明model： 引用的模型，不是字符串fields：指明過濾字段，可以是列表，列表中字典可以過濾，默認是判等；也可以字典，字典可以自定義操作exclude = [’password’] 排除字段，不允許使用列表中字典進行過濾

view.py

from django_filters.rest_framework import DjangoFilterBackendfrom rest_framework.generics import ListAPIViewfrom rest_framework import filtersclass UserViewSet(ListAPIView): queryset = User.objects.all() #獲取數據 serializer_class = UserModelSerializer #指定序列化類 filter_class = UserFilter # 指定過濾器類

serializers.py

from rest_framework import serializersfrom .models import Userclass UserModelSerializer(serializers.ModelSerializer): class Meta: model = User fields = '__all__'

urls.py

path(’user/’,UserViewSet.as_view()),

首先理解上面是動態過濾，前端在請求頭如下傳遞參數，傳遞參數的個數是不同的，而動態過濾只會過濾：有參數，且參數有值的項。

http://ip:port/user/?name=查找內容&age=查找內容http://ip:port/user/?name=&age=查找內容http://ip:port/user/?name=查找內容&age=http://ip:port/user/?name=&age=http://ip:port/user/

精準過濾、模糊過濾并存

class UserFilter(django_filters.FilterSet): class Meta: model = User # fields = ['name', 'age'] fields = { 'name': [’exact’,’icontains’], 'age': [’exact’], }

exact：默認過濾方式，精確過濾

icontains：模糊過濾

http://ip:port/user/?name=查找內容&name_icontains=查找內容&age=查找內容

范圍過濾

class UserFilter(django_filters.FilterSet): class Meta: model = User # fields = ['name', 'age'] fields = { 'name': [’exact’,’icontains’], 'age': [’exact’,’gte’,’lte’], }

對以上filter來說

name 精確查找name__icontains 模糊查找age 精準查找age__gte 大于等于age__lte 小于等于

排序

class UserFilter(django_filters.FilterSet):#定義排序字段：依賴哪個字段排序 sort = django_filters.OrderingFilter(fields=(’age’,)) class Meta: model = User # fields = ['name', 'age'] fields = { 'name': [’exact’,’icontains’], 'age': [’exact’,’gte’,’lte’], }

url示例

http://ip:port/user/?name=查找內容&sort=age:表示升序http://ip:port/user/?name=查找內容&sort=-age:表示降序

補充知識

這部分可以參考：https://zhuanlan.zhihu.com/p/110060840

過濾器可以自定義字段，開始我們這樣定義過濾字段，以及每個字段是相等運算，模糊匹配，還是范圍查詢，但是這樣的寫法可能不太直觀。

fields = {'name': [’exact’,’icontains’],'age': [’exact’,’gte’,’lte’],}

我們可以做如下類型改變

class BookFilter(filters.FilterSet): btitle = filters.CharFilter(field_name=’title’,lookup_expr=’icontains’) pub_year = filters.CharFilter(field_name=’bpub_date’,lookup_expr=’year’) pub_year__gt = filters.CharFilter(field_name=’bpub_date’,lookup_expr=’year__gt’) bread__gt = filters.NumberFilter(field_name=’bread’,lookup_expr='gt') bread__lt = filters.NumberFilter(field_name=’bread’,lookup_expr='lt') class Meta: model = Bookinfo fields = [’title’,’bread’,’bcomment’]

http://127.0.0.1:8000/book/?title=&bread=&bcomment=&btitle=%E5%B0%84%E9%9B%95&pub_year=&pub_year__gt=&bread__gt=&bread__lt=

過濾器每個字段內部配置：

field_name: 過濾字段名，為對應模型中字段名

lookup_expr: 查詢時所要進行的操作，是等值，范圍、模糊匹配等

過濾器字段類型：

CharFilter 字符串類型BooleanFilter 布爾類型DateTimeFilter 日期時間類型DateFilter 日期類型DateRangeFilter 日期范圍TimeFilter 時間類型NumberFilter 數值類型，對應模型中IntegerField, FloatField, DecimalField

以上就是本文的全部內容，希望對大家的學習有所幫助，也希望大家多多支持好吧啦網。