Easyexcel（4-模板文件）

爱编程的小生2024-11-22 11:55

相关文章链接

  1. Easyexcel（1-注解使用）
  2. Easyexcel（2-文件读取）
  3. Easyexcel（3-文件导出）
  4. Easyexcel（4-模板文件）

文件导出

获取 resources 目录下的文件，使用 withTemplate 获取文件流导出文件模板

java 复制代码 
@GetMapping("/download1")
public void download1(HttpServletResponse response) {
    try (InputStream in = new ClassPathResource("测试.xls").getInputStream()) {
        response.setContentType("application/vnd.ms-excel");
        response.setCharacterEncoding("utf-8");
        // 这里URLEncoder.encode可以防止中文乱码 当然和easyexcel没有关系
        String fileName = URLEncoder.encode("测试", "UTF-8").replaceAll("\\+", "%20");
        response.setHeader("Content-disposition", "attachment;filename=" + fileName + ".xls");

        EasyExcel.write(response.getOutputStream())
                .withTemplate(in)
                .sheet("sheet1")
                .doWrite(Collections.emptyList());
    } catch (Exception e) {
        e.printStackTrace();
    }
}

注意：获取 resources 目录下的文件需要在 maven 中添加以下配置，过滤对应的文件，防止编译生成后的 class 文件找不到对应的文件信息

xml 复制代码 
<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-resources-plugin</artifactId>
    <configuration>
        <encoding>UTF-8</encoding>
        <nonFilteredFileExtensions>
            <nonFilteredFileExtension>xls</nonFilteredFileExtension>
            <nonFilteredFileExtension>xlsx</nonFilteredFileExtension>
        </nonFilteredFileExtensions>
    </configuration>
</plugin>

对象填充导出

模板文件信息

java 复制代码 
@AllArgsConstructor
@NoArgsConstructor
@Data
public class User {

    @ExcelProperty(value = "用户Id")
    private Integer userId;

    @ExcelProperty(value = "姓名")
    private String name;

    @ExcelProperty(value = "手机")
    private String phone;

    @ExcelProperty(value = "邮箱")
    private String email;

    @ExcelProperty(value = "创建时间")
    private Date createTime;
}
java 复制代码 
@GetMapping("/download5")
public void download5(HttpServletResponse response) {
    try (InputStream in = new ClassPathResource("测试3.xls").getInputStream()) {
        response.setContentType("application/vnd.ms-excel");
        response.setCharacterEncoding("utf-8");
        // 这里URLEncoder.encode可以防止中文乱码 当然和easyexcel没有关系
        String fileName = URLEncoder.encode("测试3", "UTF-8").replaceAll("\\+", "%20");
        response.setHeader("Content-disposition", "attachment;filename=" + fileName + ".xls");

        User user = new User(1, "张三", "12345678901", "zhangsan@qq.com", new Date());
        EasyExcel.write(response.getOutputStream(), User.class)
                .withTemplate(in)
                .sheet("模板")
                .doFill(user);
    } catch (Exception e) {
        e.printStackTrace();
    }
}

注意：填充模板跟写文件使用的方法不一致，模板填充使用的方法是 doFill，而不是 doWrite

导出文件内容

List 填充导出

对象导出

模板文件信息

java 复制代码 
@AllArgsConstructor
@NoArgsConstructor
@Data
public class User {

    @ExcelProperty(value = "用户Id")
    private Integer userId;

    @ExcelProperty(value = "姓名")
    private String name;

    @ExcelProperty(value = "手机")
    private String phone;

    @ExcelProperty(value = "邮箱")
    private String email;

    @ExcelProperty(value = "创建时间")
    private Date createTime;
}
java 复制代码 
@GetMapping("/download2")
public void download2(HttpServletResponse response) {
    try (InputStream in = new ClassPathResource("测试.xls").getInputStream()) {
        response.setContentType("application/vnd.ms-excel");
        response.setCharacterEncoding("utf-8");
        // 这里URLEncoder.encode可以防止中文乱码 当然和easyexcel没有关系
        String fileName = URLEncoder.encode("测试", "UTF-8").replaceAll("\\+", "%20");
        response.setHeader("Content-disposition", "attachment;filename=" + fileName + ".xls");

        List<User> userList = new ArrayList<>();
        userList.add(new User(1, "张三", "12345678901", "zhangsan@qq.com", new Date()));
        userList.add(new User(2, "李四", "12345678902", "lisi@qq.com", new Date()));
        EasyExcel.write(response.getOutputStream(), User.class)
                .withTemplate(in)
                .sheet("模板")
                .doFill(userList);
    } catch (Exception e) {
        e.printStackTrace();
    }
}

