SpringBoot导出Word文档的三种方式

干翻全岛蛙蛙  金牌会员 | 2023-5-4 16:36:37 | 显示全部楼层 | 阅读模式
打印 上一主题 下一主题
楼主

主题 928|帖子 928|积分 2784

SpringBoot导出Word文档的三种方式

一、导出方案

  1. .doc      application/msword
  2. .dot      application/msword
  4. .docx     application/vnd.openxmlformats-officedocument.wordprocessingml.document
  5. .dotx     application/vnd.openxmlformats-officedocument.wordprocessingml.template
  6. .docm     application/vnd.ms-word.document.macroEnabled.12
  7. .dotm     application/vnd.ms-word.template.macroEnabled.12
  9. .xls      application/vnd.ms-excel
  10. .xlt      application/vnd.ms-excel
  11. .xla      application/vnd.ms-excel
  13. .xlsx     application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
  14. .xltx     application/vnd.openxmlformats-officedocument.spreadsheetml.template
  15. .xlsm     application/vnd.ms-excel.sheet.macroEnabled.12
  16. .xltm     application/vnd.ms-excel.template.macroEnabled.12
  17. .xlam     application/vnd.ms-excel.addin.macroEnabled.12
  18. .xlsb     application/vnd.ms-excel.sheet.binary.macroEnabled.12
  20. .ppt      application/vnd.ms-powerpoint
  21. .pot      application/vnd.ms-powerpoint
  22. .pps      application/vnd.ms-powerpoint
  23. .ppa      application/vnd.ms-powerpoint
  25. .pptx     application/vnd.openxmlformats-officedocument.presentationml.presentation
  26. .potx     application/vnd.openxmlformats-officedocument.presentationml.template
  27. .ppsx     application/vnd.openxmlformats-officedocument.presentationml.slideshow
  28. .ppam     application/vnd.ms-powerpoint.addin.macroEnabled.12
  29. .pptm     application/vnd.ms-powerpoint.presentation.macroEnabled.12
  30. .potm     application/vnd.ms-powerpoint.template.macroEnabled.12
  31. .ppsm     application/vnd.ms-powerpoint.slideshow.macroEnabled.12
  33. .mdb      application/vnd.ms-access
复制代码
二、富文本转换后的HTML下载为Word文档

1、准备


  • 业务需求

    • 前端使用富文本插件生成带HTML标签的word文档，然后需要下载这个word文档。
    • 每个word文档的格式是可变的

  • 扩展业务需求：

    • 甚至可以去替换HTML的Word中的内容，然后导出需要的文档；缺点：替换字符串麻烦、而且HTML的Word的标签还需要研究。
    • 基于上述的业务需求。建议使用模板技术导出（也就是“三”）

  • 参考：

  • 导出结果

2、实现

2.1、导包
  1. <dependency>
  2.     <groupId>org.apache.poi</groupId>
  3.     <artifactId>poi</artifactId>
  4.     <version>4.1.2</version>
  5. </dependency>
