使用POI实现Excel复杂模板数据导出

于 2024-04-21 17:50:49 发布
阅读量282 收藏 6
点赞数 5
分类专栏： 经验分享 文章标签： excel java
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/xianchao0127/article/details/138039824
版权

仓库

https://github.com/nhjclxc/excel-test.git

介绍

  • 鉴于easyExcel在填充list模板之后不能在添加数据这一缺陷。本人基于poi实现复杂Excel模板实现导出，在填充了List数据之后还允许填充模板数据。
  • 使用方法直接看工具类 ExcelExporterMultSheetUtils.java里面提供的public方法即可实现excel模板数据导出。
  • 使用之前应当先导入pom.xml里面的相关依赖。

代码

        <dependency>
            <groupId>org.apache.poi</groupId>
            <artifactId>poi</artifactId>
            <version>5.2.2</version>
        </dependency>
        <dependency>
            <groupId>org.apache.poi</groupId>
            <artifactId>poi-ooxml</artifactId>
            <version>5.2.2</version>
        </dependency>
        <dependency>
            <groupId>org.apache.poi</groupId>
            <artifactId>poi-ooxml-schemas</artifactId>
            <version>4.1.2</version> <!-- 这是个例子版本号 -->
        </dependency>

package com.example.exceltest;

import org.apache.poi.ss.usermodel.*;
import org.apache.poi.xssf.usermodel.XSSFWorkbook;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.io.*;
import java.lang.reflect.Field;
import java.math.BigDecimal;
import java.time.LocalDateTime;
import java.util.*;
import java.util.stream.Collectors;
import java.util.stream.StreamSupport;

/**
 * 实现根据Excel文件进行模板导出，并且list填充之后还允许继续填充当值模板数据
 *
 * @author 罗贤超
 * @since 2024/04/21 14:23
 */
public class ExcelExporterMultSheetUtils {
    protected static final Logger log = LoggerFactory.getLogger(ExcelExporterMultSheetUtils.class);

    public static void main(String[] args) throws IOException {
        String source = "dynamic-template-mult-sheet.xlsx";
        // 从resources下加载模板并替换
        InputStream resourceAsStream = ExcelExporterMultSheetUtils.class.getClassLoader().getResourceAsStream(source);
        // 输出文件路径
        String outputPath = "output -" + source;

        Map<String, Object> testMap = new HashMap<>();
        // 单值格式
        testMap.put("title", "" + "这是一个标题噢噢噢");
        testMap.put("title2", "" + "这是第二个标题啊啊啊啊啊");
        testMap.put("signName", "张一三");
        testMap.put("age", 18);
        testMap.put("time", LocalDateTime.now());
        testMap.put("word", "一个单词");
        testMap.put("amount", new BigDecimal("99999.88"));
        testMap.put("flag", true);
        testMap.put("hhh", "哈哈哈");

        // 列表填充格式
        List<TestObj> testObjList = new ArrayList<>();
        testObjList.add(TestObj.builder().id(1).name("张三 ").money(new BigDecimal("111.88")).build());
        testObjList.add(TestObj.builder().id(2).name("里斯 ").money(new BigDecimal("222.66")).build());
        testObjList.add(TestObj.builder().id(3).name("王五 ").money(new BigDecimal("333.88")).build());
        testObjList.add(TestObj.builder().id(4).name("赵六 ").money(new BigDecimal("555.88")).build());
        testObjList.add(TestObj.builder().id(5).name("钱七 ").money(new BigDecimal("666.88")).build());
        testObjList.add(TestObj.builder().id(6).name("测试空值情况 ").build());
        testObjList.add(TestObj.builder().name("测试空值情况 2").build());

        testMap.put(".list66", testObjList);
        // 由于后面要使用反射根据list获取内部属性对应的值，且同时无法直接从list推断出对应的泛型类型，因此这里必须要指明list对应的泛型类型，否则无法导出
        testMap.put(".list66" + ExcelExporterMultSheetUtils.CLAZZ_FLAG, TestObj.class);


        List<TestDistrict> testDistrictList = new ArrayList<>();
        testDistrictList.add(TestDistrict.builder().name("浙江省").level(1).time(LocalDateTime.now()).build());
        testDistrictList.add(TestDistrict.builder().name("宁波市").level(2).time(LocalDateTime.now()).build());
        testDistrictList.add(TestDistrict.builder().name("江北区").level(3).time(LocalDateTime.now()).build());
        testDistrictList.add(TestDistrict.builder().name("庄市大道").level(4).time(LocalDateTime.now()).build());
        testMap.put(".list88", testDistrictList);
        testMap.put(".list88" + ExcelExporterMultSheetUtils.CLAZZ_FLAG, TestDistrict.class);

        FileOutputStream fileOutputStream = new FileOutputStream(outputPath);
        exportByTemplate(resourceAsStream, fileOutputStream, testMap);
        fileOutputStream.close();

    }

