GitHub 搜索 Django REST 框架
relations.py

序列化器关系

数据结构，而不是算法，是编程的核心。

— Rob Pike

关系字段用于表示模型关系。它们可以应用于 ForeignKey、ManyToManyField 和 OneToOneField 关系，以及反向关系和自定义关系（如 GenericForeignKey）。

注意：关系字段在 relations.py 中声明，但按照惯例，你应该使用 from rest_framework import serializers 从 serializers 模块导入它们，并将字段称为 serializers.<FieldName>。

注意：REST Framework 不会尝试自动优化传递给序列化器的查询集，以使用 select_related 和 prefetch_related，因为它会产生太多魔法。一个通过其源属性跨越 orm 关系的字段的序列化器可能需要额外的数据库访问才能从数据库中获取相关对象。优化查询以避免使用此类序列化器时可能发生的额外数据库访问是程序员的责任。

例如，如果未预取，则以下序列化器每次评估 tracks 字段时都会导致数据库访问

class AlbumSerializer(serializers.ModelSerializer):
    tracks = serializers.SlugRelatedField(
        many=True,
        read_only=True,
        slug_field='title'
    )

    class Meta:
        model = Album
        fields = ['album_name', 'artist', 'tracks']

# For each album object, tracks should be fetched from database
qs = Album.objects.all()
print(AlbumSerializer(qs, many=True).data)

如果 AlbumSerializer 用于使用 many=True 序列化相当大的查询集，则可能是一个严重的性能问题。使用优化传递给 AlbumSerializer 的查询集

qs = Album.objects.prefetch_related('tracks')
# No additional database hits required
print(AlbumSerializer(qs, many=True).data)

将解决此问题。

检查关系。

使用 ModelSerializer 类时，序列化器字段和关系将为你自动生成。检查这些自动生成的字段可以作为确定如何自定义关系样式的有用工具。

为此，使用 python manage.py shell 打开 Django shell，然后导入序列化器类，实例化它，并打印对象表示...

>>> from myapp.serializers import AccountSerializer
>>> serializer = AccountSerializer()
>>> print(repr(serializer))
AccountSerializer():
    id = IntegerField(label='ID', read_only=True)
    name = CharField(allow_blank=True, max_length=100, required=False)
    owner = PrimaryKeyRelatedField(queryset=User.objects.all())

API 参考

为了解释各种类型的关系字段，我们将使用几个简单的模型作为示例。我们的模型将用于音乐专辑，以及列在每个专辑上的曲目。

class Album(models.Model):
    album_name = models.CharField(max_length=100)
    artist = models.CharField(max_length=100)

class Track(models.Model):
    album = models.ForeignKey(Album, related_name='tracks', on_delete=models.CASCADE)
    order = models.IntegerField()
    title = models.CharField(max_length=100)
    duration = models.IntegerField()

    class Meta:
        unique_together = ['album', 'order']
        ordering = ['order']

    def __str__(self):
        return '%d: %s' % (self.order, self.title)

StringRelatedField

StringRelatedField 可用于使用其 __str__ 方法表示关系的目标。

例如，以下序列化器

class AlbumSerializer(serializers.ModelSerializer):
    tracks = serializers.StringRelatedField(many=True)

    class Meta:
        model = Album
        fields = ['album_name', 'artist', 'tracks']

将序列化为以下表示

{
    'album_name': 'Things We Lost In The Fire',
    'artist': 'Low',
    'tracks': [
        '1: Sunflower',
        '2: Whitetail',
        '3: Dinosaur Act',
        ...
    ]
}

此字段是只读的。

参数:

  • many - 如果应用于多对多关系，则应将此参数设置为 True。

PrimaryKeyRelatedField

PrimaryKeyRelatedField 可用于使用其主键表示关系的目标。

例如，以下序列化器

class AlbumSerializer(serializers.ModelSerializer):
    tracks = serializers.PrimaryKeyRelatedField(many=True, read_only=True)

    class Meta:
        model = Album
        fields = ['album_name', 'artist', 'tracks']

将序列化为如下表示

{
    'album_name': 'Undun',
    'artist': 'The Roots',
    'tracks': [
        89,
        90,
        91,
        ...
    ]
}

默认情况下，此字段是可读写的，尽管你可以使用 read_only 标志更改此行为。

