Django REST Framework 文件字段输出完整绝对URL的方法

问题背景与默认行为

在使用 Django REST Framework 处理文件上传时，序列化器默认会将文件字段序列化为相对 URL。例如，一个包含头像的 Profile 对象序列化后可能如下所示：

{
 "id": 1,
 "nickname": "管理员",
 "mobilephone": "1234567890",
 "avatar": "/media/profiles/2017/12/17/avatar.png"
}

这里的 avatar 字段仅包含相对路径。如果前端应用与后端 API 不在同一域名下，或者需要直接通过链接访问该文件，这种相对路径将导致资源加载失败。我们需要将其转换为包含协议、域名和端口的绝对 URL。

解决方案：利用 GenericAPIView 传递 Context

Django REST Framework 的序列化器在生成文件 URL 时，会检查上下文中是否存在 request 对象。如果存在，它会尝试调用 request.build_absolute_uri() 来构建绝对地址。因此，核心思路是将当前的 request 对象传递给序列化器的上下文（context）。

1. 修改 View 继承类

首先，将原来的 APIView 替换为 generics.GenericAPIView。GenericAPIView 提供了更完善的序列化器管理方法，包括 get_serializer() 和 get_serializer_context()。

修改前的代码可能如下：

class ProfileView(APIView):
    def get(self, request):
        user = request.user
        if user.is_authenticated:
            profile = Profile.objects.get(user=user)
            return Response(ProfileSerializer(profile).data)
        else:
            raise exceptions.AuthenticationFailed('Not authenticated user!')

修改后的代码需要指定 serializer_class，并在返回响应时使用 self.get_serializer()：

class ProfileView(generics.GenericAPIView):
    parser_classes = (MultiPartParser, FormParser)
    serializer_class = ProfileSerializer

    def get(self, request):
        user = request.user
        if user.is_authenticated:
            profile = Profile.objects.get(user=user)
            # 使用 GenericAPIView 的 get_serializer 方法
            serializer = self.get_serializer(profile)
            return Response(serializer.data)
        else:
            raise exceptions.AuthenticationFailed('Not authenticated user!')

2. 理解 Context 的传递机制

GenericAPIView 中的 get_serializer() 方法会自动调用 get_serializer_context()，并将返回的字典作为 context 参数传递给序列化器实例。get_serializer_context() 默认返回包含 request、view 和 format 的字典：

def get_serializer(self, *args, **kwargs):
    """
    Return the serializer instance that should be used for validating and
    deserializing input, and for serializing output.
    """
    serializer_class = self.get_serializer_class()
    kwargs['context'] = self.get_serializer_context()
    return serializer_class(*args, **kwargs)

3. 序列化器内部的 URL 处理逻辑

当序列化器处理文件字段（如 FileField 或 ImageField）时，其 to_representation() 方法会检查上下文。如果上下文中存在 request，它将使用 request.build_absolute_uri() 将相对路径转换为绝对路径。

相关源码逻辑如下：

def to_representation(self, value):
    if not value:
        return None
    use_url = getattr(self, 'use_url', api_settings.UPLOADED_FILES_USE_URL)
    if use_url:
        if not getattr(value, 'url', None):
            # If the file has not been saved it may not have a URL.
            return None
        url = value.url
        request = self.context.get('request', None)
        if request is not None:
            return request.build_absolute_uri(url)
        return url
    return value.name

通过上述修改，API 返回的文件字段将自动包含完整的绝对 URL，例如：http://example.com/media/profiles/2017/12/17/avatar.png。

总结

通过将 View 继承自 GenericAPIView 并使用 self.get_serializer()，我们可以轻松地将 request 对象传递给序列化器上下文。这使得 Django REST Framework 能够自动为文件字段生成完整的绝对 URL，解决了跨域访问和资源直接链接的问题。以上就是 Django REST Framework 文件属性输出完整URL的详细内容，更多关于 Django API 开发的技术资料请关注本站其它相关文章！