react前端导出word文档

7,093 阅读6分钟

react项目开发中遇到需求,在前端直接将HTML报表内容导出生成word文档,在网上查阅了相关资料,大概找到3种解决思路:

1、使用jquery.wordexport.js插件导出(需要依赖jquery,不想在react项目中引入); 
2、使用npm包html-docx-js; 
3、使用ActiveXObject对象。

第3种思路由于找到的文档较少,优先级靠后,尝试了1、2的方案做了些demo,发现都遇到了样式的处理问题(导出页面有较多的表格和纸张方向控制),搜索没有找到很好的解决办法,不过找到了些解决思路,一开始想尝试去阅读html-docx-js的源码,发现有点吃力,加上时间紧,然后去阅读了wordexport插件源码基本弄清楚了其导出原理,后面通过手写获取dom节点内容然后自己拼装成完整的html文档字符串+FileSaver.js 解决问题。

网上看到了都是些思路,并没有给出非常具体的代码实现以及导出中一些细节的处理,在此分享自己的一些实践经验,供参考。

在这里给出jquery.wordexport.js源码,并简单做出分析:

if (typeof jQuery !== "undefined" && typeof saveAs !== "undefined") {
    (function ($) {
        $.fn.wordExport = function (fileName) {
            fileName = typeof fileName !== 'undefined' ? fileName : "jQuery-Word-Export";
            // 定义文档模板
            var statics = {
                mhtml: {
                    top: "Mime-Version: 1.0\nContent-Base: " + location.href + "\nContent-Type: Multipart/related; boundary=\"NEXT.ITEM-BOUNDARY\";type=\"text/html\"\n\n--NEXT.ITEM-BOUNDARY\nContent-Type: text/html; charset=\"utf-8\"\nContent-Location: " + location.href + "\n\n\n\n_html_",
                    head: "\n\n\n\n",
                body: "<body>_body_</body>"
            }
        };
        var options = {
            maxWidth: 624
        };
        // Clone selected element before manipulating it
        var markup = $(this).clone();

        // Remove hidden elements from the output
        markup.each(function () {
            var self = $(this);
            if (self.is(':hidden'))
                self.remove();
        });

        // Embed all images using Data URLs
        var images = Array();
        var img = markup.find('img');
        for (var i = 0; i < img.length; i++) {
            // Calculate dimensions of output image
            var w = Math.min(img[i].width, options.maxWidth);
            var h = img[i].height * (w / img[i].width);
            // Create canvas for converting image to data URL
            var canvas = document.createElement("CANVAS");
            canvas.width = w;
            canvas.height = h;
            // Draw image to canvas
            var context = canvas.getContext('2d');
            context.drawImage(img[i], 0, 0, w, h);
            // Get data URL encoding of image
            var uri = canvas.toDataURL("image/png/jpg");
            $(img[i]).attr("src", img[i].src);
            img[i].width = w;
            img[i].height = h;
            // Save encoded image to array
            images[i] = {
                type: uri.substring(uri.indexOf(":") + 1, uri.indexOf(";")),
                encoding: uri.substring(uri.indexOf(";") + 1, uri.indexOf(",")),
                location: $(img[i]).attr("src"),
                data: uri.substring(uri.indexOf(",") + 1)
            };
        }

        // Prepare bottom of mhtml file with image data
        var mhtmlBottom = "\n";
        for (var i = 0; i < images.length; i++) {
            mhtmlBottom += "--NEXT.ITEM-BOUNDARY\n";
            mhtmlBottom += "Content-Location: " + images[i].location + "\n";
            mhtmlBottom += "Content-Type: " + images[i].type + "\n";
            mhtmlBottom += "Content-Transfer-Encoding: " + images[i].encoding + "\n\n";
            mhtmlBottom += images[i].data + "\n\n";
        }
        mhtmlBottom += "--NEXT.ITEM-BOUNDARY--";

        //TODO: load css from included stylesheet

        //var styles=' /* Font Definitions */@font-face{font-family:宋体;panose-1:2 1 6 0 3 1 1 1 1 1;mso-font-alt:SimSun;mso-font-charset:134;mso-generic-font-family:auto;mso-font-pitch:variable;mso-font-signature:3 680460288 22 0 262145 0;}  @font-face{font-family:"Cambria Math";panose-1:2 4 5 3 5 4 6 3 2 4;mso-font-charset:1;mso-generic-font-family:roman;mso-font-format:other;mso-font-pitch:variable;mso-font-signature:0 0 0 0 0 0;}  @font-face{font-family:"\@宋体";panose-1:2 1 6 0 3 1 1 1 1 1;mso-font-charset:134;mso-generic-font-family:auto;mso-font-pitch:variable;mso-font-signature:3 680460288 22 0 262145 0;}/* Style Definitions */p.MsoNormal, li.MsoNormal, div.MsoNormal{mso-style-unhide:no;mso-style-qformat:yes;mso-style-parent:"";margin:0cm;margin-bottom:.0001pt;mso-pagination:widow-orphan;font-size:14.0pt;font-family:宋体;mso-bidi-font-family:宋体;}p.MsoHeader, li.MsoHeader, div.MsoHeader{mso-style-noshow:yes;mso-style-priority:99;mso-style-link:"页眉 Char";margin:0cm;margin-bottom:.0001pt;text-align:center;mso-pagination:widow-orphan;layout-grid-mode:char;font-size:9.0pt;font-family:宋体;mso-bidi-font-family:宋体;}p.MsoFooter, li.MsoFooter, div.MsoFooter{mso-style-noshow:yes;mso-style-priority:99;mso-style-link:"页脚 Char";margin:0cm;margin-bottom:.0001pt;mso-pagination:widow-orphan;layout-grid-mode:char;font-size:9.0pt;font-family:宋体;mso-bidi-font-family:宋体;}p.MsoAcetate, li.MsoAcetate, div.MsoAcetate{mso-style-noshow:yes;mso-style-priority:99;mso-style-link:"批注框文本 Char";margin:0cm;margin-bottom:.0001pt;mso-pagination:widow-orphan;font-size:9.0pt;font-family:宋体;mso-bidi-font-family:宋体;}span.Char{mso-style-name:"页眉 Char";mso-style-noshow:yes;mso-style-priority:99;mso-style-unhide:no;mso-style-locked:yes;mso-style-link:页眉;font-family:宋体;mso-ascii-font-family:宋体;mso-fareast-font-family:宋体;mso-hansi-font-family:宋体;}span.Char0{mso-style-name:"页脚 Char";mso-style-noshow:yes;mso-style-priority:99;mso-style-unhide:no;mso-style-locked:yes;mso-style-link:页脚;font-family:宋体;mso-ascii-font-family:宋体;mso-fareast-font-family:宋体;mso-hansi-font-family:宋体;}span.Char1{mso-style-name:"批注框文本 Char";mso-style-noshow:yes;mso-style-priority:99;mso-style-unhide:no;mso-style-locked:yes;mso-style-link:批注框文本;font-family:宋体;mso-ascii-font-family:宋体;mso-fareast-font-family:宋体;mso-hansi-font-family:宋体;}p.msochpdefault, li.msochpdefault, div.msochpdefault{mso-style-name:msochpdefault;mso-style-unhide:no;mso-margin-top-alt:auto;margin-right:0cm;mso-margin-bottom-alt:auto;margin-left:0cm;mso-pagination:widow-orphan;font-size:10.0pt;font-family:宋体;mso-bidi-font-family:宋体;}span.msonormal0{mso-style-name:msonormal;mso-style-unhide:no;}.MsoChpDefault{mso-style-type:export-only;mso-default-props:yes;font-size:10.0pt;mso-ansi-font-size:10.0pt;mso-bidi-font-size:10.0pt;mso-ascii-font-family:"Times New Roman";mso-hansi-font-family:"Times New Roman";mso-font-kerning:0pt;}/* Page Definitions */  @page WordSection1{size:595.3pt 841.9pt;margin:72.0pt 90.0pt 72.0pt 90.0pt;mso-header-margin:42.55pt;mso-footer-margin:49.6pt;mso-paper-source:0;}div.WordSection1{page:WordSection1;}';

        var styles = "";

        // Aggregate parts of the file together
        var fileContent = statics.mhtml.top.replace("_html_", statics.mhtml.head.replace("_styles_", styles) + statics.mhtml.body.replace("_body_", markup.html())) + mhtmlBottom;

        // Create a Blob with the file contents
        var blob = new Blob([fileContent], {
            type: "application/msword;charset=utf-8"
        });
        saveAs(blob, fileName + ".doc");
    };
})(jQuery);

} else { if (typeof jQuery === "undefined") { console.error("jQuery Word Export: missing dependency (jQuery)"); } if (typeof saveAs === "undefined") { console.error("jQuery Word Export: missing dependency (FileSaver.js)"); }}

