Django管理界面排序插件 django-admin-sortable2 教程

1. 项目介绍

django-admin-sortable2 是一个Django管理界面的扩展，它提供了列表视图和堆叠/表格内联视图中的对象拖放排序功能。无需更改模型基类，通过简单的混入（mixin）类即可增强现有ModelAdmin、StackedInline或TabularInline的功能，使得在已有模型及其管理接口中集成变得非常简单。

该项目主页：https://github.com/jrief/django-admin-sortable2

特点：

• 不需要继承特殊模型基类。
• 支持多个元素一起拖拽和排序。
• 使用Sortable JS替换之前的客户端部分，不再依赖jQuery。

2. 项目快速启动

安装

在你的Python环境中安装 django-admin-sortable2：

pip install django-admin-sortable2

配置

在你的Django项目设置中(settings.py)添加adminsortable2到INSTALLED_APPS:

INSTALLED_APPS = [
    # ...
    'adminsortable2',
    'your_app',
    # ...
]

应用到ModelAdmin

现在在你的admin.py文件中，将SortableMixin加入到相应的ModelAdmin类中：

from django.contrib import admin
from your_app.models import YourModel
from adminsortable2.admin import SortableAdmin

class YourModelAdmin(SortableAdmin):
    pass

admin.site.register(YourModel, YourModelAdmin)

3. 应用案例和最佳实践

假设你有一个名为Article的模型，你可以轻松地使其在Django管理界面上支持拖放排序：

from django.db import models

class Article(models.Model):
    title = models.CharField(max_length=200)
    pub_date = models.DateTimeField()

    def __str__(self):
        return self.title

然后，在admin.py中：

from .models import Article
from adminsortable2.admin import SortableAdmin

class ArticleAdmin(SortableAdmin):
    pass

admin.site.register(Article, ArticleAdmin)

这样，当你访问/admin/your_app/article/时，就能看到按标题排序的文章列表，同时还具备拖动排序的能力。

最佳实践

• 确保你的模型有一个唯一的字段，例如ID，以避免排序冲突。
• 在处理大量数据时，考虑使用分页以优化性能。

4. 典型生态项目

以下是一些与django-admin-sortable2相关的其他开源项目，可能有助于进一步拓展你的Django应用：

• django-orderable - 另一个允许在Django模型中添加顺序字段并进行管理的库。
• django-inline-ordering - 提供了一个自定义的表单字段以及行政模型混进来实现内联排序。

本教程提供了一个基础的入门指南，更多详细信息和高级配置可以参考官方文档：http://django-admin-sortable2.readthedocs.io/en/latest/。