使用Django模型将JSON数据写入关系数据库的最优雅方法?

时间:2011-12-03 12:23:07

标签: python django json django-models relational-database

我在Django中有一个典型的关系数据库模型,其中典型模型包含一些ForeignKeys,一些ManyToManyFields,以及一些扩展Django DateTimeField的字段。

我想保存我从外部api以JSON格式(不是平面)接收的数据。我不希望数据被保存到各自的表(而不是整个json字符串到一个字段)。这样做最干净,最简单的方法是什么?是否有可用于使此任务更简单的库?

这是一个澄清我的问题的例子,

模型 -

class NinjaData(models.Model):
    id = models.IntegerField(primary_key=True, unique=True)
    name = models.CharField(max_length=60)  
    birthdatetime = MyDateTimeField(null=True)
    deathdatetime = MyDatetimeField(null=True)
    skills = models.ManyToManyField(Skills, null=True)
    weapons = models.ManyToManyField(Weapons, null=True)
    master = models.ForeignKey(Master, null=True)

class Skills(models.Model):
    id = models.IntegerField(primary_key=True, unique=True)
    name = models.CharField(max_length=60)
    difficulty = models.IntegerField(null=True)

class Weapons(models.Model):
    id = models.IntegerField(primary_key=True, unique=True)
    name = models.CharField(max_length=60)
    weight = models.FloatField(null=True)

class Master(models.Model):
    id = models.IntegerField(primary_key=True, unique=True)
    name = models.CharField(max_length=60)
    is_awesome = models.NullBooleanField()

现在,我通常必须将从外部api(秘密忍者api)获得的json字符串数据保存到此模型中,json看起来像这样

JSON -

{
"id":"1234",
"name":"Hitori",
"birthdatetime":"11/05/1999 20:30:00",
"skills":[
    {
    "id":"3456",
    "name":"stealth",
    "difficulty":"2"
    },
    {
    "id":"678",
    "name":"karate",
    "difficulty":"1"
    }
],
"weapons":[
    {
    "id":"878",
    "name":"shuriken",
    "weight":"0.2"
    },
    {
    "id":"574",
    "name":"katana",
    "weight":"0.5"
    }
],
"master":{
    "id":"4",
    "name":"Schi fu",
    "is_awesome":"true"
    }
}

现在处理典型ManyToManyField的逻辑非常简单,

逻辑代码 -

data = json.loads(ninja_json)
ninja = NinjaData.objects.create(id=data['id'], name=data['name'])

if 'weapons' in data:
    weapons = data['weapons']
    for weapon in weapons:
        w = Weapons.objects.get_or_create(**weapon)  # create a new weapon in Weapon table
        ninja.weapons.add(w)

if 'skills' in data:
    ...
    (skipping rest of the code for brevity)

我可以使用很多方法,

  • 代码在view函数中的逻辑上方执行将json转换为模型实例的所有工作
  • 代码高于逻辑覆盖模型的__init__方法
  • 代码高于逻辑覆盖模型的save()方法
  • 为每个模型创建一个Manager,并在其每个方法中编写此逻辑,例如createget_or_createfilter等。
  • 延长ManyToManyField并将其放在那里,
  • 外部图书馆?

我想知道是否有一种单一最明显的方式将这种json形式的数据保存到数据库而不需要多次编写上述逻辑,那么你将采用哪种最优雅的方法提示?

感谢大家阅读长篇文章,

3 个答案:

答案 0 :(得分:9)

在我看来,您需要的代码最干净的地方是作为NinjaData模型的自定义管理器上的新Manager方法(例如from_json_string)。

我认为你不应该覆盖标准的create,get_or_create等方法,因为你做的事与他们通常做的有点不同,最好让它们保持正常工作。

<强>更新 我意识到我可能在某些时候想要这个,所以我已编码并轻微测试了一个通用函数。由于它递归地通过并影响其他模型,我不再确定它属于一个Manager方法,应该是一个独立的帮助函数。

