测试效果
先看下效果
文档内容如下：
上传
上传docx文档
查看解析内容
<html><head><style>p{margin-top:0pt;margin-bottom:1pt;}p.a{text-align:justified;}p.X1{margin-top:17.0pt;margin-bottom:16.5pt;}span.X1{font-size:22.0pt;font-weight:bold;}span.X10{font-size:22.0pt;font-weight:bold;}</style></head><body><div style="width:595.3pt;margin-bottom:72.0pt;margin-top:72.0pt;margin-left:90.0pt;margin-right:90.0pt;"><p>我的测试文档！</p><p><br/></p><p><img src="1659939780312/word/media/image1.png" style="width:200.0pt;height:200.0pt;"/></p><p><br/></p><p>正文部分</p><p>吧啦吧啦啦啦啦阿拉啦啦</p></div></body></html>
上传doc文档
查看解析内容
<html><head><META http-equiv="Content-Type" content="text/html; charset=utf-8"><style type="text/css">.b1{white-space-collapsing:preserve;}.b2{margin: 1.0in 1.25in 1.0in 1.25in;}.p1{text-align:justify;hyphenate:auto;font-family:Times New Roman;font-size:10pt;}</style><meta content="Student" name="author"></head><body class="b1 b2"><p class="p1"><span>我的测试文档！</span></p><p class="p1"></p><p class="p1"><img src="1659940657795.jpg" style="width:2.7777777in;height:2.7777777in;vertical-align:text-bottom;"></p><p class="p1"></p><p class="p1"><span>正文部分</span></p><p class="p1"><span>吧啦吧啦啦啦啦阿拉啦啦</span></p><p class="p1"></p><p class="p1"><img src="1659940657795.jpg" style="width:1.3083333in;height:1.3083333in;vertical-align:text-bottom;"></p></body></html>
导出
利用刚刚解析出来的HTML导出为Word
访问导出接口即可下载文档
导出效果
实现原理
代码结构
注意target/classes/word/image目录和content.docx模版文档要存在
content.docx中的内容就是content:
依赖
<dependency><groupId>cn.afterturn</groupId><artifactId>easypoi-spring-boot-starter</artifactId><version>4.2.0</version></dependency><dependency><groupId>org.jsoup</groupId><artifactId>jsoup</artifactId><version>1.13.1</version></dependency><dependency><groupId>org.docx4j</groupId><artifactId>docx4j</artifactId><version>3.3.6</version><!--排除slf4j包与springboot的冲突--><exclusions><exclusion><groupId>org.slf4j</groupId><artifactId>slf4j-log4j12</artifactId></exclusion></exclusions></dependency><!--word操作工具类--><dependency><groupId>com.deepoove</groupId><artifactId>poi-tl</artifactId><version>1.6.0-beta1</version></dependency><!-- POI-word文件处理需要 --><dependency><groupId>org.apache.poi</groupId><artifactId>poi</artifactId><version>3.17</version></dependency><dependency><groupId>org.apache.poi</groupId><artifactId>poi-scratchpad</artifactId><version>3.17</version></dependency><dependency><groupId>org.apache.poi</groupId><artifactId>poi-ooxml</artifactId><version>3.17</version></dependency><dependency><groupId>fr.opensagres.xdocreport</groupId><artifactId>xdocreport</artifactId><version>2.0.1</version></dependency><dependency><groupId>org.apache.poi</groupId><artifactId>poi-ooxml-schemas</artifactId><version>3.17</version></dependency><dependency><groupId>org.apache.poi</groupId><artifactId>ooxml-schemas</artifactId><version>1.4</version></dependency><dependency><groupId>mons</groupId><artifactId>commons-lang3</artifactId><version>3.7</version></dependency>
思路
上传word文件，解析出HTML内容，图片存储到定义好的静态资源目录，主题HTML文档中img的src存储的是相对路径
当导出word文件时，先对HTML文档img的src进行解析，增加服务器的静态资源访问位置路径，这样就能访问到图片输出为word
可以根据需求可以替换成图片资源服务器～
静态资源配置
用于定义图片存储和模版文件等
application.yml
spring:application:name: hotevent-serviceundertow:buffer-size: 1024direct-buffers: trueprofiles:active: devresources:static-locations: ${res.src}servlet:multipart:enabled: true #是否启用http上传处理max-request-size: 100MB #最大请求文件的大小max-file-size: 20MB #设置单个文件最大长度file-size-threshold: 20MB #当文件达到多少时进行磁盘写入#当前应用相关的配置请在app下添加app:resource-img-path: ${app.resource-img-path.val}upload-img-path: ${app.upload-img-path.val}
application-dev.properties
# 应用名称spring.application.name=html-to-word# 应用服务 WEB 访问端口server.port=9967app.upload-img-path.val=/Users/cat/Documents/image/app.resource-img-path.val=http://127.0.0.1:9967/#富文本内图片url前缀app.html.url.head=http://127.0.0.1:9967/image/# 富文本导出 word 模版路径word.src=word/content.docx#静态资源映射路径, 用于存储解析的图片res.src=file:/Users/cat/Desktop/html-to-word/target/classes/wordres.word=/Users/cat/Desktop/html-to-word/target/classes/word/
代码实现
HtmlToWordConStants 常量类
package com.hexuan.htmltoword.constants;/*** 处理富文本公共常量** @author hexuan.wang*/public class HtmlToWordConStants {/*** 固定元素节点*/public static final String COMMONATTR = "data-class";/*** html标签*/public static final String HTML_ELEMENT = "<html>";/*** word转html的默认文件名*/public static final String DEMO_HTML = "demo.html";/*** doc文件后缀*/public static final String DOC = ".doc";/*** docx文件后缀*/public static final String DOCX = ".docx";/*** 图片默认缩放宽度*/public static final String IMG_WIDTH = "400";}
TestController 接口测试案例
package com.hexuan.htmltoword.controller;import com.hexuan.htmltoword.constants.HtmlToWordConStants;import com.hexuan.htmltoword.util.word.ExcelUtils;import com.hexuan.htmltoword.util.word.XWPFDocumentUtil;import fr.opensagres.poi.xwpf.converter.core.BasicURIResolver;import fr.opensagres.poi.xwpf.converter.core.FileImageExtractor;import fr.opensagres.poi.xwpf.converter.xhtml.XHTMLConverter;import fr.opensagres.poi.xwpf.converter.xhtml.XHTMLOptions;import mons.lang3.StringUtils;import org.apache.poi.hwpf.HWPFDocument;import org.apache.poi.hwpf.converter.PicturesManager;import org.apache.poi.hwpf.converter.WordToHtmlConverter;import org.apache.poi.hwpf.usermodel.PictureType;import org.apache.poi.openxml4j.opc.OPCPackage;import org.apache.poi.xwpf.usermodel.XWPFDocument;import org.jsoup.Jsoup;import org.jsoup.nodes.Element;import org.jsoup.select.Elements;import org.springframework.beans.factory.annotation.Value;import org.springframework.web.bind.annotation.*;import org.springframework.web.multipart.MultipartFile;import org.w3c.dom.Document;import javax.servlet.http.HttpServletRequest;import javax.servlet.http.HttpServletResponse;import javax.xml.parsers.DocumentBuilderFactory;import javax.xml.parsers.ParserConfigurationException;import javax.xml.transform.OutputKeys;import javax.xml.transform.Transformer;import javax.xml.transform.TransformerException;import javax.xml.transform.TransformerFactory;import javax.xml.transform.dom.DOMSource;import javax.xml.transform.stream.StreamResult;import java.io.*;import java.util.ArrayList;import java.util.HashMap;import java.util.List;import java.util.Map;/*** 正常接口返回通用返回对象，这里只是为了演示word与html的互相转换返回的String*/@RestControllerpublic class TestController {@Value("${word.src}")private String exportWordSrc;@Value("${res.word}")private String resWord;@Value("${app.html.url.head}")private String htmlUrlHead;/*** 文件上传** @param file上传文件* @return* @throws Exception*/@PostMapping(value = "/upload")public String upload(@RequestParam("file") MultipartFile file) throws Exception {String message = "success";if (!file.isEmpty()) {StringBuilder context = new StringBuilder();try {if (file.getOriginalFilename().endsWith(HtmlToWordConStants.DOC)) {docToHtml(file);} else if (file.getOriginalFilename().endsWith(HtmlToWordConStants.DOCX)) {docxToHtml(file);} else {message = "格式有误，只允许doc,docx的word文件";return message;}} catch (FileNotFoundException e) {e.printStackTrace();message = "操作失败";return message;}String content = readFileByLines(resWord + HtmlToWordConStants.DEMO_HTML);System.out.println(content);}return "ok";}/*** 逐行读取文件** @param fileName* @return*/public static String readFileByLines(String fileName) {FileInputStream file = null;BufferedReader reader = null;InputStreamReader inputFileReader = null;String content = "";String tempString = null;try {file = new FileInputStream(fileName);inputFileReader = new InputStreamReader(file, "utf-8");reader = new BufferedReader(inputFileReader);// 一次读入一行，直到读入null为文件结束while ((tempString = reader.readLine()) != null) {content += tempString;}reader.close();} catch (IOException e) {e.printStackTrace();return null;} finally {if (reader != null) {try {reader.close();} catch (IOException e1) {}}}return content;}/*** doc转html 输出到资源/word/demo.html** @param file* @throws TransformerException* @throws IOException* @throws ParserConfigurationException*/void docToHtml(MultipartFile file) throws TransformerException, IOException, ParserConfigurationException {HWPFDocument hwpfDocument = new HWPFDocument(file.getInputStream());WordToHtmlConverter converter = new WordToHtmlConverter(DocumentBuilderFactory.newInstance().newDocumentBuilder().newDocument());//设置存储图片的管理者--使用匿名内部类实现 该类实现了PicturesManager接口，实现了其中的savePicture方法converter.setPicturesManager(new PicturesManager() {FileOutputStream out = null;//在下面的processDocument方法内部会调用该方法 用于存储word中的图片文件@Overridepublic String savePicture(byte[] bytes, PictureType pictureType, String name, float width, float height) {String imgName = String.valueOf(System.currentTimeMillis());try {//单个图片的保存out = new FileOutputStream(resWord + "image/" + imgName + ".jpg");out.write(bytes);} catch (IOException exception) {exception.printStackTrace();} finally {if (out != null) {try {out.close();} catch (IOException e) {e.printStackTrace();}}}//这里要返回给操作者（HtmlDocumentFacade）一个存储的路径 用于生成Html时定位到图片资源return imgName + ".jpg";}});//使用外观模式，将hwpfDocument文档对象设置给HtmlDocumentFacade中的Document属性converter.processDocument(hwpfDocument);//获取转换器中的document文档Document htmlDocument = converter.getDocument();//充当文档对象模型 （DOM） 树形式的转换源树的持有者 -- 源树DOMSource domSource = new DOMSource(htmlDocument);//转换器 该对象用于将源树转换为结果树Transformer transformer = TransformerFactory.newInstance().newTransformer();//设置输出时的以什么方式输出，也可说是结果树的文件类型 可以是html/xml/text或者是一些扩展前三者的扩展类型transformer.setOutputProperty(OutputKeys.METHOD, "html");//设置一些必要的属性 设置输出时候的编码为utf-8transformer.setOutputProperty(OutputKeys.ENCODING, "utf-8");//转换 将输入的源树转换为结果树并且输出到streamResult中transformer.transform(domSource, new StreamResult(new File(resWord + HtmlToWordConStants.DEMO_HTML)));}/*** docx转html 输出到资源/word/demo.html** @param file* @throws IOException*/void docxToHtml(MultipartFile file) throws IOException {OutputStreamWriter outputStreamWriter = null;XWPFDocument document = new XWPFDocument(file.getInputStream());XHTMLOptions options = XHTMLOptions.create();// 存放图片的文件夹options.setExtractor(new FileImageExtractor(new File(resWord + "image/" + System.currentTimeMillis())));// html中图片的路径options.URIResolver(new BasicURIResolver(System.currentTimeMillis() + "/"));outputStreamWriter = new OutputStreamWriter(new FileOutputStream(resWord + HtmlToWordConStants.DEMO_HTML), "utf-8");XHTMLConverter xhtmlConverter = (XHTMLConverter) XHTMLConverter.getInstance();xhtmlConverter.convert(document, outputStreamWriter, options);outputStreamWriter.close();}/*** 导出 word 文档** @param request* @param response* @return* @throws Exception*/@GetMapping(value = "/exportWord")public String exportWord(HttpServletRequest request, HttpServletResponse response) throwsException {String content = "<html><head><META http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\"><style type=\"text/css\">.b1{white-space-collapsing:preserve;}.b2{margin: 1.0in 1.25in 1.0in 1.25in;}.p1{text-align:justify;hyphenate:auto;font-family:Times New Roman;font-size:10pt;}</style><meta content=\"Student\" name=\"author\"></head><body class=\"b1 b2\"><p class=\"p1\"><span>我的测试文档！</span></p><p class=\"p1\"></p><p class=\"p1\"><img src=\"1659941077600.jpg\" style=\"width:2.7777777in;height:2.7777777in;vertical-align:text-bottom;\"></p><p class=\"p1\"></p><p class=\"p1\"><span>正文部分</span></p><p class=\"p1\"><span>吧啦吧啦啦啦啦阿拉啦啦</span></p><p class=\"p1\"></p><p class=\"p1\"><img src=\"1659941077601.jpg\" style=\"width:1.3083333in;height:1.3083333in;vertical-align:text-bottom;\"></p></body></html>\n";//由于刚刚导入解析存储的是相对路径，所以导出时要加上图片资源的前缀，我这里直接存储在了自定义的静态资源目录中content = replaceImgSrc(content);InputStream in = null;XWPFDocument doc = null;in = Thread.currentThread().getContextClassLoader().getResourceAsStream(exportWordSrc);OPCPackage srcPackage = OPCPackage.open(in);doc = new XWPFDocument(srcPackage);List<Map<String, Object>> mapList = new ArrayList<>();Map<String, Object> param = new HashMap<>(16);param.put("content", content);mapList.add(param);String s = "";XWPFDocumentUtil.wordInsertRitchText(doc, mapList);// 将docx输出ExcelUtils.exportWordList(doc, "导出文件名" + HtmlToWordConStants.DOCX, request, response);//因为上面已经使用response返回了文件，浏览器认为已经收到响应，不需要再次发送响应对象，否则会报错return null;}/*** 将html中src的相对路径增加服务器资源前缀** @param htmlBody* @return*/public String replaceImgSrc(String htmlBody) {org.jsoup.nodes.Document document = Jsoup.parse(htmlBody);Elements nodes = document.select("img");int nodeLenth = nodes.size();for (int i = 0; i < nodeLenth; i++) {Element e = nodes.get(i);String src = e.attr("src");if (StringUtils.isNotBlank(src)) {e.attr("src", htmlUrlHead + src);}}if (htmlBody.contains(HtmlToWordConStants.HTML_ELEMENT)) {return document.toString();} else {return document.select("body>*").toString();}}}
ElementEnum HTML元素映射到word的枚举
package com.hexuan.htmltoword.enums;/*** html 元素枚举映射类** @author hexuan.wang*/public enum ElementEnum {H1("h1", "h1", "一级标题"),H2("h2", "h2", "二级标题"),H3("h3", "h3", "三级标题"),H7("h7", "h7", "小标题"),P("p", "paragraph", "段落"),STRONG("strong", "", "加粗"),I("i", "", "斜体"),U("u", "", "字体下划线"),IMG("img", "imgurl", "base64图片"),TABLE("table", "table", "表格"),BR("br", "br", "换行");private String code;private String value;private String desc;public String getCode() {return code;}public String getValue() {return value;}public String getDesc() {return desc;}ElementEnum(String code, String value, String desc) {this.code = code;this.value = value;this.desc = desc;}public static String getValueByCode(String code) {for (ElementEnum e : ElementEnum.values()) {if (e.getCode().equalsIgnoreCase(code)) {return e.getValue();}}return null;}}
TitleFontEnum 标题字体样式
package com.hexuan.htmltoword.enums;/*** word 设置标题字体大小** @author hexuan.wang*/public enum TitleFontEnum {H1("h1", 24),H2("h2", 22),H3("h3", 12),H7("h7", 12);private String title;private Integer font;public String getTitle() {return title;}public Integer getFont() {return font;}TitleFontEnum(String title, Integer font) {this.title = title;this.font = font;}public static Integer getFontByTitle(String title) {for (TitleFontEnum e : TitleFontEnum.values()) {if (title.equals(e.getTitle())) {return e.getFont();}}return null;}}
WordUtils 导出 word 工具类
package com.hexuan.htmltoword.util.word;import org.apache.poi.xwpf.usermodel.XWPFDocument;import org.springframework.util.Assert;import javax.servlet.http.HttpServletRequest;import javax.servlet.http.HttpServletResponse;import java.io.OutputStream;import .URLEncoder;/*** 导出 word 工具类** @author hexuan.wang*/public class WordUtils {/*** 导出word** @param docword 模版地址* @param fileName 文件名* @param request* @param response*/public static void exportWordList(XWPFDocument doc, String fileName, HttpServletRequest request, HttpServletResponse response) {Assert.notNull(fileName, "导出文件名不能为空");Assert.isTrue(fileName.endsWith(".docx"), "word导出请使用docx格式");try {String userAgent = request.getHeader("user-agent").toLowerCase();if (userAgent.contains("msie") || userAgent.contains("like gecko")) {fileName = URLEncoder.encode(fileName, "UTF-8");} else {fileName = new String(fileName.getBytes("utf-8"), "ISO-8859-1");}// 设置强制下载不打开response.setContentType("application/force-download");// 设置文件名response.addHeader("Content-Disposition", "attachment;fileName=" + fileName);OutputStream out = response.getOutputStream();doc.write(out);out.close();} catch (Exception e) {e.printStackTrace();}}}
XWPFDocumentUtil
package com.hexuan.htmltoword.util.word;import org.apache.poi.xwpf.usermodel.XWPFDocument;import org.apache.poi.xwpf.usermodel.XWPFParagraph;import java.util.List;import java.util.Map;/*** @author hexuan.wang*/public class XWPFDocumentUtil {/*** 往doc的标记位置插入富文本内容 注意：目前支持富文本里面带url的图片，不支持base64编码的图片** @param doc需要插入内容的Word* @param ritchtextMap 标记位置对应的富文本内容* @param*/public static void wordInsertRitchText(XWPFDocument doc, List<Map<String, Object>> ritchtextMap) {try {int i = 0;long beginTime = System.currentTimeMillis();// 如果需要替换多份富文本，通过Map来操作，key:要替换的标记，value：要替换的富文本内容for (Map<String, Object> mapList : ritchtextMap) {for (Map.Entry<String, Object> entry : mapList.entrySet()) {i++;for (XWPFParagraph paragraph : doc.getParagraphs()) {if (entry.getKey().equals(paragraph.getText().trim())) {// 在标记处插入指定富文本内容HtmlUtils.resolveHtml(entry.getValue().toString(), doc, paragraph);if (i == ritchtextMap.size()) {//当导出最后一个富文本时 删除需要替换的标记doc.removeBodyElement(doc.getPosOfParagraph(paragraph));}break;}}}}} catch (Exception e) {e.printStackTrace();}}}
项目源码：/pikachu2333/html-to-word