复制代码
2.2、HTML的word文档
  1. package com.cc.ewd.html;
  3. /**
  4. * @author CC
  5. * @since 2023/4/24 0024
  6. */
  7. public interface HtmlConstants {
  9.     /**
  10.      * 普通文档（富文本生成的）
  11.      */
  12.     String HTML1 = "<h1 style="text-align: center;"><strong>文章标题</strong></h1><h1><strong>一、标题1" +
  13.             "</strong></h1><p><strong>       我是数据：{NUM}</strong></p><h2><strong>" +
  14.             "1.1、吾问无为谓</strong></h2><table style="width: 100%;">" +
  15.             "<tbody><tr><th colSpan="1" rowSpan="1" width="auto">序号</th>" +
  16.             "<th colSpan="1" rowSpan="1" width="auto">第一列</th>" +
  17.             "<th colSpan="1" rowSpan="1" width="auto">第二列</th>" +
  18.             "<th colSpan="1" rowSpan="1" width="auto">第三列</th>" +
  19.             "<th colSpan="1" rowSpan="1" width="auto">第四列</th>" +
  20.             "</tr><tr><td colspan="1" rowspan="1" width="auto" style="text-align: center;">1</td>" +
  21.             "<td colspan="1" rowspan="1" width="auto" style="text-align: center;">11</td>" +
  22.             "<td colspan="1" rowspan="1" width="auto" style="text-align: center;">22</td>" +
  23.             "<td colspan="1" rowspan="1" width="auto" style="text-align: center;">33</td>" +
  24.             "<td colspan="1" rowspan="1" width="auto" style="text-align: center;">44</td>" +
  25.             "</tr><tr><td colspan="1" rowspan="1" width="auto" style="text-align: center;">2</td>" +
  26.             "<td colspan="1" rowspan="1" width="auto" style="text-align: center;">11</td>" +
  27.             "<td colspan="1" rowspan="1" width="auto" style="text-align: center;">22</td>" +
  28.             "<td colspan="1" rowspan="1" width="auto" style="text-align: center;">33</td>" +
  29.             "<td colspan="1" rowspan="1" width="auto" style="text-align: center;">44</td>" +
  30.             "</tr><tr><td colspan="1" rowspan="1" width="auto" style="text-align: center;">3</td>" +
  31.             "<td colspan="1" rowspan="1" width="auto" style="text-align: center;">11</td>" +
  32.             "<td colspan="1" rowspan="1" width="auto" style="text-align: center;">22</td>" +
  33.             "<td colspan="1" rowspan="1" width="auto" style="text-align: center;">33</td>" +
  34.             "<td colspan="1" rowspan="1" width="auto" style="text-align: center;">44</td></tr>" +
  35.             "</tbody></table><p><br></p>";
  37.     /**
  38.      * 带表格文档（可以富文本生成，也可以使用word文档另存为HTML文件，然后拷出来）
  39.      */
  40.     String HTML2 = "<h1 align=center  style="text-align:center;" ><b style="mso-bidi-font-weight:normal" ><font face="宋体" >标题</font></b><b style="mso-bidi-font-weight:normal" ><o:p></o:p></b></h1><h2><b style="mso-bidi-font-weight:normal" ><font face="黑体" >一、段落</font><font face="Arial" >1</font></b><b style="mso-bidi-font-weight:normal" ><o:p></o:p></b></h2><p class=MsoNormal ><font face="宋体" >哒哒</font><b><font face="宋体" >哒哒哒</font></b><font face="宋体" >哒</font><o:p></o:p></p><h3><b style="mso-bidi-font-weight:normal" ><font face="Calibri" >1.1</font><font face="宋体" >、表格</font></b><b style="mso-bidi-font-weight:normal" ><o:p></o:p></b></h3><table class=MsoTableGrid  border=1  cellspacing=0  style="border-collapse:collapse;border:none;mso-border-left-alt:0.5000pt solid windowtext;\n" +
  41.             "mso-border-top-alt:0.5000pt solid windowtext;mso-border-right-alt:0.5000pt solid windowtext;mso-border-bottom-alt:0.5000pt solid windowtext;\n" +
  42.             "mso-border-insideh:0.5000pt solid windowtext;mso-border-insidev:0.5000pt solid windowtext;mso-padding-alt:0.0000pt 5.4000pt 0.0000pt 5.4000pt ;" ><tr><td width=142  valign=center  style="width:106.5000pt;padding:0.0000pt 5.4000pt 0.0000pt 5.4000pt ;border-left:1.0000pt solid windowtext;\n" +
  43.             "mso-border-left-alt:0.5000pt solid windowtext;border-right:1.0000pt solid windowtext;mso-border-right-alt:0.5000pt solid windowtext;\n" +
  44.             "border-top:1.0000pt solid windowtext;mso-border-top-alt:0.5000pt solid windowtext;border-bottom:1.0000pt solid windowtext;\n" +
  45.             "mso-border-bottom-alt:0.5000pt solid windowtext;" ><p class=MsoNormal  align=center  style="text-align:center;" ><font face="宋体" >序号</font><o:p></o:p></p></td><td width=142  valign=center  style="width:106.5000pt;padding:0.0000pt 5.4000pt 0.0000pt 5.4000pt ;border-left:1.0000pt solid windowtext;\n" +
  46.             "mso-border-left-alt:0.5000pt solid windowtext;border-right:1.0000pt solid windowtext;mso-border-right-alt:0.5000pt solid windowtext;\n" +
  47.             "border-top:1.0000pt solid windowtext;mso-border-top-alt:0.5000pt solid windowtext;border-bottom:1.0000pt solid windowtext;\n" +
  48.             "mso-border-bottom-alt:0.5000pt solid windowtext;" ><p class=MsoNormal  align=center  style="text-align:center;" ><font face="宋体" >列</font><font face="Calibri" >1</font><o:p></o:p></p></td><td width=142  valign=center  style="width:106.5500pt;padding:0.0000pt 5.4000pt 0.0000pt 5.4000pt ;border-left:1.0000pt solid windowtext;\n" +
  49.             "mso-border-left-alt:0.5000pt solid windowtext;border-right:1.0000pt solid windowtext;mso-border-right-alt:0.5000pt solid windowtext;\n" +
  50.             "border-top:1.0000pt solid windowtext;mso-border-top-alt:0.5000pt solid windowtext;border-bottom:1.0000pt solid windowtext;\n" +
  51.             "mso-border-bottom-alt:0.5000pt solid windowtext;" ><p class=MsoNormal  align=center  style="text-align:center;" ><font face="宋体" >列</font><font face="Calibri" >2</font><o:p></o:p></p></td><td width=142  valign=center  style="width:106.5500pt;padding:0.0000pt 5.4000pt 0.0000pt 5.4000pt ;border-left:1.0000pt solid windowtext;\n" +
  52.             "mso-border-left-alt:0.5000pt solid windowtext;border-right:1.0000pt solid windowtext;mso-border-right-alt:0.5000pt solid windowtext;\n" +
  53.             "border-top:1.0000pt solid windowtext;mso-border-top-alt:0.5000pt solid windowtext;border-bottom:1.0000pt solid windowtext;\n" +
  54.             "mso-border-bottom-alt:0.5000pt solid windowtext;" ><p class=MsoNormal  align=center  style="text-align:center;" ><font face="宋体" >列</font><font face="Calibri" >3</font><o:p></o:p></p></td></tr><tr><td width=142  valign=center  style="width:106.5000pt;padding:0.0000pt 5.4000pt 0.0000pt 5.4000pt ;border-left:1.0000pt solid windowtext;\n" +
  55.             "mso-border-left-alt:0.5000pt solid windowtext;border-right:1.0000pt solid windowtext;mso-border-right-alt:0.5000pt solid windowtext;\n" +
  56.             "border-top:none;mso-border-top-alt:0.5000pt solid windowtext;border-bottom:1.0000pt solid windowtext;\n" +
  57.             "mso-border-bottom-alt:0.5000pt solid windowtext;" ><p class=MsoNormal  align=center  style="text-align:center;" ><font face="Calibri" >1</font><o:p></o:p></p></td><td width=142  valign=center  style="width:106.5000pt;padding:0.0000pt 5.4000pt 0.0000pt 5.4000pt ;border-left:1.0000pt solid windowtext;\n" +
  58.             "mso-border-left-alt:0.5000pt solid windowtext;border-right:1.0000pt solid windowtext;mso-border-right-alt:0.5000pt solid windowtext;\n" +
  59.             "border-top:none;mso-border-top-alt:0.5000pt solid windowtext;border-bottom:1.0000pt solid windowtext;\n" +
  60.             "mso-border-bottom-alt:0.5000pt solid windowtext;" ><p class=MsoNormal  align=center  style="text-align:center;" ><font face="Calibri" >11</font><o:p></o:p></p></td><td width=142  valign=center  style="width:106.5500pt;padding:0.0000pt 5.4000pt 0.0000pt 5.4000pt ;border-left:1.0000pt solid windowtext;\n" +
  61.             "mso-border-left-alt:0.5000pt solid windowtext;border-right:1.0000pt solid windowtext;mso-border-right-alt:0.5000pt solid windowtext;\n" +
  62.             "border-top:none;mso-border-top-alt:0.5000pt solid windowtext;border-bottom:1.0000pt solid windowtext;\n" +
  63.             "mso-border-bottom-alt:0.5000pt solid windowtext;" ><p class=MsoNormal  align=center  style="text-align:center;" ><font face="Calibri" >22</font><o:p></o:p></p></td><td width=142  valign=center  style="width:106.5500pt;padding:0.0000pt 5.4000pt 0.0000pt 5.4000pt ;border-left:1.0000pt solid windowtext;\n" +
  64.             "mso-border-left-alt:0.5000pt solid windowtext;border-right:1.0000pt solid windowtext;mso-border-right-alt:0.5000pt solid windowtext;\n" +
  65.             "border-top:none;mso-border-top-alt:0.5000pt solid windowtext;border-bottom:1.0000pt solid windowtext;\n" +
  66.             "mso-border-bottom-alt:0.5000pt solid windowtext;" ><p class=MsoNormal  align=center  style="text-align:center;" ><font face="Calibri" >33</font><o:p></o:p></p></td></tr></table><p class=MsoNormal ><o:p> </o:p></p><p class=MsoNormal ><o:p> </o:p></p><p class=MsoNormal ><o:p> </o:p></p><h2><b style="mso-bidi-font-weight:normal" ><font face="黑体" >二、段落</font><font face="Arial" >2</font></b><b style="mso-bidi-font-weight:normal" ><o:p></o:p></b></h2><p class=MsoNormal ><o:p> </o:p></p><p class=MsoNormal ><o:p> </o:p></p><p class=MsoNormal ><o:p> </o:p></p>";
  68. }
