EasyExcel動態表頭導出（支持多級表頭）

来源:https://www.cnblogs.com/fxsen/archive/2023/09/26/17729418.html
-Advertisement-
Play Games

EasyExcel動態表頭導出（支持多級表頭） 在很多業務場景中，都會應用到動態表頭的導出，也會涉及到多級表頭的導出，如下圖所示 通過EasyExcel，我們可以快速實現這一需求，具體代碼如下 DynamicHeader import java.util.List; /** *@Author: <a ...


EasyExcel動態表頭導出（支持多級表頭）

在很多業務場景中，都會應用到動態表頭的導出，也會涉及到多級表頭的導出，如下圖所示

image-20230926091557316

通過EasyExcel，我們可以快速實現這一需求，具體代碼如下

DynamicHeader

import java.util.List;

/**
 *@Author: <a href="mailto:[email protected]">Fxsen</a>
 *@CreateTime: 2023年09月22日  09:16
 */
public class DynamicHeader {
    /**
     * 要導出的欄位名稱英文
     */
    private String fieldName;

    /**
     * 要導出的表頭名稱中文
     */
    private String headName;
    /**
     * 如果是多級表都，插入下級
     */
    private List<DynamicHeader> children;

    public String getFieldName() {
        return fieldName;
    }

    public void setFieldName(String fieldName) {
        this.fieldName = fieldName;
    }

    public String getHeadName() {
        return headName;
    }

    public void setHeadName(String headName) {
        this.headName = headName;
    }

    public List<DynamicHeader> getChildren() {
        return children;
    }

    public void setChildren(List<DynamicHeader> children) {
        this.children = children;
    }
}

CustomTitleWriteHandler

import com.alibaba.excel.write.handler.SheetWriteHandler;
import com.alibaba.excel.write.metadata.holder.WriteSheetHolder;
import com.alibaba.excel.write.metadata.holder.WriteWorkbookHolder;
import org.apache.poi.ss.usermodel.CellStyle;
import org.apache.poi.ss.usermodel.*;
import org.apache.poi.ss.util.CellRangeAddress;

public class CustomTitleWriteHandler implements SheetWriteHandler {
    /**
     * 標題
     */
    private final String fileName;

    /**
     * 欄位個數
     */
    private final Integer count;

    public CustomTitleWriteHandler(Integer count,String fileName) {
        this.fileName = fileName;
        this.count = count;
    }

    @Override
    public void beforeSheetCreate(WriteWorkbookHolder writeWorkbookHolder, WriteSheetHolder writeSheetHolder) {

    }

    @Override
    public void afterSheetCreate(WriteWorkbookHolder writeWorkbookHolder, WriteSheetHolder writeSheetHolder) {
        // 獲取clazz所有的屬性
        Workbook workbook = writeWorkbookHolder.getWorkbook();
        Sheet sheet = workbook.getSheetAt(0);
        Row row1 = sheet.createRow(0);
        row1.setHeight((short) 800);
        Cell cell = row1.createCell(0);
        //設置標題
        cell.setCellValue(fileName);
        CellStyle cellStyle = workbook.createCellStyle();
        cellStyle.setBorderBottom(BorderStyle.THIN); //下邊框
        cellStyle.setBorderLeft(BorderStyle.THIN);//左邊框
        cellStyle.setBorderTop(BorderStyle.THIN);//上邊框
        cellStyle.setBorderRight(BorderStyle.THIN);//右邊框
        cellStyle.setVerticalAlignment(VerticalAlignment.CENTER);
        cellStyle.setAlignment(HorizontalAlignment.CENTER);
        Font font = workbook.createFont();
        font.setBold(true);
        font.setFontHeight((short) 400);
        font.setFontName("宋體");
        cellStyle.setFont(font);
        cell.setCellStyle(cellStyle);
        CellRangeAddress region = new CellRangeAddress(0, 0, 0, count - 1);
        setRegionStyle(sheet,region,cellStyle);
        sheet.addMergedRegion(region);
    }
    /**
     * 為合併的單元格設置樣式（可根據需要自行調整）
     */
    public static void setRegionStyle(Sheet sheet, CellRangeAddress region, CellStyle cs) {
        for (int i = region.getFirstRow(); i <= region.getLastRow(); i++) {
            Row row = sheet.getRow(i);
            if (null == row) row = sheet.createRow(i);
            for (int j = region.getFirstColumn(); j <= region.getLastColumn(); j++) {
                Cell cell = row.getCell(j);
                if (null == cell) cell = row.createCell(j);
                cell.setCellStyle(cs);
            }
        }
    }
}

