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 获取本机ip地址的两个方法
Feb 25 Python
python字典操作实例详解
Nov 16 Python
使用Python搭建虚拟环境的配置方法
Feb 28 Python
python中in在list和dict中查找效率的对比分析
May 04 Python
python 数字类型和字符串类型的相互转换实例
Jul 17 Python
python 对字典按照value进行排序的方法
May 09 Python
python+Selenium自动化测试——输入,点击操作
Mar 06 Python
使用python自动追踪你的快递(物流推送邮箱)
Mar 17 Python
Python函数默认参数常见问题及解决方案
Mar 26 Python
使用keras内置的模型进行图片预测实例
Jun 17 Python
python 生成正态分布数据,并绘图和解析
Dec 21 Python
用Python的绘图库(matplotlib)绘制小波能量谱
Apr 17 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 清除网页病毒的方法
2008/12/05 PHP
PHP Error与Logging函数的深入理解
2013/06/03 PHP
php生成数组的使用示例 php全组合算法
2014/01/16 PHP
PHP获取二维数组中某一列的值集合
2015/12/25 PHP
PHP数组游标实现对数组的各种操作详解
2016/01/26 PHP
PHP图片水印类的封装
2017/07/06 PHP
php+websocket 实现的聊天室功能详解
2020/05/27 PHP
Ext.FormPanel 提交和 Ext.Ajax.request 异步提交函数的区别
2009/11/12 Javascript
vs2003 js文件编码问题的解决方法
2010/03/20 Javascript
JavaScript高级程序设计 阅读笔记(十八) js跨平台的事件
2012/08/14 Javascript
javascript中常用编程知识
2013/04/08 Javascript
JavaScript中数据结构与算法(三):链表
2015/06/19 Javascript
Javascript的表单验证-揭开正则表达式的面纱
2016/03/18 Javascript
JavaScript严格模式详解
2017/01/16 Javascript
使用vue构建移动应用实战代码
2017/08/02 Javascript
JavaScript变量类型以及变量作用域详解
2017/08/14 Javascript
浅谈js基础数据类型和引用类型,深浅拷贝问题,以及内存分配问题
2017/09/02 Javascript
关于JavaScript语句后面的分号问题
2017/12/07 Javascript
electron制作仿制qq聊天界面的示例代码
2018/11/26 Javascript
JavaScript实现随机点名器实例详解
2019/05/07 Javascript
Vue实现小购物车功能
2020/12/21 Vue.js
使用Django启动命令行及执行脚本的方法
2018/05/29 Python
Python自然语言处理 NLTK 库用法入门教程【经典】
2018/06/26 Python
python opencv 实现对图像边缘扩充
2020/01/19 Python
opencv+python实现均值滤波
2020/02/19 Python
浅谈在django中使用filter()(即对QuerySet操作)时踩的坑
2020/03/31 Python
Mac PyCharm中的.gitignore 安装设置教程
2020/04/16 Python
Python插件机制实现详解
2020/05/04 Python
纯css3实现宠物小鸡实例代码
2018/10/08 HTML / CSS
canvas环形倒计时组件的示例代码
2018/06/14 HTML / CSS
励志广播稿300字(5篇)
2014/09/15 职场文书
教师病假条范文
2015/08/17 职场文书
2019七夕节祝福语36句,快来收藏吧
2019/08/06 职场文书
PL350与SW11的比较
2021/04/22 无线电
浅谈Python响应式类库RxPy
2021/06/14 Python
解析Java中的static关键字
2021/06/14 Java/Android