复制代码
2.3、导出


  • 逻辑、注意事项看注释
  • 代码：
  1. package com.cc.ewd.web.controller;
  3. import com.cc.ewd.html.HtmlConstants;
  4. import org.apache.poi.poifs.filesystem.DirectoryEntry;
  5. import org.apache.poi.poifs.filesystem.POIFSFileSystem;
  6. import org.springframework.web.bind.annotation.GetMapping;
  7. import org.springframework.web.bind.annotation.RequestMapping;
  8. import org.springframework.web.bind.annotation.RestController;
  10. import javax.servlet.http.HttpServletResponse;
  11. import java.io.*;
  12. import java.net.URLEncoder;
  13. import java.nio.charset.StandardCharsets;
  15. /** 业务需求：前端使用富文本插件生成带HTML标签的word文档，然后需要下载这个word文档。
  16. * @author CC
  17. * @since 2023/4/24 0024
  18. */
  19. @RestController
  20. @RequestMapping("/apachePoiExport")
  21. public class ApachePoiExport {
  23.   /** 将HTML内容（富文本生成的HTML）转换为Word文档并下载
  24.    * @param response HTTP响应
  25.    */
  26.   @GetMapping
  27.   public void getDoc(HttpServletResponse response) {
  28.     String fileName = "Word文件名";
  29.     String html = HtmlConstants.HTML2;
  30.     //导出word的方法
  31.     exportWord(fileName, html, response);
  32.   }
  34.   /** <p>将HTML内容（富文本生成的HTML）转换为Word文档并下载（word2007之后的_docx）</p>
  35.    *  <li>参考：https://my.oschina.net/u/1045509/blog/1924024</li>
  36.    *  <li>参考：https://blog.csdn.net/qq_42682745/article/details/120867432</li>
  37.    * @param fileName 文件名
  38.    * @param html 富文本生成的HTML
  39.    * @param response 响应
  40.    * @since 2023/4/25 0025
  41.    * @author CC
  42.    **/
  43.   public static void exportWord(String fileName, String html, HttpServletResponse response) {
  44.     //0、获取富文本的html：
  45.     // HTML内容必须被<html><body></body></html>包装；最好设置一下编码格式
  46.     // HTML在这里设置<head></head>是为了让输入的文档是以"页面视图"。而不是"Web版式"
  47.     String wrappedHtml =
  48.             "<html xmlns:v="urn:schemas-microsoft-com:vml" xmlns:o="urn:schemas-microsoft-com:office:office"\n" +
  49.                     "xmlns:w="urn:schemas-microsoft-com:office:word" xmlns:m="http://schemas.microsoft.com/office/2004/12/omml"\n" +
  50.                     "xmlns="http://www.w3.org/TR/REC-html40">" +
  51.                 "<head>" +
  52.                     "" +
  53.                 "</head>" +
  54.                 "<body>%s</body>" +
  55.             "</html>";
  57.     wrappedHtml = String.format(wrappedHtml, html);
  59.     //1、将HTML转换为Word文档byte数组
  60.     byte[] bytes = wrappedHtml.getBytes(StandardCharsets.UTF_8);
  61.     try (POIFSFileSystem poifsFileSystem = new POIFSFileSystem();
  62.          InputStream byteInputStream = new ByteArrayInputStream(bytes);
  63. //             InputStream inputStream = new BufferedInputStream(byteInputStream);
  64.          ByteArrayOutputStream outputStream = new ByteArrayOutputStream();
  65.     ){
  66.       //2、使用ApachePoi转换word并设置到输出流outputStream
  67.       DirectoryEntry directory = poifsFileSystem.getRoot();
  68.       //WordDocument名称不允许修改
  69.       directory.createDocument("WordDocument", byteInputStream);
  70.       //将Word文档写入POIFSFileSystem对象
  71.       poifsFileSystem.writeFilesystem(outputStream);
  73.       //3、①将Word文档（输出流outputStream）写入HTTP响应并下载；②也可以上传到自己的文件服务器然后返回URL给前端下载。
  74.       response.setCharacterEncoding("utf-8");
  75.       //设置content-type就是告诉浏览器这是啥玩意儿
  76.       //"octet-stream" ：通用二进制流；
  77.       //"msword" ：Microsoft Word文档
  78.       //"vnd.openxmlformats-officedocument.wordprocessingml.document" ：响应的内容类型设置为Microsoft Word 2007及更高版本的docx格式。对应的文件名后缀需要改成”docx“
  79.       response.setContentType("application/vnd.openxmlformats-officedocument.wordprocessingml.document;charset=UTF-8");
  80.       //解决跨域不显示在header里面的问题
  81.       response.setHeader("Access-Control-Expose-Headers","Content-disposition");
  82.       //"attachment"：让浏览器把响应视为附件并下载
  83.       //"inline"：    让浏览器打开Word文档而不是下载它
  84.       response.setHeader("Content-disposition","attachment; filename=" +
  85.               URLEncoder.encode(fileName.concat(".docx"), "UTF-8"));
  86.       //BufferedOutputStream缓冲流：可以将数据缓存在内存中，以减少对底层IO的调用次数，从而提高性能。
  87.       //ServletOutputStream：用于向客户端发送数据的
  88.       //因为需要将数据写入HTTP响应，所以使用ServletOutputStream是更好的选择。
  89.       OutputStream out = new BufferedOutputStream(response.getOutputStream());
  90.       out.write(outputStream.toByteArray());
  91.       out.flush();
  92.       out.close();
  93.     } catch (Exception e) {
  94.       e.printStackTrace();
  95.     }
  96.   }
  98. }