def create_or_update_and_get(model_class, data):
    get_or_create_kwargs = {
        model_class._meta.pk.name: data.pop(model_class._meta.pk.name)
    }
    try:
        # get
        instance = model_class.objects.get(**get_or_create_kwargs)
    except model_class.DoesNotExist:
        # create
        instance = model_class(**get_or_create_kwargs)
    # update (or finish creating)
    for key,value in data.items():
        field = model_class._meta.get_field(key)
        if not field:
            continue
        if isinstance(field, models.ManyToManyField):
            # can't add m2m until parent is saved
            continue
        elif isinstance(field, models.ForeignKey) and hasattr(value, 'items'):
            rel_instance = create_or_update_and_get(field.rel.to, value)
            setattr(instance, key, rel_instance)
        else:
            setattr(instance, key, value)
    instance.save()
    # now add the m2m relations
    for field in model_class._meta.many_to_many:
        if field.name in data and hasattr(data[field.name], 'append'):
            for obj in data[field.name]:
                rel_instance = create_or_update_and_get(field.rel.to, obj)
                getattr(instance, field.name).add(rel_instance)
    return instance

# for example:
from django.utils.simplejson import simplejson as json

data = json.loads(ninja_json)
ninja = create_or_update_and_get(NinjaData, data)

答案 1 :(得分:2)

我不知道您是否熟悉术语,但您基本上要做的是从序列化/字符串格式反序列化(在这种情况下,JSON)进入Python模型对象。

我不熟悉使用JSON执行此操作的Python库,因此我无法推荐/认可任何内容,但使用&#34; python&#34;,&#34;这样的术语进行搜索。反序列化&#34;,&#34; json&#34;,&#34; object&#34;,&#34; graph&#34;似乎在github上显示some Django documentation for serialization和库jsonpickle

答案 2 :(得分:1)

我实际上有同样的需求,我写了一个自定义数据库字段来处理它。只需将以下内容保存在项目的Python模块中(例如,相应应用程序中的fields.py文件),然后导入并使用它:

class JSONField(models.TextField):
    """Specialized text field that holds JSON in the database, which is
    represented within Python as (usually) a dictionary."""

    __metaclass__ = models.SubfieldBase

    def __init__(self, blank=True, default='{}', help_text='Specialized text field that holds JSON in the database, which is represented within Python as (usually) a dictionary.', *args, **kwargs):
        super(JSONField, self).__init__(*args, blank=blank, default=default, help_text=help_text, **kwargs)

    def get_prep_value(self, value):
        if type(value) in (str, unicode) and len(value) == 0:
            value = None
        return json.dumps(value)

    def formfield(self, form_class=JSONFormField, **kwargs):
        return super(JSONField, self).formfield(form_class=form_class, **kwargs)

    def bound_data(self, data, initial):
        return json.dumps(data)

    def to_python(self, value):
        # lists, dicts, ints, and booleans are clearly fine as is
        if type(value) not in (str, unicode):
            return value

        # empty strings were intended to be null
        if len(value) == 0:
            return None

        # NaN should become null; Python doesn't have a NaN value
        if value == 'NaN':
            return None

        # try to tell the difference between a "normal" string
        # and serialized JSON
        if value not in ('true', 'false', 'null') and (value[0] not in ('{', '[', '"') or value[-1] not in ('}', ']', '"')):
            return value

        # okay, this is a JSON-serialized string
        return json.loads(value)

一些事情。首先,如果您使用的是South,则需要向其解释自定义字段的工作原理:

from south.modelsinspector import add_introspection_rules
add_introspection_rules([], [r'^feedmagnet\.tools\.fields\.models\.JSONField'])

其次,虽然我已经做了很多工作来确保这个自定义字段在各处都很好用,比如在序列化格式和Python之间来回干净。有一个地方它不能正常工作,这是在与manage.py dumpdata结合使用时,它将Python合并到一个字符串而不是将其转储到JSON中,这不是你想要的。我发现这在实际操作中是一个小问题。

有关writing custom model fields的更多文档。

我断言这是做到这一点的最佳和最明显的方法。请注意,我还假设您不需要对此数据执行查找 - 例如你将根据其他标准检索记录,这将随之而来。如果您需要根据JSON中的内容进行查找,请确保它是一个真正的SQL字段(并确保它已编入索引!)。