SpringBoot+EasyExcel實現(xiàn)自定義復雜樣式導入導出

更新時間：2025年07月10日 16:30:17 作者：夢想blog

這篇文章主要為大家詳細介紹了SpringBoot如何結果EasyExcel實現(xiàn)自定義復雜樣式導入導出功能,文中的示例代碼講解詳細,感興趣的小伙伴可以了解下

安裝

        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>easyexcel</artifactId>
            <version>3.1.1</version>
        </dependency>

處理自定義導出復雜場景

1、列不固定，動態(tài)列

2、動態(tài)下拉

3、自定義鎖定行/列，添加密碼

4、合并單元格

5、導入自定義統(tǒng)一注解統(tǒng)一校驗

6、樣式處理（字體，顏色，底色，富文本，列寬，行寬等）

7、凍結窗格

8、多Sheet處理

1、列不固定，動態(tài)列

首先定義一個公共實體，處理公共字段和動態(tài)列字段，具體實體則繼承該類即可。

package com.example.springbootexcel.excel.base.model;

import com.alibaba.excel.annotation.ExcelProperty;
import lombok.Data;

import java.util.List;
import java.util.Map;

@Data
public class BaseExcel {

    @ExcelProperty( value = "序號")
    private String num;

    /**
     * 動態(tài)字段處理
     */
    private List<Map<String, Object>> dynamicList;

}

2、動態(tài)下拉

封裝一個公共類，構造入?yún)ap，key為表頭，value為下拉字符串數(shù)組。

.registerWriteHandler(new DropDownHandler(dropDownMap));

package com.example.springbootexcel.excel.base.style;

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.DataValidation;
import org.apache.poi.ss.usermodel.DataValidationConstraint;
import org.apache.poi.ss.usermodel.DataValidationHelper;
import org.apache.poi.ss.usermodel.Sheet;
import org.apache.poi.ss.util.CellRangeAddressList;

import java.util.Map;

/**
 * 添加下拉選單
 *
 * @author jason
 */
public class DropDownHandler implements SheetWriteHandler {
    private final Map<Integer, String[]> dropDownMap;  // key:列號(從0開始), value:下拉數(shù)據(jù)

    public DropDownHandler(Map<Integer, String[]> dropDownMap) {
        this.dropDownMap = dropDownMap;
    }

    @Override
    public void beforeSheetCreate(WriteWorkbookHolder writeWorkbookHolder, WriteSheetHolder writeSheetHolder) {
        // 不需要實現(xiàn)
    }

    @Override
    public void afterSheetCreate(WriteWorkbookHolder writeWorkbookHolder, WriteSheetHolder writeSheetHolder) {
        if (dropDownMap == null || dropDownMap.isEmpty()) {
            return;
        }

        Sheet sheet = writeSheetHolder.getSheet();
        DataValidationHelper helper = sheet.getDataValidationHelper();

        dropDownMap.forEach((columnIndex, dropDownData) -> {
            // 設置下拉框數(shù)據(jù)范圍 (這里設置從第2行到第10000行)
            CellRangeAddressList addressList = new CellRangeAddressList(1, 9999, columnIndex, columnIndex);

            // 創(chuàng)建數(shù)據(jù)驗證約束
            DataValidationConstraint constraint = helper.createExplicitListConstraint(dropDownData);

            // 創(chuàng)建數(shù)據(jù)驗證
            DataValidation validation = helper.createValidation(constraint, addressList);

            // 阻止輸入非下拉選項的值
            validation.setErrorStyle(DataValidation.ErrorStyle.STOP);
            validation.setShowErrorBox(true);
            validation.setSuppressDropDownArrow(true);
            validation.createErrorBox("提示", "請從下拉選項中選擇");

            // 添加驗證到sheet
            sheet.addValidationData(validation);
        });
    }
}

3、自定義鎖定行/列，添加密碼

@Override
    public void afterCellCreate(CellWriteHandlerContext context) {
        WriteSheetHolder writeSheetHolder = context.getWriteSheetHolder();
        Sheet sheet = writeSheetHolder.getSheet();
        Workbook workbook = sheet.getWorkbook();
        Cell cell = context.getCell();
        int columnIndex = cell.getColumnIndex();
        Row row = cell.getRow();

        // 設置工作表保護
        if (!sheet.getProtect()) {
            XSSFSheet xssfSheet = (XSSFSheet) sheet;
            // 啟用保護
            xssfSheet.protectSheet("1234");
            // 設置保護選項：允許刪除未鎖定行
            xssfSheet.lockDeleteRows(false);
            // 設置保護選項：允許插入未鎖定行
            xssfSheet.lockInsertRows(false);
        }

        // 設置工作表的默認單元格樣式為不鎖定
        CellStyle defaultStyle = workbook.createCellStyle();
        defaultStyle.setLocked(false);
        sheet.setDefaultColumnStyle(columnIndex, defaultStyle);
        row.setRowStyle(defaultStyle);
    }

4、合并單元格

sheet.addMergedRegion(new CellRangeAddress(relativeRowIndex, relativeRowIndex, 0, 10));