复制代码
三、使用模板技术导出


  • 使用Thymeleaf模板技术（推荐，也是我使用的）。也可以使用FreeMarker
  • Word文件的格式是固定
  • 可以根据需求写入不同的数据
1、准备工作

1.1、导包
  1. <dependency>
  2.     <groupId>org.springframework.boot</groupId>
  3.     <artifactId>spring-boot-starter-thymeleaf</artifactId>
  4. </dependency>
复制代码
1.2、导出文件的预处理，Thymeleaf语法


  • 使用WPS（建议使用微软的Word）新建一个需要导出Word文件


  • 这个Word文件中，需要替换的值，最好使用单独的格式。因为单独的格式在HTML或者xml中才能区分


  • 弄好Word文件，最后另存为xml格式或者HTML（单个文件）格式。就得到我们需要的xml或者HTML格式的Word文件。


  • 使用Thymeleaf语法修改xml文件

    • 参考：Thymeleaf更多语法见下面：
      1. https://blog.csdn.net/weixin_45203607/article/details/120251923
      3. https://blog.csdn.net/guoqigengxin/article/details/108674177普通文本
      复制代码
    • 普通文本



  • 循环
  1. -----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
复制代码


  • 条件判断：if-else

1.3、把处理好的xml文件放到resources下


1.4、使用HTML的注意事项


  • 见附件：thymeleaf_3_wps.html
  • 另存为后，修改HTML的编码格式：utf-8


  • 设置值，直接可以设置在：font 标签上


  • “页面视图“修改：

    • 参考导出页面视图见：一、导出方案



2、原理


  • 可以使用xml导出、也可以使用HTML导出。
  • 导出前需要预处理xml
  • 可以使用下面的进行测试、导出。
