SpringBoot3整合EasyExcel动态实现表头重命名

 更新时间:2025年03月31日 11:04:41   作者:Moshow郑锴  
这篇文章主要为大家详细介绍了SpringBoot3整合EasyExcel如何通过WriteHandler动态实现表头重命名,文中的示例代码讲解详细,有需要的可以了解下

方案简介

为了通过 EasyExcel 实现动态表头重命名,可以封装一个方法,传入动态的新表头名称列表(List<String>),并结合 WriteHandler 接口来重命名表头。同时,通过 EasyExcel 将数据直接写入到输出流。

核心实现说明

动态表头处理器:通过 DynamicHeaderWriteHandler 的构造方法接收表头列表,并在写入表头之前动态设置表头内容。

封装写入方法:ExcelExportUtil 提供通用的导出方法,可以根据表头和数据生成 Excel 文件并写入到输出流。

直接写入输出流:通过 HttpServletResponse 将文件直接导出为响应内容,方便前端下载。

具体实现

1. 自定义动态表头处理器

我们实现一个动态表头处理器,将新表头通过构造方法传入。

import com.alibaba.excel.metadata.Head;
import com.alibaba.excel.write.handler.AbstractCellWriteHandler;
import org.apache.poi.ss.usermodel.Cell;
 
import java.util.List;
 
public class DynamicHeaderWriteHandler extends AbstractCellWriteHandler {
    private final List<String> newHeaders;
 
    // 构造方法传入动态表头列表
    public DynamicHeaderWriteHandler(List<String> newHeaders) {
        this.newHeaders = newHeaders;
    }
 
    @Override
    public void beforeCellCreate(org.apache.poi.ss.usermodel.Workbook workbook,
                                 org.apache.poi.ss.usermodel.Sheet sheet,
                                 org.apache.poi.ss.usermodel.Row row,
                                 Head head,
                                 Integer columnIndex,
                                 Boolean isHead) {
​
        //Powered by Moshow@https://zhengkai.blog.csdn.net/
 
​
        if (Boolean.TRUE.equals(isHead) && columnIndex < newHeaders.size()) {
            // 动态设置表头名称
            head.setHeadNameList(List.of(newHeaders.get(columnIndex)));
        }
    }
}

2. 封装写入方法

创建一个封装的方法,支持通过传入表头和数据,将结果直接输出到流中。

import com.alibaba.excel.EasyExcel;
import com.alibaba.excel.write.metadata.WriteSheet;
 
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
import java.util.List;
 
public class ExcelExportUtil {
 
    /**
     * 导出 Excel 表格
     *
     * @param response  HttpServletResponse 响应
     * @param data      数据列表
     * @param headers   动态表头
     * @param fileName  文件名
     * @author ​Powered by Moshow@https://zhengkai.blog.csdn.net/
     */
    public static void exportExcel(HttpServletResponse response, List<?> data, List<String> headers, String fileName) throws IOException {
        response.setContentType("application/vnd.openxmlformats-officedocument.spreadsheetml.sheet");
        response.setCharacterEncoding("utf-8");
        response.setHeader("Content-disposition", "attachment;filename=" + fileName + ".xlsx");
 
        // 创建动态表头处理器
        DynamicHeaderWriteHandler headerHandler = new DynamicHeaderWriteHandler(headers);
 
        // 写入数据到输出流
        EasyExcel.write(response.getOutputStream())
                .registerWriteHandler(headerHandler)
                .head((Class<?>) data.get(0).getClass()) // 假设数据类已经标注了 @ExcelProperty
                .sheet("Sheet1")
                .doWrite(data);
    }
}

3. 使用方法示例

在 Controller 中调用封装好的方法,传入动态表头和数据。

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
 
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
import java.util.ArrayList;
import java.util.List;
 
@RestController
public class ExcelExportController {
 
    @GetMapping("/export")
    public void export(HttpServletResponse response) throws IOException {
 
        //​Powered by Moshow@https://zhengkai.blog.csdn.net/
​
        // 模拟数据
        List<SampleData> data = new ArrayList<>();
        data.add(new SampleData("张三", 25, "北京"));
        data.add(new SampleData("李四", 30, "上海"));
 
        // 动态表头
        List<String> headers = List.of("姓名(新)", "年龄(新)", "地址(新)");
 
        // 导出 Excel
        ExcelExportUtil.exportExcel(response, data, headers, "示例文件");
    }
 
    // 数据类
    public static class SampleData {
        private String name;
        private Integer age;
        private String address;
 
        public SampleData(String name, Integer age, String address) {
            this.name = name;
            this.age = age;
            this.address = address;
        }
 
        // Getters 和 Setters 省略
    }
}

通过这种方式,你可以灵活设置动态表头,并实现直接导出到客户端的功能。

到此这篇关于SpringBoot3整合EasyExcel动态实现表头重命名的文章就介绍到这了,更多相关SpringBoot EasyExcel表头重命名内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • IDEA+JRebel实现全自动热部署的方法步骤

    IDEA+JRebel实现全自动热部署的方法步骤

    这篇文章主要介绍了IDEA+JRebel实现全自动热部署的方法步骤,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2019-11-11
  • JVM中的程序计数寄存器PC是什么详解

    JVM中的程序计数寄存器PC是什么详解

    这篇文章主要介绍了JVM中的程序计数寄存器PC原理分析,JVM中的程序计数寄存器(Program Counter Register),Register的命名源于CPU的寄存器,寄存器存储指令相关的现场信息
    2021-09-09
  • 一不小心就让Java开发踩坑的fail-fast是个什么鬼?(推荐)

    一不小心就让Java开发踩坑的fail-fast是个什么鬼?(推荐)

    这篇文章主要介绍了Java fail-fast,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2019-04-04
  • Spring MVC整合 freemarker及使用方法

    Spring MVC整合 freemarker及使用方法

    Spring MVC是一种基于Java的实现了Web MVC设计模式的请求驱动类型的轻量级Web框架,这篇文章主要介绍了Spring MVC整合 freemarker及使用方法,需要的朋友可以参考下
    2019-07-07
  • java实现顺时针打印矩阵

    java实现顺时针打印矩阵

    这篇文章主要为大家详细介绍了java实现顺时针打印矩阵的相关资料,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2019-03-03
  • @Autowired 自动注入接口失败的原因及解决

    @Autowired 自动注入接口失败的原因及解决

    这篇文章主要介绍了@Autowired 自动注入接口失败的原因及解决方案,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-02-02
  • Java中static与instance的区别及作用详解

    Java中static与instance的区别及作用详解

    这篇文章主要为大家介绍了Java中static与instance的区别及作用详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2023-07-07
  • SpringBoot使用JPA实现查询部分字段

    SpringBoot使用JPA实现查询部分字段

    这篇文章主要介绍了SpringBoot使用JPA实现查询部分字段方式,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-08-08
  • Win10系统下配置Java环境变量

    Win10系统下配置Java环境变量

    今天给大家带来的是关于Java的相关知识,文章围绕着Win10系统下配置Java环境变量展开,文中有非常详细的介绍及图文示例,需要的朋友可以参考下
    2021-06-06
  • Java连接FTP服务器并使用ftp连接池进行文件操作指南

    Java连接FTP服务器并使用ftp连接池进行文件操作指南

    使用FTP最主要的功能是对文件进行管理,下面这篇文章主要给大家介绍了关于Java连接FTP服务器并使用ftp连接池进行文件操作的相关资料,文中通过代码介绍的非常详细,需要的朋友可以参考下
    2024-08-08

最新评论