使用freemarker,数据导出word并下载

这篇具有很好参考价值的文章主要介绍了使用freemarker,数据导出word并下载。希望对大家有所帮助。如果存在错误或未考虑完全的地方,请大家不吝赐教,您也可以点击"举报违法"按钮提交疑问。

使用freemarker,导出制作好的ftl模板,并写入数据

一、背景

1.1 项目背景

  • 最近在开发一个项目,需要导出一些数据,然后写入到word文档中,然后再导出到本地,这个需求是比较常见的,但是我在网上找了很多资料,都没有找到一个比较好的解决方案,所以就自己写了一个,这里分享给大家,希望能帮助到大家。
  • 项目中使用的技术栈:freemarker
  • 项目中使用的依赖:
<dependency>
    <groupId>org.freemarker</groupId>
    <artifactId>freemarker</artifactId>
    <version>2.3.28</version>
</dependency>

二、实现

2.1 代码实现

  • 代码实现比较简单,就是先制作好ftl模板,然后在模板中标记好需要写入的数据的位置,然后在代码中将数据写入到模板中,然后再导出到本地,具体代码如下:
  • 1.首先创建一个ftl模板,这里我创建了一个test.ftl模板,模板中的内容如下:
<html>
<head>
  <title>Welcome!</title>
</head>
<body>
  <h1>Welcome ${user}!</h1>
  <p>We have there animals:
  <ul>
  <list animals as animal>
    <li>${animal.name} for ${animal.price} Euros
  </list>
  </ul>
  <include "common_footer.html">
</body>
</html>
  • 2.然后在查询数据中定义数据对象,使用@ExportWordField注解标记需要写入的数据,具体代码如下:
