Несколько методов модели Django для словаря

задняя часть Архитектура Django

В обычном процессе разработки неизбежно сталкиваться с необходимостью преобразования модели в словарь, особенно сейчас, когда популярна архитектура разделения фронтенда и бэкенда, а формат Json стал практически стандартом обмена данными между интерфейс и серверная часть, поэтому спрос на эту модель больше.Теперь в этой статье представлены несколько методов ежедневного использования для справки, все примеры основаны на демонстрации среды Django 2.0.

Введение

Содержание модели следующее:

class Group(models.Model):
    name = models.CharField(max_length=255, unique=True, verbose_name='组名称')

    def __str__(self):
        return self.name

class User(models.Model):
    create_time = models.DateTimeField(auto_now_add=True, verbose_name='创建时间')
    update_time = models.DateTimeField(auto_now=True, verbose_name='更新时间')
    username = models.EmailField(max_length=255, unique=True, verbose_name='用户名')
    fullname = models.CharField(max_length=64, null=True, verbose_name='中文名')
    is_active = models.BooleanField(default=True, verbose_name='激活状态')
    leader = models.ForeignKey('self', null=True, on_delete=models.CASCADE, verbose_name='上级')
    group = models.ManyToManyField(Group, null=True, verbose_name='所属组')

    def __str__(self):
        return self.username

Требование очень просто преобразовать данные в таблицах Group и User в формат словаря и вернуть

Способ 1: создать словарь напрямую

Образец кода:

>>> _t = Group.objects.get(id=1)
>>> 
>>> dict = {
...   'id': _t.id,
...   'name': _t.name
... }
>>> 
>>> print(dict)
{'name': 'GroupA', 'id': 1}

Преимущество этого метода заключается в том, что удобно контролировать формат окончательного возвращаемого словарного значения.Например, для таблицы User я хочу вернуть окончательные данные в виде идентификатора, времени создания, китайского имени, старшего китайского имени и список имен групп, которые можно реализовать с помощью следующего кода.

>>> _t = User.objects.get(id=2)
>>> 
>>> dict = {
...   'id': _t.id,
...   'create_time': _t.create_time.strftime('%Y-%m-%d %H:%M:%S'),
...   'fullname': _t.fullname if _t.fullname else None,
...   'leader': _t.leader.fullname if _t.leader else None,
...   'group': [ i.name for i in _t.group.all() ],
... }
>>> 
>>> print(dict)
{'fullname': '运维咖啡吧', 'group': ['GroupA', 'GroupC', 'GroupE'], 'create_time': '2018-10-12 21:20:19', 'id': 2, 'leader': '公众号'}
>>>

Недостаток тоже очевиден, то есть если у модели много полей и не нужно преобразовывать формат значения, то нужно писать много избыточного кода.Как решить эту проблему? Давайте посмотрим на метод ниже

Способ второй:dict

Образец кода:

>>> Group.objects.get(id=1).__dict__
{'id': 1, 'name': 'GroupA', '_state': <django.db.models.base.ModelState object at 0x7f68612daef0>}
>>> 
>>> User.objects.get(id=1).__dict__
{'is_active': True, '_state': <django.db.models.base.ModelState object at 0x7f68612fa0b8>, 'id': 1, 'username': 'ops@163.com', 'leader_id': None, 'fullname': '公众号', 'update_time': datetime.datetime(2018, 10, 12, 17, 49, 35, 504141), 'create_time': datetime.datetime(2018, 10, 12, 16, 9, 7, 813660)}

Преимущество этого метода в том, что его просто написать, легко понять, а объем кода невелик.

Но вы найдете больше бесполезных_stateполе, а имена полей внешнего ключа более_id, нет данных для поля ManyToManyField, и вывод не может быть отображен по требованию, будет много избыточных данных, когда мне нужно только несколько из этих полей

Способ 3: model_to_dict

Образец кода:

>>> model_to_dict(Group.objects.get(id=1))
{'name': 'GroupA', 'id': 1}
>>> 
>>> model_to_dict(User.objects.get(id=2))
{'leader': 1, 'is_active': True, 'username': 'ops-coffee@163.com', 'fullname': '运维咖啡吧', 'group': [<Group: GroupA>, <Group: GroupC>, <Group: GroupE>], 'id': 2}

Этот метод может удовлетворить большинство потребностей, и результат является разумным, и есть два параметра.fieldsа такжеexcludeдля настройки полей вывода, например:

>>> model_to_dict(User.objects.get(id=2), fields=['fullname','is_active'])
{'is_active': True, 'fullname': '运维咖啡吧'}
>>> 
>>> model_to_dict(User.objects.get(id=2), exclude=['group','leader','id'])
{'fullname': '运维咖啡吧', 'is_active': True, 'username': 'ops-coffee@163.com'}

но пропуститeditable=FalseОтображение полей атрибутов, дляauto_now_add=Trueа такжеauto_now=TrueПоле datetime атрибута добавляется по умолчаниюeditable=FalseСкрытые атрибуты, которые также являются двумя полями, связанными со временем выше.create_timeа такжеupdate_timeПричина, по которой он не отображается после преобразования в dict, официальный соответствующий исходный код заключается в следующем:

for f in chain(opts.concrete_fields, opts.private_fields, opts.many_to_many):
    if not getattr(f, 'editable', False):
        continue

Способ 4: настроить to_dict

Образец кода:

from django.db.models.fields import DateTimeField
from django.db.models.fields.related import ManyToManyField

class User(models.Model):
    ...

    def to_dict(self, fields=None, exclude=None):
        data = {}
        for f in self._meta.concrete_fields + self._meta.many_to_many:
            value = f.value_from_object(self)

            if fields and f.name not in fields:
                continue

            if exclude and f.name in exclude:
                continue

            if isinstance(f, ManyToManyField):
                value = [ i.id for i in value ] if self.pk else None

            if isinstance(f, DateTimeField):
                value = value.strftime('%Y-%m-%d %H:%M:%S') if value else None

            data[f.name] = value

        return data

Результаты:

>>> User.objects.get(id=2).to_dict()
{'is_active': True, 'update_time': '2018-10-12 21:21:39', 'username': 'ops-coffee@163.com', 'id': 2, 'leader': 1, 'group': [1, 3, 5], 'create_time': '2018-10-12 21:20:19', 'fullname': '运维咖啡吧'}
>>> 
>>> User.objects.get(id=2).to_dict(fields=['fullname','is_active','create_time'])
{'is_active': True, 'fullname': '运维咖啡吧', 'create_time': '2018-10-12 21:20:19'}
>>> 
>>> User.objects.get(id=2).to_dict(exclude=['group','leader','id','create_time'])
{'is_active': True, 'update_time': '2018-10-12 21:21:39', 'username': 'ops-coffee@163.com', 'fullname': '运维咖啡吧'}

имеютmodel_to_dictТакое же удобство, но также решает проблему невозможности вывода поля времени (editable=False), а также может выводить значение в нужном вам формате, что служит нескольким целям Конечно имея удобство нужно реализовать самомуto_dictкод, увеличивая сложность

扫码关注公众号查看更多实用文章

Похожие статьи Рекомендуем к прочтению

Категории