jsonfield注解format的详解

一、jsonfield注解format

jsonfield注解在Django里面是一个很常见的注解，可以有效地解析JSON格式的数据，以及存储JSON数据。其中，format参数是一个非常实用的功能，它可以将JSON字段的值在序列化/反序列化时格式化。

以一个简单的例子为例：

from jsonfield import JSONField
from django.db import models

class MyModel(models.Model):
    data = JSONField()
    summary = models.CharField(max_length=100)

    def __str__(self):
        return self.summary

如果我们直接使用jsonfield注解，所得到的值是一个字典类型，如：{'a': 1, 'b': 2, 'c': 3}。但是，如果我们想将其转化为{'A':1, 'B':2, 'C': 3}的形式，我们可以使用jsonfield注解的format参数来实现。

class MyModel(models.Model):
    data = JSONField(format='upper') # 单层转换 format='upper'
    summary = models.CharField(max_length=100)

    def __str__(self):
        return self.summary

上述代码中，我们通过设定format='upper'参数来将字典中的键转化为大写字母。

二、jsonfield注解坑

在使用jsonfield注解进行开发时，需要特别注意一些坑点。例如，当数据中含有类型为date和datetime的数据时，我们需要进行额外的转换，否则会因为不受支持的数据类型而导致错误。

class MyModel(models.Model):
    data = JSONField(format='upper') # 单层转换 format='upper'
    summary = models.CharField(max_length=100)

    def __str__(self):
        return self.summary

    def clean(self, *args, **kwargs):
        if 'data' in self.__dict__ and isinstance(self.data, dict):
            for key, value in self.data.items():
                if isinstance(value, datetime):
                    self.data[key] = value.strftime('%Y-%m-%d %H:%M:%S')
                elif isinstance(value, date):
                    self.data[key] = value.strftime('%Y-%m-%d')

        super().clean(*args, **kwargs)

在上述代码中，我们通过重写clean()方法，对data字段的date和datetime类型进行了序列化处理。

三、jsonfield注解时间差

由于Django对于DateTime的序列化/反序列化是有损失的，它会转化为UTC时间，这时常常需要我们进行手动转行为本地时间，并进行比较。因此，我们需要使用Format和Parse来使得数据的准确性更高。

class MyModel(models.Model):
    data = JSONField(format='%Y-%m-%d %H:%M:%S') # format和parse字段序列化和反序列化时生效
    summary = models.CharField(max_length=100)

    def __str__(self):
        return self.summary

    def clean(self, *args, **kwargs):
        if 'data' in self.__dict__ and isinstance(self.data, dict):
            for key, value in self.data.items():
                if isinstance(value, str):
                    self.data[key] = datetime.strptime(value, '%Y-%m-%d %H:%M:%S')

        super().clean(*args, **kwargs)

在上述代码中，我们添加了format='%Y-%m-%d %H:%M:%S'参数，将datetime转换为指定格式。同时，我们重写了clean()方法，对字符串进行反序列化操作，并将其转化为datetime类型。

四、jsonfield注解不生效

在有些情况下，我们可能会遇到jsonfield注解不生效的情况。例如，在使用Q所进行的OR连接查询操作中，jsonfield注解会自动忽略。因此，在这种情况下，我们需要自己手动对数据进行处理。

from django.db.models import Q

notes = MyModel.objects.filter(
    Q(data__name__icontains='hello') | 
    Q(data__name__icontains='world')
)
new_notes = []
for note in notes:
    note.data = {
        'name': note.data.get('name', ''),
        'age': note.data.get('age', 0),
        'content': note.data.get('content', '')
    }
    new_notes.append(note)

print(new_notes)

五、jsonfield注解无效

在一些使用jsonfield注解的应用程序中，我们可能会遇到底层数据库中存储的为字符串而非json格式，导致jsonfield注解无法生效的情况。在这种情况下，我们需要使用JsonFieldEncoder和JsonFieldDecoder来实现。

import json
from django.db import models

class JsonFieldEncoder(json.JSONEncoder):

    def default(self, obj):
        if isinstance(obj, (models.Model,)):
            return obj.pk
        return super().default(obj)

class JsonFieldDecoder(json.JSONDecoder):

    def __init__(self, model_class=None, *args, **kwargs):
        self.model_class = model_class
        super().__init__(*args, **kwargs)

    def object_hook(self, dct):
        if self.model_class and 'pk' in dct:
            try:
                return self.model_class.objects.get(pk=dct['pk'])
            except self.model_class.DoesNotExist:
                pass
        return dct