导出文件内容

对象嵌套对象（默认不支持）

原因排查

模板文件信息

java 复制代码 
@AllArgsConstructor
@NoArgsConstructor
@Data
public class User {

    @ExcelProperty(value = "用户Id")
    private Integer userId;

    @ExcelProperty(value = "姓名")
    private String name;

    @ExcelProperty(value = "手机")
    private String phone;

    @ExcelProperty(value = "邮箱")
    private String email;

    @ExcelProperty(value = "学生")
    private Student stu;

    @NoArgsConstructor
    @AllArgsConstructor
    @Data
    public static class Student {

        @ExcelProperty("姓名")
        private String name;

        @ExcelProperty("年龄")
        private Integer age;
    }
}
java 复制代码 
@GetMapping("/download3")
public void download3(HttpServletResponse response) {
    try (InputStream in = new ClassPathResource("测试2.xls").getInputStream()) {
        response.setContentType("application/vnd.ms-excel");
        response.setCharacterEncoding("utf-8");
        // 这里URLEncoder.encode可以防止中文乱码 当然和easyexcel没有关系
        String fileName = URLEncoder.encode("测试2", "UTF-8").replaceAll("\\+", "%20");
        response.setHeader("Content-disposition", "attachment;filename=" + fileName + ".xls");

        List<User> userList = new ArrayList<>();
        userList.add(new User(1, "张三", "12345678901", "zhangsan@qq.com", new User.Student("张三", 12)));
        userList.add(new User(2, "李四", "12345678902", "lisi@qq.com", new User.Student("李四", 13)));
        EasyExcel.write(response.getOutputStream(), User.class)
                .withTemplate(in)
                .sheet("模板")
                .doFill(userList);
    } catch (Exception e) {
        e.printStackTrace();
    }
}

导出文件内容

结果：Student 类的内容没有填充到模板文件中

查看 ExcelWriteFillExecutor 源码

可以看到 dataKeySet 集合中的数据只有 stu（没有 stu.name 和 stu.age），在! dataKeySet.contains(variable)方法中判断没有包含该字段信息，所以被过滤掉

修改源码支持

在 com.alibaba.excel.write.executor 包下创建 ExcelWriteFillExecutor 类，跟源码中的类名称一致，尝试修改 analysisCell.getOnlyOneVariable()方法中的逻辑以便支持嵌套对象，修改如下：

根据分隔符.进行划分，循环获取对象中字段的数据，同时在 FieldUtils.getFieldClass 方法中重新设置 map 对象和字段

java 复制代码 
if (analysisCell.getOnlyOneVariable()) {
    String variable = analysisCell.getVariableList().get(0);
    String[] split = variable.split("\\.");

    Map map = BeanUtil.copyProperties(dataMap, Map.class);
    Object value = null;
    if (split.length == 1) {
        value = map.get(variable);
    } else {
        int len = split.length - 1;
        for (int i = 0; i < len; i++) {
            Object o = map.get(split[i]);
            map = BeanMapUtils.create(o);
        }
        value = map.get(split[split.length - 1]);
    }

    ExcelContentProperty excelContentProperty = ClassUtils.declaredExcelContentProperty(map,
            writeContext.currentWriteHolder().excelWriteHeadProperty().getHeadClazz(), split[split.length - 1],
            writeContext.currentWriteHolder());
    cellWriteHandlerContext.setExcelContentProperty(excelContentProperty);

    createCell(analysisCell, fillConfig, cellWriteHandlerContext, rowWriteHandlerContext);
    cellWriteHandlerContext.setOriginalValue(value);
    cellWriteHandlerContext.setOriginalFieldClass(FieldUtils.getFieldClass(map, split[split.length - 1], value));

    converterAndSet(cellWriteHandlerContext);
    WriteCellData<?> cellData = cellWriteHandlerContext.getFirstCellData();

    // Restyle
    if (fillConfig.getAutoStyle()) {
        Optional.ofNullable(collectionFieldStyleCache.get(currentUniqueDataFlag))
                .map(collectionFieldStyleMap -> collectionFieldStyleMap.get(analysisCell))
                .ifPresent(cellData::setOriginCellStyle);
    }
}