参数:

  • queryset - 验证字段输入时用于模型实例查找的查询集。关系必须显式设置查询集，或设置 read_only=True。
  • many - 如果应用于多对多关系，则应将此参数设置为 True。
  • allow_null - 如果设置为 True，则该字段将接受 None 值或空字符串以用于可空关系。默认为 False。
  • pk_field - 设置为字段以控制主键值的序列化/反序列化。例如，pk_field=UUIDField(format='hex') 将 UUID 主键序列化为其紧凑的十六进制表示。

HyperlinkedRelatedField

HyperlinkedRelatedField 可用于使用超链接表示关系的目标。

例如，以下序列化器

class AlbumSerializer(serializers.ModelSerializer):
    tracks = serializers.HyperlinkedRelatedField(
        many=True,
        read_only=True,
        view_name='track-detail'
    )

    class Meta:
        model = Album
        fields = ['album_name', 'artist', 'tracks']

将序列化为如下表示

{
    'album_name': 'Graceland',
    'artist': 'Paul Simon',
    'tracks': [
        'http://www.example.com/api/tracks/45/',
        'http://www.example.com/api/tracks/46/',
        'http://www.example.com/api/tracks/47/',
        ...
    ]
}

默认情况下，此字段是可读写的，尽管你可以使用 read_only 标志更改此行为。

注意：此字段专为映射到接受单个 URL 关键字参数的 URL 的对象而设计，如使用 lookup_field 和 lookup_url_kwarg 参数设置的那样。

这适用于包含单个主键或 slug 参数作为 URL 一部分的 URL。

如果你需要更复杂的超链接表示，则需要自定义字段，如以下 自定义超链接字段 部分中所述。

参数:

  • view_name - 应作为关系目标使用的视图名称。如果你正在使用 标准路由器类，则这将是一个格式为 <modelname>-detail 的字符串。必需的。
  • queryset - 验证字段输入时用于模型实例查找的查询集。关系必须显式设置查询集，或设置 read_only=True。
  • many - 如果应用于多对多关系，则应将此参数设置为 True。
  • allow_null - 如果设置为 True，则该字段将接受 None 值或空字符串以用于可空关系。默认为 False。
  • lookup_field - 目标上用于查找的字段。应对应于引用的视图上的 URL 关键字参数。默认值为 'pk'。
  • lookup_url_kwarg - URL 配置中定义的关键字参数的名称，该参数对应于查找字段。默认为使用与 lookup_field 相同的值。
  • format - 如果使用格式后缀，超链接字段将针对目标使用相同格式后缀，除非使用 format 参数覆盖。

SlugRelatedField

SlugRelatedField 可用于使用目标上的字段表示关系目标。

例如，以下序列化器

class AlbumSerializer(serializers.ModelSerializer):
    tracks = serializers.SlugRelatedField(
        many=True,
        read_only=True,
        slug_field='title'
     )

    class Meta:
        model = Album
        fields = ['album_name', 'artist', 'tracks']

将序列化为如下表示

{
    'album_name': 'Dear John',
    'artist': 'Loney Dear',
    'tracks': [
        'Airport Surroundings',
        'Everything Turns to You',
        'I Was Only Going Out',
        ...
    ]
}

默认情况下，此字段是可读写的，尽管你可以使用 read_only 标志更改此行为。

将 SlugRelatedField 用作读写字段时，通常需要确保 slug 字段对应于具有 unique=True 的模型字段。

参数:

  • slug_field - 目标上用于表示它的字段。这应是唯一标识任何给定实例的字段。例如，username。必需
  • queryset - 验证字段输入时用于模型实例查找的查询集。关系必须显式设置查询集，或设置 read_only=True。
  • many - 如果应用于多对多关系，则应将此参数设置为 True。
  • allow_null - 如果设置为 True，则该字段将接受 None 值或空字符串以用于可空关系。默认为 False。

HyperlinkedIdentityField

此字段可以应用为标识关系，例如 HyperlinkedModelSerializer 上的 'url' 字段。它还可以用于对象上的属性。例如，以下序列化器

class AlbumSerializer(serializers.HyperlinkedModelSerializer):
    track_listing = serializers.HyperlinkedIdentityField(view_name='track-list')

    class Meta:
        model = Album
        fields = ['album_name', 'artist', 'track_listing']

将序列化为如下表示

{
    'album_name': 'The Eraser',
    'artist': 'Thom Yorke',
    'track_listing': 'http://www.example.com/api/track_list/12/',
}

此字段始终为只读。

