django-vue-admin/dvadmin-backend/apps/vadmin/op_drf/mixins.py

from django.db import transaction
from rest_framework import mixins
from rest_framework import serializers
from rest_framework import status
from rest_framework.relations import ManyRelatedField, RelatedField, PrimaryKeyRelatedField
from rest_framework.request import Request

from .response import SuccessResponse
from ..utils.export_excel import excel_to_data, export_excel_save_model
from ..utils.request_util import get_verbose_name


class CreateModelMixin(mixins.CreateModelMixin):
    """
    继承、增强DRF的CreateModelMixin, 标准化其返回值
    """
    create_serializer_class = None

    def create(self, request: Request, *args, **kwargs):
        serializer = self.get_serializer(data=request.data)
        serializer.is_valid(raise_exception=True)
        self.perform_create(serializer)
        if hasattr(self, 'handle_logging'):
            self.handle_logging(request, instance=serializer.instance, *args, **kwargs)
        headers = self.get_success_headers(serializer.data)
        return SuccessResponse(serializer.data, status=status.HTTP_201_CREATED, headers=headers)

    def perform_create(self, serializer):
        super().perform_create(serializer)


class ListModelMixin(mixins.ListModelMixin):
    """
    继承、增强DRF的CreateModelMixin, 标准化其返回值
    """
    list_serializer_class = None

    def list(self, request: Request, *args, **kwargs):
        if hasattr(self, 'handle_logging'):
            self.handle_logging(request, *args, **kwargs)
        queryset = self.filter_queryset(self.get_queryset())
        page = self.paginate_queryset(queryset)
        if page is not None:
            if getattr(self, 'values_queryset', None):
                return self.get_paginated_response(page)
            serializer = self.get_serializer(page, many=True)
            return self.get_paginated_response(serializer.data)
        if getattr(self, 'values_queryset', None):
            return SuccessResponse(page)
        serializer = self.get_serializer(queryset, many=True)
        return SuccessResponse(serializer.data)


class RetrieveModelMixin(mixins.RetrieveModelMixin):
    """
    继承、增强DRF的CreateModelMixin, 标准化其返回值
    """
    retrieve_serializer_class = None

    def retrieve(self, request: Request, *args, **kwargs):
        instance = self.get_object()
        serializer = self.get_serializer(instance)
        if hasattr(self, 'handle_logging'):
            self.handle_logging(request, instance=instance, *args, **kwargs)
        return SuccessResponse(serializer.data)


class UpdateModelMixin(mixins.UpdateModelMixin):
    """
    继承、增强DRF的CreateModelMixin, 标准化其返回值
    """
    update_serializer_class = None

    def update(self, request: Request, *args, **kwargs):
        partial = kwargs.pop('partial', False)
        instance = self.get_object()
        serializer = self.get_serializer(instance, data=request.data, partial=partial)
        serializer.is_valid(raise_exception=True)
        self.perform_update(serializer)
        if getattr(instance, '_prefetched_objects_cache', None):
            instance._prefetched_objects_cache = {}
        if hasattr(self, 'handle_logging'):
            self.handle_logging(request, instance=instance, *args, **kwargs)
        return SuccessResponse(serializer.data)

    def partial_update(self, request, *args, **kwargs):
        kwargs['partial'] = True
        return self.update(request, *args, **kwargs)


class DestroyModelMixin(mixins.DestroyModelMixin):
    """
    继承、增强DRF的CreateModelMixin, 标准化其返回值
    """
    destroy_serializer_class = None

    def get_object_list(self):
        queryset = self.filter_queryset(self.get_queryset())
        lookup_url_kwarg = self.lookup_url_kwarg or self.lookup_field
        assert lookup_url_kwarg in self.kwargs, (
                'Expected view %s to be called with a URL keyword argument '
                'named "%s". Fix your URL conf, or set the `.lookup_field` '
                'attribute on the view correctly.' %
                (self.__class__.__name__, lookup_url_kwarg)
        )
        filter_kwargs = {f"{self.lookup_field}__in": self.kwargs[lookup_url_kwarg].split(',')}
        obj = queryset.filter(**filter_kwargs)
        self.check_object_permissions(self.request, obj)
        return obj

    def destroy(self, request: Request, *args, **kwargs):
        instance = self.get_object_list()
        if hasattr(self, 'handle_logging'):
            self.handle_logging(request, instance=instance, *args, **kwargs)
        self.perform_destroy(instance)
        return SuccessResponse(status=status.HTTP_204_NO_CONTENT)

    def perform_destroy(self, instance):
        instance.delete()


