【企业级富文本编辑器功能扩展项目纪实——从需求分析到阿里云OSS集成】
2023年X月X日 周X 上海·徐汇区
一、需求拆解与核心约束
作为前端工程师,近期接到客户紧急需求:在现有Vue2 + wangEditor4的后台系统中新增三大功能:
- Word粘贴增强:保留格式(表格/字体/颜色)并自动上传图片至阿里云OSS
- 微信公众号抓取:解析HTML并替换图片为OSS链接
- 多格式导入:支持Word/Excel/PPT/PDF全格式导入,保持排版一致性
技术边界条件:
- 前端:Vue2-cli + wangEditor4(需兼容IE11及国产浏览器)
- 后端:PHP 7.4 + Laravel(现有架构不可重构)
- 存储:阿里云OSS(需预留多云接口)
- 预算:≤2万元(含第三方服务采购)
二、技术选型与风险评估
1. 富文本编辑器插件方案对比
| 方案 | 优势 | 风险 | 成本(年费) |
|---|---|---|---|
| wangEditor扩展 | 原生支持Vue2,API兼容性好 | 需自行开发Office解析模块 | ¥0(开源) |
| TinyMCE企业版 | 官方支持Word导入 | 年费¥1.8万(超出预算) | ¥18,000 |
| wangEditor插件 | 轻量级但需适配wangEditor | 样式冲突风险高 | ¥3,000 |
决策:选择wangEditor扩展方案,理由:
- 预算内可控(仅需采购阿里云OSS流量包)
- 客户现有系统已使用wangEditor4,学习成本为零
2. 关键技术验证清单
- IE11兼容性:
- 阿里云OSS签名:
// PHP后端生成STS临时凭证(安全控制)$credentials=newCredentials('ak','sk');$stsClient=newStsClient($credentials);$assumeRoleResponse=$stsClient->assumeRole(['RoleArn'=>'acs:ram::1234567890:role/oss-upload-role','RoleSessionName'=>'session-name','DurationSeconds'=>900]);
三、核心功能开发实现
1. 前端集成(Vue2 + wangEditor4)
步骤1:扩展编辑器工具栏
// src/components/RichTextEditor.vueimportwangEditorfrom'wangEditor'exportdefault{mounted(){consteditor=wangEditor.create('#editor_id',{items:['fontname','fontsize','|','wordpaste','wechatpaste',// 自定义按钮'insertfile'],afterCreate:()=>{// 绑定自定义按钮事件this.bindCustomButtons(editor)}})},methods:{bindCustomButtons(editor){// Word粘贴处理editor.cmd.do('wordpaste',()=>{consthtml=window.clipboardData.getData('Text')// IE兼容this.processWordContent(html).then(cleanHtml=>{editor.insertHtml(cleanHtml)})})// 微信公众号内容处理editor.cmd.do('wechatpaste',async()=>{consturl=prompt('请输入公众号文章URL:')constres=awaitfetch(`/api/proxy/wechat?url=${encodeURIComponent(url)}`)consthtml=awaitres.text()editor.insertHtml(awaitthis.processWechatContent(html))})},asyncprocessWordContent(html){// 使用DOMParser解析Word HTMLconstdoc=newDOMParser().parseFromString(html,'text/html')constimages=doc.querySelectorAll('img[src^="file://"]')// 处理本地粘贴的图片for(letimgofimages){try{constblob=awaitthis.fileToBlob(img.src)constformData=newFormData()formData.append('file',blob,'word-image.png')constres=awaitfetch('/api/upload',{method:'POST',body:formData})constossUrl=awaitres.text()img.src=ossUrl}catch(e){console.error('图片上传失败:',e)img.remove()}}returndoc.body.innerHTML},fileToBlob(url){returnnewPromise((resolve)=>{fetch(url).then(res=>res.blob()).then(resolve)})}}}步骤2:IE11兼容性处理
// 修复IE下clipboardData.getData('HTML')失效问题if(window.clipboardData&&!window.clipboardData.getData('HTML')){Object.defineProperty(window.clipboardData,'getData',{value:(type)=>{if(type==='HTML')returndocument.selection.createRange().htmlTextreturn''}})}2. 后端实现(PHP + Aliyun OSS)
文件上传接口:
// api/upload.phprequire_once'vendor/autoload.php';useOSS\OssClient;useOSS\Core\OssException;header('Content-Type: text/plain');try{$ossClient=newOssClient('accessKeyId','accessKeySecret','endpoint');$object='uploads/'.uniqid().'_'.basename($_FILES['file']['name']);$ossClient->uploadFile('bucket-name',$object,$_FILES['file']['tmp_name']);echo'https://bucket-name.oss-cn-hangzhou.aliyuncs.com/'.$object;}catch(OssException$e){http_response_code(500);echo'上传失败: '.$e->getMessage();}微信公众号代理服务:
// api/proxy/wechat.php$url=$_GET['url'];$html=file_get_contents($url);// 替换公众号图片为代理URL$html=preg_replace_callback('/]+src="([^"]+)"[^>]*>/i',function($matches){$imgUrl=$matches[1];if(strpos($imgUrl,'mmbiz.qpic.cn')!==false){// 生成带签名的临时访问URLreturn'';}return$matches[0];},$html);echo$html;3. 多格式导入实现(Apache POI替代方案)
使用Mammoth.js处理Word文档:
// 处理.docx文件导入asyncfunctionimportDocx(file){constarrayBuffer=awaitfile.arrayBuffer()constresult=mammoth.extractRawText({arrayBuffer})// 解析结果中的图片result.messages.forEach(msg=>{if(msg.type==='warning'&&msg.message.includes('image')){// 提取图片并上传至OSS}})returnresult.value}PDF转HTML方案:
# 使用pdf.js服务端渲染(需部署Node服务)# 安装依赖npminstallpdfjs-dist# PHP调用Node服务示例$pdfHtml=shell_exec("node pdf2html.js ".escapeshellarg($pdfPath));四、成本控制与优化
OSS费用优化:
- 使用低频访问类型存储历史文件(成本降低40%)
- 启用CDN加速(减少回源流量)
第三方服务替代:
- 放弃商业版Office解析库,采用:
- Word/Excel:SheetJS Community Edition
- PPT:pptxjs
- PDF:pdf.js + pdf-lib
- 放弃商业版Office解析库,采用:
最终成本构成:
| 项目 | 费用 |
|---|---|
| 阿里云OSS流量包 | ¥1,200 |
| 域名SSL证书 | ¥0 |
| 开发人力成本 | ¥15,000 |
| 总计 | ¥16,200 |
五、交付与验收标准
功能验收:
- 在IE11中成功导入含20张图片的Word文档
- 微信公众号图片抓取准确率≥95%
性能指标:
- 50MB PPT导入耗时≤8秒
- OSS上传并发支持20QPS
交付物:
- 完整Vue组件源码(含IE兼容补丁)
- PHP后端接口文档
- 《阿里云OSS安全配置指南》
项目总结:
- 关键突破:通过DOMParser+正则表达式实现轻量级Word样式解析
- 遗留问题:复杂表格样式在IE11下存在1px偏移(已记录在JIRA)
- 知识沉淀:形成《前端信创环境兼容性手册》纳入公司知识库
(附:项目Git仓库地址已同步至公司Confluence,权限申请路径:IT部→前端组→2023-Q3-wangEditor扩展)
复制插件文件
安装jquery
npm install jquery导入组件
importEfrom'wangeditor'const{$,BtnMenu,DropListMenu,PanelMenu,DropList,Panel,Tooltip}=Eimport{WordPaster}from'../../static/WordPaster/js/w'import{zyCapture}from'../../static/zyCapture/z'import{zyOffice}from'../../static/zyOffice/js/o'初始化组件
//zyCapture ButtonclasszyCaptureBtnextendsBtnMenu{constructor(editor){const$elem=E.$(`<div class="w-e-menu">`)super($elem,editor)}clickHandler(){window.zyCapture.setEditor(this.editor).Capture();}tryChangeActive(){this.active()}}//zyOffice ButtonclassimportWordBtnextendsBtnMenu{constructor(editor){const$elem=E.$(`<div class="w-e-menu">`)super($elem,editor)}clickHandler(){window.zyOffice.SetEditor(this.editor).api.openDoc();}tryChangeActive(){this.active()}}//zyOffice ButtonclassexportWordBtnextendsBtnMenu{constructor(editor){const$elem=E.$(`<div class="w-e-menu">`)super($elem,editor)}clickHandler(){window.zyOffice.SetEditor(this.editor).api.exportWord();}tryChangeActive(){this.active()}}//zyOffice ButtonclassimportPdfBtnextendsBtnMenu{constructor(editor){const$elem=E.$(`<div class="w-e-menu">`)super($elem,editor)}clickHandler(){window.zyOffice.SetEditor(this.editor).api.openPdf();}tryChangeActive(){this.active()}}//WordPaster ButtonclassWordPasterBtnextendsBtnMenu{constructor(editor){const$elem=E.$(`<div class="w-e-menu">`)super($elem,editor)}clickHandler(){WordPaster.getInstance().SetEditor(this.editor).Paste();}tryChangeActive(){this.active()}}//wordImport ButtonclassWordImportBtnextendsBtnMenu{constructor(editor){const$elem=E.$(`<div class="w-e-menu">`)super($elem,editor)}clickHandler(){WordPaster.getInstance().SetEditor(this.editor).importWord();}tryChangeActive(){this.active()}}//excelImport ButtonclassExcelImportBtnextendsBtnMenu{constructor(editor){const$elem=E.$(`<div class="w-e-menu">`)super($elem,editor)}clickHandler(){WordPaster.getInstance().SetEditor(this.editor).importExcel();}tryChangeActive(){this.active()}}//ppt paster ButtonclassPPTImportBtnextendsBtnMenu{constructor(editor){const$elem=E.$(`<div class="w-e-menu">`)super($elem,editor)}clickHandler(){WordPaster.getInstance().SetEditor(this.editor).importPPT();}tryChangeActive(){this.active()}}//pdf paster ButtonclassPDFImportBtnextendsBtnMenu{constructor(editor){const$elem=E.$(`<div class="w-e-menu">`)super($elem,editor)}clickHandler(){WordPaster.getInstance().SetEditor(this.editor);WordPaster.getInstance().ImportPDF();}tryChangeActive(){this.active()}}//importWordToImg ButtonclassImportWordToImgBtnextendsBtnMenu{constructor(editor){const$elem=E.$(`<div class="w-e-menu">`)super($elem,editor)}clickHandler(){WordPaster.getInstance().SetEditor(this.editor).importWordToImg();}tryChangeActive(){this.active()}}//network paster ButtonclassNetImportBtnextendsBtnMenu{constructor(editor){const$elem=E.$(`<div class="w-e-menu">`)super($elem,editor)}clickHandler(){WordPaster.getInstance().SetEditor(this.editor);WordPaster.getInstance().UploadNetImg();}tryChangeActive(){this.active()}}exportdefault{name:'HelloWorld',data(){return{msg:'Welcome to Your Vue.js App'}},mounted(){vareditor=newE('#editor');WordPaster.getInstance({//上传接口:http://www.ncmem.com/doc/view.aspx?id=d88b60a2b0204af1ba62fa66288203edPostUrl:"http://localhost:8891/upload.aspx",License2:"",//为图片地址增加域名:http://www.ncmem.com/doc/view.aspx?id=704cd302ebd346b486adf39cf4553936ImageUrl:"http://localhost:8891{url}",//设置文件字段名称:http://www.ncmem.com/doc/view.aspx?id=c3ad06c2ae31454cb418ceb2b8da7c45FileFieldName:"file",//提取图片地址:http://www.ncmem.com/doc/view.aspx?id=07e3f323d22d4571ad213441ab8530d1ImageMatch:''});zyCapture.getInstance({config:{PostUrl:"http://localhost:8891/upload.aspx",License2:'',FileFieldName:"file",Fields:{uname:"test"},ImageUrl:'http://localhost:8891{url}'}})// zyoffice,// 使用前请在服务端部署zyoffice,// http://www.ncmem.com/doc/view.aspx?id=82170058de824b5c86e2e666e5be319czyOffice.getInstance({word:'http://localhost:13710/zyoffice/word/convert',wordExport:'http://localhost:13710/zyoffice/word/export',pdf:'http://localhost:13710/zyoffice/pdf/upload'})// 注册菜单E.registerMenu("zyCaptureBtn",zyCaptureBtn)E.registerMenu("WordPasterBtn",WordPasterBtn)E.registerMenu("ImportWordToImgBtn",ImportWordToImgBtn)E.registerMenu("NetImportBtn",NetImportBtn)E.registerMenu("WordImportBtn",WordImportBtn)E.registerMenu("ExcelImportBtn",ExcelImportBtn)E.registerMenu("PPTImportBtn",PPTImportBtn)E.registerMenu("PDFImportBtn",PDFImportBtn)E.registerMenu("importWordBtn",importWordBtn)E.registerMenu("exportWordBtn",exportWordBtn)E.registerMenu("importPdfBtn",importPdfBtn)//挂载粘贴事件editor.txt.eventHooks.pasteEvents.length=0;editor.txt.eventHooks.pasteEvents.push(function(){WordPaster.getInstance().SetEditor(editor).Paste();e.preventDefault();});editor.create();varedt2=newE('#editor2');//挂载粘贴事件edt2.txt.eventHooks.pasteEvents.length=0;edt2.txt.eventHooks.pasteEvents.push(function(){WordPaster.getInstance().SetEditor(edt2).Paste();e.preventDefault();return;});edt2.create();}}h1,h2{font-weight:normal;}ul{list-style-type:none;padding:0;}li{display:inline-block;margin:010px;}a{color:#42b983;}测试前请配置图片上传接口并测试成功
接口测试
接口返回JSON格式参考
为编辑器添加按钮
components:{Editor,Toolbar},data(){return{editor:null,html:'dd',toolbarConfig:{insertKeys:{index:0,keys:['zycapture','wordpaster','pptimport','pdfimport','netimg','importword','exportword','importpdf']}},editorConfig:{placeholder:''},mode:'default'// or 'simple'}},整合效果
导入Word文档,支持doc,docx
导入Excel文档,支持xls,xlsx
粘贴Word
一键粘贴Word内容,自动上传Word中的图片,保留文字样式。
Word转图片
一键导入Word文件,并将Word文件转换成图片上传到服务器中。
导入PDF
一键导入PDF文件,并将PDF转换成图片上传到服务器中。
导入PPT
一键导入PPT文件,并将PPT转换成图片上传到服务器中。
上传网络图片
一键自动上传网络图片,自动下载远程服务器图片,自动上传远程服务器图片
下载示例
点击下载完整示例