Django模型序列化返回自然主键值示例代码


Posted in Python onJune 12, 2019

场景

在设计表结构时,难免需要建立一些外键关联。例如这样两个模型:

from django.db import models

class Person(models.Model):
 username = models.CharField(max_length=100)
 birthdate = models.DateField()

class Book(models.Model):
 name = models.CharField(max_length=100)
 author = models.ForeignKey(Person, on_delete=models.CASCADE)

表 Book 的字段 author 是表 Person 的外键,我们试用 Django 原生的 Serializer 模块来对 Book 实例序列化:

from django.core import serializers
book_json = serializers.serialize("json", Book.objects.get(pk=1))

JSON 序列化结果如下:

{
 "pk": 1,
 "model": "store.book",
 "fields": {
  "name": "Mostly Harmless",
  "author": 42
 }
}

这个 "author": 42 对用户来说相当于未知,我们需要的是 Person 表中主键为 42 的用户姓名,即 username 的值。

解决方案

在 Django 官方文档的「序列化」一节中提到了用 models.Manager 处理的方案;在搜索解决方案过程中,也接触到 Django-REST-Framework(DRF) ,了解到 DRF 中的 Serializer 模块也能解决这类问题。那我们不妨对比一下两种解决方案。

方案一:models.Manager

根据文档,要返回自然主键,我们需要定义一个模型管理器,创建一个 get_by_natural_key 方法,如下:
from django.db import models

from django.db import models

class PersonManager(models.Manager):
 def get_by_natural_key(self, username):
  return self.get(username=username)

class Person(models.Model):
 username = models.CharField(max_length=100)
 birthdate = models.DateField()
 objects = PersonManager()

然后再次序列化 Book 实例:

from django.core import serializers
book_json = serializers.serialize("json", Book.objects.get(pk=1), use_natural_foreign_keys=True)

得到新的结果如下:

{
    "pk": 1,
    "model": "store.book",
    "fields": {
        "name": "Mostly Harmless",
        "author": ["DouglasAdams"]
    }
}

如果需要对其他应用的数据模型做修改,例如使用了 django.auth.User(默认认证后端)作为 Book  的外键,要想不修改 User 模型又使用新的模型管理器,可以使用代理模式完成:

from django.db import models

class NewManager(models.Manager):
 # ...
 pass

class MyPerson(Person):
 objects = NewManager()

 class Meta:
  proxy = True

总的来说,这个方案可以完美解决我所遇到的问题,代码量稍微大一些,但是也更灵活。

方案二:DRF 的 Serializer

下面我们试试用 Django-REST-Framework 的序列化模块:

from rest_framework import serializers
from .models import Book

class BookSerializer(serializers.ModelSerializer):
 author_name = serializers.CharField(source='author.username')

 class Meta:
  model = Book
  fields = '__all__'

这段代码表示,在序列化 Book 实例时,添加一个新的属性 author_name,该值的来源为 source 参数定义的外键 author 实例的自然主键 username。

然后是执行序列化的过程:

queryset = Book.objects.get(pk=1)
BookSerializer(instance=queryset)

序列化结果:

{
    "id": 1,
    "name": "Mostly Harmless",
    "author": 42,
    "author_name": "DouglasAdams"
}

当然,序列化一批 Book 实例也是可以的:

queryset = Book.objects.all()
BookSerializer(instance=queryset, many=True)

序列化结果:

[
    {
        "id": 1,
        "name": "Mostly Harmless",
        "author": 42,
        "author_name": "DouglasAdams"
    },
    {
        "id": 2,
        "name": "Harry Potter",
        "author": 2,
        "author_name": "JKRowling"
    }
]

可以看到,使用 DRF 的序列化模块返回自然主键,不仅代码清晰改动少,而且效果也很不错,序列化数据少了一个层级,对前端也是十分友好的。

方案三:手动修改序列化后的外键

当然,还有一种最傻也是最容易想到的办法,就是在序列化后,手动修改 JSON 串中对应的外键值为自然主键值。

这种做法可以得到和方案一一样的效果,但是遇到查询结果为列表时我们需要遍历替换。同时试想一下,如果我们在每个视图中都这么处理,那代码会变得十分糟糕。不建议使用该方案。

总结

对比两种序列化方案,我个人更偏向于 DRF 优雅的处理方式。当然,除了序列化,DRF 还有很多功能,例如分页等,强烈建议学习学习。

