Django模型序列化返回自然主鍵值示例代碼

更新時間：2019年06月12日 09:00:45 作者：嚴北

這篇文章主要給大家介紹了關于Django模型序列化返回自然主鍵值的相關資料，文中通過示例代碼介紹的非常詳細，對大家學習或者使用Django具有一定的參考學習價值，需要的朋友們下面來一起學習學習吧

場景

在設計表結構時，難免需要建立一些外鍵關聯(lián)。例如這樣兩個模型：

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 官方文檔的「序列化」一節(jié)中提到了用 models.Manager 處理的方案；在搜索解決方案過程中，也接觸到 Django-REST-Framework(DRF) ，了解到 DRF 中的 Serializer 模塊也能解決這類問題。那我們不妨對比一下兩種解決方案。

方案一：models.Manager

根據(jù)文檔，要返回自然主鍵，我們需要定義一個模型管理器，創(chuàng)建一個 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"]
    }
}

如果需要對其他應用的數(shù)據(jù)模型做修改，例如使用了 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 參數(shù)定義的外鍵 author 實例的自然主鍵 username。

然后是執(zhí)行序列化的過程：

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 的序列化模塊返回自然主鍵，不僅代碼清晰改動少，而且效果也很不錯，序列化數(shù)據(jù)少了一個層級，對前端也是十分友好的。

方案三：手動修改序列化后的外鍵

當然，還有一種最傻也是最容易想到的辦法，就是在序列化后，手動修改 JSON 串中對應的外鍵值為自然主鍵值。

這種做法可以得到和方案一一樣的效果，但是遇到查詢結果為列表時我們需要遍歷替換。同時試想一下，如果我們在每個視圖中都這么處理，那代碼會變得十分糟糕。不建議使用該方案。

總結

對比兩種序列化方案，我個人更偏向于 DRF 優(yōu)雅的處理方式。當然，除了序列化，DRF 還有很多功能，例如分頁等，強烈建議學習學習。

當然，可能不存在最好的最好的技術方案，遇到這類問題選擇最合適自己的就好。也可能還有更多的方法可以解決標題的問題，也歡迎留言探討！

參考