该插件的主要原理就是获取dom节点内容,然后将其用模板拼接成字符串,然后生成Blob对象后使用saveAs保存。

了解了原理后其实我们可以不用这个插件自己完成导出。如下是我的项目中的实现:
<pre>
const mhtml={
top: "<!DOCTYPE html>\n<html xmlns:o=\"urn:schemas-microsoft-com:office:office\"\n" +
"      xmlns:w=\"urn:schemas-microsoft-com:office:word\"\n" +
"      xmlns:dt=\"uuid:C2F41010-65B3-11d1-A29F-00AA00C14882\"\n" +
"      xmlns=\"http://www.w3.org/TR/REC-html40\">\n_html_</html>",
head: "<head>\n<meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\">\n<style>\n_styles_\n</style>\n</head>\n",
body: "<body>_body_</body>"}</pre>
const exportReport=(styles,html,reportName)=>{
    let fileContent = mhtml.top.replace("_html_", mhtml.head.replace("_styles_", styles)+
        mhtml.body.replace("_body_",html));
    let blob = new Blob([fileContent], { type: "application/msword;charset=utf-8" });
    saveAs(blob, reportName+".doc");
}

在此我传入了样式参数styles和报告名称reportName,项目中没有用到图片的导出,所以此处做了简化,导出图片的需要可以直接参考以上jQuery插件的实现。