CellStyle

import com.alibaba.excel.metadata.CellData;
import com.alibaba.excel.metadata.Head;
import com.alibaba.excel.write.metadata.holder.WriteSheetHolder;
import com.alibaba.excel.write.style.column.AbstractColumnWidthStyleStrategy;
import org.apache.poi.ss.usermodel.Cell;
import org.apache.poi.ss.usermodel.Sheet;

import java.util.List;

public class CellStyle extends AbstractColumnWidthStyleStrategy {

    @Override
    protected void setColumnWidth(WriteSheetHolder writeSheetHolder, List<CellData> cellDataList, Cell cell, Head head,
                                  Integer relativeRowIndex, Boolean isHead) {
        // 簡單設置
        Sheet sheet = writeSheetHolder.getSheet();
        sheet.setColumnWidth(cell.getColumnIndex(), 5000);
    }

}

DynamicExcelUtils

import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.lang.reflect.Field;
import java.net.URLEncoder;
import java.nio.charset.StandardCharsets;
import java.time.LocalDate;
import java.time.LocalDateTime;
import java.time.format.DateTimeFormatter;
import java.util.*;
import java.util.stream.Collectors;
import cn.hutool.core.util.ReflectUtil;
import com.alibaba.excel.EasyExcel;
import com.alibaba.excel.EasyExcelFactory;
import com.alibaba.excel.ExcelWriter;
import com.alibaba.excel.write.metadata.WriteSheet;
import com.alibaba.excel.write.metadata.fill.FillConfig;
import com.wisesoft.core.util.DateUtil;
import org.apache.commons.collections4.CollectionUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import javax.servlet.ServletOutputStream;
import javax.servlet.http.HttpServletResponse;
/**
 * 動態導出工具
 *@Author: <a href="mailto:[email protected]">Fxsen</a>
 *@CreateTime: 2023年09月22日  09:13
 */
public class DynamicExcelUtils {
    private static final Logger log = LoggerFactory.getLogger(DynamicExcelUtils.class);

    /**
     * 根據模板導出數據 單個sheet
     *
     * @param response     返回對象
     * @param dataList     導出的數據集合
     * @param object       填充對象
     * @param fileName     文件名稱
     * @param templateName 模板名稱
     * @throws Exception
     */
    public void exportTemplateExcel(HttpServletResponse response, List<?> dataList, Object object,
                                    String fileName, String templateName) throws Exception {
        InputStream inputStream = this.getClass().getResourceAsStream(templateName);
        FillConfig fillConfig = FillConfig.builder().forceNewRow(Boolean.TRUE).build();
        ExcelWriter excelWriter = EasyExcelFactory.write(getOutputStream(fileName, response)).withTemplate(inputStream).build();
        WriteSheet writeSheet0 = EasyExcelFactory.writerSheet(0).build();
        excelWriter.fill(object, fillConfig, writeSheet0);
        excelWriter.fill(dataList, fillConfig, writeSheet0);
        excelWriter.finish();
    }

    /**
     * 構建輸出流
     *
     * @param fileName 文件名稱
     * @param response 輸出流
     * @return
     * @throws Exception
     */
    private OutputStream getOutputStream(String fileName, HttpServletResponse response) throws Exception {
        fileName = URLEncoder.encode(fileName, StandardCharsets.UTF_8.name()).replaceAll("\\+", "%20");
        response.setContentType("application/vnd.ms-excel");
        response.setCharacterEncoding(StandardCharsets.UTF_8.name());
        response.setHeader("Content-Disposition", "attachment;filename=" + fileName + ".xlsx");
        return response.getOutputStream();
    }
    /**
     * 動態表頭生成excel
     * @param headers 要生成的表頭
     * @param dataList 數據
     * @param response
     * @param fileName 文件名稱
     * @param titleName title名稱
     * @param <T>
     */
    public static <T> void dynamicExportExcel(List<DynamicHeader> headers, List<T> dataList, HttpServletResponse response, String fileName, String titleName) {
        long startTime = System.currentTimeMillis();
        List<List<T>> allList = new ArrayList<>();
        if (CollectionUtils.isNotEmpty(dataList)){
            for (T detail : dataList) {
                allList.addAll(dataList(headers, detail));
            }
        }
        List<List<String>> headerList = headers(headers);
        try (ServletOutputStream outputStream = response.getOutputStream()) {
            String name = URLEncoder.encode(fileName, StandardCharsets.UTF_8.name()).replaceAll("\\+", "%20");
            response.setContentType("application/vnd.ms-excel");
            response.setCharacterEncoding("utf-8");
            response.setHeader("Content-disposition", "attachment;filename*=utf-8''" + name + ".xlsx");//設置響應頭
            EasyExcel.write(outputStream).head(headerList)
                    //表格標題占位
                    .relativeHeadRowIndex(1)
                    //文件樣式
                    .registerWriteHandler(new CustomTitleWriteHandler(headerList.size(),titleName))
                    .registerWriteHandler(new CellStyle())
                    .sheet(fileName).doWrite(allList);
        } catch (IOException e) {
            e.printStackTrace();
            log.error("生成動態EXL失敗，欄位", e);
        }
        long endTime = System.currentTimeMillis();
        log.info("動態導出耗時:{}", endTime - startTime);
    }