参数:

  • view_name - 应作为关系目标使用的视图名称。如果您正在使用 标准路由器类，这将是一个格式为 <model_name>-detail 的字符串。必需。
  • lookup_field - 目标上用于查找的字段。应对应于引用的视图上的 URL 关键字参数。默认值为 'pk'。
  • lookup_url_kwarg - URL 配置中定义的关键字参数的名称，该参数对应于查找字段。默认为使用与 lookup_field 相同的值。
  • format - 如果使用格式后缀，超链接字段将针对目标使用相同格式后缀，除非使用 format 参数覆盖。

嵌套关系

与前面讨论的到另一个实体的引用相反，引用的实体也可以嵌入或嵌套在引用它的对象的表示中。此类嵌套关系可以通过使用序列化器作为字段来表示。

如果该字段用于表示多对多关系，则应将 many=True 标志添加到序列化器字段。

示例

例如，以下序列化器

class TrackSerializer(serializers.ModelSerializer):
    class Meta:
        model = Track
        fields = ['order', 'title', 'duration']

class AlbumSerializer(serializers.ModelSerializer):
    tracks = TrackSerializer(many=True, read_only=True)

    class Meta:
        model = Album
        fields = ['album_name', 'artist', 'tracks']

将序列化为如下所示的嵌套表示

>>> album = Album.objects.create(album_name="The Grey Album", artist='Danger Mouse')
>>> Track.objects.create(album=album, order=1, title='Public Service Announcement', duration=245)
<Track: Track object>
>>> Track.objects.create(album=album, order=2, title='What More Can I Say', duration=264)
<Track: Track object>
>>> Track.objects.create(album=album, order=3, title='Encore', duration=159)
<Track: Track object>
>>> serializer = AlbumSerializer(instance=album)
>>> serializer.data
{
    'album_name': 'The Grey Album',
    'artist': 'Danger Mouse',
    'tracks': [
        {'order': 1, 'title': 'Public Service Announcement', 'duration': 245},
        {'order': 2, 'title': 'What More Can I Say', 'duration': 264},
        {'order': 3, 'title': 'Encore', 'duration': 159},
        ...
    ],
}

可写嵌套序列化器

默认情况下，嵌套序列化器是只读的。如果您想支持对嵌套序列化器字段的写操作，则需要创建 create() 和/或 update() 方法，以便明确指定如何保存子关系

class TrackSerializer(serializers.ModelSerializer):
    class Meta:
        model = Track
        fields = ['order', 'title', 'duration']

class AlbumSerializer(serializers.ModelSerializer):
    tracks = TrackSerializer(many=True)

    class Meta:
        model = Album
        fields = ['album_name', 'artist', 'tracks']

    def create(self, validated_data):
        tracks_data = validated_data.pop('tracks')
        album = Album.objects.create(**validated_data)
        for track_data in tracks_data:
            Track.objects.create(album=album, **track_data)
        return album

>>> data = {
    'album_name': 'The Grey Album',
    'artist': 'Danger Mouse',
    'tracks': [
        {'order': 1, 'title': 'Public Service Announcement', 'duration': 245},
        {'order': 2, 'title': 'What More Can I Say', 'duration': 264},
        {'order': 3, 'title': 'Encore', 'duration': 159},
    ],
}
>>> serializer = AlbumSerializer(data=data)
>>> serializer.is_valid()
True
>>> serializer.save()
<Album: Album object>

自定义关系字段

在极少数情况下，如果现有关系样式都不适合您需要的表示，您可以实现一个完全自定义的关系字段，该字段准确描述如何从模型实例生成输出表示。

要实现自定义关系字段，您应覆盖 RelatedField，并实现 .to_representation(self, value) 方法。此方法将字段的目标作为 value 参数，并应返回用于序列化目标的表示。value 参数通常将是模型实例。

如果您想实现可读写的关联字段，您还必须实现 .to_internal_value(self, data) 方法。

为了根据 context 提供动态查询集，您还可以覆盖 .get_queryset(self)，而不是在类中指定 .queryset 或在初始化字段时指定。

示例

例如，我们可以定义一个关联字段，使用其排序、标题和持续时间将曲目序列化为自定义字符串表示形式

import time

class TrackListingField(serializers.RelatedField):
    def to_representation(self, value):
        duration = time.strftime('%M:%S', time.gmtime(value.duration))
        return 'Track %d: %s (%s)' % (value.order, value.name, duration)

