djangp-filter的使用

2024-03-31 22:29:10

Filter定义

Filter定义

定义如下Filter类

class BookFilter(django_filters.FilterSet):
    name = django_filters.CharFilter(lookup_expr='icontains')
    author = django_filters.CharFilter(lookup_expr='icontains')
    isbn = django_filters.NumberFilter(lookup_expr='icontains')
    press = django_filters.CharFilter(lookup_expr='icontains')

    class Meta:
        model = Book
        fields = {'name', 'author', 'isbn', 'press'}

这个类解释如下：

model 该类是为Model Book定义的过滤类
fields 该过滤类可以处理Book model中字段name，author，isbn，press的查询
name = django_filters.CharFilter(lookup_expr='icontains') 指定name字段的过滤条件为icontains

值得注意的是django_filters如何只指定fields，不指定特定fields的过滤方法，那么默认会使用exact的过滤条件进行查询。

在view中的使用

# filter objects according to user inputs
objects = BookFilter(request.POST, queryset=objects)

recordsFiltered = objects.qs.count()
objects = objects.qs[start:(start + length)]

在官网的介绍当中，使用的比较多场景是使用过滤器的返回值作为参数去渲染模板文件。那如果需要后端进行分页处理，就需要使用返回值的qs属性呢
比如示例当中的 recordsFiltered = objects.qs.count()，将查询得到的query set的记录个数返回给前端Datatable插件。

多表查询

单表查询比较容易理解，那么当我们需要使用多表查询的时候，该怎么做呢？

model定义

class Book(models.Model):
    name = models.CharField(max_length=48)
    isbn = models.IntegerField(primary_key=True, unique=True)
    author = models.CharField(max_length=24)
    press = models.CharField(max_length=48)
    price = models.PositiveIntegerField(default=0)

class LibBook(models.Model):
    # Relations
    book = models.ForeignKey(Book, on_delete=models.PROTECT,null=False)
    # Attributes
   
    uuid = models.UUIDField(default=uuid.uuid4, null=False)
    inDate = models.DateField(auto_now_add=True)
    dueDate = models.DateField(blank=True, null=True)
    overDays = models.PositiveIntegerField(default=0)
    LendAmount = models.PositiveIntegerField(default=0)

在这个例子当中，书本信息和馆藏图书是一对多的关系，我们在LibBook当中使用ForeignKey来指定LibBook和Book之间的关系。

问题：如何使用书本的书名和isbn信息来查询本地图书馆的藏书信息？

Fileter定义

class LibBookFilter(django_filters.FilterSet):
    book__name = django_filters.CharFilter(lookup_expr='icontains')
    book__isbn = django_filters.NumberFilter(lookup_expr='icontains')

    class Meta:
        model = LibBook
        fields = {'book__name', 'book__isbn'}

值得注意的是fields的定义，要使用Django中规定的双下划线符号__来指定查询的字段。
在本例中，我们同样指定查询的条件是icontains

View使用

# filter objects according to user inputs
objects = LibBookFilter(request.POST, queryset=objects)
recordsFiltered = objects.qs.count()
objects = objects.qs[start:(start + length)]

看到这里，感觉和单表查询也差不了太多啊。在笔者使用django_filters的过程中，最大的坑就是在这里呢，怎么设置都不好使。后来发现问题是：

POST 数据定义

前端同样使用ajax将查询数据通过POST传到后台。 ajax的data必须如下定义，django_filters才能正常工作。

"ajax": {
    "url": "#",
    "type": "POST",
    "data": function(d){
        return $.extend( {}, d, {
            "book__isbn"  : document.getElementById('isbn').value,
            "book__name"  : document.getElementById('book').value,
            });
    }
},

注意POST数据的数据名字必须和Filter中保持一致才行

码农公寓