Django中JSONField转TextField后格式异常的解决方案咨询

直接替换JSONField为TextField时，Django会用Python默认的repr()把字典转成字符串，导致出现单引号、大写布尔值等非标准JSON格式，手动替换不仅容易遗漏嵌套结构的问题，还不够优雅。推荐用自定义字段封装序列化/反序列化逻辑，同时修正现有数据。

1. 自定义OrderedJSONTextField字段 #

这个字段继承TextField，用标准json模块处理数据，既保证顺序，又输出标准JSON格式：

import json
from collections import OrderedDict
from django.db import models

class OrderedJSONTextField(models.TextField):
    def to_python(self, value):
        # 处理空值
        if value is None or value == '':
            return OrderedDict()
        # 如果已经是字典直接返回
        if isinstance(value, dict):
            return value
        
        # 先尝试标准JSON解析，失败则兼容错误格式
        try:
            return json.loads(value, object_pairs_hook=OrderedDict)
        except json.JSONDecodeError:
            # 修正单引号和布尔值格式
            corrected = value.replace("'", '"').replace('True', 'true').replace('False', 'false')
            return json.loads(corrected, object_pairs_hook=OrderedDict)

    def get_prep_value(self, value):
        if value is None:
            return None
        # 用json.dump生成标准JSON字符串，保留顺序
        return json.dumps(value, ensure_ascii=False)

注：Python3.7+ 中普通dict已默认保留插入顺序，可把object_pairs_hook=OrderedDict改成object_pairs_hook=dict（或直接省略）。

2. 更新模型字段 #

把原来的TextField替换为自定义字段：

class UserProfile(models.Model):
    ...
    data = OrderedJSONTextField(blank=True, null=True)

3. 生成迁移并修正现有数据 #

1. 生成迁移文件：

python manage.py makemigrations

2. 打开生成的迁移文件，添加RunPython操作来批量修正现有格式错误的数据：

from django.db import migrations, models
import json
from collections import OrderedDict

def fix_existing_data(apps, schema_editor):
    UserProfile = apps.get_model('你的应用名', 'UserProfile')
    # 遍历所有非空数据记录
    for profile in UserProfile.objects.exclude(data__isnull=True).exclude(data=''):
        try:
            # 尝试解析现有数据
            parsed_data = json.loads(profile.data, object_pairs_hook=OrderedDict)
        except json.JSONDecodeError:
            # 修正格式后再解析
            corrected_str = profile.data.replace("'", '"').replace('True', 'true').replace('False', 'false')
            parsed_data = json.loads(corrected_str, object_pairs_hook=OrderedDict)
        # 重新序列化为标准JSON并保存
        profile.data = json.dumps(parsed_data, ensure_ascii=False)
        profile.save(update_fields=['data'])

class Migration(migrations.Migration):
    dependencies = [
        # 这里填你的上一个迁移文件名，比如('myapp', '0002_xxx'),
    ]

    operations = [
        migrations.AlterField(
            model_name='userprofile',
            name='data',
            field=你的应用名.models.OrderedJSONTextField(blank=True, null=True),
        ),
        migrations.RunPython(fix_existing_data),
    ]

3. 执行迁移：

python manage.py migrate

为什么这个方案更优 #

• 封装性强：所有序列化/反序列化逻辑集中在字段类里，业务代码无需额外处理
• 兼容性好：自动兼容现有错误格式数据，一次性修正后不会再出现格式问题
• 标准合规：用官方json模块保证输出标准JSON，避免手动替换的遗漏（比如嵌套字典里的单引号）
• 性能高效：无需每次访问数据时排序，插入时就通过json.dumps保留顺序

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