Django Rest API：序列化模型时如何摆脱 json 中的“UUID”

Django

使用Django Rest Framework来构建RESTful API时，我们经常需要将数据库模型序列化为JSON格式以供前端使用。然而，有时我们会遇到一个问题，即在生成的JSON中包含了UUID字段，这可能会给前端开发人员带来一些麻烦。那么，我们应该如何摆脱这个问题呢？

什么是UUID？

在深入讨论问题之前，让我们先了解一下什么是UUID。UUID（Universally Unique Identifier）是一种用于标识信息的128位数字，它在理论上是唯一的。在Django中，我们可以使用UUIDField来定义一个模型字段，用于存储UUID值。

问题的根源

问题的根源在于Django Rest Framework默认使用了ModelSerializer来序列化模型，而ModelSerializer会将模型中的所有字段都包含在生成的JSON中。这意味着，无论我们是否需要UUID字段，它都会出现在生成的JSON中。

解决方案

为了摆脱JSON中的UUID字段，我们可以使用自定义的Serializer来代替ModelSerializer。通过自定义Serializer，我们可以选择性地包含或排除特定的字段。

首先，让我们创建一个自定义的Serializer类，例如ExcludeUUIDSerializer：

Python
from rest_framework import serializers
class ExcludeUUIDSerializer(serializers.ModelSerializer):
    class Meta:
        exclude = ('uuid',)

在上述代码中，我们定义了一个名为ExcludeUUIDSerializer的类，继承自serializers.ModelSerializer。在Meta类中，我们使用exclude属性来排除UUID字段。这样，当我们使用ExcludeUUIDSerializer来序列化模型时，生成的JSON中就不会包含UUID字段了。

示例代码

假设我们有一个模型叫做User，其中包含了一个UUID字段和其他一些字段。我们想要将User模型序列化为JSON，并将其用于API的响应。

首先，我们需要在models.py文件中定义User模型：

Python
from Django.db import models
import uuid
class User(models.Model):
    uuid = models.UUIDField(default=uuid.uuid4, editable=False)
    name = models.CharField(max_length=100)
    emAIl = models.EmAIlField()
    # 其他字段...

接下来，我们创建一个serializers.py文件，并在其中定义ExcludeUUIDSerializer：

Python
from rest_framework import serializers
from .models import User
class ExcludeUUIDSerializer(serializers.ModelSerializer):
    class Meta:
        model = User
        exclude = ('uuid',)

然后，我们可以在views.py文件中使用ExcludeUUIDSerializer来序列化User模型：

Python
from rest_framework import generics
from .models import User
from .serializers import ExcludeUUIDSerializer
class UserList(generics.ListAPIView):
    queryset = User.objects.all()
    serializer_class = ExcludeUUIDSerializer

在上述代码中，我们使用ExcludeUUIDSerializer作为serializer_class，这样在API的响应中就不会包含UUID字段了。

通过自定义Serializer，我们可以选择性地排除JSON中的特定字段，从而解决Django Rest Framework中序列化模型时JSON中包含UUID字段的问题。这样我们就可以更好地控制API的输出，使其更适合前端开发人员使用。

文章结尾

在本文中，我们解决了Django Rest Framework中序列化模型时JSON中包含UUID字段的问题。通过自定义Serializer并选择性地排除UUID字段，我们可以更好地控制API的输出。这种方法可以帮助我们解决前端开发人员在使用API时的一些麻烦。希望本文能对你有所帮助！