猿大师中间件金山WPS内嵌网页小程序开发文档

猿大师中间件金山WPS内嵌网页小程序开发原理：

基于猿大师中间件网络版开发，底层调用金山WPS的VBA接口实现可程序化驱动的网页在线编辑办公控件，可分别将WPS文字、WPS表格、WPS演示软件窗口内嵌到网页指定区域运行并操控。最低可用在Chrome 41、Firefox 50、Edge 80(Chromium内核)、360极速/安全、IE 8、Oprea 36、QQ、搜狗等浏览器，也兼容运行于这些浏览器的最新版本。
 

1.猿大师中间件金山WPS内嵌网页小程序安装步骤：
 

1)、如果是exe的安装程序，请直接运行安装；

2)、如果是绿色版的程序包，请解压到磁盘某个目录后，双击“InstallWrl.bat”进行安装；

3)、安装完成时会启动猿大师中间件服务，在安装目录下的Data子目录有ZbaService.txt日志文件输出运行情况。

 

2.猿大师中间件金山WPS内嵌网页小程序相关接口：
 

说明：以下功能请通过Web Socket连接猿大师主服务(ws://localhost?sid=12345&flag=1)后可执行，如默认侦听端口不是80(关于如何配置侦听端口，请参考SDK包中的文档“猿大师开发者手册.doc”)，请在连接地址中指定端口号进行连接。
 

HTTP在线测试网页：http://test.yuanmaster.com/wordfull.html
HTTPS在线测试网页：https://test.yuanmaster.com/wordfull.html
 

前端集成可参考以上测试网页进行，HTML网页中需要嵌入以下类似代码；
 

A、标记小程序的显示位置和大小

.OfficeApplet {

            margin: 20px 0 0 20px;

            width: 480px;

            height: 320px;

            border: 1px solid blue;

        }

或者

.OfficeApplet {

            width: 480px;

            height: 320px;

            top: 20px;

            left: 20px;

            border: 1px solid blue;

        }

如果在网页Header区没有标记小程序初始显示位置和大小，请在启动小程序的JSON参数里，添加以下参数：

"Left":20,"Top":20,"Width":480,"Height":320

 

B、网页中嵌入元素

支持IFrame的：

<iframe name="OfficeApplet" id="OfficeApplet" src="OfficeApplet3.html" frameborder="0" align="left" width="550" height="540" scrolling="no">

或者直接用

<div id="OfficeApplet" class="OfficeApplet"</div>

 

另外需要嵌入用到的JS脚本，脚本程序是完全开源的。

 

1)、请求启动微软Office内嵌网页小程序实现网页中局部加载doc/xls/ppt等文档显示：

Type为浏览器类型，传0自动判断(前提是当前浏览器已启动并显示在最前端，Flag指定当前页加载时必须是0) 可强制指定浏览器类型Type(2代表Chrome 4代表Firefox 8代表Opera 16代表Edge(Chromium内核) 32代表360极速浏览器 33代表360安全浏览器 34代表360企业安全浏览器 50代表QQ浏览器 60代表搜狗浏览器)

Title：网页标题中的关键词

Flag掩码标记：1指定新标签加载(1和16都不指定时为当前页加载) 2小程序显示窗口边框 4不自动裁剪越界窗口 8自动适配网页高度和宽度显示  64根据标题避免重复加载相同的小程序

IframeX和IframeY分别为iframe嵌套的横竖偏移修正坐标

BarW和BarH分别是网页右侧和底部预留区域

小程序实际显示首先会基于网页中指定的坐标和大小，再根据IframeX、IframeY、BarW、BarH设定的值做修正

OType 11启动WPS 文字处理;OType 12启动WPS 表格;OType 13启动WPS 演示

Url：加载小程序所在的网页实际地址

Open：为需要打开的文档路径，磁盘目录斜杠用/

注意：Open和Url如果有特殊字符或中文等，需要用URL编码处理后传递

举例：

自动识别当前浏览器并启动WPS文字处理

{"req":"Wrl_OfficeApplet","rid":6,"para":{"Type":"0","Title":"Office Applet","Flag":0,"IframeX":0,"IframeY":0,"BarW":0,"BarH":0,"Url": "http://test.yuanmaster.com/OfficeApplet2.html","OType":"11","Open":"D:/Zorro/test.doc"}}

 

自动识别当前浏览器并启动WPS表格处理

{"req":"Wrl_OfficeApplet","rid":6,"para":{"Type":"0","Title":"Office Applet","Flag":0,"IframeX":0,"IframeY":0,"BarW":0,"BarH":0,"Url": "http://test.yuanmaster.com/OfficeApplet2.html","OType":"12","Open":"D:/Zorro/test.xls"}}

 

自动识别当前浏览器并启动WPS演示处理

{"req":"Wrl_OfficeApplet","rid":6,"para":{"Type":"0","Title":"Office Applet","Flag":0,"IframeX":0,"IframeY":0,"BarW":0,"BarH":0,"Url": "http://test.yuanmaster.com/OfficeApplet2.html","OType":"13","Open":"D:/Zorro/test.ppt"}}

 

