Django StreamingHttpResponse导出CSV添加字段名表头实现方法

现有导出逻辑直接遍历数据行写入CSV，没有在文件起始位置插入表头行，只需对代码做两处调整即可，完全保留原有values_list的性能优化逻辑，不会额外增加内存开销。

1. 修改CSVStream类，新增表头支持 #

调整export方法，增加可选的header入参，在生成流式内容时优先写入表头行，再写入业务数据：

import csv
from django.http import StreamingHttpResponse

class CSVBuffer:
    """实现file-like接口的write方法，用于流式CSV写入"""
    def write(self, value):
        return value

class CSVStream:
    """流式导出迭代器内容为CSV文件"""
    def export(self, filename, iterator, header=None):
        writer = csv.writer(CSVBuffer())

        # 按顺序生成CSV内容：表头 -> 数据行
        def content_generator():
            # 传入表头时先写入表头行
            if header:
                yield writer.writerow(header)
            for row in iterator:
                # 兼容named=True返回的命名元组，转普通元组写入
                yield writer.writerow(tuple(row))

        response = StreamingHttpResponse(
            content_generator(),
            content_type="text/csv"
        )
        response['Content-Disposition'] = f"attachment; filename={filename}.csv"
        return response

2. 在视图中传入和字段顺序匹配的表头 #

调用export方法时传入表头列表，注意表头顺序必须和values_list中声明的字段顺序完全一致，避免列错位：

class descargarAsignacion(View):
    template_name='gestionAsignacion/detalle_Asignacion.html'
    
    def get(self, request,pk):
        # 表头顺序和下方values_list字段顺序严格对应
        csv_headers = [
            "ID",
            "分配ID",
            "产品",
            "合同号",
            "订阅人姓名",
            "服务类型",
            "总欠款",
            "当前未到期应收",
            "到期应收",
            "当前总欠款",
            "代理商最低还款额",
            "Surtigas政策",
            "分类",
            "阶层",
            "参考年份",
            "历史参考值",
            "周期",
            "仪表编号",
            "读数",
            "协议计划",
            "社区描述",
            "地址",
            "欠款天数"
        ]
               
        queryset=AsignacionSurtigas.objects.filter(idasignacion=pk)
       
        queryset_valueslist=queryset.values_list(
                "id",
                "idasignacion",
                "producto",
                "contrato",
                "nombre_suscriptor",
                "tipo_servicio",
                "total_deuda",
                "corriente_no_vencida_actual",
                "corrente_vencida",
                "total_deuda_corriente",
                "cuota_minima_agente",
                "politica_surtigas",
                "categoria",
                "estrato",
                "ref_anio",
                "historico_ref",
                "ciclo",
                "medidor",
                "lectura",
                "plan_acuerdo",
                "descripcion_barrio",
                "direccion",
                "dias_deuda",
                named=True,
        )
        
        csv_stream = CSVStream()
        return csv_stream.export("myfile", queryset_valueslist, header=csv_headers)

注意事项 #

• 不要随意调换values_list字段顺序和表头列表顺序，否则会出现表头和数据不匹配的问题
• 生成器写法完全保留流式导出特性，不会把全量数据加载到内存，性能和原有实现一致
• 代码自动兼容values_list(named=True)返回的命名元组格式，不需要额外修改查询逻辑

内容的提问来源于stack exchange，提问作者cudris