    /** 字节码标识符 */
    public final static String CLAZZ_FLAG = ".CLAZZ_FLAG";


    /**
     * 根据excel模板文件进行导出
     *
     * @param templateStream 模板文件输入流
     * @param outputStream   数据输出流
     * @param dataMap        数据集
     * @author 罗贤超
     */
    public static void exportByTemplate(InputStream templateStream, OutputStream outputStream, Map<String, ?> dataMap) throws IOException {
        // 读取模板文件
        assert templateStream != null;
        Workbook workbook = new XSSFWorkbook(templateStream);
        workbook.sheetIterator().forEachRemaining(sheet -> {
            // 遍历每一个sheet进行模板数据填充
            fillCell(sheet, dataMap);
        });

        // 输出数据
        workbook.write(outputStream);
        outputStream.flush();
        workbook.close();
    }

    public static void exportByTemplate(String templatePath, OutputStream outputStream, Map<String, ?> dataMap) throws IOException {
        InputStream resourceAsStream = ExcelExporterMultSheetUtils.class.getClassLoader().getResourceAsStream(templatePath);
        exportByTemplate(resourceAsStream, outputStream, dataMap);
    }

    public static ByteArrayOutputStream exportByTemplate(String templatePath, Map<String, ?> dataMap) throws IOException {
        InputStream resourceAsStream = ExcelExporterMultSheetUtils.class.getClassLoader().getResourceAsStream(templatePath);
        ByteArrayOutputStream byteArrayOutputStream = new ByteArrayOutputStream();
        exportByTemplate(resourceAsStream, byteArrayOutputStream, dataMap);
        return byteArrayOutputStream;
    }

    public static ByteArrayOutputStream exportByTemplate(InputStream templateStream, Map<String, ?> dataMap) throws IOException {
        ByteArrayOutputStream byteArrayOutputStream = new ByteArrayOutputStream();
        exportByTemplate(templateStream, byteArrayOutputStream, dataMap);
        return byteArrayOutputStream;
    }