class TableSerializerMixin:
    table_option = None
    extra_columns = []

    FIELD_TYPE_MAP = {
        'AutoField': {
            'type': 'input',
            'addDisabled': True,
        },

        'CharField': {
            'type': 'input',
            "maxlength": 255
        },

        'PasswordField': {
            'type': 'input',
            'maxlength': 255
        },

        'URLField': {
            'type': 'input',
        },

        'UUIDField': {
            'type': 'input',
            'minlength': 32,
            'maxlength': 32,
        },

        'UUID8Field': {
            'type': 'input',
            'minlength': 8,
            'maxlength': 8,
        },

        'UUID16Field': {
            'type': 'input',
            'minlength': 16,
            'maxlength': 16,
        },

        'UUID32Field': {
            'type': 'input',
            'minlength': 32,
            'maxlength': 32,
        },

        'UUID36Field': {
            'type': 'input',
            'minlength': 36,
            'maxlength': 36
        },

        'DateTimeField': {
            'type': 'datetime',
            'format': "yyyy-MM-dd hh:mm:ss",
            'valueFormat': "yyyy-MM-dd hh:mm:ss",
        },
        'DateField': {
            'type': 'date',
            'format': "yyyy-MM-dd",
            'valueFormat': "yyyy-MM-dd",
        },

        'TimeField': {
            'type': 'time',
            'format': "hh:mm:ss",
            'valueFormat': "hh:mm:ss",
        },

        'BooleanField': {
            'type': 'radio',
            'dicData': [
                {'value': False, 'label': '否'},
                {'value': True, 'label': '是'},
            ]
        },

        'ManyRelatedField': {
            # 'type': 'select',
            'type': 'array',
            # "multiple": True,
            'required': False,
        },
    }

    FIELD_TYPE_DEFAULT = {
        'type': 'input',
    }

    def getTable(self, serializer: serializers.ModelSerializer = None):
        if not serializer:
            serializer = self.get_serializer()
        serializer_class = serializer.__class__
        model = serializer_class.Meta.model
        title = model.__name__
        if hasattr(model, 'Meta'):
            if hasattr(model.Meta, 'verbose_name'):
                title = model.Meta.verbose_name or ''
        column = self.getColumn(serializer)
        table = {
            'title': title,
            'page': True,
            'align': 'center',
            'menuAlign': 'center',
            'columnBtn': True,
            'menu': True,
            'menuType': 'icon',
            'addBtn': True,
            'delBtn': True,
            'editBtn': True,
            'column': column
        }
        return table

    def getColumn(self, serializer: serializers.ModelSerializer = None):
        if not serializer:
            serializer = self.get_serializer()
        serializer_class = serializer.__class__
        fields = serializer.get_fields()
        show_fields = getattr(serializer_class.Meta, 'show_fields', set())
        hide_fields = getattr(serializer_class.Meta, 'hide_fields', set())
        search_fields = getattr(serializer_class.Meta, 'search_fields', set())
        sortable_fields = getattr(serializer_class.Meta, 'sortable_fields', set())
        column = []
        for prop in fields:
            field = fields[prop]
            field_type = field.__class__.__name__
            info = {
                'prop': prop,
                'label': field.label or prop,
                'hide': hide_fields == '__all__' or prop in hide_fields,
                'search': search_fields == '__all__' or prop in search_fields,
                'sortable': sortable_fields == '__all__' or prop in sortable_fields,
                'width': 'auto',
                'align': 'left',
                'overHidden': False,
            }
            type_info = self.FIELD_TYPE_MAP.get(field_type, self.FIELD_TYPE_DEFAULT)
            info.update(type_info)

            allow_null = getattr(field, 'allow_null', False)
            allow_blank = getattr(field, 'allow_blank', False)
            allow_empty = getattr(field, 'allow_empty', False)

            read_only = getattr(field, 'read_only', False)
            write_only = getattr(field, 'write_only', False)

            if not any([allow_null, allow_blank, allow_empty]):
                rules = [{
                    'required': True,
                    'message': f"""请输入{info['label']}""",
                    'trigger': "blur"
                }]
                info['rules'] = rules
            if read_only:
                info['editDisabled'] = True,
                info['clearable'] = False

            if not isinstance(field, (ManyRelatedField, RelatedField, PrimaryKeyRelatedField)):
                # 防止序列化该字段的关系模型所有数据
                choices = getattr(field, 'choices', None)
                if choices:
                    dicData = list(map(lambda choice: {'value': choice[0], 'label': choice[1]}, choices.items()))
                    info['dicData'] = dicData
                    info['type'] = 'select'
            column.append(info)
        return column


class ImportSerializerMixin:
    """
    自定义导出模板、导入功能
    """
    # 导入字段
    import_field_data = {}
    # 导入序列化器
    import_serializer_class = None

    @transaction.atomic  # Django 事物
    def importTemplate(self, request: Request, *args, **kwargs):
        """
        用户导人模板
        :param request:
        :param args:
        :param kwargs:
        :return:
        """
        assert self.import_field_data, (
                "'%s' 请配置对应的导出模板字段。"
                % self.__class__.__name__
        )
        # 导出模板
        if request.method == 'GET':
            # 示例数据
            return SuccessResponse(
                export_excel_save_model(request, self.import_field_data.values(), [], '导入用户数据模板.xls'))
        updateSupport = request.data.get('updateSupport')
        # 从excel中组织对应的数据结构，然后使用序列化器保存
        data = excel_to_data(request.data.get('file_url'), self.import_field_data)
        queryset = self.filter_queryset(self.get_queryset())
        unique_list = [ele.attname for ele in queryset.model._meta.get_fields() if
                       hasattr(ele, 'unique') and ele.unique == True]
        for ele in data:
            # 获取 unique 字段
            filter_dic = {i: ele.get(i) for i in list(set(self.import_field_data.keys()) & set(unique_list))}
            instance = queryset.filter(**filter_dic).first()
            if instance and not updateSupport:
                continue
            if not filter_dic:
                instance = None
            serializer = self.import_serializer_class(instance, data=ele)
            serializer.is_valid(raise_exception=True)
            serializer.save()
        return SuccessResponse(msg=f"导入成功！")


class ExportSerializerMixin:
    """
    自定义导出功能
    """
    # 导出字段
    export_field_data = []
    # 导出序列化器
    export_serializer_class = None

    def export(self, request: Request, *args, **kwargs):
        """
        导出功能
        :param request:
        :param args:
        :param kwargs:
        :return:
        """
        assert self.export_field_data, (
                "'%s' 请配置对应的导出模板字段。"
                % self.__class__.__name__
        )
        queryset = self.filter_queryset(self.get_queryset())
        data = self.export_serializer_class(queryset, many=True).data
        return SuccessResponse(export_excel_save_model(request, self.export_field_data, data,
                                                       f'导出{get_verbose_name(queryset)}.xls'))