Django将字典传至前端及Model转字典的四种方法详解

江屿
江屿
发布时间:2026-10-13| 5人浏览过
原创

本文详解Django如何将字典数据传递至前端页面展示,并深入剖析将Model转换为字典的四种常用方法:手动构建、__dict__、model_to_dict及自定义to_dict。重点解析各方法的优缺点、字段过滤机制及时间字段处理问题,提供基于Django 2.0环境的完整代码示例与最佳实践建议。

Django将字典传至前端显示

后台代码实现如下:

fielddict = {'name':'张三','age':18} return render(request,'test.html',{'field':fielddict})

前端模板代码编写如下:


{% for m,n in field.items %}
   {{ m }}:{{ n }}
{% endfor %}

页面显示效果如图所示:

若需在前端通过键名获取对应值,可参考以下写法:

{{field.name}} {{field.age}}

Django Model转字典的四种方法

补充知识:Django Model转换为字典的多种实现方式

在常规开发流程中,经常需要将Model对象转换为字典格式,特别是在前后端分离架构下,JSON已成为数据交互的标准格式,此类转换需求尤为频繁。本文介绍几种日常使用的转换方法供参考,所有示例均基于Django 2.0环境进行演示。

背景介绍

涉及的Model定义如下:


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表中的数据分别转换为字典格式并返回。

方法一:手动构建字典

方法一:手动构建字典

示例代码如下:


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

该方法的优点在于可以灵活控制最终返回字典中value的格式。例如,对于User表,若需返回包含id、创建时间、中文名、上级中文名及所属组名列表的数据,可使用如下代码实现:


>>> _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': '公众号'}
>>> 

其缺点同样明显:当Model字段较多且无需转换value格式时,需编写大量冗余代码。如何解决这一问题?请参见下文介绍的其他方法。

方法二:使用__dict__

方法二:使用__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字段,同时Foreignkey字段名会附加_id后缀,且未包含ManyToManyField的数据。此外,无法按需筛选输出字段,当仅需部分字段时会产生大量冗余数据。

方法三:使用model_to_dict

方法三:使用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隐藏属性,这也是上述两个time相关字段(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

方法四:自定义to_dict方法

方法四:自定义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的便利性,同时解决了无法输出time字段(因editable=False被隐藏)的问题,并支持按自定义格式输出value,实现一举多得。

当然,在享受便利性的同时,需要自行实现to_dict代码,这增加了代码复杂度。

以上关于Django实现将字典传至前端显示及Model转字典的四种方法即为全部内容分享,希望能对大家有所帮助,也希望大家多多支持本站。

相关标签:

免责声明:本文内容仅供参考,不代表本站观点。转载或引用请注明出处。

Python 相关产品和应用

全部下载
Selenium

Selenium

4.51.0 · Windows

用于浏览器自动化和 Web 测试的 Python 工具。

scikit-learn

scikit-learn

1.9.1 · Windows

常用 Python 机器学习算法与模型评估工具库。

Black

Black

26.10.1 · Windows

强调一致性的 Python 自动代码格式化工具。

Ruff

Ruff

0.17.1 · macOS

由 Rust 编写的高速 Python 代码检查和格式化工具。

pytest

pytest

9.1.1 · Windows

简洁而强大的 Python 自动化测试框架。

FastAPI

FastAPI

0.146.0 · Windows

高性能 Python API 框架,支持类型提示和自动接口文档。

Flask

Flask

3.1.3 · Windows

轻量灵活的 Python Web 应用框架。

Django

Django

6.1.2 · Windows

成熟的 Python Web 框架,适合构建内容站点和业务系统。

Spyder

Spyder

6.1.7 · Windows

面向科学计算与数据分析的 Python 集成开发环境。

SciPy

SciPy

1.18.1 · Windows

面向科学、工程和技术计算的 Python 算法库。