    /**
     * 执行单元格数据填充填充
     *
     * @param sheet   sheet页
     * @param dataMap 数据map
     * @author 罗贤超
     */
    private static void fillCell(Sheet sheet, Map<String, ?> dataMap) {

        // 遍历整个sheet，每一行
        Iterator<Row> rowIterator = sheet.rowIterator();
        int lastRowNum = sheet.getLastRowNum();

        int listValueStartRowIndex = -1;
        int dataListSize = 0;

        // 将迭代器里面的数据收集到List里面， 便于后续的递归使用 （将Iterator转换为Stream）
        List<Row> allRowList = StreamSupport.stream(Spliterators.spliteratorUnknownSize(rowIterator, Spliterator.ORDERED), false).collect(Collectors.toList());
        for (int rowIndex = 0; rowIndex < allRowList.size(); rowIndex++) {
            Row row = allRowList.get(rowIndex);

            // 用于保存是不是有创建新的一行
            List<Row> listRow = new ArrayList<>();

            // 遍历每一个单元格，看看是不是要进行模板数据填充
            Iterator<Cell> cellIterator = row.cellIterator();
            List<Cell> allCellList = StreamSupport.stream(Spliterators.spliteratorUnknownSize(cellIterator, Spliterator.ORDERED), false).collect(Collectors.toList());
            for (Cell cell : allCellList) {
                int columnIndex = cell.getColumnIndex();

                String cellValue = getCellValue(cell);
                // 首先检查是不是单数据填充
                if (isSingleValueFill(cellValue)) {
                    String singleValueFlag = trimSingleValueFillBraces(cellValue);
                    Object setValue = dataMap.get(singleValueFlag);
                    cell.setCellValue(setValue == null ? "" : setValue.toString());
                } else if (isListValueFill(cellValue)) {
                    // 接着检查是不是列表元素填充
                    String attribute = trimSingleValueFillBraces(cellValue); // .list1.id

                    int lastDotIndex = attribute.lastIndexOf('.');
                    String listAttribute = attribute.substring(0, lastDotIndex);  // .list1
                    String listInnerAttribute = attribute.substring(lastDotIndex + 1);  //  id
                    List<?> dataList = (List<?>) dataMap.get(listAttribute); // 获取list数据
                    Class<?> clazz = (Class<?>) dataMap.get(listAttribute + ExcelExporterMultSheetUtils.CLAZZ_FLAG); // 获取list对应的泛型，后续使用反射获取值
                    if (dataList == null) {
                        continue;
                    }
                    if (listValueStartRowIndex == -1)
                        listValueStartRowIndex = rowIndex;

                    for (int i = 0; i < dataList.size(); i++) {
                        String fieldValue = getFieldValue(clazz, listInnerAttribute, dataList.get(i));

                        // 创建新的n行，其中n等于列表长度
                        Row newRow;
                        if (listRow.size() < dataList.size()) {
                            // i == 0 直接使用模板这一行，否则在最后创建新的行
                            if (i == 0) {
                                newRow = row;
                                dataListSize = dataList.size(); // 记录list数据的长度，便于后续单元格的移动
                            } else {
                                newRow = sheet.createRow(i + lastRowNum);
                            }
                            listRow.add(newRow);
                        } else {
                            newRow = listRow.get(i);
                        }
                        // 将原有单元格样式拿出来保存到副本里面，创建新的单元格之后再设置回去
                        CellStyle cellStyle = cell.getCellStyle();

                        // 创建单元格
                        Cell listRowCell = newRow.createCell(columnIndex);
                        // 从原有单元格中克隆样式 newStyle.cloneStyleFrom(sourceStyle);
                        listRowCell.setCellStyle(cellStyle);
                        // 从列表里面获取对应的值进行填充
                        listRowCell.setCellValue(fieldValue);
                    }
                }
            }
        }

        // 移动单元格
        if (listValueStartRowIndex != -1) {
            // sheet.shiftRows(6, 12, -5);  // 从第6（在excel中指第7行）行到第12（在excel中指第13行）行全部向上移5行

            int moveStart = listValueStartRowIndex + 1; // listValueStartRowIndex表示当前模板行，+1表示从模板行的下一行开始
            int moveEnd = allRowList.size() - 1; // allRowList.size()表示原有模板excel的行数，-1是因为索引从0开始
            int moveSize = (dataListSize - 1) + (moveEnd - moveStart + 1); // (dataList.size() - 1)表示追加到行尾的数据列，(moveEnd - moveStart + 1)表示从原始开头到原始结尾的行数

            // 把原始list填充后面的数据先往最后移动
            sheet.shiftRows(moveStart, moveEnd, moveSize); // moveStart和moveEnd都是闭区间，

            // 再把list填充（去除第一行）和原始list填充后面的数据整体往前移动（去除空白单元格），sheet.getLastRowNum()表示单元格的最后一行
            sheet.shiftRows(moveEnd + 1, sheet.getLastRowNum(), -(moveEnd - moveStart + 1));
        }

    }

    /**
     * 获取单元格的值
     *
     * @param cell 单元格
     * @return 单元格原始数据数据
     * @author 罗贤超
     */
    private static String getCellValue(Cell cell) {
        String cellValue = "";
        try {
            CellType cellType = cell.getCellType();
            switch (cellType) {
                case NUMERIC:
                    cellValue = String.valueOf(cell.getNumericCellValue());
                    break;
                case STRING:
                    cellValue = String.valueOf(cell.getStringCellValue());
                    break;
                case FORMULA:
                    break;
                case BLANK:
                    break;
                case BOOLEAN:
                    cellValue = String.valueOf(cell.getBooleanCellValue());
                    break;
            }
        } catch (Exception ignored) {
        }
        return cellValue;
    }

