如何在Django-autocomplete-light中对ModelSelect2Multiple初始数据排序

这个问题的核心在于：ModelSelect2Multiple组件的选项显示顺序由其绑定的queryset排序决定，而非get_initial()传递的顺序。当你编辑已有实例时，默认的queryset（比如Author.objects.all()）会使用模型自身的排序规则，而忽略through模型的排序，导致显示顺序不符合预期。

下面是两种针对性的解决方案，结合常见的模型结构来举例：

假设你的模型结构如下（参考常规多对多through场景） #

# models.py
class Book(models.Model):
    title = models.CharField(max_length=100)

class Author(models.Model):
    name = models.CharField(max_length=100)
    books = models.ManyToManyField(Book, through='BookAuthor', related_name='authors')

class BookAuthor(models.Model):
    book = models.ForeignKey(Book, on_delete=models.CASCADE)
    author = models.ForeignKey(Author, on_delete=models.CASCADE)
    order = models.PositiveIntegerField(default=0)  # 控制排序的字段

    class Meta:
        ordering = ['order']  # Through模型的默认排序规则

方案一：在表单初始化时动态设置有序QuerySet #

直接在表单的__init__方法中，针对编辑场景覆盖字段的queryset，让它遵循through模型的排序规则：

# forms.py
from dal import autocomplete
from django import forms
from .models import Book, Author

class BookForm(forms.ModelForm):
    authors = autocomplete.ModelSelect2Multiple(
        url='author-autocomplete',
        queryset=Author.objects.all(),
    )

    class Meta:
        model = Book
        fields = ['title', 'authors']

    def __init__(self, *args, **kwargs):
        super().__init__(*args, **kwargs)
        
        # 仅在编辑已有书籍实例时生效
        if self.instance.pk:
            # 获取当前书籍关联的作者，自动遵循BookAuthor的order排序
            ordered_authors = self.instance.authors.all()
            # 覆盖字段的queryset为有序集合
            self.fields['authors'].queryset = ordered_authors
            # 同时确保初始值是有序的列表（避免组件重新排序）
            self.initial['authors'] = list(ordered_authors)

这个方案的优势是简单直接，利用Django自动应用through模型Meta排序的特性，直接复用已有关联数据的顺序。

方案二：在Autocomplete视图中动态排序QuerySet #

如果需要在下拉选择时也保持through模型的排序（比如编辑时搜索作者，结果优先显示已关联的且按顺序排列），可以在Autocomplete视图中处理：

1. 先修改Autocomplete视图 #

# views.py
from dal import autocomplete
from django.db.models import Case, When
from .models import Author, BookAuthor

class AuthorAutocomplete(autocomplete.Select2QuerySetView):
    def get_queryset(self):
        if not self.request.user.is_authenticated:
            return Author.objects.none()

        qs = Author.objects.all()
        # 从前端获取当前编辑的书籍ID（需要表单传递该参数）
        book_id = self.forwarded.get('book_id')
        
        if book_id:
            try:
                # 获取当前书籍的BookAuthor记录，按order排序后提取作者ID列表
                book_authors = BookAuthor.objects.filter(book_id=book_id).order_by('order')
                author_ids = [ba.author_id for ba in book_authors]
                
                # 使用Case/When强制保持已关联作者的顺序，未关联的按名称排序
                preserved_order = Case(*[When(id=aid, then=pos) for pos, aid in enumerate(author_ids)])
                qs = qs.order_by(preserved_order, 'name')
            except Book.DoesNotExist:
                pass

        # 处理搜索关键词
        if self.q:
            qs = qs.filter(name__icontains=self.q)

        return qs

2. 再修改表单，传递书籍ID到Autocomplete视图 #

# forms.py
class BookForm(forms.ModelForm):
    authors = autocomplete.ModelSelect2Multiple(
        url='author-autocomplete',
        queryset=Author.objects.all(),
        forward=['book_id'],  # 声明要传递的参数
    )

    class Meta:
        model = Book
        fields = ['title', 'authors']

    def __init__(self, *args, **kwargs):
        super().__init__(*args, **kwargs)
        
        if self.instance.pk:
            # 给forward参数赋值当前书籍ID
            self.fields['authors'].widget.forward['book_id'] = self.instance.pk

这个方案更灵活，不仅解决了初始显示的顺序问题，还优化了编辑时的搜索体验。

关键注意事项 #

1. 确保through模型的Meta.ordering已经设置了正确的排序字段（比如order），这样Django在查询多对多关联时会自动应用这个排序。
2. 不要依赖get_initial()来控制显示顺序，组件始终会根据queryset的排序来渲染选项。
3. 如果你的through模型没有显式设置Meta.ordering，需要在queryset中手动指定排序规则，比如self.instance.authors.order_by('bookauthor__order')。

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