编程技术分享平台

网站首页 > 技术教程 正文

EasyExcel 整合 SpringBoot :EasyExcel 填充数据实操展示

xnh888 2025-02-08 13:21:10 技术教程 32 ℃ 0 评论
  • 官方演示地址：https://github.com/alibaba/easyexcel/blob/master/easyexcel-test/src/test/java/com/alibaba/easyexcel/test/demo/fill/FillTest.java
  • 官方文档演示：填充Excel | Easy Excel 官网 (alibaba.com)

一、前提准备

温馨提示：本文撰写时 alibaba/easyexcel 版本为 4.0.1 ，本文的版本已足够演示填充数据所涵盖的演示操作演示。

（1）引入maven依赖


    cn.hutool
    hutool-all
    5.7.22




    com.alibaba
    easyexcel
    3.3.2



    org.projectlombok
    lombok
    true

（2）代码准备

定义一个业务实体对象

@Data
@Builder
class Student {
    /** 成绩 */
    private String name;
    /** 年龄 */
    private Integer age;
    /** 分数 */
    private Double score;
    /** 考试日期 */
    private LocalDate testDate;
}

定义一个数据集合方法

private static List data(int dataTotal) {
    List students = new ArrayList<>();
    students.add(Student.builder().name("Allen").age(23).score(85.5).testDate(LocalDate.now()).build());
    students.add(Student.builder().name("Bob").age(23).score(55.5).testDate(LocalDate.now()).build());
    students.add(Student.builder().name("诸葛亮").age(73).score(95.5).testDate(LocalDate.now()).build());
    students.add(Student.builder().name("孙悟空").age(523).score(85.5).testDate(LocalDate.now()).build());
    for (int i = 0; i < dataTotal; i++) {
        students.add(Student.builder().name("孙悟空" + i).age(10 + i).score(60D + i).testDate(LocalDate.now()).build());
    }
    return students;
}

二、EasyExcel 整合 SpringBoot

注意每个使用方法的 版本，有些用法会再不同的版本上存在差异，具体根据项目中引入的 easyexcel 版本确定使用调整即可。

（1）简单填充

填充模板示例


填充结果示例


完整演示源码

public static void testFillSimple() {
    // 模板注意 用{} 来表示你要用的变量 如果本来就有"{","}" 特殊字符 用"\{","\}"代替
    String templateFileName =  fileDir + "simple.xlsx";

    // 方案1 根据对象填充
    String fileName =  fileDir + "simpleFill" + System.currentTimeMillis() + ".xlsx";
    // 这里 会填充到第一个sheet， 然后文件流会自动关闭
    Student student = Student.builder().name("Bob").age(23).score(96.5).testDate(LocalDate.now()).build();
    EasyExcel.write(fileName).withTemplate(templateFileName).sheet().doFill(student);


    // 方案2 根据Map填充
    fileName = fileDir + "simpleFill" + System.currentTimeMillis() + ".xlsx";
    // 这里 会填充到第一个sheet， 然后文件流会自动关闭
    Map map = MapUtils.newHashMap();
    map.put("name", "张三");
    map.put("age", 25);
    map.put("score", 99.9);
    map.put("testDate", LocalDate.now().plusDays(1));
    EasyExcel.write(fileName).withTemplate(templateFileName).sheet().doFill(map);
}

（2）填充列表数据

excel 模板


填充完成


演示完整源码

public static void testFillListDate() {
    // 模板注意 用{} 来表示你要用的变量 如果本来就有"{","}" 特殊字符 用"\{","\}"代替
    // 填充list 的时候还要注意 模板中{.} 多了个点 表示list
    // 如果填充list的对象是map,必须包涵所有list的key,哪怕数据为null，必须使用map.put(key,null)
    String templateFileName = fileDir + "list.xlsx";


    // 方案1 一下子全部放到内存里面 并填充
    String fileName = fileDir + "listFill" + System.currentTimeMillis() + ".xlsx";
    // 这里 会填充到第一个sheet， 然后文件流会自动关闭
    EasyExcel.write(fileName).withTemplate(templateFileName).sheet().doFill(data(4));

    // 方案2 分多次 填充 会使用文件缓存（省内存）
    fileName = fileDir + "listFill" + System.currentTimeMillis() + ".xlsx";
    try (ExcelWriter excelWriter = EasyExcel.write(fileName).withTemplate(templateFileName).build()) {
        WriteSheet writeSheet = EasyExcel.writerSheet().build();
        excelWriter.fill(data(3), writeSheet);
    }
}