    /**
     * 获取对象对应属性的值
     *
     * @param clazz     泛型
     * @param attribute 属性名称
     * @param obj       对象
     * @author 罗贤超
     */
    private static String getFieldValue(Class<?> clazz, String attribute, Object obj) {
        try {
            Field field = clazz.getDeclaredField(attribute);
            field.setAccessible(true);
            return field.get(obj).toString();
        } catch (Exception e) {
            log.info("获取数据为空：{}", e.getMessage());
        }
        return "";
    }

    /**
     * 去除模板里面的"{{"和"}}"，注意调用此方法前，必须调用isSingleValueFill返回为true，才调用这个方法
     *
     * @param str 模板里面的只发出
     * @return 返回的字符串
     * @author 罗贤超
     */
    private static String trimSingleValueFillBraces(String str) {
        if (str == null || "".equals(str)) {
            return str;
        }
        return str.substring(2, str.length() - 2);
    }

    /**
     * 判断这个单元格是不是要填充
     * 要填充的单元格必须以"{{"打头和"}}"结尾
     *
     * @param str 单元格的str值
     * @return 如果满足"{{"打头和"}}"结尾则返回true，否则返回false
     * @author 罗贤超
     */
    private static boolean isSingleValueFill(String str) {
        if (str == null || "".equals(str)) {
            return false;
        }
        // (str.startsWith("{{") && str.endsWith("}}"))表示是以"{{"打头"}}"结尾
        // !isListValueFill(str) 表示不是列表填充，注意取了反
        return (str.startsWith("{{") && str.endsWith("}}")) && !isListValueFill(str);
    }

    private static boolean isListValueFill(String str) {
        if (str == null || "".equals(str)) {
            return false;
        }
        return str.startsWith("{{.") && str.endsWith("}}");
    }

}

示例

模板sheet1

在这里插入图片描述

模板sheet2

在这里插入图片描述

sheet1结果

在这里插入图片描述

sheet2结果

在这里插入图片描述