class MyModel(models.Model):
    data = JSONField(encoder=JsonFieldEncoder, decoder=JsonFieldDecoder(model_class=self), default=dict)
    summary = models.CharField(max_length=100)

    def __str__(self):
        return self.summary

在上述代码中，我们通过自定义JsonFieldEncoder和JsonFieldDecoder来进行jsonfield注解的序列化/反序列化操作。

六、jsonfield注解多层转换成一层

很多时候我们需要将多层的JSON结构转化为一层，以便于序列化/反序列化操作。这时，我们可以定义一个JsonFieldReplacer对象，通过递归操作来完成转换。

class JsonFieldReplacer:

    def __init__(self, key_map=None):
        self.key_map = key_map or {}

    def __call__(self, key, v):
        k = self.key_map.get(key, key)
        if isinstance(v, dict):
            return {f'{k}.{hk}': hv for hk, hv in JsonFieldReplacer()(hk, hv) for hk, hv in v.items()}
        return {k: v}

class MyModel(models.Model):
    data = JSONField(default=dict, encoder=JsonFieldEncoder, decoder=JsonFieldDecoder(model_class=self))
    summary = models.CharField(max_length=255)

    def __str__(self):
        return self.summary

    def clean(self, *args, **kwargs):
        if isinstance(self.data, dict) and any('.' in k for k in self.data):
            self.data = dict(*map(JsonFieldReplacer(), self.data.items()))
        super().clean(*args, **kwargs)

在上述代码中，我们定义了JsonFieldReplacer对象，当遇到复合字段时，可以将其按照一定的规则拆分成多个简单字段，便于序列化/反序列化操作。

七、jsonfield注解类属性是引用类型

在jsonfield注解开发中，我们还需要特别注意到一个问题：类属性如果是引用类型，可能会在使用jsonfield注解的过程中导致无法序列化的问题。因此，我们需要使用函数进行序列化/反序列化操作。

class MyModel(models.Model):

    title = models.CharField(max_length=255)
    tags = ArrayField(models.IntegerField(), default=list)
    extra_data = models.TextField(default='{}')

    def __str__(self):
        return self.title

    def set_extra_data(self, data):
        self.extra_data = json.dumps(data, ensure_ascii=False)

    def get_extra_data(self):
        return json.loads(self.extra_data, encoding='utf-8')

    def clean(self, *args, **kwargs):
        self.extra_data = self.get_extra_data()
        super().clean(*args, **kwargs)

    @property
    def extra_tags(self):
        return self.get_extra_data().get('tags', [])
    @extra_tags.setter
    def extra_tags(self, data):
        edata = self.get_extra_data()
        edata.update({'tags': data})
        self.set_extra_data(edata)

在上述代码中，我们通过set_extra_data()和get_extra_data()方法来对extra_data字段进行了序列化/反序列化操作，这样就避免了类属性是引用类型带来的序列化问题。

八、jsonformat注解

jsonformat注解提供了一个一般性的json格式化工具，可以将json格式的字符串，转换为json对象，也可以直接将json对象转换为字符串，可以更方便地进行数据操作。

import json
from django.utils.encoding import force_text
from django.utils.functional import Promise
from django.utils.html import escape, conditional_escape

class DataJsonEncoder(json.JSONEncoder):

    def default(self, obj):
        if isinstance(obj, Promise):
            return force_text(obj)
        return super().default(obj)

def data_json_dump(data):
    return json.dumps(data, ensure_ascii=False, cls=DataJsonEncoder)

def data_json_loads(data):
    return json.loads(conditional_escape(data))

在上述代码中，我们使用了Django内置的Promise对象，以及escape和conditional_escape方法，来实现json对象的格式化转换。

九、jsonfield注解一个一个改么

当我们遇到需要对大量jsonfield注解的字段进行修改时，我们可能需要一个一个进行修改，工作量很大。所以，我们可以使用装饰器来批量修改。

from django.db.models import TextField

def jsonfield2text(model):
    for field in model._meta.fields:
        if isinstance(field, JSONField):
            db_column = field.db_column or field.name
            model.add_to_class(field.name, TextField(
                verbose_name=field.verbose_name,
                db_column=db_column,
                help_text=field.help_text,
            ))
    return model

@jsonfield2text
class MyModel(models.Model):
    data = JSONField(default=dict)
    summary = models.CharField(max_length=100)

    def __str__(self):
        return self.summary

在上述代码中，我们通过定义jsonfield2text装饰器，将原有的JSONField改为了TextField，并将JSONField的字段信息转移到TextField中。