class AlbumSerializer(serializers.ModelSerializer):
    tracks = TrackListingField(many=True)

    class Meta:
        model = Album
        fields = ['album_name', 'artist', 'tracks']

此自定义字段随后将序列化为以下表示形式

{
    'album_name': 'Sometimes I Wish We Were an Eagle',
    'artist': 'Bill Callahan',
    'tracks': [
        'Track 1: Jim Cain (04:39)',
        'Track 2: Eid Ma Clack Shaw (04:19)',
        'Track 3: The Wind and the Dove (04:34)',
        ...
    ]
}

自定义超链接字段

在某些情况下，您可能需要自定义超链接字段的行为，以便表示需要多个查找字段的 URL。

您可以通过覆盖 HyperlinkedRelatedField 来实现此目的。有两个方法可以覆盖

get_url(self, obj, view_name, request, format)

get_url 方法用于将对象实例映射到其 URL 表示形式。

如果 view_name 和 lookup_field 属性未配置为正确匹配 URL 配置，则可能会引发 NoReverseMatch。

get_object(self, view_name, view_args, view_kwargs)

如果您想支持可写的超链接字段，那么您还将需要覆盖 get_object，以便将传入的 URL 映射回它们表示的对象。对于只读超链接字段，无需覆盖此方法。

此方法的返回值应该是与匹配的 URL 配置参数相对应的对象。

可能会引发 ObjectDoesNotExist 异常。

示例

假设我们有一个客户对象 URL，它采用两个关键字参数，如下所示

/api/<organization_slug>/customers/<customer_pk>/

这无法用默认实现来表示，默认实现只接受一个查找字段。

在这种情况下，我们需要覆盖 HyperlinkedRelatedField 以获得我们想要的行为

from rest_framework import serializers
from rest_framework.reverse import reverse

class CustomerHyperlink(serializers.HyperlinkedRelatedField):
    # We define these as class attributes, so we don't need to pass them as arguments.
    view_name = 'customer-detail'
    queryset = Customer.objects.all()

    def get_url(self, obj, view_name, request, format):
        url_kwargs = {
            'organization_slug': obj.organization.slug,
            'customer_pk': obj.pk
        }
        return reverse(view_name, kwargs=url_kwargs, request=request, format=format)

    def get_object(self, view_name, view_args, view_kwargs):
        lookup_kwargs = {
           'organization__slug': view_kwargs['organization_slug'],
           'pk': view_kwargs['customer_pk']
        }
        return self.get_queryset().get(**lookup_kwargs)

请注意，如果您想将此样式与通用视图一起使用，那么您还需要覆盖视图中的 .get_object 以获得正确的查找行为。

一般来说，我们建议在可能的情况下为 API 表示采用扁平样式，但在适度使用时，嵌套 URL 样式也可以合理。

进一步说明

queryset 参数

queryset 参数仅在可写关系字段中需要，在这种情况下，它用于执行模型实例查找，该查找从原始用户输入映射到模型实例。

在 2.x 版本中，如果正在使用 ModelSerializer 类，那么序列化器类有时可以自动确定 queryset 参数。

此行为现已替换为始终对可写关系字段使用显式 queryset 参数。

这样做减少了 ModelSerializer 提供的隐藏“魔法”量，使字段的行为更加清晰，并确保在使用 ModelSerializer 快捷方式或使用完全显式的 Serializer 类之间进行移动变得轻而易举。

自定义 HTML 显示

将使用模型的内置 __str__ 方法来生成用于填充 choices 属性的对象的字符串表示形式。这些选择用于填充可浏览 API 中的选择 HTML 输入。

要为此类输入提供自定义表示形式，请覆盖 RelatedField 子类的 display_value()。此方法将接收一个模型对象，并应返回一个适合于表示它的字符串。例如

class TrackPrimaryKeyRelatedField(serializers.PrimaryKeyRelatedField):
    def display_value(self, instance):
        return 'Track: %s' % (instance.title)

选择字段截止

在可浏览 API 中呈现时，关系字段将默认仅显示最多 1000 个可选择项。如果存在更多项，则会显示一个带有“超过 1000 项……”的禁用选项。

此行为旨在防止模板由于显示大量关系而无法在可接受的时间范围内呈现。

有两个关键字参数可用于控制此行为

  • html_cutoff - 如果设置，这将是 HTML 选择下拉菜单显示的最大选择数量。设置为 None 以禁用任何限制。默认为 1000。
  • html_cutoff_text - 如果设置，如果 HTML 选择下拉菜单中的最大项目数量已被截断，这将显示一个文本指示符。默认为 "超过 {count} 个项目……"

