Django Unfold 中自定义只读 JSON 字段的格式化技巧

在 Django Unfold 项目中，开发者经常会遇到需要在前端界面展示 JSON 数据的场景。系统默认的 JSON 字段展示已经提供了良好的格式化效果，但当我们需要自定义只读字段时，如何实现同样美观的 JSON 格式化显示呢？

默认 JSON 字段的展示效果

Django Unfold 对于模型中的 JSONField 类型字段，默认会以美观的格式化方式展示在前端界面。这种展示方式具有以下特点：

• 自动缩进，保持层级结构清晰
• 语法高亮，便于区分不同类型的数据
• 可折叠/展开的交互功能
• 良好的可读性和视觉体验

自定义只读字段的格式化需求

当开发者需要创建自定义的只读字段来展示 JSON 数据时，简单的使用 Python 的 json.dumps() 方法并不能达到同样的效果。直接使用 json.dumps() 会产生以下问题：

• 缺少语法高亮
• 没有交互功能
• 在 HTML 中显示为纯文本，不够美观

解决方案

Django Unfold 提供了一个实用的工具函数 display_json 专门用于解决这个问题。这个函数位于项目的工具模块中，它能够：

1. 将 Python 对象转换为格式化的 JSON 字符串
2. 添加必要的 HTML 结构和类名
3. 保持与系统默认 JSON 字段一致的展示风格

使用这个工具函数非常简单，只需在自定义字段方法中调用它即可：

from unfold.utils import display_json

def custom_json_field(self, obj):
    return display_json(obj.some_field)

实现原理

display_json 函数的内部实现考虑了多个方面：

• 自动处理 None 值情况
• 支持自定义缩进级别
• 添加了 Unfold 特定的 CSS 类
• 确保输出的 HTML 结构符合前端展示要求

最佳实践

在实际项目中，建议：

1. 对于简单的 JSON 数据展示，直接使用 display_json 函数
2. 对于复杂的数据结构，可以先进行适当的数据处理再传入
3. 考虑添加字段描述，提升用户体验
4. 注意数据安全性，避免敏感信息泄露

通过这种方式，开发者可以轻松地在 Django Unfold 项目中实现美观、一致的自定义 JSON 数据展示效果，保持整个系统的 UI 风格统一。