Django REST Framework 如何按user_type动态隐藏raw_data指定列?
Django REST Framework 基于user_type规则动态隐藏raw_data列表指定列的实现
核心设计思路
这类动态列控制不需要改动底层SQL查询逻辑,核心控制点放在序列化器的初始化流程上——DRF list接口的最终返回字段完全由序列化器实例的可用字段集合决定,只要在序列化器初始化阶段,结合当前请求用户对应的user_type权限规则,动态从字段集合中剔除需要隐藏的列,即可实现灵活的列显隐控制,性能损耗极低,也不会和分页、权限校验等DRF原生逻辑产生冲突。
具体实现步骤
1. 对齐前置数据规则
首先在user_type表中预存不同用户类型对应的raw_data列隐藏规则,示例模型定义:
# models.py from django.db import models class UserType(models.Model): type_name = models.CharField(max_length=32, unique=True) # 存储当前用户类型需要隐藏的raw_data字段名,例如 ["cid", "eup"] hidden_raw_data_fields = models.JSONField( default=list, help_text="需要对当前用户类型隐藏的raw_data列名集合" ) # 假设系统内的User模型通过外键关联UserType,可直接通过request.user.user_type拿到对应规则 class RawData(models.Model): # 原有raw_data表的业务字段,比如需要控制显隐的cid、eup cid = models.CharField(max_length=64) eup = models.CharField(max_length=64) # 其他业务字段...
2. 实现支持动态裁剪字段的序列化器
不要在序列化器的Meta类中写死固定返回字段,而是重写序列化器的__init__方法,从请求上下文获取用户对应的隐藏规则,动态剔除目标字段:
# serializers.py from rest_framework import serializers from .models import RawData class RawDataListSerializer(serializers.ModelSerializer): class Meta: model = RawData # 先把所有可对外暴露的raw_data字段全量列在这里,后续根据规则动态裁剪 fields = ["id", "cid", "eup", "create_time", "business_field"] def __init__(self, *args, **kwargs): super().__init__(*args, **kwargs) # 从序列化器上下文获取当前请求对象 request = self.context.get("request") # 场景1:未登录请求,默认隐藏所有敏感列 if not request or not request.user.is_authenticated: hidden_fields = ["cid", "eup"] # 场景2:已登录请求,读取对应用户类型的配置规则 else: hidden_fields = request.user.user_type.hidden_raw_data_fields # 动态从可用字段集合中移除需要隐藏的列 for field_name in hidden_fields: if field_name in self.fields: self.fields.pop(field_name)
3. 配置list接口视图
DRF原生的ListAPIView会自动将当前请求对象传入序列化器的上下文,无需额外开发上下文传递逻辑,直接复用序列化器即可:
# views.py from rest_framework.generics import ListAPIView from .models import RawData from .serializers import RawDataListSerializer class RawDataListView(ListAPIView): queryset = RawData.objects.all() serializer_class = RawDataListSerializer # 原有权限、过滤、分页逻辑正常配置即可,不影响动态列控制
实际效果说明
当使用配置了
hidden_raw_data_fields = ["cid", "eup"]的普通用户类型请求接口时,返回的每条raw_data数据会自动剔除cid、eup两个字段;当使用隐藏规则为空的管理员类型请求时,会返回所有配置在fields列表中的完整字段,不需要为不同用户类型开发多套序列化器。
避坑提示
- 不要在视图层手动遍历返回结果字典删除目标字段:这种写法会和序列化层逻辑脱节,遇到分页、批量操作等场景很容易出现逻辑不一致的问题,统一在序列化层做字段裁剪是最符合DRF设计规范的实现方式。
- 动态移除字段前一定要先判断目标字段是否存在于当前序列化器的字段集合中,避免配置了不存在的列名导致程序报错。
- 如果后续规则从「黑名单隐藏」调整为「白名单允许展示」,只需要修改
__init__中的判断逻辑:遍历所有现有字段,把不在白名单内的字段剔除即可,整体架构不需要改动。 - 如果详情接口也需要相同的列显隐规则,直接复用当前序列化器即可,不需要重复开发。
内容的提问来源于stack exchange,提问作者Vilas Patil
相关产品推荐
相关产品推荐

