Django-filter實現動態過濾與排序

阿新 • • 發佈：2020-09-18

前期準備

在虛擬開發環境中安裝：

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_filters
from .models import User

class UserFilter(django_filters.FilterSet):

    class Meta:
        model = User
        fields = ["name", "age 
"] #指定動態過濾的欄位，預設精準匹配

注意：

Meta欄位說明

model： 引用的模型，不是字串
fields：指明過濾欄位，可以是列表，列表中字典可以過濾，預設是判等；也可以字典，字典可以自定義操作
exclude = ['password'] 排除欄位，不允許使用列表中字典進行過濾

view.py

from django_filters.rest_framework import DjangoFilterBackend
from rest_framework.generics import ListAPIView
from rest_framework import  filters

class UserViewSet(ListAPIView):

    queryset = User.objects.all()    #獲取資料
    serializer_class = UserModelSerializer #指定序列化類
    filter_class = UserFilter   # 指定過濾器類

serializers.py

from rest_framework import serializers
from .models import User

class 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