你还可以使用设置 HTML_SELECT_CUTOFF 和 HTML_SELECT_CUTOFF_TEXT 全局控制这些设置。

在强制执行截断的情况下，你可能希望改用 HTML 表单中的普通输入字段。你可以使用 style 关键字参数来执行此操作。例如

assigned_to = serializers.SlugRelatedField(
   queryset=User.objects.all(),
   slug_field='username',
   style={'base_template': 'input.html'}
)

反向关系

请注意，反向关系不会自动包含在 ModelSerializer 和 HyperlinkedModelSerializer 类中。要包含反向关系，你必须将其明确添加到字段列表中。例如

class AlbumSerializer(serializers.ModelSerializer):
    class Meta:
        fields = ['tracks', ...]

你通常需要确保已在关系上设置了适当的 related_name 参数，你可以将其用作字段名称。例如

class Track(models.Model):
    album = models.ForeignKey(Album, related_name='tracks', on_delete=models.CASCADE)
    ...

如果您尚未为反向关系设置相关名称，则需要在 fields 参数中使用自动生成的相关名称。例如

class AlbumSerializer(serializers.ModelSerializer):
    class Meta:
        fields = ['track_set', ...]

有关更多详细信息，请参阅 Django 文档中的 反向关系。

通用关系

如果您要序列化通用外键，则需要定义一个自定义字段，以明确确定您希望如何序列化关系的目标。

例如，给定以下标签模型，它与其他任意模型具有通用关系

class TaggedItem(models.Model):
    """
    Tags arbitrary model instances using a generic relation.

    See: https://docs.django.ac.cn/en/stable/ref/contrib/contenttypes/
    """
    tag_name = models.SlugField()
    content_type = models.ForeignKey(ContentType, on_delete=models.CASCADE)
    object_id = models.PositiveIntegerField()
    tagged_object = GenericForeignKey('content_type', 'object_id')

    def __str__(self):
        return self.tag_name

以及以下两个模型，它们可能具有关联的标签

class Bookmark(models.Model):
    """
    A bookmark consists of a URL, and 0 or more descriptive tags.
    """
    url = models.URLField()
    tags = GenericRelation(TaggedItem)


class Note(models.Model):
    """
    A note consists of some text, and 0 or more descriptive tags.
    """
    text = models.CharField(max_length=1000)
    tags = GenericRelation(TaggedItem)

我们可以定义一个自定义字段，该字段可用于序列化标记的实例，并使用每个实例的类型来确定如何序列化该实例

class TaggedObjectRelatedField(serializers.RelatedField):
    """
    A custom field to use for the `tagged_object` generic relationship.
    """

    def to_representation(self, value):
        """
        Serialize tagged objects to a simple textual representation.
        """
        if isinstance(value, Bookmark):
            return 'Bookmark: ' + value.url
        elif isinstance(value, Note):
            return 'Note: ' + value.text
        raise Exception('Unexpected type of tagged object')

如果您需要关系的目标具有嵌套表示，则可以在 .to_representation() 方法中使用所需的序列化器

    def to_representation(self, value):
        """
        Serialize bookmark instances using a bookmark serializer,
        and note instances using a note serializer.
        """
        if isinstance(value, Bookmark):
            serializer = BookmarkSerializer(value)
        elif isinstance(value, Note):
            serializer = NoteSerializer(value)
        else:
            raise Exception('Unexpected type of tagged object')

        return serializer.data

请注意，使用 GenericRelation 字段表示的反向通用键可以使用常规关系字段类型进行序列化，因为关系中目标的类型始终是已知的。

有关更多信息，请参阅 Django 文档中的通用关系。

带有 Through Model 的 ManyToManyFields

默认情况下，将针对指定了 through 模型的 ManyToManyField 的关系字段设置为只读。

如果您明确指定指向具有通过模型的 ManyToManyField 的关系字段，请务必将 read_only 设置为 True。

如果您希望表示 通过模型上的额外字段，那么您可以将通过模型序列化为 嵌套对象。

第三方包

以下第三方软件包也可使用。

DRF 嵌套路由器

drf-nested-routers 软件包 提供了用于处理嵌套资源的路由器和关系字段。

Rest Framework 通用关系

rest-framework-generic-relations 库为通用外键提供读/写序列化。