如何在Django Admin中重写特定模型字段的自动补全视图？

核心思路 #

Django 4.x 中，ModelAdmin 提供了 get_autocomplete_view 方法用于指定自动补全请求的处理视图，通过重写该方法并自定义 AutocompleteJsonView 子类，即可实现对Select2小部件AJAX行为的深度定制，包括修改分页数量、调整查询逻辑等。

步骤1：自定义AutocompleteJsonView子类 #

创建自定义视图，重写 paginate_by 来调整AJAX返回的对象数量，也可扩展其他方法实现更复杂的定制：

from django.contrib.admin.views.autocomplete import AutocompleteJsonView

class CustomAutocompleteJsonView(AutocompleteJsonView):
    # 修改AJAX请求返回的分页数量（默认是20）
    paginate_by = 50

    # 可选：重写get_queryset实现自定义过滤/排序逻辑
    def get_queryset(self):
        queryset = super().get_queryset()
        # 示例：仅返回活跃状态的对象
        # queryset = queryset.filter(is_active=True)
        return queryset

    # 可选：重写get_context_data修改返回给Select2的数据格式
    def get_context_data(self, **kwargs):
        context = super().get_context_data(**kwargs)
        # 示例：给每个选项添加额外的显示字段
        # for item in context['object_list']:
        #     item['extra_info'] = item.some_field
        return context

步骤2：重写ModelAdmin的get_autocomplete_view方法 #

在目标模型的 ModelAdmin 中，指定使用自定义的视图类：

from django.contrib import admin
from .models import YourTargetModel
from .views import CustomAutocompleteJsonView

class YourTargetModelAdmin(admin.ModelAdmin):
    # 启用自动补全的ForeignKey字段
    autocomplete_fields = ['your_foreign_key_field']

    def get_autocomplete_view(self, request):
        # 返回自定义视图的实例，绑定当前模型和admin站点
        return CustomAutocompleteJsonView.as_view(
            model=self.model,
            admin_site=self.admin_site
        )

admin.site.register(YourTargetModel, YourTargetModelAdmin)

针对多字段的差异化定制（可选） #

如果同一个模型中有多个ForeignKey字段，需要不同的自动补全行为，可以通过请求参数判断字段名称，返回不同的视图：

# 先定义多个不同的视图类
class FirstFieldAutocompleteView(AutocompleteJsonView):
    paginate_by = 30

class SecondFieldAutocompleteView(AutocompleteJsonView):
    paginate_by = 100

# 在ModelAdmin中判断字段
class YourTargetModelAdmin(admin.ModelAdmin):
    autocomplete_fields = ['first_fk_field', 'second_fk_field']

    def get_autocomplete_view(self, request):
        field_name = request.GET.get('field_name')
        if field_name == 'first_fk_field':
            view_class = FirstFieldAutocompleteView
        elif field_name == 'second_fk_field':
            view_class = SecondFieldAutocompleteView
        else:
            view_class = CustomAutocompleteJsonView
        return view_class.as_view(model=self.model, admin_site=self.admin_site)

对比临时方案的优势 #

之前重写 get_paginator 的方式是全局修改模型的分页行为，会影响Admin列表页等其他场景；而自定义 AutocompleteJsonView 的方式仅针对Select2自动补全的AJAX请求生效，且支持更灵活的定制（如字段级别的差异化逻辑、修改搜索规则、扩展返回数据等）。

内容的提问来源于stack exchange，提问作者Buddyshot