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的函数嵌套的使用方法
Jan 24 Python
python关闭windows进程的方法
Apr 18 Python
Python实现定时任务
Feb 08 Python
python引入导入自定义模块和外部文件的实例
Jul 24 Python
Python地图绘制实操详解
Mar 04 Python
简单了解python 邮件模块的使用方法
Jul 24 Python
浅谈多卡服务器下隐藏部分 GPU 和 TensorFlow 的显存使用设置
Jun 30 Python
Python下划线5种含义代码实例解析
Jul 10 Python
利用python 读写csv文件
Sep 10 Python
python SOCKET编程基础入门
Feb 27 Python
Python 读写 Matlab Mat 格式数据的操作
May 19 Python
关于Python中进度条的六个实用技巧分享
Apr 05 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提交表单发送邮件的方法
2015/03/20 PHP
PHP YII框架开发小技巧之模型(models)中rules自定义验证规则
2015/11/16 PHP
Yii框架结合sphinx,Ajax实现搜索分页功能示例
2016/10/18 PHP
jQuery.each()用法分享
2012/07/31 Javascript
js自定义事件及事件交互原理概述(二)
2013/02/01 Javascript
js遍历、动态的添加数据的小例子
2013/06/22 Javascript
查看大图功能代码jquery版
2013/11/05 Javascript
关于js数组去重的问题小结
2014/01/24 Javascript
js确认删除对话框适用于a标签及submit
2014/07/10 Javascript
JS小游戏之象棋暗棋源码详解
2014/09/25 Javascript
jQuery实现平滑滚动到指定锚点的方法
2015/03/20 Javascript
易操作的jQuery表单提示插件
2015/12/01 Javascript
JS区分浏览器页面是刷新还是关闭
2016/04/17 Javascript
Node.js中防止错误导致的进程阻塞的方法
2016/08/11 Javascript
nodejs实例解析(输出hello world)
2017/01/03 NodeJs
angular+bootstrap的双向数据绑定实例
2017/03/03 Javascript
JS检测window.open打开的窗口是否关闭
2017/06/25 Javascript
基于JavaScript实现评论框展开和隐藏功能
2017/08/25 Javascript
如何选择适合你的JavaScript框架
2017/11/20 Javascript
基于JS实现前端压缩上传图片的实例代码
2019/05/14 Javascript
在 Vue 应用中使用 Netlify 表单功能的方法详解
2019/06/03 Javascript
js页面加载后执行的几种方式小结
2020/01/30 Javascript
python创建和删除目录的方法
2015/04/29 Python
python实现马耳可夫链算法实例分析
2015/05/20 Python
python 开发的三种运行模式详细介绍
2017/01/18 Python
利用PyInstaller将python程序.py转为.exe的方法详解
2017/05/03 Python
flask框架视图函数用法示例
2018/07/19 Python
python获取磁盘号下盘符步骤详解
2019/06/19 Python
Python 根据数据模板创建shapefile的实现
2019/11/26 Python
使用pth文件添加Python环境变量方式
2020/05/26 Python
OpenCV实现机器人对物体进行移动跟随的方法实例
2020/11/09 Python
HTML5 UTF-8 中文乱码的解决方法
2013/11/18 HTML / CSS
德国电子产品购物网站:TechInTheBasket德国
2018/12/07 全球购物
2014领导班子四风问题查摆思想汇报
2014/09/13 职场文书
全国法制宣传日活动总结2014
2014/11/01 职场文书
js作用域及作用域链工作引擎
2022/07/07 Javascript