自动识别当前浏览器指定位置自动适配网页大小启动：

{"req":"Wrl_OfficeApplet","rid":6,"para":{"Type":"0","Title":"Office Applet","Flag":8,"IframeX":0,"IframeY":0,"BarW":0,"BarH":0,"Url": "http://test.yuanmaster.com/OfficeApplet2.html","OType":"11","Open":"D:/Zorro/test.doc"}}

 

当前页指定位置自动适配网页加载测试

http://test.yuanmaster.com/officeframe.html

 

启动后会先后收到三个JSON数据包

A、{"ret":0,"rid":1,"data":{"ID":3}}

代表小程序WS侦听服务就绪

B、{"event":"Wrl_Listen","aid":3,"data":{"SID":"123","PID":"WpsApplet","port":910}}

返回的侦听端口，可再建立一个Web Socket连接后，调用小程序中的相关功能，比如打开一个文档。

返回ID为当前小程序运行ID，通过此ID，可执行Wrl_AppletControl、Wrl_AppletScroll、Wrl_AppletResize等命令。

C、{"event":"Wrl_AppletOK","aid":3,"data":{"SID":"123","PID":"WpsApplet","Port":910}}

 

2)、请求控制金山WPS内嵌网页小程序：

当前端不再需要小程序时可指定关闭，或者显示/隐藏及全屏显示等

ID为启动小程序时返回JSON中的ID值，Code代表控制类型掩码：1关闭 2全屏显示 4自动隐藏 8还原显示 16自动适配网页高度和宽度显示模式切换 32强制隐藏。其中全屏显示2，可直接通过热键ESC或取消,4和32隐藏后可通过8恢复显示

{"req":"Wrl_AppletControl","rid":2,"para":{"ID":"1","Code":4}}

 

3)、请求滚动金山WPS内嵌网页小程序：

当前端截取到网页滚动时，需要调用此接口实现小程序和网页的滚动联动

ID为启动小程序时返回JSON中的ID值

Code为滚动方向1是水平直，2是垂直，3是同时

Left为横向滚动条位置，Top为纵向滚动条位置

{"req":"Wrl_AppletScroll","rid":3,"para":{"ID":"1","Code":2,"Left":0,"Top":100}}

 

4)、请求改变金山WPS内嵌网页小程序显示位置或大小：

当前端网页显示区域缩放时，可动态修改小程序的显示位置或大小

ID为启动小程序时返回JSON中的ID值，Width和Height分别为新的宽度和高度，X和Y分别为新的显示位置，不指定时保持不变，指定时原设置的IframeX和IframeY失效

{"req":"Wrl_AppletResize","rid":4,"para":{"ID":1,"Width":500,"Height":600}}

或同时设置小程序显示起始坐标

{"req":"Wrl_AppletResize","rid":5,"para":{"ID":1,"Width":500,"Height":600,"X":20,"Y":20}}

 

5)、请求设置网页预留右侧宽度和底部高度，滚动条信息、垂直滚动及水平滚动位置：

当小程序显示区域超过当前网页时，需去除滚动条的显示影响

ID为启动小程序时返回JSON中的ID值，BarW为预留右侧宽度 BarH为预留底部高度

Code 1代表有水平滚动条，2代表有垂直滚动条，3代表都有

ScrollTop垂直滚动条位置 ScrollTop水平滚动条位置

{"req":"Wrl_ScrollBar","rid":6,"para":{"ID":"1","Code":2,"BarW":0,"BarH":0,"ScrollTop":0,"ScrollLeft":0}}

 

6)、请求对小程序窗口做Alpha透明处理，便于前端临时显示覆盖到小程序窗口的菜单等：

ID为Wrl_OfficeApplet启动小程序时返回的ID值，Alpha为透明度百分比，1-100

{"req":"Wrl_AppletAlpha","rid":7,"para":{"ID":1,"Alpha":30}}

 

7)、请求对小程序窗口内容进行截图：

ID为启动小程序时返回JSON中的ID值，

File为指定截图文件保存路径或扩展名

Base64指定为1时代表返回BASE64编码的图像内容

{"req":"Wrl_AppletSnap","rid":10,"para":{"ID":1,"Base64":1,"File":".png"}}

 

8)、请求缩放IE控件内嵌网页小程序，用于浏览器网页按比例缩放，一般不需要处理：

ID为启动小程序时返回JSON中的ID值，Scall为缩放百分比

{"req":"Wrl_AppletScale","rid":11,"para":{"ID":1,"Scale":120}}

 

3、小程序安装、升级、卸载

1)、请求安装金山WPS内嵌网页小程序

请在输入框中，输入如下请求，然后点击发送，完成安装：

 