    //excel表頭
    public static List<List<String>> headers(List<DynamicHeader> excelHeaders) {
        List<List<String>> headers = new ArrayList<>();
        for (DynamicHeader header : excelHeaders) {
            List<DynamicHeader> children = header.getChildren();
            if (CollectionUtils.isNotEmpty(children)){
                for (DynamicHeader child : children) {
                    List<String> head = new ArrayList<>();
                    head.add(header.getHeadName());
                    head.add(child.getHeadName());
                    headers.add(head);
                }
            }else {
                List<String> head = new ArrayList<>();
                head.add(header.getHeadName());
                headers.add(head);
            }
        }
        return headers;
    }

    /**
     * 要導出的欄位
     *
     * @param exportFields 表頭集合
     * @param obj          數據對象
     * @return 集合
     */
    public static <T> List<List<T>> dataList(List<DynamicHeader> exportFields, T obj) {
        List<List<T>> list = new ArrayList<>();
        List<T> data = new ArrayList<>();
        List<String> propList = new ArrayList<>();
        for (DynamicHeader exportField : exportFields) {
            List<DynamicHeader> children = exportField.getChildren();
            if (CollectionUtils.isNotEmpty(children)){
                propList.addAll(children.stream().map(DynamicHeader::getFieldName).collect(Collectors.toList()));
            }else {
                propList.add(exportField.getFieldName());
            }
        }
        if (obj instanceof Map){
            Map map = (Map) obj;
            for (String prop : propList) {
                map.forEach((k,v)->{
                    if (prop.equals(k)){
                        if (Objects.isNull(v)){
                            v = "";
                        }else if (v instanceof Date){
                            v = DateUtil.format((Date)v,DateUtil.DATETIME_YMD_DASH);
                        }
                        data.add((T)v);
                    }
                });
            }
        }else {
            //先根據反射獲取實體類的class對象
            Class<?> objClass = obj.getClass();
            //設置實體類屬性的集合
            Field[] fields = ReflectUtil.getFields(objClass);
            for (String prop : propList) {
                //迴圈實體類對象集合
                for (Field field : fields) {
                    field.setAccessible(true);
                    //判斷實體類屬性跟特定欄位集合名是否一樣
                    if (field.getName().equals(prop)) {
                        T object = null;
                        try {
                            object = (T) field.get(obj);
                        } catch (IllegalAccessException e) {
                            e.printStackTrace();
                            log.error("生成動態EXL失敗，欄位", e);
                        }
                        //獲取屬性對應的值
                        if(null == object){
                            object = (T) "";
                        }else{
                            if(object instanceof LocalDate){
                                object = (T)((LocalDate)object).format(DateTimeFormatter.ofPattern(DateUtil.DEFAULT_DATETIME_FORMAT));
                            }
                            if(object instanceof LocalDateTime){
                                object = (T) ((LocalDateTime)object).format(DateTimeFormatter.ofPattern(DateUtil.DEFAULT_DATETIME_FORMAT));
                            }
                        }
                        data.add(object);
                    }
                }
            }
        }
        list.add(data);
        return list;
    }
}

測試：

