使用Freemarker模版导出xls文件使用excel打开提示文件损坏

本文是通过一步步的还原事件的发生并解决的一个过程记录,如果想知道如何解决的可以直接跳转文章末尾结论部分

提示一下,关注一下 Table 标签中的 ss:ExpandedRowCount 属性

解决的问题

在项目中使用freemarker的xml模板导出xls格式的Excel文件时,使用国产Office工具可以打开查看,使用Excel打开提示文件已损坏

关键词

国产office,Excel,freemarker

环境信息

  • Windows 11
  • office 2019
  • 永中office2022体验版
  • JDK8
  • springboot 2.6.13
  • freemarker 2.6.13

事件还原

1、首先使用Excel创建一个空白excel文件,输入我们要导出的表格模板,如下图所示,我们创建一个表格,表格中导出姓名、年龄、电话、住址等信息的这样一个表格,并且添加了一行示例数据

使用Freemarker模版导出xls文件使用excel打开提示文件损坏_第1张图片

2、点击另存为,选中xml格式导出

使用Freemarker模版导出xls文件使用excel打开提示文件损坏_第2张图片

3、打开xml文件,修改添加数据的地方,使用freemarker语法遍历输出数据

修改前如下图所示

使用Freemarker模版导出xls文件使用excel打开提示文件损坏_第3张图片

修改后如下图所示

使用Freemarker模版导出xls文件使用excel打开提示文件损坏_第4张图片

其中的#list为固定语法,resultList为获取输入模板数据的key,该值是一个Listas item是*List**中的每一个对象以item来遍历

item.name为获取姓名,item.age为获取年龄,item.phont为获取电话,item.address为获取住址

${item.name!''}的完整意思就是输出用户名,为空时输出为空

4、创建springboot程序,并在resources下创建freemarker目录,继续创建test.xml模板文件,test.xml文件内容就是上一步我们修改完成之后的xml文件,结构如下

使用Freemarker模版导出xls文件使用excel打开提示文件损坏_第5张图片

文件内容如下(本内容为Excel打开异常的,如需正常的,需跳转文章末尾

提示一下,关注一下 Table 标签中的 ss:ExpandedRowCount 属性




    
        zuiyu
        zuiyu
        2023-07-26T02:16:31Z
        2023-07-26T02:18:00Z
        16.00
    
    
        
    
    
        5880
        14400
        32767
        32767
        False
        False
    
    
        
    
    
        
                姓名
                年龄
                电话
                住址
            
            <#list resultList as item>
            
                ${item.name!''}
                ${item.age!''}
                ${item.phone!''}
                ${item.address!''}
            
3 4 5 False False

5、编写导出excel文件的代码,都是测试数据,看看就好,只是举个例子

需要关注的点是,我们此处导出的用户数据为100,而上文中提示需要关注的参数ss:ExpandedRowCount参数值为2,这就是后文要探讨的关键所在

package com.example.exceldemo.demos.excel;

import freemarker.template.Configuration;
import freemarker.template.Template;
import freemarker.template.TemplateException;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import javax.servlet.ServletOutputStream;
import javax.servlet.http.HttpServletResponse;
import java.io.BufferedWriter;
import java.io.IOException;
import java.io.OutputStreamWriter;
import java.net.URLEncoder;
import java.util.*;

/**
 * @Author zuiyu
 * @Date 2023/7/26 10:26
 */
@RestController
@RequestMapping("/excel")
public class ExcelController {
    @GetMapping("/export")
    public void export(HttpServletResponse response) throws IOException, TemplateException {
        Configuration configuration = new Configuration(Configuration.VERSION_2_3_26);
        configuration.setDefaultEncoding("utf-8");
        configuration.setClassForTemplateLoading(getClass(),"/freemarker");
        Template template = configuration.getTemplate("test.xml");
        List list = new ArrayList<>();
        for (int i = 0; i < 100; i++) {
            Person person1 = new Person();
            person1.setName("测试用户名:"+i);
            person1.setAge((i+1)*2);
            person1.setPhone(new Random().nextInt(100));
            person1.setAddress("地址:"+i);
            list.add(person1);
        }

        Map map = new HashMap<>();
        map.put("resultList",list);
        ServletOutputStream outputStream = response.getOutputStream();
        response.setContentType("application/octet-stream");
        response.setHeader("Content-Disposition", "attachment; filename=" + URLEncoder.encode("测试xml导出excel.xls", "UTF-8"));
        BufferedWriter bw = new BufferedWriter(new OutputStreamWriter(outputStream));
        template.process(map,bw);
        bw.flush();
        bw.close();
        System.out.println("导出成功");

    }
}

6、下面执行接口http://localhost:8080/excel/export导出xls文件进行查看文件内容,我们的预期就是国产Office可以打开观看,而Excel打开时提示文件已损坏。打开结果就不进行展示了,感兴趣的可以使用上面的代码进行一下测试

7、下面我们修改ss:ExpandedRowCount="2"ss:ExpandedRowCount="9999",这样就可以容纳我们的100条记录。此时重启程序进行导出我们就可以发现不管是使用Excel查看还是国产Office查看都可以进行正常的显示了

8、下面是修改之后的完整的xml文件内容




    
        zuiyu
        zuiyu
        2023-07-26T02:16:31Z
        2023-07-26T02:18:00Z
        16.00
    
    
        
    
    
        5880
        14400
        32767
        32767
        False
        False
    
    
        
    
    
        
                姓名
                年龄
                电话
                住址
            
            <#list resultList as item>
            
                ${item.name!''}
                ${item.age!''}
                ${item.phone!''}
                ${item.address!''}
            
3 4 5 False False

总结

通过这次实验可以得知,文件的打开失败的根本原因就是数据行超过了设置的ExpandedRowCount属性值。而我们要做的就是修改该值到能容纳我们要导出的数据即可。甚至是可以改为变量读取数据长度是否可行 。

如果感觉有用的话欢迎点赞、收藏、转发,关注公众号《醉鱼Java》获取一手面试资料,一起学编程

本文由 mdnice 多平台发布

你可能感兴趣的:(后端)