Django Rest Framework 序列化器中获取图像完整路径：一个分步指南

2024-03-17 05:45:27

在 Django Rest Framework 序列化器中获取图像的完整路径：分步指南

引言

在 Django Rest Framework 中，处理图像字段时，默认情况下，序列化器只会返回图像文件的名称。如果您需要图像的完整路径，请继续阅读本指南，了解如何配置它。

使用 `ImageField`

在您的模型中，使用 ImageField 定义图像字段。ImageField 具有 upload_to 属性，用于指定图像文件的上传目录。

from django.db import models

class UserAccount(models.Model):
    ...
    icon = models.ImageField(upload_to='icon/user')

使用自定义字段序列化器

要获取图像的完整路径，请创建一个自定义字段序列化器。通过继承 serializers.ImageField 实现这一点。

from rest_framework import serializers
from django.conf import settings

class IconFieldSerializer(serializers.ImageField):
    def to_representation(self, value):
        if value:
            return settings.MEDIA_URL + value.name
        return None

在模型序列化器中使用自定义字段序列化器

在您的模型序列化器中，使用自定义字段序列化器序列化图像字段。

from rest_framework import serializers
from .models import UserAccount
from .serializers import IconFieldSerializer

class UserSerializer(serializers.ModelSerializer):
    icon = IconFieldSerializer()

    class Meta:
        model = UserAccount
        fields = (..., 'icon')

使用视图集或 API 视图

无论使用视图集还是 API 视图，都可以使用自定义字段序列化器获取图像的完整路径。

视图集

from rest_framework import viewsets, serializers

class IconFieldSerializer(serializers.ImageField):
    def to_representation(self, value):
        if value:
            return settings.MEDIA_URL + value.name
        return None

class UserAccount(models.Model):
    ...
    icon = models.ImageField(upload_to='icon/user')

class UserSerializer(serializers.ModelSerializer):
    icon = IconFieldSerializer()

    class Meta:
        model = UserAccount
        fields = (..., 'icon')

class UserViewSet(viewsets.ModelViewSet):
    serializer_class = UserSerializer

API 视图

from rest_framework import views, serializers

class IconFieldSerializer(serializers.ImageField):
    def to_representation(self, value):
        if value:
            return settings.MEDIA_URL + value.name
        return None

class UserAccount(models.Model):
    ...
    icon = models.ImageField(upload_to='icon/user')

class UserSerializer(serializers.ModelSerializer):
    icon = IconFieldSerializer()

    class Meta:
        model = UserAccount
        fields = (..., 'icon')

class UserView(views.APIView):
    def get(self, request):
        ...
        user_account = user.userAccount
        serializer = UserSerializer(user_account)
        return Response(serializer.data)