导出文件内容

查看导出的文件内容，此时发现嵌套对象的内容可以导出了

对象嵌套 List（默认不支持）

原因排查

模板文件信息

java 复制代码 
@AllArgsConstructor
@NoArgsConstructor
@Data
public class User {

    @ExcelProperty(value = "用户Id")
    private Integer userId;

    @ExcelProperty(value = "姓名")
    private String name;

    @ExcelProperty(value = "手机")
    private String phone;

    @ExcelProperty(value = "邮箱")
    private String email;

    @ExcelProperty(value = "创建时间")
    private Date createTime;

    @ExcelProperty(value = "id列表")
    private List<String> idList;
}
java 复制代码 
@GetMapping("/download4")
public void download4(HttpServletResponse response) {
    try (InputStream in = new ClassPathResource("测试2.xls").getInputStream()) {
        response.setContentType("application/vnd.ms-excel");
        response.setCharacterEncoding("utf-8");
        // 这里URLEncoder.encode可以防止中文乱码 当然和easyexcel没有关系
        String fileName = URLEncoder.encode("测试", "UTF-8").replaceAll("\\+", "%20");
        response.setHeader("Content-disposition", "attachment;filename=" + fileName + ".xls");

        List<User> userList = new ArrayList<>();
        userList.add(new User(1, "张三", "12345678901", "zhangsan@qq.com", new Date(), Arrays.asList("234", "465")));
        userList.add(new User(2, "李四", "12345678902", "lisi@qq.com", new Date(), Arrays.asList("867", "465")));
        EasyExcel.write(response.getOutputStream(), User.class)
                .withTemplate(in)
                .sheet("模板")
                .doFill(userList);
    } catch (Exception e) {
        e.printStackTrace();
    }
}

执行后会发现报错 Can not find 'Converter' support class ArrayList.

EasyExcel 默认不支持对象嵌套 List 的，可以通过自定义转换器的方式修改导出的内容

自定义转换器

java 复制代码 
public class ListConvert implements Converter<List> {

    @Override
    public WriteCellData<?> convertToExcelData(List value, ExcelContentProperty contentProperty, GlobalConfiguration globalConfiguration) {
        if (value == null || value.isEmpty()) {
            return new WriteCellData<>("");
        }
        String val = (String) value.stream().collect(Collectors.joining(","));
        return new WriteCellData<>(val);
    }

    @Override
    public List convertToJavaData(ReadCellData<?> cellData, ExcelContentProperty contentProperty, GlobalConfiguration globalConfiguration) {
        if (cellData.getStringValue() == null || cellData.getStringValue().isEmpty()) {
            return new ArrayList<>();
        }
        List list = new ArrayList();
        String[] items = cellData.getStringValue().split(",");
        Collections.addAll(list, items);
        return list;
    }
}
java 复制代码 
@AllArgsConstructor
@NoArgsConstructor
@Data
public class User {

    @ExcelProperty(value = "用户Id")
    private Integer userId;

    @ExcelProperty(value = "姓名")
    private String name;

    @ExcelProperty(value = "手机")
    private String phone;

    @ExcelProperty(value = "邮箱")
    private String email;

    @ExcelProperty(value = "创建时间")
    private Date createTime;

    @ExcelProperty(value = "id列表", converter = ListConvert.class)
    private List<String> idList;
}

导出文件内容

可以看到 List 列表的数据导出内容为 String 字符串，显示在一个单元格内

Map 填充导出

简单导出

模板文件信息

注意：map跟对象导出有所区别，最前面没有.