（3）复杂混合填充

填充模板demo


填充结果示例


完整演示代码

public static void testFillComplexData() {
    // 模板注意 用{} 来表示你要用的变量 如果本来就有"{","}" 特殊字符 用"\{","\}"代替
    // {} 代表普通变量 {.} 代表是list的变量
    String templateFileName = fileDir + "complex.xlsx";

    String fileName = fileDir + "complexFill" + System.currentTimeMillis() + ".xlsx";
    // 方案1
    try (ExcelWriter excelWriter = EasyExcel.write(fileName).withTemplate(templateFileName).build()) {
        WriteSheet writeSheet = EasyExcel.writerSheet().build();
        // 这里注意 入参用了forceNewRow 代表在写入list的时候不管list下面有没有空行 都会创建一行，然后下面的数据往后移动。默认 是false，会直接使用下一行，如果没有则创建。
        // forceNewRow 如果设置了true,有个缺点 就是他会把所有的数据都放到内存了，所以慎用
        // 简单的说 如果你的模板有list,且list不是最后一行，下面还有数据需要填充 就必须设置 forceNewRow=true 但是这个就会把所有数据放到内存 会很耗内存
        // 如果数据量大 list不是最后一行 参照下一个
        FillConfig fillConfig = FillConfig.builder().forceNewRow(Boolean.TRUE).build();
        // 填充一次
        excelWriter.fill(data(2), fillConfig, writeSheet);
        // 填充两次
        excelWriter.fill(data(3), fillConfig, writeSheet);
        Map map = MapUtils.newHashMap();
        map.put("date", "2019年10月9日13:28:28");
        map.put("total", 1000);
        excelWriter.fill(map, writeSheet);
    }
}

（4）横向填充

填充模板demo


填充结果示例


完整演示代码

public static void horizontalFill() {
    // 模板注意 用{} 来表示你要用的变量 如果本来就有"{","}" 特殊字符 用"\{","\}"代替
    // {} 代表普通变量 {.} 代表是list的变量
    String templateFileName = fileDir + "horizontal.xlsx";

    String fileName = fileDir + "horizontalFill" + System.currentTimeMillis() + ".xlsx";
    // 方案1
    try (ExcelWriter excelWriter = EasyExcel.write(fileName).withTemplate(templateFileName).build()) {
        WriteSheet writeSheet = EasyExcel.writerSheet().build();
        FillConfig fillConfig = FillConfig.builder().direction(WriteDirectionEnum.HORIZONTAL).build();
        excelWriter.fill(data(2), fillConfig, writeSheet);
        excelWriter.fill(data(1), fillConfig, writeSheet);

        Map map = new HashMap<>();
        map.put("date", "2024年07月19日 10:31:30");
        excelWriter.fill(map, writeSheet);
    }
}

（5）多列表横向竖向填充展示

填充模板 demo


填充结果


完整代码

public static void testCompositeFill() {
    // 模板注意 用{} 来表示你要用的变量 如果本来就有"{","}" 特殊字符 用"\{","\}"代替
    // {} 代表普通变量 {.} 代表是list的变量 {前缀.} 前缀可以区分不同的list
    String templateFileName = fileDir + "composite.xlsx";

    String fileName = fileDir+ "compositeFill" + System.currentTimeMillis() + ".xlsx";

    // 方案1
    try (ExcelWriter excelWriter = EasyExcel.write(fileName).withTemplate(templateFileName).build()) {
        WriteSheet writeSheet = EasyExcel.writerSheet().build();
        FillConfig fillConfig = FillConfig.builder().direction(WriteDirectionEnum.HORIZONTAL).build();
        // 如果有多个list 模板上必须有{前缀.} 这里的前缀就是 data1，然后多个list必须用 FillWrapper包裹
        excelWriter.fill(new FillWrapper("data1", data(1)), fillConfig, writeSheet);
        excelWriter.fill(new FillWrapper("data2", data(2)), writeSheet);;

        Map map = new HashMap<>();
        map.put("date", LocalDate.now());

        excelWriter.fill(map, writeSheet);
    }
}