image-20230926091557316


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • Java 集合
    集合概述 為了保存數量不確定的數據，以及保存具有映射關係的數據，Java 提供了集合類。集合類主要負責保存、盛裝其他數據，因此集合類也被稱為容器類。所有的集合都位於java.util包下 Java 的集合類主要由兩個介面派生而出：Collection和Map，Collection和Map 是 Jav ...
  • Springboot簡單功能示例-6 使用加密數據源並配置日誌
    0. 數據說明 本項目所用數據集包含了一個家庭6個月的用電數據，收集於2007年1月至2007年6月。 這些數據包括有功功率、無功功率、電壓、電流強度、分項計量1（廚房）、分項計量2（洗衣房）和分項計量3（電熱水器和空調）等信息。該數據集共有260,640個測量值，可以為瞭解家庭用電情況提供重要的見 ...
  • Java 21 正式 GA，虛擬線程真的來了
    UTC 時間 2023 年 9 月 19 日，期盼已久的 Java 21 終於發佈正式版！ 本文一起來看看其中最受 Java 開發者關註的一項新特性：Loom 項目的兩個新特性之一的 ”虛擬線程（Virtual Thread）“（另外一個新特性是 ”結構化併發（Structured Concurre ...
  • Redis記憶體碎片：深度解析與優化策略
    本文已收錄至GitHub，推薦閱讀 👉 Java隨想錄 微信公眾號：Java隨想錄 原創不易，註重版權。轉載請註明原作者和原文鏈接 目錄記憶體碎片如何產生的記憶體分配器怎麼看是否有記憶體碎片碎片率的意義清理記憶體碎片低於4.0-RC3版本的Redis高於4.0-RC3版本的Redis 在我們探究和優化Re ...
  • [Go 夜讀 第 148 期] Excelize 構建 WebAssembly 版本跨語言支持實踐
    本期分享將對 Excelize 的 2023 年部分更新背後的技術點、Go 1.21.0 版本中 XML 標準庫的相容性問題，以及如何構建 WebAssembly 版本跨語言支持展開討論。 ...
  • service.getClass().getAnnotation(XXXAnnotation.class) 取值為Null
    springboot2.7 java8 問題 在使用工廠模式封裝service時，需要通過service的class獲取其類型註解，但是有些工廠類可以取到annotation註解，有些取不到 渠道註解： /** * xxx渠道註解 * */ @Target({ElementType.TYPE}) @ ...
  • 8.2 BeingDebugged
    BeingDebugged 是`Windows`系統`PEB`結構體中的一個成員，它是一個標誌位，用於標識當前進程是否正在被調試。BeingDebugged的值為0表示當前進程未被調試，值為1表示當前進程正在被調試。由於`BeingDebugged`是在`PEB`結構體中存儲的，因此可以通過訪問`P... ...
  • 80基於java線上婚紗定製系統設計與實現（含配套lun文，可參考做bi設）
    基於java線上婚紗定製系統設計與實現,可適用於線上婚紗攝影預定系統，基於web的婚紗影樓管理系統設計，基於web的婚紗影樓管理系統設計，婚紗攝影網系統，婚紗攝影網站系統，婚紗攝影網站系統，婚紗系統，婚紗管理系統等等； ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發（一）：使用.NET MAUI開發第一個安卓APP
    移動開發（一）：使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說，近來想嘗試開發一款安卓APP，考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP，畢竟是使用Visual Studio開發工具，使用起來也比較的順手，結合微軟官方的教程進行了安卓 ...
  • wpf ToggleButton選中效果和一個登錄界面
    前言 QuestPDF 是一個開源 .NET 庫，用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫，它徹底改變了我們生成 PDF 文檔的方 ...
  • 彈幕樹洞項目功能新增篇
    項目地址 項目後端地址： https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址： ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址： http://tree ...
  • 第27篇 sqlserver2022詳細安裝步驟
    話不多說，直接開乾 一.下載 1.官方鏈接下載： https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe，運行開始下載SQL server； 二. ...
  • .NET 開源高性能 MQTT 類庫
    前言 隨著物聯網（IoT）技術的迅猛發展，MQTT（消息隊列遙測傳輸）協議憑藉其輕量級和高效性，已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫，為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog文檔翻譯系列（六） - 可用的接收器、增強器、格式化輸出
    Serilog支持多種接收器用於日誌存儲，增強器用於添加屬性，LogContext管理動態屬性，支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項，適用於不同需求。 ...
  • 警惕 Visual Studio 屬性求值副作用導致邏輯不符合預期
    目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據，爬取信息時需要模擬瀏覽器行為，否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下： 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • [使用目前最新版]HybridCLR6.9.0+YooAsset2.2.4實現純C# Unity熱更新方案 (一)
    1.前言 什麼是熱更新 游戲或者軟體更新時，無需重新下載客戶端進行安裝，而是在應用程式啟動的情況下，在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR，Xlua，ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles，Addressable， ...
  • 在 ASP.NET Core Web API 中使用操作篩選器統一處理通用操作
    本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺，其實像阿裡雲，騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後，它會送 ...
  • 第28篇 如何.net中實現高效可靠數據同步api
    通過以下方式可以高效，並保證數據同步的可靠性 1.API設計 使用RESTful設計，確保API端點明確，並使用適當的HTTP方法（如POST用於創建，PUT用於更新）。 設計清晰的請求和響應模型，以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類