实际开发中需要注意的是,html文档的有些样式在word中是不能识别的,如后代元素选择器等,我采取的做法是直接在jsx中写行内样式,如:

const tdStyle={ borderTop:'solid black 1.0pt',borderLeft:'solid black 1.0pt',
    padding:'5px 0',whiteSpace: 'nowrap'};
    

报告内容一方面作为html文档要在web上显示,另一方面又需要导出,在样式处理上我采取了一种不太合理的方式,即同样公共的样式我使用了两个文件,如下图:

reportTpl.css for web,reportExportStyle.js for 导出

const styles=`
    @page WordSection1{
        size:595.3pt 841.9pt;
        margin:72.0pt 90.0pt 72.0pt 90.0pt;
        mso-header-margin:42.55pt;
        mso-footer-margin:49.6pt;
        mso-paper-source:0;
        layout-grid:15.6pt;
    }`

(这在维护上会有点不便,后来在网上看到是否可以采用Juice等包实现一套样式完成此两种功能)

导出word文档过程中遇到的一些细节问题,我是通过直接创建word文档,然后将其另存为html文件去查看其html源码然后再去尝试完成。记录开发中遇到的其它问题处理如下: 1.jsx换行的实现

word文件另存为html文件换行的实现
2.table中单元格内容换行问题,使用whiteSpace: 'nowrap'属性(这里看着简单,实际开发中一直没想到,一直在尝试调整列宽,不加此属性table会被压缩在纸张内(下图红框内)导致表格显示非常难看,加了这个后表格会被撑开,如下图),
3.导出word中纸张横向的实现

@page WordSection1
{   size:595.3pt 841.9pt;
    margin:72.0pt 90.0pt 72.0pt 90.0pt;
    mso-header-margin:42.55pt;
    mso-footer-margin:49.6pt;
    mso-paper-source:0;
    layout-grid:15.6pt;
}
div.WordSection1
{page:WordSection1;}
@page WordSection2
{size:841.9pt 595.3pt;
    mso-page-orientation:landscape;
    margin:90.0pt 72.0pt 90.0pt 72.0pt;
    mso-header-margin:42.55pt;
    mso-footer-margin:49.6pt;
    mso-paper-source:0;
    layout-grid:15.6pt;}
div.WordSection2
{page:WordSection2;}

4.目前有一个问题没有解决思路,导出的word文档在wps上默认以web版式显示,暂不知道如何配置实现默认以页面视图显示,欢迎给出解决方案。

最后,Talk is cheap,Show me the code。附上demo地址,供参考,欢迎交流!