2.1、原理
  1. package com.cc.ewd.web.controller;
  3. import com.cc.ewd.vo.Msg4Vo;
  4. import org.springframework.web.bind.annotation.GetMapping;
  5. import org.springframework.web.bind.annotation.RequestMapping;
  6. import org.springframework.web.bind.annotation.RestController;
  7. import org.thymeleaf.context.Context;
  8. import org.thymeleaf.spring5.SpringTemplateEngine;
  9. import org.thymeleaf.templatemode.TemplateMode;
  10. import org.thymeleaf.templateresolver.ClassLoaderTemplateResolver;
  12. import javax.annotation.Resource;
  13. import javax.servlet.ServletOutputStream;
  14. import javax.servlet.http.HttpServletResponse;
  15. import java.io.ByteArrayInputStream;
  16. import java.io.ByteArrayOutputStream;
  17. import java.io.IOException;
  18. import java.net.URLEncoder;
  19. import java.nio.charset.StandardCharsets;
  20. import java.util.ArrayList;
  21. import java.util.HashMap;
  22. import java.util.List;
  23. import java.util.Map;
  25. /** thymeleaf导出的原理
  26. * @author CC
  27. * @since 2023/4/25 0025
  28. */
  29. @RestController
  30. @RequestMapping("/thymeleafTheoryExport")
  31. public class ThymeleafTheoryExport {
  33.     @Resource
  34.     private SpringTemplateEngine springTemplateEngine;
  36.     /** <p>原理</p>
  37.      * <ol>
  38.      *     <li>相当于把word文件转为xml或者html，然后修改其中的值再以xml、html下载成word文件</li>
  39.      *     <li>这个方法只能运行一次，因为对ClassLoaderTemplateResolver的设置是一次性的</li>
  40.      *     <li>所以需要将ClassLoaderTemplateResolver设置成单例：配置Bean。</li>
  41.      *     <li>doc或docx的模板别使用WPS的文档，使用微软的office新建word文档，然后转为xml或html</li>
  42.      *     <li>可以导出xml、也可以导出html：建议使用xml</li>
  43.      * </ol>
  44.      */
  45.     @GetMapping
  46.     public void thymeleafExport(HttpServletResponse response){
  47.         String fileName = "第一个thy的文件";
  49.         //一、设置Thymeleaf模板
  50.         ClassLoaderTemplateResolver templateResolver = new ClassLoaderTemplateResolver();
  51.         //xml文件地址：自定义xml的文件夹：thymeleafcs/thymeleaf_1_wps.xml
  52.         //xml文件地址：默认放在thymeleaf下就可以读取到
  53.         templateResolver.setPrefix("thymeleafcs/");
  54.         //设置文件的后缀
  55.         templateResolver.setSuffix(".xml");
  56. //        templateResolver.setSuffix(".html");
  57.         templateResolver.setCharacterEncoding("utf-8");
  58.         //模板模式：默认是HTML。改为xml
  59. //        templateResolver.setTemplateMode(TemplateMode.XML);
  60.         templateResolver.setTemplateMode(TemplateMode.HTML);
  61.         //加载模板
  62.         springTemplateEngine.setTemplateResolver(templateResolver);
  63.         //启用Spring EL编译器
  64.         springTemplateEngine.setEnableSpringELCompiler(true);
  66.         //二、设置数据（可以用map，也可以用对象）
  67.         Map<String,Object> map = new HashMap<>();
  68.         //1普通文本参数
  69.         map.put("msg1","我是参数1111");
  70.         map.put("msg2","我是参数2222");
  71.         map.put("msg3","我是参数3333");
  72.         //2if-else参数
  73.         map.put("thIf1","1");
  74.         map.put("thIf2","2");
  76.         //3循环：构建集合参数，用于表格：可以是Map；可以是对象
  77. //        List<Map<String,Object>> msg4Vos = new ArrayList<>();
  78.         List<Msg4Vo> msg4Vos = new ArrayList<>();
  79.         for (int i = 0; i < 10; i++) {
  80.             //1map方式
  81. //            Map<String,Object> map4 = new HashMap<>();
  82. //            map4.put("l1","列1-" + i);
  83. //            map4.put("l2","列2-" + i);
  84. //            map4.put("l3","列3-" + i);
  85. //            map4.put("l4","列4-" + i);
  86. //            msg4Vos.add(map4);
  87.             //2对象方式
  88.             Msg4Vo vo = new Msg4Vo();
  89.             vo.setL1("列1-" + i);
  90.             vo.setL2("列2-" + i);
  91.             vo.setL3("列3-" + i);
  92.             vo.setL4("列4-" + i);
  93.             msg4Vos.add(vo);
  94.         }
  95.         map.put("msg4Vos",msg4Vos);
  97.         //4设置数据
  98.         Context context = new Context();
  99.         context.setVariables(map);
  100.         //写入输入（模板名称，数据）
  101.         String process = springTemplateEngine.process("thymeleaf_4_wps_final", context);
  103.         //三、下载
  104.         //建议下载成doc的。不然微软的office可能打不开
  105.         try {
  106.             byte[] bytes = process.getBytes(StandardCharsets.UTF_8);
  107. //            ByteArrayInputStream inputStream = new ByteArrayInputStream(bytes);
  108. //            ByteArrayOutputStream outputStream = getByteArrayOutputStream(inputStream);
  110.             response.setCharacterEncoding("utf-8");
  111.             response.setContentType("application/msword");
  112.             response.setHeader("Access-Control-Expose-Headers","Content-disposition");
  113.             response.setHeader("Content-disposition","attachment; filename=" +
  114.                     URLEncoder.encode(fileName.concat(".doc"), "UTF-8"));
  115.             ServletOutputStream out = response.getOutputStream();
  117.             //两种方式都可以：用bytes好些
  118. //            out.write(outputStream.toByteArray());
  119.             out.write(bytes);
  120.             out.flush();
  121.             out.close();
  122.         }catch(Exception e){
  123.             e.printStackTrace();
  124.         }
  126.     }
  128.     /** 将 ByteArrayInputStream 拷贝成 ByteArrayOutputStream
  129.      *  将 字节数组输入流 拷贝成 字节数组输出流
  130.      */
  131.     public static ByteArrayOutputStream getByteArrayOutputStream(ByteArrayInputStream inputStream) throws IOException {
  132.         ByteArrayOutputStream outputStream = new ByteArrayOutputStream();
  133.         byte[] buffer = new byte[1024];
  134.         int length;
  135.         while ((length = inputStream.read(buffer)) != -1) {
  136.             outputStream.write(buffer, 0, length);
  137.         }
  138.         return outputStream;
  139.     }
  141. }
复制代码
2.2、导出后预览


3、实现

3.1、yml配置
  1. server:
  2.   port: 5555
  4. spring:
  5.   #thymeleaf的配置
  6.   thymeleaf:
  7.     #关闭 Thymeleaf 的缓存开发过程中无需重启
  8.     #Thymeleaf默认会开启页面缓存，提高页面并发能力。但会导致我们修改页面不会立即被展现，因此我们关闭缓存
  9.     cache: false
  10.     #设置thymeleaf页面的编码
  11.     encoding: UTF-8
  12.     #模型：XML/HTML5：HTML是默认值, 为了清楚起见, 在此处添加。
  13.     mode: XML
  14.     #设置thymeleaf页面的后缀：.html是默认。
  15.     suffix: .xml
  16.     #设置thymeleaf页面的存储路径
  17.     prefix: classpath:/thymeleafcs/
  18.     #使用Spring 4.2.4或更高版本启用SpringEL编译器
  19.     #可以加快大多数情况下的执行速度, 但是当一个模板中
  20.     #的表达式在不同数据类型之间重用时,
  21.     #可能与特定情况不兼容, 因此该标志默认为“false”
  22.     #以实现更安全的向后兼容性。
  23.     enable-spring-el-compiler: true