三、上述演示汇总代码展示

汇总上述演示代码情况，用于更加完整的展示和清楚使用的情况。有整体的观摩了解！

package com.example.demo;

import com.alibaba.excel.EasyExcel;
import com.alibaba.excel.ExcelWriter;
import com.alibaba.excel.enums.WriteDirectionEnum;
import com.alibaba.excel.util.MapUtils;
import com.alibaba.excel.write.metadata.WriteSheet;
import com.alibaba.excel.write.metadata.fill.FillConfig;
import com.alibaba.excel.write.metadata.fill.FillWrapper;
import lombok.Builder;
import lombok.Data;

import java.time.LocalDate;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

/**
 * easy excel 填充模板 演示示例
 *
 * @author drew
 * @date 2024/7/19 上午9:40
 */
public class EasyExcelFillExcelTemplateTests {
    /** 演示文件存放目录 */
    private static final String fileDir = "D:/";

    public static void main(String[] args) {
        //testFillSimple();// 简单数据填充演示
        //testFillListDate();// 列表数据填充演示
        //testFillComplexData();// 复杂混合填充
        //horizontalFill();// 横向填充
        //testCompositeFill();// 多列表横向竖向混合填充
    }

    public static void testFillSimple() {
        // 模板注意 用{} 来表示你要用的变量 如果本来就有"{","}" 特殊字符 用"\{","\}"代替
        String templateFileName =  fileDir + "simple.xlsx";

        // 方案1 根据对象填充
        String fileName =  fileDir + "simpleFill" + System.currentTimeMillis() + ".xlsx";
        // 这里 会填充到第一个sheet， 然后文件流会自动关闭
        Student student = Student.builder().name("Bob").age(23).score(96.5).testDate(LocalDate.now()).build();
        EasyExcel.write(fileName).withTemplate(templateFileName).sheet().doFill(student);


        // 方案2 根据Map填充
        fileName = fileDir + "simpleFill" + System.currentTimeMillis() + ".xlsx";
        // 这里 会填充到第一个sheet， 然后文件流会自动关闭
        Map map = MapUtils.newHashMap();
        map.put("name", "张三");
        map.put("age", 25);
        map.put("score", 99.9);
        map.put("testDate", LocalDate.now().plusDays(1));
        EasyExcel.write(fileName).withTemplate(templateFileName).sheet().doFill(map);
    }

    public static void testFillListDate() {
        // 模板注意 用{} 来表示你要用的变量 如果本来就有"{","}" 特殊字符 用"\{","\}"代替
        // 填充list 的时候还要注意 模板中{.} 多了个点 表示list
        // 如果填充list的对象是map,必须包涵所有list的key,哪怕数据为null，必须使用map.put(key,null)
        String templateFileName = fileDir + "list.xlsx";


        // 方案1 一下子全部放到内存里面 并填充
        String fileName = fileDir + "listFill" + System.currentTimeMillis() + ".xlsx";
        // 这里 会填充到第一个sheet， 然后文件流会自动关闭
        EasyExcel.write(fileName).withTemplate(templateFileName).sheet().doFill(data(4));

        // 方案2 分多次 填充 会使用文件缓存（省内存）
        fileName = fileDir + "listFill" + System.currentTimeMillis() + ".xlsx";
        try (ExcelWriter excelWriter = EasyExcel.write(fileName).withTemplate(templateFileName).build()) {
            WriteSheet writeSheet = EasyExcel.writerSheet().build();
            excelWriter.fill(data(3), writeSheet);
        }
    }

