Django admin: 将相关字段的选择框更改为自动完成

在本文中，我们将介绍如何将Django admin中相关字段的选择框更改为自动完成。Django是一个功能强大的开发框架，它提供了一个灵活且易于使用的管理后台 – Django admin。在Django admin中，我们可以轻松地管理和编辑与模型关联的数据。然而，默认情况下，Django admin使用选择框来显示与其他模型相关联的字段，但是我们可能希望使用自动完成来提高用户体验和效率。

阅读更多：Django 教程

什么是自动完成？

自动完成是一种用户界面技术，它通过显示与已输入内容相关的建议来帮助用户快速选择或补全输入。在相关字段中使用自动完成，可以让用户通过输入相关模型的名称或其他标识符来选择字段值，而不是通过选择框从一个下拉列表中选择。

安装依赖包

要在Django admin中使用自动完成，我们需要安装一个名为”django-autocomplete-light”的第三方应用。可以使用pip命令来安装它：

pip install django-autocomplete-light

创建自动完成视图

首先，我们需要创建一个自动完成视图来处理与相关字段的搜索和建议相关的逻辑。

from dal import autocomplete

class RelatedModelAutocomplete(autocomplete.Select2QuerySetView):
    def get_queryset(self):
        qs = super().get_queryset()

        # 实现自定义逻辑来获取相关模型的查询集
        # 这里只是一个示例，你可能需要根据自己的模型和需求进行适当的更改

        if self.q:
            qs = qs.filter(name__icontains=self.q)

        return qs

在这个示例中，我们创建了一个名为RelatedModelAutocomplete的视图，它继承自autocomplete.Select2QuerySetView。这个视图覆盖了get_queryset方法，其中包含了我们的自定义逻辑来获取与查询相关的模型对象。在这个示例中，我们假设模型有一个名为”name”的字段，并通过使用icontains来进行模糊查询。

更新admin.py文件

接下来，我们需要更新我们的admin.py文件，以使用新的自动完成视图来替换相关字段的选择框。

from dal import autocomplete
from django.contrib import admin

from .models import MyModel

class MyModelAdmin(admin.ModelAdmin):
    form = MyModelForm

    autocomplete_fields = ['related_model']

    def get_form(self, request, obj=None, **kwargs):
        form = super().get_form(request, obj, **kwargs)
        form.base_fields['related_model'].widget = autocomplete.ModelSelect2(
            url='related_model-autocomplete'
        )
        return form

admin.site.register(MyModel, MyModelAdmin)

在这个示例中，我们首先导入了autocomplete库和django.contrib.admin库。然后，我们定义了一个名为MyModelAdmin的ModelAdmin类，它继承自admin.ModelAdmin。在MyModelAdmin中，我们指定了一个自定义的表单类MyModelForm，并使用autocomplete_fields属性将相关字段的名称作为字符串列表传递给它。这将使Django admin自动应用自动完成功能。

我们还重写了get_form方法，这样我们就可以在表单中为相关字段设置自动完成小部件。在这个示例中，我们将autocomplete.ModelSelect2小部件分配给related_model字段，并传递了一个名为’related_model-autocomplete’的URL。

最后，我们使用admin.site.register方法将MyModel和MyModelAdmin关联起来，并将它们注册到Django admin中。

测试自动完成

完成了上述步骤后，我们可以在Django admin中测试自动完成功能了。打开浏览器，并访问admin后台。点击相关模型的链接，你将看到相关字段的选择框已经被替换为自动完成输入框。现在，当你在相关字段中开始输入内容时，它会为你提供匹配的建议。你可以通过键盘上的上下箭头键来选择建议中的值，或者继续输入以进一步缩小筛选范围。

使用自动完成功能，我们可以更快速地找到和选择与相关字段关联的模型对象。这对于具有大量相关选项的字段特别有用。此外，自动完成还可以改善用户体验，使用户不再需要滚动或搜索大型下拉列表来查找所需的选项。

总结

在本文中，我们介绍了如何将Django admin中相关字段的选择框更改为自动完成。我们使用了一个名为”django-autocomplete-light”的第三方应用，创建了一个自动完成视图来处理搜索和建议的逻辑，并在admin.py中更新了相关的设置。通过使用自动完成功能，我们可以提高Django admin的用户体验和效率。

在实际应用中，你可能需要根据自己的模型和需求进行适当的更改。你可以根据自己的要求来定制自动完成视图和小部件的行为。希望本文对你在Django admin中使用自动完成功能有所帮助！