@__Chao - L
关注
  • 5
    点赞
  • 踩
  • 6
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
POI导出复杂表格数据
Connie_kinkin的博客
08-01 193
poi，springboot
POI导出复杂表格数据(合并单元格)
weixin_42910007的博客
01-07 1233
POI导出复杂数据(合并单元格)
POI实现导出复杂Excel（动态行，复杂单元格，水印，Excel转换为PDF）。
m0_63131835的博客
02-07 3610
深入使用poi框架，制作复杂excel
Poi实现复杂Excel导出，理解POI操作Excel思路！！！
最新发布
迷途小书童的博客
12-20 1163
复杂excel导出，单元格合并，理解poi操作excel原理！！！
poi导出复杂的excle，简单易懂一看既会
GQ_666的博客
03-26 394
首先，poi老的版本是和新版本是不兼容的，现在poi依赖都到<version>4.1.1</version>了，搜到的博客大部分是前几年的，好多方法基本上都用不了。----》大家注意一下 1.我实现的功能：上图片 月度任务目标，默认有8行。数据少于8行，剩余的行留在哪里。大于8行，for循环递增添加。 2.前置知识，懂了看代码会舒服很多 1)创建workbook工作薄； 2)创建一个工作表sheet； 3)创建一个行对象row(下标起始值为0)； 4)创建一个单元格
POI使用Excel模板文件循环输出行并导出Excel
08-15
POI使用excel模板循环输出行到文件并导出的一个小例子
javaWeb中使用Excel模板导出业务数据
12-07
在javaWeb开发中，会经常遇到导出业务数据的业务需求，导出Excel最常用的技术就是poi，对于简单的业务，我们可以动态的生成一个Excel文件，但对于复杂的业务，我们可以通过使用读取Excel模板的，然后往里面填充数据...
poi_模板导出excel，支持百万级数据模板导出
07-09
poi导入、导出,支持百万级数据模板导出、合并excel。项目为spring-boot-2上开发。resource里面有模板，在junit测试类中修改为本地存在路径即可导出文件，在junit测试类中修改for循环的i可以模拟百万级数据导出。注意...
java基于模板导出Excel表格
09-14
除了平时简单的数据导出需求外，我们也经常...源码案例提供了模板，单个数据写入与列表数据写入以及文件导出的代码，详细的说明请参照个人博客“Excel模板导出”，源码可以让读者更加详细的了解Excel导出的过程和原理。
java实现导出Excel多行表头复杂模板
12-20
java实现导出Excel多行表头复杂模板 一般我们都会选择poi来导出，选择一个比较好的ExcelUtils 但是对于初学者而言不了解poi的，还需从poi API文档去学习，如果是自学的话更好，如果是公司安排的任务，没有接触过有...
使用POI导出Excel复杂表头（超详细）
ggjklncffd的博客
05-13 4364
相信很多小伙伴不管是在项目开发中还是在学习过程中，会碰到这样的需求：导出一些复杂表头的报表。今天看我这篇保证你不在为此头痛，Begin 引入依赖： <dependency> <groupId>org.apache.poi</groupId> <artifactId>poi</artifactId> <version>5.2.2</version&.
复杂的POI导出Excel表格（多行表头、合并单元格）
weixin_30675967的博客
08-22 1337
poi导出excel有两种方式： 第一种：从无到有的创建整个excel，通过HSSFWorkbook,HSSFSheet HSSFCell, 等对象一步一步的创建出工作簿，sheet，和单元格，并添加样式，数据等。 第二种：通过excel.xls 模板的方式，自己在桌面创建一个excel， 然后修改这个excel为模板，复制到项目中（我是放在根目录下），再然后读取模板，修改模板，...
报表技术POI导入导出复杂样式Excel和百万数据（Java代码、模板、数据）
欢迎朋友，我是一名十多年开发经验的新手，希望多多指教。
11-08 580
报表技术POI导入导出含复杂样式的Excel和百万数据（Java代码、模板、数据）
使用easypoi模板方法导出excel
weixin_49832841的博客
04-25 6848
使用excelpoi模板方法导出excel，实现横向与纵向输出数据
POI实现自定义复杂表头Excel导出(POI旧版本实现，新版本需要根据实际情况进行修改)
小智博客
11-25 2293
POI实现自定义EXcel多行复杂表头导出
POI复杂EXCEL导出
weixin_41581877的博客
04-10 1598
对于excel导出一直懵懵懂懂，今日招投标部门提出了一个复杂的excel导出格式，就学习了一下，记录一下成果， excel导出的表头是动态的，合并单元格也是动态不固定的 public static HSSFWorkbook exportProjFix(Map<String,List<JSONArray>> titleList,JSONArray itemData, J...
Java Poi导出Excel表格详解
wry2000的博客
06-10 3669
导出多个sheet页，合并单元格、设置单元格样式、设置字体样式
Java POI 基于模板导出列表数据
白白白鲤鱼的博客
08-02 1373
java POI 基于模板导出列表数据
poi复杂模板导出excel
05-05
如果您需要导出复杂的Excel文件，可以使用Apache POI来完成。下面是一些基本的步骤： 1. 从Apache POI网站下载最新版本的POI库并将其添加到您的项目中。 2. 创建一个工作簿对象，这是您要导出的Excel文件的主要部分。 ``` Workbook workbook = new XSSFWorkbook(); ``` 3. 创建一个工作表对象，这里我们使用默认名称“Sheet1”。 ``` Sheet sheet = workbook.createSheet(); ``` 4. 创建一个行对象，该对象将包含您要导出的数据。 ``` Row row = sheet.createRow(0); ``` 5. 创建一个单元格对象，并将其添加到每行中。 ``` Cell cell = row.createCell(0); cell.setCellValue("Hello World!"); ``` 6. 如果您需要添加样式、合并单元格等高级操作，则需要使用POI提供的各种类和方法。 7. 最后，将工作簿写入Excel文件。 ``` FileOutputStream fileOut = new FileOutputStream("workbook.xlsx"); workbook.write(fileOut); fileOut.close(); ``` 您可以根据自己的需要进行更改和扩展。希望这可以帮助您开始创建复杂的Excel导出。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值