@Documented
@Target({ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
@Inherited
public @interface ExportWordField {

    //字段名称
    String fieldName() default "";

    //是否是文件名称字段,只有导出zip时才会用到
    boolean isFileNameFiled() default false;

    //文件名称字段排序,只有导出zip时才会用到
    int fileNameFiledSort() default 0;
}
//测试数据对象
@Data
public class Something{
    @ExportWordField(fieldName = "user",isFileNameFiled = true,fileNameFiledSort = 1)
    private String user;
    @ExportWordField(fieldName = "animals")
    private List<Animal> animals;
}

@Data
public class Animal{
    @ExportWordField(fieldName = "name")
    private String name;
    @ExportWordField(fieldName = "price")
    private String price;
}
  • 3.然后在代码中将数据写入到模板中,具体代码如下:
@Slf4j
public class ExportTemplateUtil {

    private static final String DOC_SUFFIX = ".doc";

    /**
     * @Description: 导出word文件放在zip里面
     * @param zipName 压缩包名称
     * @param templateName 模板名称,默认取resources下的template文件夹
     * @param dataList 数据集合
     * @param clazz 数据类型
     * @param <T> 泛型
     */
    public static <T>void exportListFileOnZip(HttpServletResponse response, String zipName, String templateName, List<T> dataList,Class<T> clazz){
        //所有数据的输出流
        ByteArrayOutputStream outputStream = new ByteArrayOutputStream();
        // 压缩流
        ZipOutputStream zipOutputStream = null;
        try {
            response.setContentType("application/octet-stream;charset=UTF-8");
            response.setHeader("Content-Disposition", "attachment;filename=" + URLEncoder.encode(zipName, "UTF-8") + ".zip");
            zipOutputStream = new ZipOutputStream(response.getOutputStream());
            Template template = getTemplate(templateName,clazz);
            Map<String,Integer> nameMap = new HashMap<>();
            for (T data : dataList) {
                String fileName = getFileName(data);
                if (nameMap.containsKey(fileName)) {
                    nameMap.put(fileName,nameMap.get(fileName) +1);
                    fileName = fileName+"(" + nameMap.get(fileName) +")";
                }else {
                    nameMap.put(fileName,0);
                }
                ByteArrayOutputStream byteArrayOutputStream = generateOneFile(template,data);
                outputStream.write(byteArrayOutputStream.toByteArray());
                ZipEntry zipEntry = new ZipEntry(fileName+DOC_SUFFIX);
                zipOutputStream.putNextEntry(zipEntry);
                zipOutputStream.write(byteArrayOutputStream.toByteArray());
                zipOutputStream.closeEntry();
            }
            zipOutputStream.write(outputStream.toByteArray());
            zipOutputStream.closeEntry();
            zipOutputStream.flush();
            zipOutputStream.close();
        } catch (Exception e) {
            log.error("导出word文件放在zip里面异常",e);
        }finally {
            try {
                outputStream.close();
                zipOutputStream.close();
            } catch (IOException e) {
                log.error("导出word文件放在zip里面异常",e);
            }
        }
    }


    /**
     * @Description: 导出word文件所有数据都放在一个文件里面
     * @param fileName 文件名称
     * @param templateName 模板名称,默认取resources下的template文件夹
     * @param dataList 数据集合
     * @param clazz 数据类型
     * @param <T> 泛型
     */
    public static <T> void exportListOnOneFile(HttpServletResponse response,String fileName,String templateName, List<T> dataList,Class<T> clazz){
        ByteArrayOutputStream outputStream = new ByteArrayOutputStream();
        try {
            response.setContentType("application/msword;charset=UTF-8");
            response.setHeader("Content-Disposition", "attachment;filename=" + URLEncoder.encode(fileName, "UTF-8") + ".doc");
            Template template = getTemplate(templateName,clazz);
            for (T data : dataList) {
                ByteArrayOutputStream byteArrayOutputStream = generateOneFile(template,data);
                outputStream.write(byteArrayOutputStream.toByteArray());
            }
            response.getOutputStream().write(outputStream.toByteArray());
            response.getOutputStream().flush();
            response.getOutputStream().close();
        } catch (Exception e) {
            log.error("导出word文件失败",e);
        }finally {
            try {
                outputStream.close();
            } catch (IOException e) {
                log.error("关闭流失败",e);
            }
        }
    }

    /**
     * 导出提条数据放在一个word文件里面
     * @param response 响应
     * @param fileName 文件名称
     * @param templateName 模板名称,默认取resources下的template文件夹
     * @param data 数据
     * @param clazz 数据类型
     * @param <T> 泛型
     * @throws Exception 异常
     */
    public static <T> void exportOneFile(HttpServletResponse response, String fileName, String templateName, T data, Class<T> clazz) throws Exception{
        Template template = getTemplate(templateName,clazz);
        ByteArrayOutputStream outputStream = generateOneFile(template,data);
        response.setContentType("application/msword;charset=UTF-8");
        response.setHeader("Content-Disposition", "attachment;filename=" + new String(fileName.getBytes("UTF-8"), "ISO8859-1") + ".doc");
        response.getOutputStream().write(outputStream.toByteArray());
        response.getOutputStream().flush();
        response.getOutputStream().close();
    }


    /**
     * 生成一个word文件的字节流
     * @param data 数据
     * @param <T> 泛型
     * @return 字节流
     * @throws Exception 异常
     */
    private static <T> ByteArrayOutputStream generateOneFile(Template template,T data) throws Exception{
        ByteArrayOutputStream outputStream = new ByteArrayOutputStream();
        OutputStreamWriter writer = new OutputStreamWriter(outputStream);
        HashMap<String, Object> dataMap =  convertDataToHashMap(data);
        if (null == dataMap || dataMap.size() == 0) {
            log.error("数据为空");
            throw new RuntimeException("数据为空");
        }
        template.process(dataMap, writer);
        return outputStream;
    }

    /**
     * 转换数据为hashMap供freemarker使用
     * @param data 数据
     * @param <T> 泛型
     * @return hashMap
     */
    private static <T>HashMap<String,Object> convertDataToHashMap(T data){
        //使用反射获取类的属性
        Class<?> myClass = data.getClass();
        Field[] fields = myClass.getDeclaredFields();
        HashMap<String,Object> dataMap = new HashMap<>();
        for (Field field : fields) {
            if (field.isAnnotationPresent(ExportWordField.class)) {
                //允许访问私有变量
                field.setAccessible(true);
                //如果是list类型的数据需要深度遍历处理
                if (field.getType().equals(List.class)) {
                    List<?> list = null;
                    try {
                        list = convertListDataToHashMap((List<?>) field.get(data));
                    } catch (IllegalAccessException e) {
                        log.error("获取属性值失败",e);
                        throw new RuntimeException("获取属性值失败");
                    }
                    dataMap.put(field.getName(),list);
                    continue;
                }
                ExportWordField exportWordField = field.getAnnotation(ExportWordField.class);
                String fieldName = exportWordField.fieldName();
                try {
                    if (fieldName != null && !"".equals(fieldName)) {
                        dataMap.put(fieldName,  field.get(data) == null ? "" : field.get(data));
                    }else {
                        dataMap.put(field.getName(), field.get(data) == null ? "" : field.get(data));
                    }
                } catch (IllegalAccessException e) {
                    log.error("获取属性值失败",e);
                    throw new RuntimeException("获取属性值失败");
                }
            }
        }
        return dataMap;
    }

    /**
     * 如果fidel是list类型的数据则需要判断此层是否有list类型的如果有需要不停的往底层变量一直到最后一层然后取每一层符合ExportWordField的数据返回给上一层
     * @param list list数据
     * @param <T> 泛型
     * @return hashMap
     */
    private static <T> List<HashMap<String, Object>> convertListDataToHashMap(List<T> list) {
        List<HashMap<String, Object>> listMap = new ArrayList<>();
        if (!CollectionUtils.isEmpty(list)) {
            for (T t : list) {
                HashMap<String, Object> hashMap = convertDataToHashMap(t);
                listMap.add(hashMap);
            }
        }
        return listMap;
    }

    /**
     * @Description: 读取模板文件
     * @param templateName 模板名称,默认取resources下的template文件夹
     * @return freemarker.template.Template
     */
    private static <T>Template getTemplate(String templateName,Class<T> clazz) throws IOException {
        Configuration configuration = new Configuration(Configuration.getVersion());
        configuration.setDefaultEncoding("UTF-8");
        configuration.setClassForTemplateLoading(clazz, "/templates");
        return configuration.getTemplate(templateName);
    }
    
    private static <T> String getFileName(T data){
        Field[] fields = data.getClass().getDeclaredFields();
        StringBuilder fileName = new StringBuilder();
        Arrays.stream(fields).filter(field -> field.getAnnotation(ExportWordField.class) != null
                && field.getAnnotation(ExportWordField.class).isFileNameFiled()).sorted((o1, o2) -> {
            ExportWordField annotation1 = o1.getAnnotation(ExportWordField.class);
            ExportWordField annotation2 = o2.getAnnotation(ExportWordField.class);
            return annotation1.fileNameFiledSort() - annotation2.fileNameFiledSort();
        }).forEach(field -> {
            field.setAccessible(true);
            try {
                fileName.append(field.get(data)+"-");
            } catch (IllegalAccessException e) {
                log.error("获取文件名称异常",e);
            }
        });
        return fileName.toString();
    }
}

3.使用

  //导出压缩包
  ExportTemplateUtil.exportListFileOnZip(response,"测试导出","template2.0.ftl",somethingObj,Something.class);
  //导出一个文件
  ExportTemplateUtil.exportOneFile(response,"测试导出","template2.0.ftl",somethingObj,Something.class);

文章来源地址https://www.toymoban.com/news/detail-750491.html

到了这里,关于使用freemarker,数据导出word并下载的文章就介绍完了。如果您还想了解更多内容,请在右上角搜索TOY模板网以前的文章或继续浏览下面的相关文章,希望大家以后多多支持TOY模板网!

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处: 如若内容造成侵权/违法违规/事实不符,请点击违法举报进行投诉反馈,一经查实,立即删除!

领支付宝红包 赞助服务器费用

相关文章

  • freemarker 使用word模板赋值

    这里贴上自己测试的ftl文件 生成的效果 参考: https://blog.csdn.net/weixin_46174854/article/details/116855252 https://blog.csdn.net/weixin_45853881/article/details/129298494 https://blog.csdn.net/qq_42851623/article/details/122879852 https://blog.csdn.net/weixin_45103378/article/details/118395284 https://www.cnblogs.com/ayueC/p/15118381.html

    2024年02月11日
    浏览(42)
  • 根据模板动态生成word(一)使用freemarker生成word

    @ 目录 一、准备模板 1、创建模板文件 2、处理模板 2.1 处理普通文本 2.2 处理表格 2.3 处理图片 二、项目代码 1、引入依赖 2、生成代码 三、验证生成word 首先先建立一个word文件,输入模板内容freemaker的内容,下面是本次演示的word文件。 然后将word文件另存为 .xml 文件,然后再

    2024年02月13日
    浏览(83)
  • SpringBoot整合FreeMarker生成word表格文件(使用FTL模板)

    一,什么是FreeMarker,FTL模板? FreeMarker 是一款 模板引擎: 即一种基于模板和要改变的数据, 并用来生成输出文本(HTML网页,电子邮件,配置文件,源代码等)的通用工具。 它不是面向最终用户的,而是一个Java类库,是一款程序员可以嵌入他们所开发产品的组件。 模板编写为

    2024年03月24日
    浏览(52)
  • 使用FreeMarker生成word文件自定义每页页眉或页脚

    最新工作中遇到生成word中表格时,要求文档中每页头部和底部都是固定格式的表格,但是内容不一样,头部信息在word中画样式的时候就可以设置为“在各页顶端以标题形式重复出现”,而底部就没有办法这样设置了,之后就想着在眉脚中设置相应的样式就可以啦,但是发现

    2024年02月16日
    浏览(83)
  • 若依框架中使用FreeMarker使用word动态模板生成pdf给前端展示(模板中并没用使用到图片,所以没有图片的方法,只用了表格展示数据,模板里面只涉及到了循环判断和日期格式)

    首先使用word创建动态模板  下方两组信息是通过循环展示的,在生成模板时注意,如果不点击里面表格,选择居中表格打印出来可能还有偏差,两边距离页面拒了可能不一样 存储需要的模板时注意      存成这个格式,如果不是2003可能会有坑,找到你生成的.xml文件,把后缀改成ftl  

    2024年02月04日
    浏览(41)
  • freemarker模板操作excel或word

    二维码生成

    2024年01月18日
    浏览(35)
  • freemarker模板生成的word文档优化

    使用压缩工具打开docx模板,取出document.xml,如下图: 将用压缩工具打开后的docx文档里面的document.xml复制出来,并将document.xml后缀改为.ftl,然后进行参数预设。 将内容格式化后修改需要替换的内容为freemarker标签,对document.ftl进行参数预设,如下图: 文件准备好后存放到某个

    2024年02月02日
    浏览(49)
  • springboot基础(78):Freemarker模板生成word文档

    利用Freemarker模板生成word文档。示例,将左侧的模板生成为右侧的文档并下载。 1.编辑一份addr.docx文档 2. 另存为addr.xml文档 3. 打开addr.xml文件,修改内容,由于table表格,需要遍历list集合,需要添加 将addr.xml后缀更改为addr.ftl文件,存放到resources/templates下 导入依赖 编写contr

    2024年02月11日
    浏览(37)
  • 基于Java+freemarker实现动态赋值以及生成Word文档

    有一个需求就是给定一个正确格式的 Word 文档模板,要求通过动态赋值方式,写入数据并新生成 该模板格式的 Word 文档。这很明显使用 Java+freemarker 方式来实现颇为简单。 (1)准备好一个正确格式的 Word 文档(测试文档 - 原版.docx) (2)将其另存为xml文件(测试文档 - 原版

    2024年02月09日
    浏览(45)
  • Aspose导出word使用记录

    背景 :Aspose系列的控件,功能实现都比较强大,可以实现多样化的报表设计及输出。 通过这次业务机会,锂宝碳审核中业务功需要实现Word文档表格的动态导出功能,因此学习了相关内容,在学习和参考了官方API文档的帮助下,将学习和简单的使用记录在wiki中。下面由我来简

    2024年02月10日
    浏览(47)

觉得文章有用就打赏一下文章作者

支付宝扫一扫打赏

博客赞助

微信扫一扫打赏

请作者喝杯咖啡吧~博客赞助

支付宝扫一扫领取红包,优惠每天领

二维码1

领取红包

二维码2

领红包