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 相关文章推荐
使用Python3中的gettext模块翻译Python源码以支持多语言
Mar 31 Python
浅谈python中的变量默认是什么类型
Sep 11 Python
python中os和sys模块的区别与常用方法总结
Nov 14 Python
python如何通过实例方法名字调用方法
Mar 21 Python
python定时关机小脚本
Jun 20 Python
Sanic框架配置操作分析
Jul 17 Python
python用plt画图时,cmp设置方法
Dec 13 Python
Python实现高斯函数的三维显示方法
Dec 29 Python
Python求一批字符串的最长公共前缀算法示例
Mar 02 Python
Python集合基本概念与相关操作实例分析
Oct 30 Python
如何基于python把文字图片写入word文档
Jul 31 Python
Python matplotlib多个子图绘制整合
Apr 13 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中英混合字符串截取函数代码
2011/07/17 PHP
PHP文件读写操作相关函数总结
2014/11/18 PHP
php程序员应具有的7种能力小结
2014/11/27 PHP
使用PHP实现生成HTML静态页面
2015/11/18 PHP
详解WordPress中简码格式标签编写的基本方法
2015/12/22 PHP
Ajax+PHP实现的分类列表框功能示例
2019/02/11 PHP
JavaScript 脚本将当地时间转换成其它时区
2009/03/19 Javascript
基于JQuery的密码强度验证代码
2010/03/01 Javascript
jQuery初学:find()方法及children方法的区别分析
2011/01/31 Javascript
JQuery实现简单验证码提示解决方案
2012/12/20 Javascript
js触发select onchange事件的小技巧
2014/08/05 Javascript
JavaScript操作URL的相关内容集锦
2015/10/29 Javascript
基于javascript实现泡泡大冒险网页版小游戏
2016/03/23 Javascript
AngularJS中$http服务常用的应用及参数
2016/08/22 Javascript
JS表单数据验证的正则表达式(常用)
2017/02/18 Javascript
javascript  删除select中的所有option的实例
2017/09/17 Javascript
微信禁止下拉查看URL的处理方法
2017/09/28 Javascript
如何自动化部署项目?折腾服务器之旅~
2019/04/16 Javascript
nodejs环境使用Typeorm连接查询Oracle数据
2019/12/05 NodeJs
three.js 如何制作魔方
2020/07/31 Javascript
Python的多维空数组赋值方法
2018/04/13 Python
用xpath获取指定标签下的所有text的实例
2019/01/02 Python
如何用C代码给Python写扩展库(Cython)
2019/05/17 Python
python 并发编程 多路复用IO模型详解
2019/08/20 Python
python多进程(加入进程池)操作常见案例
2019/10/21 Python
使用tensorflow显示pb模型的所有网络结点方式
2020/01/23 Python
Python析构函数__del__定义原理解析
2020/11/20 Python
html5中的input新属性range使用记录
2014/09/05 HTML / CSS
html5 postMessage前端跨域并前端监听的方法示例
2018/11/01 HTML / CSS
春秋航空官方网站:Spring Airlines
2017/09/27 全球购物
乡镇干部十八大感言
2014/02/17 职场文书
某某同志考察材料
2014/05/28 职场文书
小班教师个人总结
2015/02/05 职场文书
毕业论文致谢部分怎么写
2015/05/14 职场文书
刑事辩护词范文
2015/05/21 职场文书
Python实现PIL图像处理库绘制国际象棋棋盘
2021/07/16 Python