【Dv3Admin】工具序列化配置文件解析

在 API 开发中，序列化器承担着数据校验、转换和保存的重要职责。基于 DRF 的 ModelSerializer 定制化扩展，可在提升开发效率的同时，规范数据流转流程，统一接口标准，降低系统复杂度。

文章围绕 dvadmin/utils/serializers.py 中的 CustomModelSerializer 展开，解析其在动态字段控制、审计字段自动填充、错误信息国际化处理等方面的实现方式与实际效果，探讨其对接口开发带来的具体改进。

serializers.py

系统采用 Django Rest Framework（DRF）构建 API 接口，dvadmin/utils/serializers.py 模块基于 DRF 原生 ModelSerializer 进行增强，封装了审计字段自动填充、动态字段控制、错误信息国际化等功能。该模块帮助系统在序列化和反序列化过程中自动补充当前用户、所属部门等通用字段，减少开发重复代码，提升接口开发效率和一致性。

dvadmin/utils/serializers.py 文件通过定义 CustomModelSerializer 类，扩展了 DRF 的基础序列化功能。模块中实现了请求对象注入、请求用户自动填充、创建更新自动处理、字段名国际化错误返回、动态筛选字段等机制。无论是单独表单提交还是批量处理接口，都能保持数据审计字段一致、错误信息友好、请求流程简化，显著提升开发体验和系统规范性。

在构建 API 接口时，尤其是涉及表单数据保存、后台管理系统录入操作、数据审计需求时，dvadmin/utils/serializers.py 提供的 CustomModelSerializer 可以直接使用或继承扩展。无须手动处理当前用户、部门归属信息，无需编写重复的数据填充逻辑，同时接口返回的错误信息自动优化为中文提示，极大提升了开发效率和用户体验。

项目源码解析

自定义模型序列化器（类定义）

基于 DynamicFieldsMixin 和 ModelSerializer 扩展，实现自动审计字段赋值、动态字段控制、统一时间格式处理。与请求对象 request 紧密结合，在数据保存、更新时注入当前登录用户信息。该序列化器与 Users 模型协作，支持按需定制，非常适合复杂项目中复用。

class CustomModelSerializer(DynamicFieldsMixin, ModelSerializer):
    modifier_field_id = "modifier"
    creator_field_id = "creator"
    dept_belong_id_field_name = "dept_belong_id"
    modifier_name = serializers.SerializerMethodField(read_only=True)
    creator_name = serializers.SlugRelatedField(slug_field="name", source="creator", read_only=True)
    create_datetime = serializers.DateTimeField(format="%Y-%m-%d %H:%M:%S", required=False, read_only=True)
    update_datetime = serializers.DateTimeField(format="%Y-%m-%d %H:%M:%S", required=False, read_only=True)

初始化时自动绑定请求对象 request，为后续保存、更新操作提供用户上下文基础。

    def __init__(self, instance=None, data=empty, request=None, **kwargs):
        super().__init__(instance, data, **kwargs)
        self.request: Request = request or self.context.get("request", None)

继承原有 save，保持接口兼容，预留扩展空间。

    def save(self, **kwargs):
        return super().save(**kwargs)

在数据创建时，自动注入 creator、modifier、dept_belong_id 等字段，确保所有数据记录完整来源。

    def create(self, validated_data):
        if self.request and str(self.request.user) != "AnonymousUser":
            if self.modifier_field_id in self.fields.fields:
                validated_data[self.modifier_field_id] = self.get_request_user_id()
            if self.creator_field_id in self.fields.fields:
                validated_data[self.creator_field_id] = self.request.user
            if (self.dept_belong_id_field_name in self.fields.fields and 
                validated_data.get(self.dept_belong_id_field_name, None) is None):
                validated_data[self.dept_belong_id_field_name] = getattr(
                    self.request.user, "dept_id", validated_data.get(self.dept_belong_id_field_name, None)
                )
        return super().create(validated_data)

在更新数据时，自动刷新 modifier 字段，记录最后修改人。

    def update(self, instance, validated_data):
        if self.request and str(self.request.user) != "AnonymousUser":
            if self.modifier_field_id in self.fields.fields:
                validated_data[self.modifier_field_id] = self.get_request_user_id()
            if hasattr(self.instance, self.modifier_field_id):
                setattr(self.instance, self.modifier_field_id, self.get_request_user_id())
        return super().update(instance, validated_data)

根据 modifier ID 查询出对应的用户名，用于接口展示或日志记录。

    def get_modifier_name(self, instance):
        if not hasattr(instance, "modifier"):
            return None
        queryset = (
            Users.objects.filter(id=instance.modifier)
            .values_list("name", flat=True)
            .first()
        )
        return queryset if queryset else None

辅助方法，提取当前请求中的用户名。

    def get_request_username(self):
        if getattr(self.request, "user", None):
            return getattr(self.request.user, "username", None)
        return None

辅助方法，提取当前请求中的用户真实姓名。

    def get_request_name(self):
        if getattr(self.request, "user", None):
            return getattr(self.request.user, "name", None)
        return None

