Django Admin 自定义 Action 导出 Excel 完整实现

橘子海
橘子海
发布时间:2026-10-13 | 3人浏览过
原创

本文详解如何在 Django Admin 后台通过自定义 Action 实现数据导出为 Excel 文件。涵盖 xlwt 模块安装、admin.py 配置、样式定义、单元格合并及中文文件名处理等核心步骤,提供完整代码示例,帮助开发者快速构建数据导出功能。

Django Admin 导出 Excel 功能概述

Django 的强大不仅源于其先进的编程理念,更在于其丰富的内置功能模块可直接复用。其中,admin 模块表现尤为出色,能够迅速搭建起高效的信息登记与管理平台。

在 admin 模块中,action 支持自定义扩展。例如,本次介绍的导出 Excel 功能,即可通过注册自定义 action 来触发执行。

本文将逐步演示如何将 admin 中录入的数据导出为 Excel 文件,该方案可直接用于向管理层汇报或交付使用。

环境准备与模块安装

首先,需要安装 xlwt 工具模块以支持 Excel 文件的写入操作。


pip install xlwt

Admin 配置与 Action 注册

在开始编码前,需修改 admin.py 文件以引入必要的依赖库。


#-*-coding:utf-8 -*-
from django.contrib import admin
from .models import *
from django.http import StreamingHttpResponse
from django.shortcuts import render,HttpResponse,redirect
import xlwt
import os
from io import BytesIO

接下来,在 ModelAdmin 类中注册自定义 action,使其出现在操作下拉菜单中。


class testAdmin(admin.ModelAdmin):
  list_display = ('a_name','b_level','...')
  actions = ["export_excel",]
  ...
  export_excel.short_description = "导出Excel文件"

配置完成后,Admin 后台界面将显示新增的导出选项,具体效果如图所示。

Excel 导出核心代码实现

随后,编写处理导出逻辑的核心函数,负责生成 Excel 文件内容。


  def export_excel(self, request, queryset): #三个参数必不可少,queryset是你要导出的文件名
    for i in queryset:  #这个for循环是为了在多选的时候只导出第一个文件,避免多个被同时导出
      filenames = str(i)
      break;
    response = HttpResponse(content_type='application/vnd.ms-excel')
    for i in Case_Study.objects.all().filter(a_name = filenames):
      filename = i.a_name
      filename = filename.encode('gb2312') #为了能将导出的excel命名为中文,必须转成gb2312
      typess = 'attachment;filename='+filename+'.xls' #这一步命名导出的excel,为登记的case名称
      response['Content-Disposition'] = typess
      #print typess
    # 创建一个文件对象
    wb = xlwt.Workbook(encoding='utf8')
    # 创建一个sheet对象
    sheet = wb.add_sheet('casestudy',cell_overwrite_ok=True) #创建的sheet名称为casestudy,注意如果想要开启覆盖写入,必须将overwrite功能开启

定义表格的字体、颜色及边框等样式,确保导出文件的视觉规范。


    # 接下里是定义表格的样式,如果你想对不同的表格定义不同的样式只能采用下面这种方式,否则将会默认成一种格式,即使定义了不同的变量,也会影响全局变量
    style_heading = xlwt.easyxf("""
          font: # 字体设置
            name Microsoft YaHei,  # 定义字体为微软雅黑
            colour_index black,  # 字体颜色为黑色
            bold off,  # 不加粗
            height 200; #字体大小 此处的200实际对应的字号是10号
          align: # 对齐方式设置
            wrap off, #自动换行 关闭
            vert center, #上下居中
            horiz center; #左右居中
          pattern: #表格样式设置
            pattern solid, 
            fore-colour white; # 表格颜色 白色
          borders: # 表格外框设置
            left THIN, #THIN 为实线
            right THIN,
            top THIN,
            bottom THIN; 
          """)
    style_playback = xlwt.easyxf("""
          font:
            name Microsoft YaHei,
            colour_index black,
            bold off,
            height 200;
          align:
            wrap 1, # 此处设置为1时表示开启自动换行
            vert center,
            horiz left;
          pattern:
            pattern solid,
            fore-colour white;
          borders:
            left THIN,
            right THIN,
            top THIN,
            bottom THIN;
          """)
    style_time_s = xlwt.easyxf("""
          font:
            name Microsoft YaHei,
            colour_index black,
            bold off,
            height 200;
          align:
            wrap off,
            vert center,
            horiz center;
          pattern:
            pattern solid,
            fore-colour white;
          borders:
            left THIN,
            right THIN,
            top THIN,
            bottom THIN;
          """,num_format_str='YYYY-MM-DD') # 设置时间格式样式为 2019-03-01
    style_time = style_heading
    style_time.num_format_str = 'YYYY-MM-DD hh:mm' # 设置时间格式样式为 2019-03-01 17:30