复制代码
3.2、实现
  1. package com.cc.ewd.web.controller;
  3. import com.cc.ewd.vo.Msg4Vo;
  4. import org.springframework.web.bind.annotation.GetMapping;
  5. import org.springframework.web.bind.annotation.RequestMapping;
  6. import org.springframework.web.bind.annotation.RestController;
  7. import org.thymeleaf.context.Context;
  8. import org.thymeleaf.spring5.SpringTemplateEngine;
  10. import javax.annotation.Resource;
  11. import javax.servlet.ServletOutputStream;
  12. import javax.servlet.http.HttpServletResponse;
  13. import java.io.ByteArrayInputStream;
  14. import java.io.ByteArrayOutputStream;
  15. import java.io.IOException;
  16. import java.net.URLEncoder;
  17. import java.nio.charset.StandardCharsets;
  18. import java.util.ArrayList;
  19. import java.util.HashMap;
  20. import java.util.List;
  21. import java.util.Map;
  23. /** thymeleaf导出的实现
  24. * @author CC
  25. * @since 2023/5/4 0025
  26. */
  27. @RestController
  28. @RequestMapping("/thymeleafExport")
  29. public class ThymeleafExport {
  31.     @Resource
  32.     private SpringTemplateEngine springTemplateEngine;
  34.     /** <p>原理</p>
  35.      * <ol>
  36.      *     <li>相当于把word文件转为xml或者html，然后修改其中的值再以xml、html下载成word文件</li>
  37.      *     <li>这个方法只能运行一次，因为对ClassLoaderTemplateResolver的设置是一次性的</li>
  38.      *     <li>所以需要将ClassLoaderTemplateResolver设置成单例：配置Bean。</li>
  39.      *     <li>doc或docx的模板别使用WPS的文档，使用微软的office新建word文档，然后转为xml或html</li>
  40.      *     <li>可以导出xml、也可以导出html：建议使用xml</li>
  41.      * </ol>
  42.      */
  43.     @GetMapping
  44.     public void thymeleafExport(HttpServletResponse response){
  45.         String fileName = "第二个thy的文件";
  47.         //一、设置数据（可以用map，也可以用对象）
  48.         Map<String,Object> map = new HashMap<>();
  49.         //1普通文本参数
  50.         map.put("msg1","我是参数1111");
  51.         map.put("msg2","我是参数2222");
  52.         map.put("msg3","我是参数3333");
  53.         //2if-else参数
  54.         map.put("thIf1","1");
  55.         map.put("thIf2","2");
  57.         //3循环：构建集合参数，用于表格：可以是Map；可以是对象
  58. //        List<Map<String,Object>> msg4Vos = new ArrayList<>();
  59.         List<Msg4Vo> msg4Vos = new ArrayList<>();
  60.         for (int i = 0; i < 10; i++) {
  61.             //1map方式
  62. //            Map<String,Object> map4 = new HashMap<>();
  63. //            map4.put("l1","列1-" + i);
  64. //            map4.put("l2","列2-" + i);
  65. //            map4.put("l3","列3-" + i);
  66. //            map4.put("l4","列4-" + i);
  67. //            msg4Vos.add(map4);
  68.             //2对象方式
  69.             Msg4Vo vo = new Msg4Vo();
  70.             vo.setL1("列1-" + i);
  71.             vo.setL2("列2-" + i);
  72.             vo.setL3("列3-" + i);
  73.             vo.setL4("列4-" + i);
  74.             msg4Vos.add(vo);
  75.         }
  76.         map.put("msg4Vos",msg4Vos);
  78.         //4设置数据
  79.         Context context = new Context();
  80.         context.setVariables(map);
  81.         //写入输入（模板名称，数据）
  82.         String process = springTemplateEngine.process("thymeleaf_4_wps_final", context);
  84.         //二、下载
  85.         //建议下载成doc的。不然微软的office可能打不开
  86.         try {
  87.             byte[] bytes = process.getBytes(StandardCharsets.UTF_8);
  88. //            ByteArrayInputStream inputStream = new ByteArrayInputStream(bytes);
  89. //            ByteArrayOutputStream outputStream = getByteArrayOutputStream(inputStream);
  91.             response.setCharacterEncoding("utf-8");
  92.             response.setContentType("application/msword");
  93.             response.setHeader("Access-Control-Expose-Headers","Content-disposition");
  94.             response.setHeader("Content-disposition","attachment; filename=" +
  95.                     URLEncoder.encode(fileName.concat(".doc"), "UTF-8"));
  96.             ServletOutputStream out = response.getOutputStream();
  98.             //两种方式都可以：用bytes好些
  99. //            out.write(outputStream.toByteArray());
  100.             out.write(bytes);
  101.             out.flush();
  102.             out.close();
  103.         }catch(Exception e){
  104.             e.printStackTrace();
  105.         }
  107.     }
  109.     /** 将 ByteArrayInputStream 拷贝成 ByteArrayOutputStream
  110.      *  将 字节数组输入流 拷贝成 字节数组输出流
  111.      */
  112.     public static ByteArrayOutputStream getByteArrayOutputStream(ByteArrayInputStream inputStream) throws IOException {
  113.         ByteArrayOutputStream outputStream = new ByteArrayOutputStream();
  114.         byte[] buffer = new byte[1024];
  115.         int length;
  116.         while ((length = inputStream.read(buffer)) != -1) {
  117.             outputStream.write(buffer, 0, length);
  118.         }
  119.         return outputStream;
  120.     }
  122. }
