news 2026/4/18 4:00:12

在 Blazor Server 中集成 docx-preview.js 实现高保真 Word 预览

作者头像

张小明

前端开发工程师

1.2k 24
文章封面图
在 Blazor Server 中集成 docx-preview.js 实现高保真 Word 预览

前言

这两天在做一个在线预览各种类型文档的模块,主要是针对pdf和word,pdf好说,方案一大把,选一个最合适的就好,我这里的管理项目是基于MudBlazor的,所以我使用了官方推荐的Pdf扩展组件Gotho.BlazorPdf,当然即便不用原生组件,自己基于pdf.js等前端方案来封装也是完全没问题的,这个我就不多说了。

这里主要想聊聊在线预览word文档的实现思路,总结起来基本就是3条路线

  • 第一条是先把word格式转成pdf,然后再通过pdf预览组件来预览,这条路线实现方案也很多,问题就是装换的实现如果你之前没有写过类似的功能,可能要费一番功夫,当然不差钱的话,可以用一些商用组件,比如Aspose, Spire.Doc等,虽然价格略高,但专业性高,功能极强,物有所值。当然除了转化成pdf还可以转换成html或者markdown等,总之就是转换的路线,这里不再赘述。
  • 第二条路线是借助微软原生的 Office Online 服务或者Google Viewer等方案,实现在线预览,当然这也有一个要求,就是你的文档需要能在公网访问,或者有运维能力的话,可以在本地部署一个私有Office Online服务,这个微软官方有详细的文档(https://learn.microsoft.com/zh-cn/officeonlineserver/deploy-office-online-server),对这种方式感兴趣的小伙伴可以试试(笔者不推荐私有部署的方式,如果你的场景里文档允许外网访问的话,推荐直接使用在线方式,最简单)。
  • 第三条路线是,使用一些纯前端方案,更加的轻量级,当然他会有一些限制条件,比如一些表现好的组件不支持原始的doc格式,只能是docx,超过10M的渲染可能也会很慢。所以选型时要考虑这些条件,笔者采用的就是这条路线。

方案介绍

近几年前端发展迅猛在线预览复杂的word文档已经有了成熟方案,比如mammoth.js,docx-preview.js,amis.js等,这里面mammoth还提供了.net的nuget包,方便Blazor环境使用,但有个问题是,他渲染出来的文档会影响原文布局,所以如果只是“看内容”不在乎排版受影响,那.net环境下,使用前端方案实现文档预览,mammoth毫无疑问是最佳方案。

但我这里是一个“审核”的场景,需要对源文件实现“公文级”,设置“像素级”的还原,也就是和word文档几乎一样,所以更适合我这里的方案是“docx-preview.js”,仓库地址👉:https://github.com/VolodymyrBaydalka/docxjs。

至于另外一个amis.js,这个是国内大厂百度出品的一个组件,文档很全,也是一个不错的路线。

实现步骤

引入组件

因为是客户端方案,我们可以在外边通过npm等方式先把核心组件拉到本地,当然直接在VS里添加客户端库也可以。

npminstalldocx-preview

编写隔离型 JS 互操作层

在 wwwroot/assets/js/docxInterop.js 中,我们不仅要处理预览逻辑,还要处理环境隔离。

/** * 我这里因为用到了Monaco Editor组件,因此要处理一下AMD加载器的冲突 */exportasyncfunctionrenderDocxFromUrl(url,containerId){constcontainer=document.getElementById(containerId);if(!container)return;constloadScriptWithIsolation=(src)=>{returnnewPromise((resolve,reject)=>{if(document.querySelector(`script[src="${src}"]`)){resolve();return;}// 临时屏蔽全局define函数,防止与Monaco Editor等库的AMD加载器冲突const_backupDefine=window.define;window.define=undefined;constscript=document.createElement('script');script.src=src;script.onload=()=>{window.define=_backupDefine;// 加载后立即还原resolve();};script.onerror=reject;document.head.appendChild(script);});};try{// 1. 加载依赖awaitloadScriptWithIsolation('./assets/js/jszip.min.js');awaitloadScriptWithIsolation('./assets/js/docx-preview.min.js');// 2. 获取文件流constresponse=awaitfetch(url);constarrayBuffer=awaitresponse.arrayBuffer();// 3. 调用预览逻辑constoptions={className:"docx-preview",inWrapper:true,breakPages:true};awaitwindow.docx.renderAsync(arrayBuffer,container,null,options);}catch(e){console.error("预览失败:",e);container.innerHTML="文档加载失败";}}

封装 Blazor 预览组件

使用 IJSObjectReference 确保 JS 逻辑的模块化,避免污染全局命名空间。

@inject IJSRuntime JS @implements IAsyncDisposable<divid="@_containerId"class="docx-render-area"style="height:@Height; overflow:auto;"></div>@code{[Parameter]publicstringHeight{get;set;}="700px";privatestring_containerId=$"docx-{Guid.NewGuid():N}";// JS 模块引用privateIJSObjectReference?_module;protectedoverrideasyncTaskOnAfterRenderAsync(boolfirstRender){if(firstRender){// 动态加载 JS 模块文件_module=awaitJS.InvokeAsync<IJSObjectReference>("import","/assets/js/docxInterop.js");}}publicasyncTaskLoadFromUrlAsync(stringurl){if(_module==null)return;try{//_isLoading = true;StateHasChanged();// 直接把 URL 传给 JS 处理,避免大数组在 SignalR 中传输await_module.InvokeVoidAsync("renderDocxFromUrl",url,_containerId);}finally{//_isLoading = false;StateHasChanged();}}publicasyncTaskLoadFromStreamAsync(Streamstream){if(_module==null)return;usingvarms=newMemoryStream();awaitstream.CopyToAsync(ms);await_module.InvokeVoidAsync("renderDocx",ms.ToArray(),_containerId);}// 释放模块引用,防止内存泄漏publicasyncValueTaskDisposeAsync(){if(_module!=null){try{// 只有当连接还活着的时候才去调用 Disposeawait_module.DisposeAsync();}catch(JSDisconnectedException){// 忽略连接断开导致的异常,这是正常的}}}}

父组件引入

父组件的引入的时候只要给一个高度参数就可以了

// blazor页面部分,引入组件<DocxViewer@ref="_docxViewer"Height="75vh"/>// code部分编写引入逻辑privateDocxViewer_docxViewer;privateasyncTaskLoadFile(stringurl){if(_docxViewer!=null)await_docxViewer.LoadFromUrlAsync(url);}

最后的效果如下

服务器配置

在服务注入的入口中适当调高 SignalR 的传输上限,这个仅限Blazor Server模式,BlazerWSAM或者Hybird方式不需要:

builder.Services.AddServerSideBlazor().AddHubOptions(options=>{options.MaximumReceiveMessageSize=32*1024*1024;// 32MB});

* 避坑

我在集成过程中,遇到了类似“Uncaught Error: Can only have one anonymous define call”的报错。排查后的原因是:

  1. 使用了Monaco Editor这样的库自带了 AMD 加载器(loader.js)。
  2. docx-preview 检测到define函数后会尝试注册模块,导致冲突。
  3. 解决方案:采用动态加载脚本,并在加载期间暂时“抹除”全局define。

总结

通过这种方式,不仅在 Blazor Server 中实现了 Word 文档的高保真预览,而且足够轻量化,还可以方便的将其用到任何需要预览功能的页面中。我真的越来越喜欢Blazor这个组件化的开发模式了,好了,就这些,下次再见。

版权声明: 本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若内容造成侵权/违法违规/事实不符,请联系邮箱:809451989@qq.com进行投诉反馈,一经查实,立即删除!
网站建设 2026/4/18 3:57:12

大数据领域分布式存储的存储性能优化技巧

大数据领域分布式存储的存储性能优化技巧&#xff1a;从"数据仓库"到"超级快递站"的升级指南 关键词&#xff1a;分布式存储、性能优化、数据分片、一致性协议、IO路径优化、副本机制、硬件加速 摘要&#xff1a;在大数据时代&#xff0c;分布式存储就像一…

作者头像 李华
网站建设 2026/4/18 3:17:14

三脚电感布局布线对EMI性能的影响研究

三脚电感布局布线对EMI性能的影响研究&#xff1a;从理论到实战的深度解析当电子系统“吵”起来时&#xff0c;谁在负责降噪&#xff1f;在今天的电子产品设计中&#xff0c;我们常常追求更高的效率、更小的体积和更低的功耗。但当这些目标达成的同时&#xff0c;一个问题却悄然…

作者头像 李华
网站建设 2026/4/15 11:03:54

SiFive平台下RISC-V用户模式与特权模式切换详解

深入SiFive平台&#xff1a;RISC-V用户态与特权态切换的底层逻辑与实战解析你有没有遇到过这样的情况&#xff1f;在SiFive开发板上跑一个裸机程序&#xff0c;突然ecall指令一执行就卡死&#xff1b;或者写了个简单的系统调用&#xff0c;结果返回后程序“飞了”——PC指针指向…

作者头像 李华
网站建设 2026/4/17 5:31:43

科技是把双刃剑ai到底是不是双刃剑

科技双刃剑属性概述定义科技双刃剑的核心特征&#xff08;利弊并存&#xff09;历史案例&#xff08;如核能、互联网的正面与负面影响&#xff09;引出AI作为典型双刃剑技术的争议性AI的积极应用场景效率提升&#xff1a;自动化生产、数据分析加速决策医疗突破&#xff1a;疾病…

作者头像 李华
网站建设 2026/4/15 13:46:33

安全继电器模块PCB原理图设计新手教程

从零开始设计一个安全继电器模块&#xff1a;原理图实战入门指南你有没有遇到过这样的情况&#xff1f;在做一个自动化控制项目时&#xff0c;明明程序写得没问题&#xff0c;继电器也“咔哒”响了&#xff0c;结果设备却在不该运行的时候突然启动——或者更糟&#xff0c;紧急…

作者头像 李华
网站建设 2026/4/10 8:50:28

Altium Designer中高速PCB布线的完整指南

高速PCB设计实战&#xff1a;在Altium Designer中驾驭信号完整性挑战你有没有遇到过这样的情况&#xff1f;电路原理图完美无缺&#xff0c;元器件选型严谨&#xff0c;可板子一上电&#xff0c;DDR就是跑不起来&#xff0c;时钟抖得像筛子&#xff0c;数据采集满屏乱码。反复检…

作者头像 李华