Django-import-export 实现基于外键关联数据的导出功能

在Django项目开发中，经常会遇到需要根据模型间关联关系导出数据的需求。本文将以django-import-export库为例，详细介绍如何实现基于外键关联数据的导出功能。

模型关系分析

假设我们有两个主要模型：Event（活动）和Reservation（预约）。它们之间通过外键建立关联关系：

• Event模型包含活动的基本信息，并通过promoter字段关联到User模型
• Reservation模型通过event字段关联到Event模型，表示某个活动的预约记录，同时通过participant字段关联到User模型

这种一对多的关系在实际业务场景中非常常见，例如音乐会活动与门票预约、会议与参会报名等。

需求场景

管理员在后台查看活动列表时，希望能够：

1. 导出单个活动下的所有预约记录
2. 批量导出多个活动，每个活动对应Excel中的一个独立工作表

实现方案

单个活动预约记录导出

要实现导出特定活动下的预约记录，可以通过重写Resource类的filter_export方法来实现：

from import_export import resources

class ReservationResource(resources.ModelResource):
    class Meta:
        model = Reservation
    
    def filter_export(self, queryset, *args, **kwargs):
        # 获取请求参数中的event_id
        event_id = kwargs.get('event_id')
        if event_id:
            queryset = queryset.filter(event_id=event_id)
        return queryset

然后在Admin类中使用这个Resource：

@admin.register(Event)
class EventAdmin(ImportExportModelAdmin):
    # 其他配置...
    
    def get_resource_classes(self):
        # 在EventAdmin中重写get_resource_classes方法
        # 添加ReservationResource用于导出预约
        return [ReservationResource] + super().get_resource_classes()

批量导出多个活动到多工作表Excel

要实现将多个活动导出到同一个Excel文件的不同工作表中，需要更复杂的处理：

from import_export.admin import ImportExportModelAdmin
from openpyxl import Workbook
from django.http import HttpResponse

class EventAdmin(ImportExportModelAdmin):
    # 其他配置...
    
    def export_action(self, request, *args, **kwargs):
        # 获取选中的活动ID
        selected_ids = request.POST.getlist('_selected_action')
        events = Event.objects.filter(id__in=selected_ids)
        
        # 创建Excel工作簿
        wb = Workbook()
        
        # 为每个活动创建一个工作表
        for event in events:
            ws = wb.create_sheet(title=str(event.id))
            reservations = event.reservations.all()
            
            # 写入表头
            headers = ['ID', 'Participant', 'Create Time']  # 根据实际需求调整
            ws.append(headers)
            
            # 写入数据
            for res in reservations:
                row = [
                    str(res.id),
                    res.participant.username,
                    res.created_at.strftime('%Y-%m-%d %H:%M')
                ]
                ws.append(row)
        
        # 删除默认创建的空工作表
        if 'Sheet' in wb.sheetnames:
            del wb['Sheet']
        
        # 准备响应
        response = HttpResponse(
            content_type='application/vnd.openxmlformats-officedocument.spreadsheetml.sheet')
        response['Content-Disposition'] = 'attachment; filename=events_reservations.xlsx'
        wb.save(response)
        
        return response

实际应用中的优化建议

1. 性能优化：当处理大量数据时，应考虑使用批量查询和分页处理，避免内存溢出。

2. 字段定制：可以根据实际需求定制导出的字段，隐藏敏感信息或添加计算字段。

3. 格式美化：使用openpyxl的样式功能对Excel进行美化，如设置列宽、添加边框等。

4. 错误处理：添加适当的异常处理，确保导出过程稳定可靠。

5. 权限控制：确保只有有权限的用户才能执行导出操作。

总结

通过django-import-export库，我们可以灵活地实现各种复杂的数据导出需求。本文介绍的方法不仅适用于活动-预约这种场景，也可以推广到其他具有类似关系的模型中。关键在于理解模型间的关系，并合理利用Resource类和Admin类的扩展点来实现定制化的导出功能。