复制代码
3.3、不使用yml配置，使用配置bean方式


  • 可以配置不同的bean，注入使用的时候，使用我们需要的bean。实现动态使用不同类型的模板的功能。
  • 如果yml中配置了， 又配置了bean。yml中的配置会失效。
  • 其中一个bean一定要添加：@Primary。来设置默认的bean
  • config配置
  1. package com.cc.ewd.config;
  3. import org.springframework.context.ApplicationContext;
  4. import org.springframework.context.annotation.Bean;
  5. import org.springframework.context.annotation.Configuration;
  6. import org.springframework.context.annotation.Primary;
  7. import org.thymeleaf.spring5.SpringTemplateEngine;
  8. import org.thymeleaf.spring5.templateresolver.SpringResourceTemplateResolver;
  9. import org.thymeleaf.templatemode.TemplateMode;
  11. import javax.annotation.Resource;
  13. /** ThymeLeaf单独的配置
  14. * @since 2023/5/4 0004
  15. * @author CC
  16. **/
  17. @Configuration
  18. public class MyThymeLeafConfig {
  20.     @Resource
  21.     private ApplicationContext applicationContext;
  23.     /** 自定义的bean
  24.      * @return SpringTemplateEngine
  25.      * @Primary :<li>作用：指定使用名为“myTemplateEngine”的bean作为默认bean。</li>
  26.      *          <li>这样，当您在需要使用SpringTemplateEngine的地方没有指定@Qualifier注释时，Spring将使用该默认bean。</li>
  27.      *          <li>使用@Resource时，可直接设置名字。不用使用@Qualifier注释</li>
  28.      */
  29.     @Bean(name = "myTemplateEngine")
  30.     @Primary
  31.     public SpringTemplateEngine myTemplateEngine(){
  32.         // SpringTemplateEngine自动应用SpringStandardDialect
  33.         // 并启用Spring自己的MessageSource消息解析机制。
  34.         SpringTemplateEngine templateEngine = new SpringTemplateEngine();
  35.         SpringResourceTemplateResolver templateResolver = myTemplateResolver();
  36.         templateEngine.setTemplateResolver(templateResolver);
  37.         // 使用Spring 4.2.4或更高版本启用SpringEL编译器
  38.         // 可以加快大多数情况下的执行速度, 但是当一个模板中
  39.         // 的表达式在不同数据类型之间重用时,
  40.         // 可能与特定情况不兼容, 因此该标志默认为“false”
  41.         // 以实现更安全的向后兼容性。
  42.         templateEngine.setEnableSpringELCompiler(true);
  43.         return templateEngine;
  44.     }
  46.     /** 自定义配置
  47.      * @return SpringResourceTemplateResolver
  48.      */
  49.     @Bean("myTemplateResolver")
  50.     public SpringResourceTemplateResolver myTemplateResolver(){
  51.         // SpringResourceTemplateResolver自动与Spring自己集成
  52.         // 资源解决基础设施, 强烈推荐。
  53.         SpringResourceTemplateResolver templateResolver = new SpringResourceTemplateResolver();
  54.         templateResolver.setApplicationContext(this.applicationContext);
  55.         templateResolver.setPrefix("classpath:thymeleafcs/");
  56.         templateResolver.setSuffix(".html");
  57.         templateResolver.setCharacterEncoding("UTF-8");
  58.         // HTML是默认值, 为了清楚起见, 在此处添加。
  59.         templateResolver.setTemplateMode(TemplateMode.HTML);
  60.         return templateResolver;
  61.     }
  63. //----------------------------------------------
  65.     /** 自定义的bean2
  66.      * @return SpringTemplateEngine
  67.      */
  68.     @Bean(name = "myTemplateEngine2")
  69.     public SpringTemplateEngine myTemplateEngine2(){
  70.         // SpringTemplateEngine自动应用SpringStandardDialect
  71.         // 并启用Spring自己的MessageSource消息解析机制。
  72.         SpringTemplateEngine templateEngine = new SpringTemplateEngine();
  73.         SpringResourceTemplateResolver templateResolver = myTemplateResolver2();
  74.         templateEngine.setTemplateResolver(templateResolver);
  75.         // 使用Spring 4.2.4或更高版本启用SpringEL编译器
  76.         // 可以加快大多数情况下的执行速度, 但是当一个模板中
  77.         // 的表达式在不同数据类型之间重用时,
  78.         // 可能与特定情况不兼容, 因此该标志默认为“false”
  79.         // 以实现更安全的向后兼容性。
  80.         templateEngine.setEnableSpringELCompiler(true);
  81.         return templateEngine;
  82.     }
  84.     /** 自定义配置2
  85.      * @return SpringResourceTemplateResolver
  86.      */
  87.     @Bean("myTemplateResolver2")
  88.     public SpringResourceTemplateResolver myTemplateResolver2(){
  89.         // SpringResourceTemplateResolver自动与Spring自己集成
  90.         // 资源解决基础设施, 强烈推荐。
  91.         SpringResourceTemplateResolver templateResolver = new SpringResourceTemplateResolver();
  92.         templateResolver.setApplicationContext(this.applicationContext);
  93.         templateResolver.setPrefix("classpath:thymeleafcs/");
  94.         templateResolver.setSuffix(".xml");
  95.         templateResolver.setCharacterEncoding("UTF-8");
  96.         // HTML是默认值, 为了清楚起见, 在此处添加。
  97.         templateResolver.setTemplateMode(TemplateMode.XML);
  98.         return templateResolver;
  99.     }
  101. }