    public static void testFillComplexData() {
        // 模板注意 用{} 来表示你要用的变量 如果本来就有"{","}" 特殊字符 用"\{","\}"代替
        // {} 代表普通变量 {.} 代表是list的变量
        String templateFileName = fileDir + "complex.xlsx";

        String fileName = fileDir + "complexFill" + System.currentTimeMillis() + ".xlsx";
        // 方案1
        try (ExcelWriter excelWriter = EasyExcel.write(fileName).withTemplate(templateFileName).build()) {
            WriteSheet writeSheet = EasyExcel.writerSheet().build();
            // 这里注意 入参用了forceNewRow 代表在写入list的时候不管list下面有没有空行 都会创建一行，然后下面的数据往后移动。默认 是false，会直接使用下一行，如果没有则创建。
            // forceNewRow 如果设置了true,有个缺点 就是他会把所有的数据都放到内存了，所以慎用
            // 简单的说 如果你的模板有list,且list不是最后一行，下面还有数据需要填充 就必须设置 forceNewRow=true 但是这个就会把所有数据放到内存 会很耗内存
            // 如果数据量大 list不是最后一行 参照下一个
            FillConfig fillConfig = FillConfig.builder().forceNewRow(Boolean.TRUE).build();
            // 填充一次
            excelWriter.fill(data(2), fillConfig, writeSheet);
            // 填充两次
            excelWriter.fill(data(3), fillConfig, writeSheet);
            Map map = MapUtils.newHashMap();
            map.put("date", "2019年10月9日13:28:28");
            map.put("total", 1000);
            excelWriter.fill(map, writeSheet);
        }
    }

    public static void horizontalFill() {
        // 模板注意 用{} 来表示你要用的变量 如果本来就有"{","}" 特殊字符 用"\{","\}"代替
        // {} 代表普通变量 {.} 代表是list的变量
        String templateFileName = fileDir + "horizontal.xlsx";

        String fileName = fileDir + "horizontalFill" + System.currentTimeMillis() + ".xlsx";
        // 方案1
        try (ExcelWriter excelWriter = EasyExcel.write(fileName).withTemplate(templateFileName).build()) {
            WriteSheet writeSheet = EasyExcel.writerSheet().build();
            FillConfig fillConfig = FillConfig.builder().direction(WriteDirectionEnum.HORIZONTAL).build();
            excelWriter.fill(data(2), fillConfig, writeSheet);
            excelWriter.fill(data(1), fillConfig, writeSheet);

            Map map = new HashMap<>();
            map.put("date", "2024年07月19日 10:31:30");
            excelWriter.fill(map, writeSheet);
        }
    }

    public static void testCompositeFill() {
        // 模板注意 用{} 来表示你要用的变量 如果本来就有"{","}" 特殊字符 用"\{","\}"代替
        // {} 代表普通变量 {.} 代表是list的变量 {前缀.} 前缀可以区分不同的list
        String templateFileName = fileDir + "composite.xlsx";

        String fileName = fileDir+ "compositeFill" + System.currentTimeMillis() + ".xlsx";

        // 方案1
        try (ExcelWriter excelWriter = EasyExcel.write(fileName).withTemplate(templateFileName).build()) {
            WriteSheet writeSheet = EasyExcel.writerSheet().build();
            FillConfig fillConfig = FillConfig.builder().direction(WriteDirectionEnum.HORIZONTAL).build();
            // 如果有多个list 模板上必须有{前缀.} 这里的前缀就是 data1，然后多个list必须用 FillWrapper包裹
            excelWriter.fill(new FillWrapper("data1", data(1)), fillConfig, writeSheet);
            excelWriter.fill(new FillWrapper("data2", data(2)), writeSheet);;

            Map map = new HashMap<>();
            map.put("date", LocalDate.now());

            excelWriter.fill(map, writeSheet);
        }
    }


    private static List data(int dataTotal) {
        List students = new ArrayList<>();
        students.add(Student.builder().name("Allen").age(23).score(85.5).testDate(LocalDate.now()).build());
        students.add(Student.builder().name("Bob").age(23).score(55.5).testDate(LocalDate.now()).build());
        students.add(Student.builder().name("诸葛亮").age(73).score(95.5).testDate(LocalDate.now()).build());
        students.add(Student.builder().name("孙悟空").age(523).score(85.5).testDate(LocalDate.now()).build());
        for (int i = 0; i < dataTotal; i++) {
            students.add(Student.builder().name("孙悟空" + i).age(10 + i).score(60D + i).testDate(LocalDate.now()).build());
        }
        return students;
    }
}

@Data
@Builder
class Student {
    /** 成绩 */
    private String name;
    /** 年龄 */
    private Integer age;
    /** 分数 */
    private Double score;
    /** 考试日期 */
    private LocalDate testDate;
}

附录

如果对你有帮助花，还起感谢 点赞收藏分享 哦

Tags：

猜你喜欢

本文暂时没有评论，来添加一个吧(●'◡'●)

欢迎 你 发表评论:

最近发表
标签列表
Copyright Your WebSite.Some Rights Reserved.