Django-Grappelli 高级定制指南：打造个性化管理后台-CSDN博客

本文链接：https://blog.csdn.net/gitblog_00567/article/details/148552197

Django-Grappelli 高级定制指南：打造个性化管理后台

django-grappelli A jazzy skin for the Django Admin-Interface (official repository). 项目地址: https://gitcode.com/gh_mirrors/dj/django-grappelli

前言

Django-Grappelli 作为 Django 管理后台的皮肤扩展，不仅提供了优雅的界面设计，还包含了许多实用的功能扩展。本文将深入探讨 Grappelli 的各项定制功能，帮助开发者打造更符合项目需求的个性化管理后台。

基础配置选项

Grappelli 提供了一系列配置选项，可以通过 Django 的 settings.py 文件进行全局设置：

# 管理后台标题设置
GRAPPELLI_ADMIN_TITLE = "我的管理后台"

# 自动完成下拉项显示数量
GRAPPELLI_AUTOCOMPLETE_LIMIT = 10

# 用户切换功能配置
GRAPPELLI_SWITCH_USER = True  # 启用用户切换功能

这些配置项让开发者无需修改模板文件即可实现基本定制需求。

折叠面板功能

Grappelli 提供了强大的折叠面板功能，可以优化管理后台的界面布局：

class ArticleAdmin(admin.ModelAdmin):
    fieldsets = (
        ('基本信息', {
            'fields': ('title', 'author', 'publish_date'),
            'classes': ('grp-collapse grp-open',)  # 默认展开
        }),
        ('高级设置', {
            'fields': ('is_featured', 'allow_comments'),
            'classes': ('grp-collapse grp-closed',)  # 默认折叠
        }),
    )

对于内联模型，同样支持折叠功能：

class CommentInline(admin.StackedInline):
    model = Comment
    classes = ('grp-collapse grp-open',)
    inline_classes = ('grp-collapse grp-closed',)  # 内联项默认状态

内联模型拖拽排序

Grappelli 为内联模型提供了直观的拖拽排序功能：

首先在模型中添加位置字段：

class Chapter(models.Model):
    book = models.ForeignKey(Book, on_delete=models.CASCADE)
    title = models.CharField(max_length=100)
    position = models.PositiveIntegerField(null=True, blank=True)
    
    class Meta:
        ordering = ['position']

在管理后台配置中启用排序：

class ChapterInline(admin.TabularInline):
    model = Chapter
    fields = ('title', 'position')
    sortable_field_name = "position"
    
    # 排除某些字段不影响排序判断
    sortable_excludes = ('title',)

如果需要隐藏位置字段，可以使用内置的 Mixin：

from grappelli.forms import GrappelliSortableHiddenMixin

class HiddenPositionChapterInline(GrappelliSortableHiddenMixin, admin.TabularInline):
    model = Chapter
    fields = ('title',)  # position 字段会自动处理

关联字段高级查询

Grappelli 提供了两种强大的关联字段查询方式：

1. 关联查询 (Related Lookups)

class BookAdmin(admin.ModelAdmin):
    raw_id_fields = ('author', 'categories')
    related_lookup_fields = {
        'fk': ['author'],  # 外键字段
        'm2m': ['categories'],  # 多对多字段
    }

对于通用关系 (Generic Relations)：

related_lookup_fields = {
    'generic': [['content_type', 'object_id']],
}

2. 自动完成查询 (Autocomplete Lookups)

首先在目标模型中定义搜索字段：

class Author(models.Model):
    name = models.CharField(max_length=100)
    
    @staticmethod
    def autocomplete_search_fields():
        return ("id__iexact", "name__icontains",)

然后在管理后台配置：

class BookAdmin(admin.ModelAdmin):
    autocomplete_lookup_fields = {
        'fk': ['author'],
        'm2m': ['categories'],
    }

自定义列表过滤器

Grappelli 提供了多种列表过滤器的显示方式：

class BookAdmin(admin.ModelAdmin):
    # 下拉式过滤器(自动应用)
    change_list_template = "admin/change_list.html"
    
    # 下拉式过滤器(手动应用)
    # change_list_template = "admin/change_list_filter_confirm.html"
    
    # 侧边栏过滤器(自动应用)
    # change_list_template = "admin/change_list_filter_sidebar.html"
    
    # 侧边栏过滤器(手动应用)
    # change_list_template = "admin/change_list_filter_confirm_sidebar.html"
    
    # 使用列表式过滤器(类似原生Django)
    change_list_filter_template = "admin/filter_listing.html"

用户切换功能

Grappelli 提供了便捷的用户切换功能，方便开发者测试不同权限：

# settings.py
GRAPPELLI_SWITCH_USER = True

# 自定义切换权限规则
def can_switch_user(user):
    return user.is_superuser  # 仅超级用户可以切换

GRAPPELLI_SWITCH_USER_ORIGINAL = can_switch_user

# 定义可切换的目标用户条件
def is_switch_target(user):
    return user.is_staff and not user.is_superuser  # 可切换到普通员工

GRAPPELLI_SWITCH_USER_TARGET = is_switch_target

富文本编辑器集成

Grappelli 内置了 TinyMCE 的支持：

class ArticleAdmin(admin.ModelAdmin):
    class Media:
        js = [
            '/static/grappelli/tinymce/jscripts/tiny_mce/tiny_mce.js',
            '/static/js/custom_tinymce_setup.js',
        ]

注意：从 Grappelli 3.0 开始将不再内置 TinyMCE，建议开发者考虑其他现代编辑器方案。