复制代码

  • 使用

    • @Resource注入：
      1.     @Resource(name = "myTemplateEngine")
      2.     private SpringTemplateEngine springTemplateEngine;
      复制代码
    • @Autowired注入：
      1.     @Autowired
      2.     @Qualifier("myTemplateEngine")
      3.     private SpringTemplateEngine springTemplateEngine1Html;
      复制代码
    • 配置文件会失效——配置类优先
    • 使用：根据传入的type不同。使用的模板是不同的。

  1. package com.cc.ewd.web.controller;
  3. import com.cc.ewd.vo.Msg4Vo;
  4. import org.springframework.beans.factory.annotation.Qualifier;
  5. import org.springframework.web.bind.annotation.GetMapping;
  6. import org.springframework.web.bind.annotation.RequestMapping;
  7. import org.springframework.web.bind.annotation.RequestParam;
  8. import org.springframework.web.bind.annotation.RestController;
  9. import org.thymeleaf.context.Context;
  10. import org.thymeleaf.spring5.SpringTemplateEngine;
  12. import javax.annotation.Resource;
  13. import javax.servlet.ServletOutputStream;
  14. import javax.servlet.http.HttpServletResponse;
  15. import java.io.ByteArrayInputStream;
  16. import java.io.ByteArrayOutputStream;
  17. import java.io.IOException;
  18. import java.net.URLEncoder;
  19. import java.nio.charset.StandardCharsets;
  20. import java.util.ArrayList;
  21. import java.util.HashMap;
  22. import java.util.List;
  23. import java.util.Map;
  25. /** thymeleaf导出的实现
  26. * @author CC
  27. * @since 2023/5/4 0025
  28. */
  29. @RestController
  30. @RequestMapping("/thymeleafExport")
  31. public class ThymeleafExport {
  33. //    @Resource
  34. //    private SpringTemplateEngine springTemplateEngine;
  35.     @Resource(name = "myTemplateEngine")
  36.     private SpringTemplateEngine springTemplateEngine1Html;
  37.     @Resource(name = "myTemplateEngine2")
  38.     private SpringTemplateEngine springTemplateEngine2Xml;
  40.     /** <p>原理</p>
  41.      * <ol>
  42.      *     <li>相当于把word文件转为xml或者html，然后修改其中的值再以xml、html下载成word文件</li>
  43.      *     <li>这个方法只能运行一次，因为对ClassLoaderTemplateResolver的设置是一次性的</li>
  44.      *     <li>所以需要将ClassLoaderTemplateResolver设置成单例：配置Bean。</li>
  45.      *     <li>doc或docx的模板别使用WPS的文档，使用微软的office新建word文档，然后转为xml或html</li>
  46.      *     <li>可以导出xml、也可以导出html：建议使用xml</li>
  47.      * </ol>
  48.      */
  49.     @GetMapping
  50.     public void thymeleafExport(@RequestParam String type, HttpServletResponse response){
  51.         String fileName = "第二个thy的文件";
  53.         //一、设置数据（可以用map，也可以用对象）
  54.         Map<String,Object> map = new HashMap<>();
  55.         //1普通文本参数
  56.         map.put("msg1","我是参数1111");
  57.         map.put("msg2","我是参数2222");
  58.         map.put("msg3","我是参数3333");
  59.         //2if-else参数
  60.         map.put("thIf1","1");
  61.         map.put("thIf2","2");
  63.         //3循环：构建集合参数，用于表格：可以是Map；可以是对象
  64. //        List<Map<String,Object>> msg4Vos = new ArrayList<>();
  65.         List<Msg4Vo> msg4Vos = new ArrayList<>();
  66.         for (int i = 0; i < 10; i++) {
  67.             //1map方式
  68. //            Map<String,Object> map4 = new HashMap<>();
  69. //            map4.put("l1","列1-" + i);
  70. //            map4.put("l2","列2-" + i);
  71. //            map4.put("l3","列3-" + i);
  72. //            map4.put("l4","列4-" + i);
  73. //            msg4Vos.add(map4);
  74.             //2对象方式
  75.             Msg4Vo vo = new Msg4Vo();
  76.             vo.setL1("列1-" + i);
  77.             vo.setL2("列2-" + i);
  78.             vo.setL3("列3-" + i);
  79.             vo.setL4("列4-" + i);
  80.             msg4Vos.add(vo);
  81.         }
  82.         map.put("msg4Vos",msg4Vos);
  84.         //4设置数据
  85.         Context context = new Context();
  86.         context.setVariables(map);
  87.         //写入输入（模板名称，数据）：1：html；2：xml
  88.         String process = "";
  89.         if ("1".equals(type)){
  90.             process = springTemplateEngine1Html.process("thymeleaf_3_wps", context);
  91.         }else if ("2".equals(type)){
  92.             process = springTemplateEngine2Xml.process("thymeleaf_4_wps_final", context);
  93.         }
  95.         //二、下载
  96.         //建议下载成doc的。不然微软的office可能打不开
  97.         try {
  98.             byte[] bytes = process.getBytes(StandardCharsets.UTF_8);
  99. //            ByteArrayInputStream inputStream = new ByteArrayInputStream(bytes);
  100. //            ByteArrayOutputStream outputStream = getByteArrayOutputStream(inputStream);
  102.             response.setCharacterEncoding("utf-8");
  103.             response.setContentType("application/msword");
  104.             response.setHeader("Access-Control-Expose-Headers","Content-disposition");
  105.             response.setHeader("Content-disposition","attachment; filename=" +
  106.                     URLEncoder.encode(fileName.concat(".doc"), "UTF-8"));
  107.             ServletOutputStream out = response.getOutputStream();
  109.             //两种方式都可以：用bytes好些
  110. //            out.write(outputStream.toByteArray());
  111.             out.write(bytes);
  112.             out.flush();
  113.             out.close();
  114.         }catch(Exception e){
  115.             e.printStackTrace();
  116.         }
  118.     }
  120.     /** 将 ByteArrayInputStream 拷贝成 ByteArrayOutputStream
  121.      *  将 字节数组输入流 拷贝成 字节数组输出流
  122.      */
  123.     public static ByteArrayOutputStream getByteArrayOutputStream(ByteArrayInputStream inputStream) throws IOException {
  124.         ByteArrayOutputStream outputStream = new ByteArrayOutputStream();
  125.         byte[] buffer = new byte[1024];
  126.         int length;
  127.         while ((length = inputStream.read(buffer)) != -1) {
  128.             outputStream.write(buffer, 0, length);
  129.         }
  130.         return outputStream;
  131.     }
  133. }
复制代码
四、总结


  • 甚至可以结合Thymeleaf模板技术和ApachePoi技术。
  • 先使用Thymeleaf模板技术替换Word文档中的值。然后得到完整的HTML格式的Word文档
  • 然后使用ApachePoi导出HTML格式的Word文档
  • 文中使用到的文档：
https://files.cnblogs.com/files/blogs/787464/SpringBoot导出Word文档的三种方式-文档.rar?t=1683184411&download=true

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！

本帖子中包含更多资源

您需要 登录 才可以下载或查看，没有账号？立即注册

x
回复

使用道具 举报

0 个回复

倒序浏览
返回列表

快速回复

高级模式
B Color Image Link Quote Code Smilies
您需要登录后才可以回帖 登录 or 立即注册

本版积分规则

干翻全岛蛙蛙

金牌会员
这个人很懒什么都没写!

楼主热帖

标签云

存储 服务器
微信订阅号
微信服务号
微信客服
小程序
H5
关于我们 商务合作 网站地图
©Copyright 2022-2024 杭州祥升科技有限公司 版权所有 浙ICP备20004199号
快速回复 返回顶部 返回列表