java 复制代码 
@GetMapping("/download4")
public void download4(HttpServletResponse response) {
    try (InputStream in = new ClassPathResource("测试3.xls").getInputStream()) {
        response.setContentType("application/vnd.ms-excel");
        response.setCharacterEncoding("utf-8");
        // 这里URLEncoder.encode可以防止中文乱码 当然和easyexcel没有关系
        String fileName = URLEncoder.encode("测试", "UTF-8").replaceAll("\\+", "%20");
        response.setHeader("Content-disposition", "attachment;filename=" + fileName + ".xls");

        Map<String, String> map = new HashMap<>();
        map.put("userId", "123");
        map.put("name", "张三");
        map.put("phone", "12345678901");
        map.put("email", "zhangsan@qq.com");
        map.put("createTime", "2021-01-01");
        EasyExcel.write(response.getOutputStream(), User.class)
                .withTemplate(in)
                .sheet("模板")
                .doFill(map);
    } catch (Exception e) {
        e.printStackTrace();
    }
}

导出文件内容

嵌套方式（不支持）

模板文件信息

java 复制代码 
@GetMapping("/download4")
public void download4(HttpServletResponse response) {
    try (InputStream in = new ClassPathResource("测试3.xls").getInputStream()) {
        response.setContentType("application/vnd.ms-excel");
        response.setCharacterEncoding("utf-8");
        // 这里URLEncoder.encode可以防止中文乱码 当然和easyexcel没有关系
        String fileName = URLEncoder.encode("测试", "UTF-8").replaceAll("\\+", "%20");
        response.setHeader("Content-disposition", "attachment;filename=" + fileName + ".xls");

        Map<String, String> map = new HashMap<>();
        map.put("userId", "123");
        map.put("name", "张三");
        map.put("phone", "12345678901");
        map.put("email", "zhangsan@qq.com");
        map.put("createTime", "2021-01-01");
        map.put("student.name", "小张");
        map.put("student.age", "23");
        EasyExcel.write(response.getOutputStream(), User.class)
                .withTemplate(in)
                .sheet("模板")
                .doFill(map);
    } catch (Exception e) {
        e.printStackTrace();
    }
}

导出文件内容

注意：Easyexcel 不支持嵌套的方式导出数据

相关推荐
禁默30 分钟前
深入浅出：AWT的基本组件及其应用
java·开发语言·界面编程
Cachel wood37 分钟前
python round四舍五入和decimal库精确四舍五入
java·linux·前端·数据库·vue.js·python·前端框架
Code哈哈笑40 分钟前
【Java 学习】深度剖析Java多态：从向上转型到向下转型，解锁动态绑定的奥秘，让代码更优雅灵活
java·开发语言·学习
gb421528743 分钟前
springboot中Jackson库和jsonpath库的区别和联系。
java·spring boot·后端
程序猿进阶43 分钟前
深入解析 Spring WebFlux：原理与应用
java·开发语言·后端·spring·面试·架构·springboot
zfoo-framework1 小时前
【jenkins插件】
java
风_流沙1 小时前
java 对ElasticSearch数据库操作封装工具类（对你是否适用嘞）
java·数据库·elasticsearch
ProtonBase1 小时前
如何从 0 到 1 ，打造全新一代分布式数据架构
java·网络·数据库·数据仓库·分布式·云原生·架构
乐之者v2 小时前
leetCode43.字符串相乘
java·数据结构·算法
热门推荐
01〔AI 绘画〕Stable Diffusion 之 解决绘制多人或面部很小的人物时面部崩坏问题 篇02ARM学习（31）编译器对overlay方式的支持03玄机平台应急响应—webshell查杀04DisplayPort AltMode On Type-c协议_Ver2.0(学习笔记)05校验 GPT-4 真实性的三个经典问题：快速区分 GPT-3.5 与 GPT-4，并提供免费测试网站06Docker 夺命连环 15 问076个主流的工业3D管道设计软件08基于大语言模型（LLM）的合成数据生成、策展和评估的综述09(欧拉)openEuler系统添加网卡文件配置流程、(欧拉)openEuler系统手动配置ipv6地址流程、(欧拉)openEuler系统网络管理说明10红米手机使用google play