当然,可能不存在最好的最好的技术方案,遇到这类问题选择最合适自己的就好。也可能还有更多的方法可以解决标题的问题,也欢迎留言探讨!

参考

  • docs.djangoproject.com/zh-hans/2.2…
  • docs.djangoproject.com/en/2.2/topi…
  • www.django-rest-framework.org/api-guide/f…

好了,以上就是这篇文章的全部内容了,希望本文的内容对大家的学习或者工作具有一定的参考学习价值,谢谢大家对三水点靠木的支持。

Python 相关文章推荐
Python完全新手教程
Feb 08 Python
Flask SQLAlchemy一对一,一对多的使用方法实践
Feb 10 Python
python list语法学习(带例子)
Nov 01 Python
python中去空格函数的用法
Aug 21 Python
python中Flask框架简单入门实例
Mar 21 Python
深入解析Python中的线程同步方法
Jun 14 Python
Python与R语言的简要对比
Nov 14 Python
python计算阶乘和的方法(1!+2!+3!+...+n!)
Feb 01 Python
OpenCV HSV颜色识别及HSV基本颜色分量范围
Mar 22 Python
python模块和包的应用BASE_PATH使用解析
Dec 14 Python
TensorFlow tensor的拼接实例
Jan 19 Python
利用Python批量识别电子账单数据的方法
Feb 08 Python
pandas实现将dataframe满足某一条件的值选出
Jun 12 #Python
python 列表输出重复值以及对应的角标方法
Jun 11 #Python
使用python list 查找所有匹配元素的位置实例
Jun 11 #Python
python找出一个列表中相同元素的多个索引实例
Jun 11 #Python
三步实现Django Paginator分页的方法
Jun 11 #Python
python-tkinter之按钮的使用,开关方法
Jun 11 #Python
人工神经网络算法知识点总结
Jun 11 #Python
You might like
php Session存储到Redis的方法
2013/11/04 PHP
thinkphp备份数据库的方法分享
2015/01/04 PHP
php 指定范围内多个随机数代码实例
2016/07/18 PHP
prototype 1.5 & scriptaculous 1.6.1 学习笔记
2006/09/07 Javascript
input+select(multiple) 实现下拉框输入值
2009/05/21 Javascript
jQuery 学习6 操纵元素显示效果的函数
2010/02/07 Javascript
爆炸式的JS圆形浮动菜单特效代码
2010/03/03 Javascript
JQuery slideshow的一个小问题(如何发现及解决过程)
2013/02/06 Javascript
javascript中this做事件参数相关问题解答
2013/03/17 Javascript
js调用css属性写法
2013/09/21 Javascript
angular框架实现全选与单选chekbox的自定义
2017/07/06 Javascript
史上最全JavaScript常用的简写技巧(推荐)
2017/08/17 Javascript
利用JavaScript的%做隔行换色的实例
2017/11/25 Javascript
解析Vue 2.5的Diff算法
2017/11/28 Javascript
[51:39]DOTA2-DPC中国联赛 正赛 Magma vs LBZS BO3 第二场 2月7日
2021/03/11 DOTA
Python基本数据类型详细介绍
2014/03/11 Python
python实现百度关键词排名查询
2014/03/30 Python
使用python批量修改文件名的方法(视频合并时)
2020/03/24 Python
Python根据服务获取端口号的方法
2019/09/25 Python
Python数据可视化:顶级绘图库plotly详解
2019/12/07 Python
Python+Appium实现自动化测试的使用步骤
2020/03/24 Python
马来西亚在线时尚女装商店:KEI MAG
2017/09/28 全球购物
实习医生自我评价
2013/09/22 职场文书
通信生自我鉴定
2014/01/18 职场文书
岗位职责的构建方法
2014/02/01 职场文书
理工大学毕业生自荐信范文
2014/02/22 职场文书
会计电算化毕业生自荐信
2014/03/03 职场文书
廉洁校园实施方案
2014/05/25 职场文书
关于读书的演讲稿600字
2014/08/27 职场文书
公务员群众路线专题民主生活会发言材料
2014/09/17 职场文书
不尊敬老师检讨书范文
2014/11/19 职场文书
劳动保障个人工作总结
2015/03/04 职场文书
2015年小学重阳节活动总结
2015/07/29 职场文书
MySQL Router的安装部署
2021/04/24 MySQL
PostgreSQL13基于流复制搭建后备服务器的方法
2022/01/18 PostgreSQL
java高级用法JNA强大的Memory和Pointer
2022/04/19 Java/Android