Django JET 中的自动补全功能详解-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_01200/article/details/148575358

Django JET 中的自动补全功能详解

django-jet Modern responsive template for the Django admin interface with improved functionality. We are proud to announce completely new Jet. Please check out Live Demo 项目地址: https://gitcode.com/gh_mirrors/dj/django-jet

什么是自动补全功能

Django JET 是一个现代化的 Django 后台管理界面增强工具，它提供了许多实用的功能来提升管理后台的用户体验。其中自动补全(Autocomplete)功能是一个非常实用的特性，它能够优化选择框(select)的用户交互体验。

默认情况下，Django 会渲染选择框中的所有选项。当选项数量较少时，这种方式没有问题。但如果选项数量庞大（比如有成百上千条记录），一次性加载所有选项会导致页面性能下降，用户体验变差。Django JET 的自动补全功能通过 AJAX 动态加载选项，完美解决了这个问题。

如何配置自动补全

1. 定义可搜索字段

首先，我们需要在模型(Model)中指定哪些字段可以通过 AJAX 查询进行搜索。这通过添加一个名为 autocomplete_search_fields 的静态方法来实现：

class YourModel(models.Model):
    name = models.CharField(max_length=255)
    category = models.ForeignKey(Category, related_name='items')
    
    @staticmethod
    def autocomplete_search_fields():
        return 'name', 'category__name'

这个方法返回一个元组或列表，包含所有可搜索的字段名。对于外键字段，可以使用 __ 语法指定关联模型的字段。

2. 使用 AJAX 列表过滤器

如果你在 ModelAdmin 中使用了外键字段的列表过滤器，需要使用 Django JET 提供的特殊过滤器类：

from jet.filters import RelatedFieldAjaxListFilter

class YourModelAdmin(admin.ModelAdmin):
    list_filter = (
        ('category', RelatedFieldAjaxListFilter),
    )

这样，列表过滤器也会使用 AJAX 动态加载选项，而不是一次性加载所有可能的值。

自动补全的工作原理

配置完成后，Django JET 会自动将相关选择框转换为支持自动补全的控件。当用户开始输入时，系统会通过 AJAX 请求向服务器发送查询，只返回匹配的选项。这种方式有以下几个优点：

大幅减少初始页面加载时间
降低服务器和客户端的内存消耗
提供更流畅的用户体验
支持模糊搜索，用户可以更容易找到所需选项

禁用自动补全功能

虽然自动补全功能很实用，但在某些特定场景下，我们可能需要禁用它。例如：

当我们需要限制可选的查询集时
当字段选项数量很少，自动补全反而增加复杂度时
当有特殊业务逻辑需要处理时

可以通过在 ModelForm 中设置字段的 autocomplete 属性为 False 来禁用自动补全：

class YourForm(forms.ModelForm):
    def __init__(self, *args, **kwargs):
        super(YourForm, self).__init__(*args, **kwargs)
        if some_condition:
            self.fields['field_name'].autocomplete = False
            self.fields['field_name'].queryset = Model.objects.filter(...)