前期準(zhǔn)備

在虛擬開(kāi)發(fā)環(huán)境中安裝：

pip install django-filter

在Django的項(xiàng)目配置文件中安裝并配置django_filters應(yīng)用：

INSTALLED_APPS = [ ... ’django_filters’,]REST_FRAMEWORK = { # 過(guò)濾器默認(rèn)后端 ’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：過(guò)濾器類(lèi)

import django_filtersfrom .models import Userclass UserFilter(django_filters.FilterSet): class Meta: model = User fields = ['name', 'age'] #指定動(dòng)態(tài)過(guò)濾的字段，默認(rèn)精準(zhǔn)匹配

注意：

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

view.py

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

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()),

首先理解上面是動(dòng)態(tài)過(guò)濾，前端在請(qǐng)求頭如下傳遞參數(shù)，傳遞參數(shù)的個(gè)數(shù)是不同的，而動(dòng)態(tài)過(guò)濾只會(huì)過(guò)濾：有參數(shù)，且參數(shù)有值的項(xiàng)。

http://ip:port/user/?name=查找內(nèi)容&age=查找內(nèi)容http://ip:port/user/?name=&age=查找內(nèi)容http://ip:port/user/?name=查找內(nèi)容&age=http://ip:port/user/?name=&age=http://ip:port/user/

精準(zhǔn)過(guò)濾、模糊過(guò)濾并存

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

exact：默認(rèn)過(guò)濾方式，精確過(guò)濾

icontains：模糊過(guò)濾

http://ip:port/user/?name=查找內(nèi)容&name_icontains=查找內(nèi)容&age=查找內(nèi)容

范圍過(guò)濾

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

對(duì)以上filter來(lái)說(shuō)

name 精確查找name__icontains 模糊查找age 精準(zhǔn)查找age__gte 大于等于age__lte 小于等于

排序

class UserFilter(django_filters.FilterSet):#定義排序字段：依賴(lài)哪個(gè)字段排序 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=查找內(nèi)容&sort=age:表示升序http://ip:port/user/?name=查找內(nèi)容&sort=-age:表示降序

補(bǔ)充知識(shí)

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

過(guò)濾器可以自定義字段，開(kāi)始我們這樣定義過(guò)濾字段，以及每個(gè)字段是相等運(yùn)算，模糊匹配，還是范圍查詢(xún)，但是這樣的寫(xiě)法可能不太直觀。

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

我們可以做如下類(lèi)型改變

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=

過(guò)濾器每個(gè)字段內(nèi)部配置：

field_name: 過(guò)濾字段名，為對(duì)應(yīng)模型中字段名

lookup_expr: 查詢(xún)時(shí)所要進(jìn)行的操作，是等值，范圍、模糊匹配等

過(guò)濾器字段類(lèi)型：

CharFilter 字符串類(lèi)型BooleanFilter 布爾類(lèi)型DateTimeFilter 日期時(shí)間類(lèi)型DateFilter 日期類(lèi)型DateRangeFilter 日期范圍TimeFilter 時(shí)間類(lèi)型NumberFilter 數(shù)值類(lèi)型，對(duì)應(yīng)模型中IntegerField, FloatField, DecimalField

以上就是本文的全部?jī)?nèi)容，希望對(duì)大家的學(xué)習(xí)有所幫助，也希望大家多多支持好吧啦網(wǎng)。