5、導入自定義統(tǒng)一注解統(tǒng)一校驗

package com.example.springbootexcel.excel.base.component;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * tips：非必填校驗，填了就校驗，不填不校驗
 */
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.FIELD})
public @interface ExcelValidation {

    /**
     * 日期校驗
     *
     * @return true表示必須為日期，false表示不限制
     */
    boolean date() default false;

    /**
     * 是否必須為數(shù)字
     *
     * @return true表示必須為數(shù)字，false表示不限制
     */
    boolean numeric() default false;

    /**
     * 是否允許小數(shù)，且最多兩位小數(shù)
     *
     * @return true表示允許最多兩位小數(shù)，false表示不允許小數(shù)
     */
    boolean decimal() default false;

    /**
     * 是否允許斜杠
     *
     * @return true表示允許斜杠，false表示不允許
     */
    boolean allowSlash() default false;

    /**
     * 校驗失敗時的錯誤提示信息
     *
     * @return 錯誤提示信息
     */
    String message() default "字段校驗失敗";

}

6、樣式處理（字體，顏色，底色，富文本，列寬，行寬等）

// 基本樣式設置
        cellStyle.setBorderTop(BorderStyle.THIN);
        cellStyle.setBorderBottom(BorderStyle.THIN);
        cellStyle.setBorderLeft(BorderStyle.THIN);
        cellStyle.setBorderRight(BorderStyle.THIN);
        // 設置水平對齊為左對齊
        cellStyle.setAlignment(HorizontalAlignment.LEFT);
        // 設置垂直對齊為垂直居中
        cellStyle.setVerticalAlignment(VerticalAlignment.CENTER);
        // 設置自動換行
        cellStyle.setWrapText(true);

        // 創(chuàng)建默認字體
        Font defaultFont = workbook.createFont();
        defaultFont.setFontName(DEFAULT_FONT_NAME);
        defaultFont.setFontHeightInPoints(DEFAULT_FONT_POINTS);
        defaultFont.setColor(IndexedColors.BLACK.getIndex());
        defaultFont.setBold(false);

        // 創(chuàng)建紅色字體
        Font redFont = workbook.createFont();
        redFont.setFontName(DEFAULT_FONT_NAME);
        redFont.setFontHeightInPoints(DEFAULT_FONT_POINTS);
        redFont.setColor(IndexedColors.RED.getIndex());
        redFont.setBold(true);

        // 自定義列寬
        String cellValue = cell.getStringCellValue();
        Integer columnWidth = COLUMN_WIDTHS.get(cellValue);
        if (ObjectUtil.isNotNull(columnWidth) && !CollectionUtil.contains(COLUMN_WIDTHS_EXIST, context.getColumnIndex())) {
            sheet.setColumnWidth(context.getColumnIndex(), columnWidth);
            COLUMN_WIDTHS_EXIST.add(context.getColumnIndex());
        }
        // 設置默認寬度
        if (!CollectionUtil.contains(COLUMN_WIDTHS_EXIST, context.getColumnIndex())) {
            sheet.setColumnWidth(context.getColumnIndex(), DEFAULT_COLUMN_WIDTH);
        }

        // 提示詞
        if (CollectionUtil.contains(TIPS_LIST, relativeRowIndex)) {
            defaultFont = redFont;
            // 合并單元格
            sheet.addMergedRegion(new CellRangeAddress(relativeRowIndex, relativeRowIndex, 0, 10));
        }
        // 表頭
        if (CollectionUtil.contains(HEAD_LIST, relativeRowIndex)) {
            defaultFont.setBold(true);
            // 背景色
            cellStyle.setFillForegroundColor(IndexedColors.GREY_25_PERCENT.getIndex());
            cellStyle.setFillPattern(FillPatternType.SOLID_FOREGROUND);

            // 動態(tài)字段標紅
            if (CollectionUtil.contains(HEAD_READ_COLOR, cell.getColumnIndex())) {
                defaultFont = redFont;
            } else {
                // 星號標紅
                RichTextString richText = cell.getRichStringCellValue();
                if (StrUtil.startWith(cellValue, "*")) {
                    richText.applyFont(0, 1, redFont);
                    if (cellValue.length() > 1) {
                        richText.applyFont(1, cellValue.length(), defaultFont);
                    }
                    cell.setCellValue(richText);
                }
            }
        }
        cellStyle.setFont(defaultFont);

7、凍結窗格

.registerWriteHandler(new FreezePaneHandler(2))

package com.example.springbootexcel.excel.base.style;

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.Sheet;

/**
 * 凍結窗格
 *
 * @author jason
 */
public class FreezePaneHandler implements SheetWriteHandler {
    private final int row;  // 需要凍結的行

    public FreezePaneHandler(int row) {
        this.row = row;
    }

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

    @Override
    public void afterSheetCreate(WriteWorkbookHolder writeWorkbookHolder, WriteSheetHolder writeSheetHolder) {
        Sheet sheet = writeSheetHolder.getSheet();
        // 凍結首行
        // sheet.createFreezePane(0, 1, 0, 1);

        sheet.createFreezePane(0, row, 0, row);
    }

}