辅助方法，提取当前请求中的用户ID。

    def get_request_user_id(self):
        if getattr(self.request, "user", None):
            return getattr(self.request.user, "id", None)
        return None

重写 errors 属性，将错误字段名转换为模型中定义的中文 verbose_name，提升用户体验。

    @property
    def errors(self):
        errors = super().errors
        verbose_errors = {}
        fields = {field.name: field.verbose_name for field in self.Meta.model._meta.get_fields() if hasattr(field, 'verbose_name')}
        for field_name, error in errors.items():
            if field_name in fields:
                verbose_errors[str(fields[field_name])] = error
            else:
                verbose_errors[field_name] = error
        return verbose_errors

应用案例

自定义序列化器在后台管理系统中的应用

在后台管理系统中，表单提交、数据保存和更新等操作往往需要处理用户信息、部门信息、创建和修改记录等多个字段。dvadmin/utils/serializers.py 模块通过自定义 CustomModelSerializer 序列化器，统一处理这些常见需求，减少开发中的重复代码，提升开发效率和系统一致性。

该序列化器不仅能够自动填充审计字段（如创建人、修改人、部门信息等），还支持动态字段控制和错误信息国际化，优化了前后端交互体验。

审计字段自动填充与请求用户注入

例如，在用户提交信息时，系统需要自动填充当前用户和其所属部门信息。通过继承 CustomModelSerializer，数据保存时 creator 和 modifier 字段会自动填充为当前登录用户的信息。以下是创建数据时的具体实现：

class UserSerializer(CustomModelSerializer):
    class Meta:
        model = User
        fields = ['name', 'email', 'creator', 'modifier', 'dept_belong_id']

    def create(self, validated_data):
        # 自动填充创建人、修改人、所属部门信息
        if self.request and str(self.request.user) != "AnonymousUser":
            validated_data['creator'] = self.request.user
            validated_data['modifier'] = self.request.user
            validated_data['dept_belong_id'] = getattr(self.request.user, 'dept_id', None)
        return super().create(validated_data)

在上述代码中，CustomModelSerializer 自动注入了当前请求的用户（self.request.user），确保了每个数据记录都能追溯到操作用户和其部门信息。

动态字段控制与错误信息国际化

CustomModelSerializer 还支持动态控制字段的返回，前端可以通过传递字段参数来指定需要的字段，而无需修改序列化器本身。此外，字段校验错误提示会自动转换为中文，提升了前端的用户体验。例如：

class UserSerializer(CustomModelSerializer):
    class Meta:
        model = User
        fields = ['name', 'email', 'creator', 'modifier']

    def validate_name(self, value):
        if len(value) < 3:
            raise serializers.ValidationError("姓名长度必须大于等于3个字符")
        return value

当 name 字段验证失败时，系统会返回类似“姓名长度必须大于等于3个字符”的中文提示，前端无需额外处理字段映射，提高了接口的可用性与维护性。

前后端协作中的统一接口设计

在用户注册和信息更新等场景中，系统通过统一的序列化器与视图逻辑，确保了前后端接口设计的一致性。举例来说，在批量创建用户时，CustomModelSerializer 会自动填充每个用户的创建人、修改人以及部门信息，且通过 DynamicFieldsMixin 支持前端按需获取字段。

class BulkUserSerializer(CustomModelSerializer):
    class Meta:
        model = User
        fields = ['name', 'email', 'creator', 'modifier', 'dept_belong_id']

    def create(self, validated_data):
        for user_data in validated_data:
            user_data['creator'] = self.request.user
            user_data['modifier'] = self.request.user
            user_data['dept_belong_id'] = getattr(self.request.user, 'dept_id', None)
        return super().create(validated_data)

这确保了无论是单个创建还是批量操作，creator、modifier 等字段都能够正确地注入当前用户，避免硬编码，提高了系统的灵活性和维护性。

CustomModelSerializer 在后台管理系统中的应用，不仅提高了数据处理的自动化程度，还提升了前后端协作的效率。通过自动填充审计字段、动态字段控制、错误信息国际化等功能，开发者能够在不重复编写逻辑的情况下，实现灵活且一致的接口设计。这种设计不仅减少了系统复杂度，还增强了系统扩展性，尤其在多模块、动态配置的后台系统中，展现出显著的优势。

总结

模块在标准 ModelSerializer 基础上，增强了自动审计字段管理与动态字段过滤功能。通过请求对象注入，自动填充创建人、修改人、所属部门等信息，同时重写错误处理逻辑，将校验错误字段转化为中文提示，优化了前后端交互体验。设计注重实际场景适配，简化了表单提交、后台录入等操作中的重复逻辑。

当前错误提示国际化处理仅覆盖模型字段，无法覆盖自定义字段或嵌套序列化器。动态字段控制粒度较粗，缺乏细化筛选支持。审计字段注入耦合在序列化器内部，影响复用灵活性。如果重写，建议抽离审计逻辑为独立混入类，并细化动态字段控制与错误处理模块，提高模块组合性与可维护性。