Django Unfold 中实现应用侧边栏可折叠配置的优化方案

背景介绍

在使用 Django Unfold 这个现代化 Django 后台主题时，开发者经常会遇到管理大量应用和模型的情况。默认情况下，Unfold 会在侧边栏展示所有注册的应用和模型，这在项目规模较大时会导致侧边栏变得冗长，影响用户体验。

问题分析

当前 Unfold 提供了通过 SIDEBAR 配置来自定义侧边栏行为的方式，包括设置可折叠分组。然而，当应用数量较多时，手动为每个应用和模型添加 collapsible: True 配置会变得非常繁琐且难以维护。

现有解决方案

目前开发者需要这样配置：

"SIDEBAR": {
    "navigation": [
        {
            "collapsible": True,
            "items": [
                {
                    "title": _("Users"),
                    "link": reverse_lazy("admin:users_user_changelist"),
                },
                # 更多模型...
            ],
        },
        # 更多应用...
    ],
}

这种配置方式虽然灵活，但在大型项目中会导致配置文件变得庞大且难以维护。

优化方案

更优雅的解决方案是在应用配置(AppConfig)级别设置侧边栏行为，这样可以将配置分散到各个应用中，提高可维护性。具体实现思路如下：

1. 在应用的 apps.py 中扩展 AppConfig 类
2. 添加 sidebar 属性来定义该应用在侧边栏中的表现
3. 修改 Unfold 的 AdminSite 实现，自动收集这些配置

示例实现：

# myapp/apps.py
from django.apps import AppConfig
from django.utils.translation import gettext_lazy as _

class MyAppConfig(AppConfig):
    name = "myapp"
    verbose_name = _("My Application")
    sidebar = {
        'collapsible': True,
        'icon': 'heroicons-outline:users',
        'order': 100  # 可选排序
    }

技术实现细节

要实现这一功能，需要：

1. 扩展 Django 的 AdminSite 类，重写 get_app_list 方法
2. 在构建侧边栏导航时检查每个应用的 AppConfig 是否有 sidebar 属性
3. 将这些配置合并到最终的侧边栏结构中
4. 提供合理的默认值，确保向后兼容

优势分析

这种配置方式具有以下优势：

1. 模块化：将配置分散到各个应用中，符合 Django 的应用隔离原则
2. 可维护性：每个应用负责自己的侧边栏表现，修改时无需触及全局配置
3. 灵活性：除了可折叠属性，还可以扩展其他配置如图标、排序等
4. 可读性：配置更接近相关代码，便于理解应用的整体行为

替代方案

如果暂时不想修改核心代码，也可以考虑以下替代方案：

1. 编写中间件动态修改 SIDEBAR 配置
2. 使用元类或装饰器自动注册侧边栏配置
3. 创建自定义的管理命令来生成侧边栏配置

总结

在大型 Django 项目中使用 Unfold 主题时，通过 AppConfig 级别配置侧边栏行为是一种更优雅和可维护的解决方案。这种方式不仅解决了大量模型导致侧边栏冗长的问题，还提高了代码的组织性和可读性。对于正在使用 Unfold 并面临类似问题的开发者，值得考虑实现这一优化方案。