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中。

以上就是jsonfield註解format相關的詳細闡述。使用jsonfield註解的時候，遇到問題不要着急，我們可以根據具體情況，選擇不同的解決方案，使得數據操作更加輕鬆便捷。