{"req":"Plugin_Install","rid":1,"para":{"Name":"金山WPS在线编辑小程序","PID":"WpsApplet","Date":"2021-03-27","Desc":"猿大师中间件之上跨浏览器的金山WPS内嵌网页小程序，支持在Chrome、Edge、Firefox、IE、Oprea、360、QQ等最新版本浏览器网页中内嵌文字、表格、演示等程序进行在线编辑或审阅各类办公文档。","DownAddr":"http://local.zorrosoft.com/Files/Net/WpsApplet.pid","MD5":"A8CAB9B331B9A9CF46437375C80255B8","Version":"2.1.3.1","Size":753664,"HideIns":0,"Type":8,"Cookie":"","Auth":"","TK":"9DCFF02AB0C46C8D9E3AF022D01F9C1D825660713007D8F442D2BFDC3CA6C098B8A3899C2DDBD74460512C31F0FB148E6F8A1A93346C549E283C5ECE832549D69C0E2692323E607305B04E306096E72F56AE7319CD4B12F36AFE16E67EFCC662DAA57E27032A2BD966AA2E14BFDCB708027EA95BEBFD6CA8A6E9CB6A02277BC96198D05FC2ED7191FE417DF2236A28AEB328C3D4E88EB052959AC602A3F56BC102236EE87589E84B8384401C1EA33C95DAEAE1A4D8C3467A74B6C159A3AA66FC0F18795461301EF39B842C54605B23F789084426ABCFCD6DA3184806E97D0B62BB0D95E74DC7F710779D7E583509E3B7CD4FF29FA7BE4DED55421547A5C0277C"}}

 

启动安装后，会不断收到安装进度直到安装结束。

在发布时，也可以把此小程序目录文件和中间件一起打包后发布，不用单独分发。

 

2)、请求升级金山WPS内嵌网页小程序：

 

{"req":"Plugin_Update","rid":1,"para":{"Name":"金山WPS在线编辑小程序","PID":"WpsApplet","Date":"2021-03-27","Desc":"猿大师之上跨浏览器的金山WPS内嵌网页小程序，支持在Chrome、Edge、Firefox、IE、Oprea、360、QQ等最新版本浏览器网页中内嵌文字、表格、演示等程序进行在线编辑或审阅各类办公文档。","DownAddr":"http://local.zorrosoft.com/Files/Net/WpsApplet_Update.pid","MD5":"906BEA15253DB7002FBB70633EB85A6E","Version":"2.1.3.1","Size":753664,"HideIns":0,"Type":8,"Cookie":"","Auth":"","TK":"55865804EB535ED3E009318BACAD0B26BC3A605653FED608110F9CA01ED3DD262E681FF21B32CD67E83662BEC68B4ECEBD69495BAE8CAE14F4007E310F0122C9A14C0EEC0E3A5DED11FE8A54C5630ABABDE81A32665195BF59B32BA058ADA3DEAA9307CE1F211FC64CA9564222E249355E68F0B224FF7AED0DCC23E3DC77461E6D8B0C000902853FAA81DE0D4B8F0DF5DA5F24DAB03B6CFCD395A7598B26AA1423E99608AB931C4F4C95D949FC863E29F21B85038B26594C1188553C71027CEB27704724586EE47D8994213240B2A61E663BD45B6C7DCDCAD524A8B282ADD105E84495D983D53D49A2BEAA7FFE57622AE33EBBF0A1B4531256B96C33954F32B8"}}

 

以上安装和升级的JSON请求包，可能因版本升级导致内容不同，如遇安装或升级时报错，请联系客服获取最新的请求包。 

 

3)、请求卸载金山WPS内嵌网页小程序：

 

{"req":"Plugin_Remove","rid":3,"para":{"PID":"WpsApplet","Type":8}}

 

4、金山WPS内嵌网页小程序转调用WPS软件的VBA接口，先根据Wrl_OfficeApplet请求启动后返回的端口号，新建立一个WebSocket连接后可执行如下指令：

A、常用功能请求：

 

请求退出小程序

{"req":"Office_Exit","rid":1,"para":{}}

请求关闭文档

{"req":"Office_Close","rid":2,"para":{}}

 

请求打开文档

{"req":"Office_Open","rid":3,"para":{"Open":"D:/Zorro/test.doc"}}

 

/// 请求转换为PDF格式

{"req":"Office_SaveAs","rid":4,"para":{"NewFile":"D:/Zorro/test1.pdf"}}

 

5、事件通知：

A、

B、猿大师支持的事件通知：

 

1) 小程序是否响应了热键全屏

以下分别为Word字处理、Excel表格、Powerpoint演示程序的全屏事件通知

{"event":"WORD_FullScreen","data":{"FullScreen":0}} FullScreen为当前是否全屏标记

{"event":"EXCEL_FullScreen","data":{"FullScreen":0}} FullScreen为当前是否全屏标记

{"event":"PPT_FullScreen","data":{"FullScreen":0}} FullScreen为当前是否全屏标记

 

2) Wrl_AppletExit 小程序退出通知

{"event":"Wrl_AppletExit","data":{"ID":1}}

 

6、其它

请求参数的JSON数据包，请确保是UTF-8无签名的编码。

更多接口请求说明，请参考安装目录中的文档TestWrl.txt、SDK包中的“猿大师开发者手册.doc”及“猿大师中间件安全解决方案”。

如还有疑问请直接联系客服。