Django中如何将Postgres JSONField以YAML展示并转存为JSON？

这事儿其实不难，咱们可以通过自定义Django表单字段来实现需求——让模型里的Postgres JSONField在表单中以YAML格式展示，提交时自动转成JSON格式存回数据库。下面是具体步骤：

1. 先装依赖 #

因为要处理YAML解析和生成，得先安装pyyaml：

pip install pyyaml

2. 自定义表单字段 #

咱们写一个继承自CharField的自定义字段，专门处理JSON（Python对象）和YAML字符串的互相转换：

import yaml
from django import forms
from django.core.exceptions import ValidationError

class YAMLCharField(forms.CharField):
    def prepare_value(self, value):
        # 把模型中存储的Python对象（JSON转来的）转换成YAML字符串，用于表单显示
        if value is not None and value != '':
            # sort_keys=False 保持原JSON的键顺序，避免自动排序
            return yaml.dump(value, sort_keys=False)
        return super().prepare_value(value)
    
    def to_python(self, value):
        # 把用户提交的YAML字符串转换成Python对象，供JSONField存储
        value = super().to_python(value)
        if value.strip() == '':
            return None  # 如果允许空值，返回None；也可以返回空字典{}，看你的业务需求
        try:
            # 用safe_load避免执行恶意代码，更安全
            return yaml.safe_load(value)
        except yaml.YAMLError as e:
            # 验证失败时抛出错误，用户会在表单看到提示
            raise ValidationError(f"YAML格式错误: {str(e)}") from e

3. 在表单中使用自定义字段 #

假设你的模型是这样的：

from django.db import models

class MyModel(models.Model):
    data = models.JSONField(null=True, blank=True)

那对应的ModelForm就可以这样写，把默认的字段替换成咱们的YAMLCharField，并且用Textarea组件方便编辑多行YAML：

from django.forms import ModelForm, Textarea
from .models import MyModel

class MyModelForm(ModelForm):
    data = YAMLCharField(
        widget=Textarea(attrs={'rows': 10}),
        required=False  # 如果字段允许空，记得设为False
    )

    class Meta:
        model = MyModel
        fields = ['data']

4. （可选）在Admin后台使用 #

如果想在Django Admin里也用上这个功能，只需要把自定义表单绑定到Admin类就行：

from django.contrib import admin
from .models import MyModel
from .forms import MyModelForm

@admin.register(MyModel)
class MyModelAdmin(admin.ModelAdmin):
    form = MyModelForm

注意事项 #

• 异常处理：to_python方法里的yaml.safe_load会捕获YAML格式错误，抛出的ValidationError会在表单验证时显示给用户，避免无效数据存入数据库。
• 空值处理：根据你的模型字段是否允许null或blank，调整to_python里的空值返回逻辑。
• 键顺序：yaml.dump里的sort_keys=False能保持原JSON的键顺序，如果你不介意键排序，可以去掉这个参数。

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