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

2024-04-02 22:21:22

场景

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

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 还有很多功能，例如分页等，强烈建议学习学习。

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

参考

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

django Serializer序列化使用方法详解

Serializer序列化器定义Serializer 1. 定义方法 Django REST framework中的Serializer使用类来定义,须继承自rest_framework.serializers.Serializer. 例如,我们已有了一个数据库模型类BookInfo class BookInfo(models.Model): btitle = models.CharField(max_length=20, verbose_name='名称') bpub_date = mode
Django model序列化为json的方法示例

本文环境 Python 3.6.5 Django 2.0.4 fix(2018.5.19):最近得知Django 的model基类需要声明为abstract,故在原来的代码加入abstract声明,以免误导在Django中,关于如何将model类序列化为json,一般的话有两a器将model类转为字典,再使用json库的dumps方法转为json 第一种方法就不多讲了,直接去看官方文档就好啦一般来说,官方提供的方法应该都是比较好用和稳定的,然而,使用官方的序列化器却问题不少: 格式丑陋,格
Python的Django REST框架中的序列化及请求和返回

序列化Serialization 1. 设置一个新的环境在我们开始之前, 我们首先使用virtualenv要创建一个新的虚拟环境,以使我们的配置和我们的其他项目配置彻底分开. $mkdir ~/env $virtualenv ~/env/tutorial $source ~/env/tutorial/bin/avtivate 现在我们处在一个虚拟的环境中,开始安装我们的依赖包 $pip install django $pip install djangorestframework $pip i
详解django的serializer序列化model几种方法

序列化是将对象状态转换为可保持或传输的格式的过程.与序列化相对的是反序列化,它将流转换为对象.这两个过程结合起来,可以轻松地存储和传输数据方法一:通过继承View类,重写get方法,获取商品的前是前十条数据,通过serialize序列化数据,返回数据响应. from django.views.generic import View from goods.models import Goods from django.core import serializers from django.htt
Django模型序列化返回自然主键值示例代码

场景在设计表结构时,难免需要建立一些外键关联.例如这样两个模型: 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.Fo
PHP和JavaScrip分别获取关联数组的键值示例代码

PHP版: 复制代码代码如下: $o = array('x'=>1, 'y'=>2, 'z'=>3); $arr = array(); $i = 0; foreach( $o as $arr[$i++]=>$v )/*empty*/; var_dump($arr); //$arr = array('x', 'y', 'z'); JavaScrip版: 复制代码代码如下: var o = {x:1, y:2, z:3}; var arr = [], i = 0; for ( ar
MybatisPlus中插入数据后获取该对象主键值的实现

实体对象主键IdType要设置为AUTO 表示数据库ID自增 @Data @EqualsAndHashCode(callSuper = false) @Accessors(chain = true) public class Employee implements Serializable { private static final long serialVersionUID = 1L; @TableId(value = "id", type = IdType.AUTO) priv
php在多维数组中根据键名快速查询其父键以及父键值的代码

我这么想的: 遍历一遍多维数组,将所有的键建立索引生成一个一维数组: 每次通过键名去查这个键的上级数组及数据 OK,代码如下 indexKey创建索引数组函数: 复制代码代码如下: <?php /** * FILE_NAME : arr.php FILE_PATH : test/ * 在多维数组中根据键名快速查询其父键以及父键值 * * @copyright Copyright (c) 2006-2010 mail:levi@cgfeel.com * @author Levi * @packa
C++中vector可以作为map的键值实例代码

因为项目中需要根据状态找到一个对应的结果,就采用了map的结构,但是状态本身较为复杂,存在一个vector中.上次使用map的经验是自定义类类型作为键值必须重载<操作符,因为map的快速查找是基于红黑树的构建,因而键值必须能相互之间比较.所以担心vector作为类类型的键值会引发一些错误,就写了一个例子测试.结果证明vector可以直接作为map的键值使用. #include<iostream> #include<string> #include<vector>
Pyqt5设置返回键和跳转页面键的示例代码

例子一 import sys from PyQt5.QtWidgets import QMainWindow, QPushButton, QApplication class First(QMainWindow): def __init__(self): super().__init__() self.initUI() def initUI(self): self.btn = QPushButton("进入页面2", self) self.btn.move(30, 50) self.s
django在保存图像的同时压缩图像示例代码详解

假设我们有一个非常简单的Post模型,它将是一个图像及其描述, from django.db import models class Post(models.Model): text = models.TextField() image = models.ImageField(upload_to='images/') 但是我们要优化图像大小,这将由我们Post的image字段指出. 这样做有充分的理由-它有助于更快地加载网站/应用程序并减少我们的服务器存储. 在使用Django之前,首先让我们简
SpringBoot中时间类型序列化、反序列化、格式处理示例代码

[SpringBoot] 中时间类型序列化.反序列化.格式处理 Date yml全局配置 spring: jackson: time-zone: GMT+8 date-format: yyyy-MM-dd HH:mm:ss #配置POST请求Body中Date时间类型序列化格式处理,并返回请求参数类型转换 /** * 时间Date转换 * 配置GET请求,Query查询Date时间类型参数转换 */ @Component public class DateConverter implemen
Django与AJAX实现网页动态数据显示的示例代码

前言这部分已经折腾我两天了,还是没有头绪,可能还会折腾更久,最后在第三天上午解决问题,在一个不起眼的地方被坑了,jQuery加载的问题.会者不难,难者不会,希望后面人少走弯路吧环境 windows10 pycharm2017.3.3 professional edition python3.6.4 django2.0.2 方法创建后台读取数据函数,用于后台从数据库读取数据.在views.py文件内增加以下代码 from django.http import JsonResponse def
Django 实现Admin自动填充当前用户的示例代码

model.py import datetime from django.contrib.auth.models import User from django.db import models class Entry(models.Model): title = models.CharField(max_length=250) slug = models.SlugField() pub_date = models.DateTimeField(default=datetime.datetime.

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

相关推荐

随机推荐