8、多Sheet處理

        // 創(chuàng)建 ExcelWriter 對象
        ExcelWriter excelWriter = EasyExcel.write(filePath).inMemory(true).build();

        // 寫入第1個 Sheet
        WriteSheet sheet1 = EasyExcel.writerSheet("Sheet1")
                .registerWriteHandler(new CommonStyleHandler(MockDataUtil.getHeadReadColor(headList, dynamicList)))
                .registerWriteHandler(new DropDownHandler(dropDownMap))
                .registerWriteHandler(new FreezePaneHandler(2))
                .build();
        excelWriter.write(sheet1DataList, sheet1);

        // 寫入第2個 Sheet
        WriteSheet sheet2 = EasyExcel.writerSheet("Sheet2")
                .head(BrandModelExcel.class)
                .registerWriteHandler(new FreezePaneHandler(1))
                .build();
        excelWriter.write(MockDataUtil.brandModelExcelList(), sheet2);

        // 寫入第3個 Sheet
        WriteSheet sheet3 = EasyExcel.writerSheet("Sheet3")
                .head(VehicleNameExcel.class)
                .registerWriteHandler(new FreezePaneHandler(1))
                .build();
        excelWriter.write(MockDataUtil.vehicleNameExcelList(), sheet3);

        // 非常重要：最后一定要關閉 excelWriter
        excelWriter.finish();

        log.info("導出成功：{}", filePath);

源碼：https://gitee.com/zhaomingjian/workspace_dora/tree/master/spring-boot-excel

到此這篇關于SpringBoot+EasyExcel實現(xiàn)自定義復雜樣式導入導出的文章就介紹到這了,更多相關SpringBoot EasyExcel自定義樣式導入導出內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家！

您可能感興趣的文章:

一文帶你全面了解Java?Properties類
Properties是JDK1.0中引入的java類，目前也在項目中大量使用，主要用來讀取外部的配置，那除了這個，你對它其他的一些api也了解嗎？?你了解它是怎么實現(xiàn)的嗎??如果不清楚的話，就通過本篇文章帶你一探究竟
2022-09-09
IDEA 2020 無法啟動的解決辦法(啟動崩盤)附IDEA 2020 新功能
這篇文章主要介紹了IDEA 2020 無法啟動的解決辦法(啟動崩盤)附IDEA 2020 新功能，本文通過圖文并茂的形式給大家介紹的非常詳細，對大家的學習或工作具有一定的參考借鑒價值,需要的朋友可以參考下
2020-04-04
Java實現(xiàn)微信掃碼登入的實例代碼
這篇文章主要介紹了java實現(xiàn)微信掃碼登入功能，本文通過實例代碼給大家介紹的非常詳細，對大家的學習或工作具有一定的參考借鑒價值,需要的朋友可以參考下
2020-06-06
Java設計模式之抽象工廠模式
這篇文章主要為大家詳細介紹了Java設計模式之抽象工廠模式的相關資料，具有一定的參考價值，感興趣的小伙伴們可以參考一下
2018-03-03
SpringBoot整合MD5加密完成注冊和登錄方式
MD5（MessageDigestAlgorithm5）是一種常見的哈希算法,用于生成固定長度（128位）的哈希值,主要應用于數(shù)據(jù)完整性校驗和密碼存儲,MD5具有快速計算、不可逆性和抗碰撞性等特點,盡管存在碰撞漏洞,MD5仍廣泛應用于文件下載校驗和數(shù)字簽名等場景
2024-10-10
java實現(xiàn)播放背景音樂
這篇文章主要為大家詳細介紹了java實現(xiàn)播放背景音樂，文中示例代碼介紹的非常詳細，具有一定的參考價值，感興趣的小伙伴們可以參考一下
2021-03-03
Java實現(xiàn)超市會員管理系統(tǒng)
這篇文章主要為大家詳細介紹了Java實現(xiàn)超市會員管理系統(tǒng)，文中示例代碼介紹的非常詳細，具有一定的參考價值，感興趣的小伙伴們可以參考一下
2022-03-03
Feign使用@PathVariable方式
Feign使用@PathVariable注解在URL中插入變量,類似于SpringMVC的用法,通過示例展示了如何使用該注解,并在實際調(diào)用中替換占位符
2024-11-11
SpringBoot整合Redis實現(xiàn)緩存分頁數(shù)據(jù)查詢功能
類似淘寶首頁，這些商品是從數(shù)據(jù)庫中查出來的嗎，答案肯定不是，本文我們就通過一個案例實操一下，首頁熱點數(shù)據(jù)怎么放到Redis中去查詢，感興趣的同學可以參考一下
2023-06-06
SpringMVC中的HandlerMappingIntrospector工具類詳解
這篇文章主要介紹了SpringMVC中的HandlerMappingIntrospector工具類詳解,這是一個Spring MVC助手類,用于集合應用所配置的HandlerMapping(url pattern和請求處理handler之間的映射)表,用于獲取針對某個請求的如下信息,需要的朋友可以參考下
2023-12-12