处理单元格合并逻辑,这是一项细致的工作,需精确指定行列范围。


    #合并单元格 顺序是从0开始
    sheet.write_merge(0, 0, 1, 3,) # 参数说明为 从第0行到第0行的第1列到第3列合并
    sheet.write_merge(2, 3, 1, 5,) # 参数说明为 从第2行到第3行的第1列到第5列合并
    #多行执行相同的合并可以写个for循环
    for i in range(6,12):
      sheet.write_merge(i,i,1,3,) #相当于在6到12行的第1列到第3列分别合并 如果这个逻辑绕不明白可以自己实践一下
接下来是添加边框,因为合并了单元格不等于自动加边框,导致导出的表格里有未加边框的情况,所以只能先行添加好

    #添加边框,可以用两个for来实现,具体逻辑可自行根据实际情况修改
    for i in range(6,12):
      for j in range(1,6):
        sheet.write(i,j,'',style_heading)

向表格中写入表头信息,明确各列数据的含义。


    # 写入文件标题
    sheet.write(0,0,'标题',style_heading)
    sheet.write(0,4,'故障等级',style_heading)
    sheet.write(1,0,'开始时间',style_heading)
    sheet.write(1,2,'结束时间',style_heading)
    sheet.write(1,4,'持续时间',style_heading)
    sheet.write(2,0,'影响描述',style_heading)
    ...

设定表格的列宽与行高,优化数据的展示效果。


    sheet.col(0).width = 3333
    sheet.col(1).width = 6666
    ...
    sheet.row(0).height_mismatch = True # 高度可不依赖字体大小定义,定义高度时最好开启此选项
    sheet.row(0).height = 40*20
    ...
    for i in range(7,12): # 也可以通过for循环批量定义高度或宽度
      sheet.row(i).height_mismatch = True
      sheet.row(i).height = 40*20

遍历查询集,将数据库中的数据逐行写入 Excel 表格。


    #写入数据
    for i in Case_Study.objects.all().filter(a_name = filenames): # 查询要写入的数据
      sheet.write(0,1,i.a_name,style_playback)
      sheet.write(0,5,i.b_level,style_heading)
      sheet.write(1,1,i.d_starttime,style_time)
      sheet.write(1,3,i.e_endttime,style_time)
      ...

最后,将生成的 Excel 数据写入内存流并返回 HTTP 响应,完成导出流程。


    # 写出到IO
    output = BytesIO()
    wb.save(output)
    # 重新定位到开始
    output.seek(0)
    response.write(output.getvalue())
    return response
    
  export_excel.short_description = "导出Excel文件"

admin.site.register(test,testAdmin)

注意事项与格式兼容性说明

以上即为导出 Excel 的全部代码实现。需注意,由于使用的是 xls 格式,新版 Excel 的高级功能(如瀑布图、雷达图等)可能无法直接保留。建议将导出的表格复制粘贴至 xlsx 格式中进行后续修改,以避免格式兼容问题。希望上述内容能对各位的学习有所帮助,也欢迎大家继续支持本站。

本站声明

本文内容仅供参考,不代表本站观点。转载或引用请注明出处。如发现内容问题,请通过联系我们页面反馈。

Python 相关产品和应用

全部下载

专题列表