Django REST Framework如何从多关联模型选取指定字段返回接口
接口实现代码方案
序列化器编写
针对跨模型提取关联字段的需求,需要为关联模型定义仅包含目标返回字段的精简序列化类,在主序列化器中嵌套引用,避免返回多余字段。
- 导入对应依赖与模型
from rest_framework import serializers from .models import Product, Category, UnitOfMeasurement
- 定义Category模型的精简序列化器,仅保留需求指定的name字段
class CategoryNameSerializer(serializers.ModelSerializer): class Meta: model = Category fields = ["name"]
- 定义UnitOfMeasurement模型的精简序列化器,仅保留需求指定的name、measurement_type字段
class UnitOfMeasurementSerializer(serializers.ModelSerializer): class Meta: model = UnitOfMeasurement fields = ["name", "measurement_type"]
- 定义Product主序列化器,嵌套关联序列化器并严格按需求选取返回字段
class ProductInfoSerializer(serializers.ModelSerializer): # 嵌套关联序列化器,映射外键关联对象 category = CategoryNameSerializer() unit_of_measurement = UnitOfMeasurementSerializer() class Meta: model = Product fields = [ "name", "category", "brand", "model", "tag", "unit_of_measurement" ]
序列化后的接口返回结构示例:
{ "name": "工业扳手", "category": { "name": "手动工具" }, "brand": "精工", "model": "12寸开口", "tag": "耐磨款", "unit_of_measurement": { "name": "把", "measurement_type": "个数计量" } }
视图编写
视图层需要提前通过联表查询加载关联对象,避免N+1数据库查询问题,直接复用定义好的序列化器即可。
列表查询视图
from rest_framework import generics from .models import Product from .serializers import ProductInfoSerializer class ProductListView(generics.ListAPIView): serializer_class = ProductInfoSerializer def get_queryset(self): # 提前联表查询category、unit_of_measurement关联数据,优化查询性能 return Product.objects.select_related( "category", "unit_of_measurement" ).filter(active=True)
详情查询视图
class ProductDetailView(generics.RetrieveAPIView): serializer_class = ProductInfoSerializer queryset = Product.objects.select_related("category", "unit_of_measurement").all()
注意:原模型中UnitOfMeasurement外键的related_name参数被误写为category,该问题不影响当前正向查询的序列化逻辑,但会导致反向查询的命名冲突,后续可调整为更合理的标识如measurement_units。
内容的提问来源于stack exchange,提问作者Will
相关产品推荐
相关产品推荐

