4 Star 6 Fork 3

WPS加载项开发/加载顶开发首页

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
张秋峰-fxzqf 张秋峰 1 8ae0e3f 4个月前
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
MulanPSL-2.0

WPS加载项开发实战之一安装、部署与调试

介绍

WPS 加载项(简称WPSJS)是一套基于 Web 技术用来扩展 WPS 应用程序的解决方案,开发完成一个WPSJS加载项后首先要面对的是用户怎么安装和使用,为了让用户使用WPSJ就必须发布到一个WEB服务器上,在这个项目中就是实现一个加载项的安装。以WPS文档助手加载项为例,这个加载项的具体实现在第二部分展现。为了便于掌握wpsjs加载项的实现机制所以没有使用wpsjs工具包创建而是从0创建,为了便于理解把功能尽可能简化。

开发环境准备

开发WPSJS需要熟悉WEB和WPS客户端两种技术。基本配置是一个静态网页服务器和WPS软件。静态网页服务使用gitee.com的pages服务功能,所以对应的代码也存储在了gitee.com仓库中。 打开代码仓库https://gitee.com/wpsoa/wpsoa 在这儿可以看所有的代码,访问https://wpsoa.gitee.io 安装或卸载加载项。编程和调试还需一套开发环境这个可根据个人喜好,从gitee.com拉取或推送代码,最好选用支持git命令的集成开发环境如VSCODE或VSSTUDIO等。WPS客户提供了非常多的接口来操作对应的文档,wpsjs提供了几个.d.ts扩展名的文件,这是TypeScript的声明文件,在这里面基本上把所有的接口作了描述,使用Typescript编写代码时这些接口会出现在编辑提示中,而且还可以在编译成javascript之前发现错误,提高编程效率,因些建议使用Typescript语言。安装与管理的加载项是仅实现在WPS表格的视图选项卡中显示一个文档助手按钮加载项代码仓库https://gitee.com/wpsoa/xlsapp ,后续在其中一步步实现具体功能。

文件目录

  1. index.html 用户访问首页,进行加载项的安装或卸载操作
  2. js/wpsjsrpcsdk.js WPS封装好的wpsjs管理工具(与官方提供的相比做了修改解决了https支持的问题)

理解管理加载项的实现原理

在用户的电脑上安装过WPS软件后,WPS会在用户的电脑上安装WEB服务(就相当于一个小的WEB服务器),这个服务器的地址是http://127.0.0.1:58890https://127.0.0.1:58891,wpsjsrpcsdk.js中就是用js的发送http请求到上述两个地址来管理加载项或启动WPS客户端。具体用法参加WPS开放平台。

index.html 代码分析

以下内容是index.html中的定义了要管理的加载项的信息

 window.element = { "name": "wpsapp", "addonType": "et", "online": "true", "multiUser": "false", "url": "https://wpsoa.gitee.io/xlsapp/"};  

点击安装按钮后执行加载项安装,在这里没使用检测是否安装而是先卸载后再重新安装

document.getElementById("setup").onclick = function () { WpsAddonMgr.disable(element); WpsAddonMgr.enable(element); };

单进程和多进程启动,其中openBook是启动WPS客户端后执行的加载项中的方法,执行这个方法需要先安装加载项,在下一步的加载项开发时实现。

document.getElementById("start").onclick = function () {
                WpsInvoke.InvokeAsHttps(WpsInvoke.ClientType.et,
                    "wpsapp",
                    "openBook",
                    JSON.stringify(""), (e) => {console.log(e) }, true, "https://fxzqf.github.io/wpsapp/jsplugins.xml", false);
            };
            document.getElementById("client").onclick = function () {
                var wpsClient = new WpsClient(WpsInvoke.ClientType.et);
                wpsClient.jsPluginsXml = "https://fxzqf.gitee.io/wpsapp/jsplugins.xml";
                wpsClient.InvokeAsHttps("wpsapp", "openBook", JSON.stringify(""),(e)=>{console.log(e)});
            }

使用和调试

在安装了WPS客户端的电脑上访问https://wpsoa.gitee.io点击安装按钮,弹出用户确认对话框后安装加载项到本机,打开WPS客户端新建或打开一个WPS表格,你会看到在视图选项卡的最后多了一个“文档助手”按钮,该按钮还没有任何功能,在下一步的开发中实现。访问本机文件路径可以在C:\Users{用户名如administrator}\AppData\Roaming\kingsoft\wps\jsaddons路径下安装的wps加载项信息,删除所有文件就可以卸载所有加载项了。

1、启用调WPSJS调试功能

打开 WPS 安装目录,进入 wps.exe 程序同级目录,在cfgs文件夹下新建或打开oem.ini文件,在文档最后添加如下配置

[Support]
##启用加载项
JsApiPlugin = true
##启用网页调试,详情请参考 WPS 基础接口说明
JsApiShowWebDebugger=true
[Server]
##指定加载项配置文件 jsplugins.xml 链接地址
JSPluginsServer = http://***/jsplugins.xml

JsApiShowWebDebugger=true是启用调试

2、调试

重新启动WPS客户端,在视图选项卡中的新出现"打开JS调试器"按钮,点击该按钮打开调试窗口进行调试。

木兰宽松许可证, 第2版 木兰宽松许可证, 第2版 2020年1月 http://license.coscl.org.cn/MulanPSL2 您对“软件”的复制、使用、修改及分发受木兰宽松许可证,第2版(“本许可证”)的如下条款的约束: 0. 定义 “软件”是指由“贡献”构成的许可在“本许可证”下的程序和相关文档的集合。 “贡献”是指由任一“贡献者”许可在“本许可证”下的受版权法保护的作品。 “贡献者”是指将受版权法保护的作品许可在“本许可证”下的自然人或“法人实体”。 “法人实体”是指提交贡献的机构及其“关联实体”。 “关联实体”是指,对“本许可证”下的行为方而言,控制、受控制或与其共同受控制的机构,此处的控制是指有受控方或共同受控方至少50%直接或间接的投票权、资金或其他有价证券。 1. 授予版权许可 每个“贡献者”根据“本许可证”授予您永久性的、全球性的、免费的、非独占的、不可撤销的版权许可,您可以复制、使用、修改、分发其“贡献”,不论修改与否。 2. 授予专利许可 每个“贡献者”根据“本许可证”授予您永久性的、全球性的、免费的、非独占的、不可撤销的(根据本条规定撤销除外)专利许可,供您制造、委托制造、使用、许诺销售、销售、进口其“贡献”或以其他方式转移其“贡献”。前述专利许可仅限于“贡献者”现在或将来拥有或控制的其“贡献”本身或其“贡献”与许可“贡献”时的“软件”结合而将必然会侵犯的专利权利要求,不包括对“贡献”的修改或包含“贡献”的其他结合。如果您或您的“关联实体”直接或间接地,就“软件”或其中的“贡献”对任何人发起专利侵权诉讼(包括反诉或交叉诉讼)或其他专利维权行动,指控其侵犯专利权,则“本许可证”授予您对“软件”的专利许可自您提起诉讼或发起维权行动之日终止。 3. 无商标许可 “本许可证”不提供对“贡献者”的商品名称、商标、服务标志或产品名称的商标许可,但您为满足第4条规定的声明义务而必须使用除外。 4. 分发限制 您可以在任何媒介中将“软件”以源程序形式或可执行形式重新分发,不论修改与否,但您必须向接收者提供“本许可证”的副本,并保留“软件”中的版权、商标、专利及免责声明。 5. 免责声明与责任限制 “软件”及其中的“贡献”在提供时不带任何明示或默示的担保。在任何情况下,“贡献者”或版权所有者不对任何人因使用“软件”或其中的“贡献”而引发的任何直接或间接损失承担责任,不论因何种原因导致或者基于何种法律理论,即使其曾被建议有此种损失的可能性。 6. 语言 “本许可证”以中英文双语表述,中英文版本具有同等法律效力。如果中英文版本存在任何冲突不一致,以中文版为准。 条款结束 如何将木兰宽松许可证,第2版,应用到您的软件 如果您希望将木兰宽松许可证,第2版,应用到您的新软件,为了方便接收者查阅,建议您完成如下三步: 1, 请您补充如下声明中的空白,包括软件名、软件的首次发表年份以及您作为版权人的名字; 2, 请您在软件包的一级目录下创建以“LICENSE”为名的文件,将整个许可证文本放入该文件中; 3, 请将如下声明文本放入每个源文件的头部注释中。 Copyright (c) [Year] [name of copyright holder] [Software Name] is licensed under Mulan PSL v2. You can use this software according to the terms and conditions of the Mulan PSL v2. You may obtain a copy of Mulan PSL v2 at: http://license.coscl.org.cn/MulanPSL2 THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT, MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE. See the Mulan PSL v2 for more details. Mulan Permissive Software License,Version 2 Mulan Permissive Software License,Version 2 (Mulan PSL v2) January 2020 http://license.coscl.org.cn/MulanPSL2 Your reproduction, use, modification and distribution of the Software shall be subject to Mulan PSL v2 (this License) with the following terms and conditions: 0. Definition Software means the program and related documents which are licensed under this License and comprise all Contribution(s). Contribution means the copyrightable work licensed by a particular Contributor under this License. Contributor means the Individual or Legal Entity who licenses its copyrightable work under this License. Legal Entity means the entity making a Contribution and all its Affiliates. Affiliates means entities that control, are controlled by, or are under common control with the acting entity under this License, ‘control’ means direct or indirect ownership of at least fifty percent (50%) of the voting power, capital or other securities of controlled or commonly controlled entity. 1. Grant of Copyright License Subject to the terms and conditions of this License, each Contributor hereby grants to you a perpetual, worldwide, royalty-free, non-exclusive, irrevocable copyright license to reproduce, use, modify, or distribute its Contribution, with modification or not. 2. Grant of Patent License Subject to the terms and conditions of this License, each Contributor hereby grants to you a perpetual, worldwide, royalty-free, non-exclusive, irrevocable (except for revocation under this Section) patent license to make, have made, use, offer for sale, sell, import or otherwise transfer its Contribution, where such patent license is only limited to the patent claims owned or controlled by such Contributor now or in future which will be necessarily infringed by its Contribution alone, or by combination of the Contribution with the Software to which the Contribution was contributed. The patent license shall not apply to any modification of the Contribution, and any other combination which includes the Contribution. If you or your Affiliates directly or indirectly institute patent litigation (including a cross claim or counterclaim in a litigation) or other patent enforcement activities against any individual or entity by alleging that the Software or any Contribution in it infringes patents, then any patent license granted to you under this License for the Software shall terminate as of the date such litigation or activity is filed or taken. 3. No Trademark License No trademark license is granted to use the trade names, trademarks, service marks, or product names of Contributor, except as required to fulfill notice requirements in Section 4. 4. Distribution Restriction You may distribute the Software in any medium with or without modification, whether in source or executable forms, provided that you provide recipients with a copy of this License and retain copyright, patent, trademark and disclaimer statements in the Software. 5. Disclaimer of Warranty and Limitation of Liability THE SOFTWARE AND CONTRIBUTION IN IT ARE PROVIDED WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED. IN NO EVENT SHALL ANY CONTRIBUTOR OR COPYRIGHT HOLDER BE LIABLE TO YOU FOR ANY DAMAGES, INCLUDING, BUT NOT LIMITED TO ANY DIRECT, OR INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES ARISING FROM YOUR USE OR INABILITY TO USE THE SOFTWARE OR THE CONTRIBUTION IN IT, NO MATTER HOW IT’S CAUSED OR BASED ON WHICH LEGAL THEORY, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. 6. Language THIS LICENSE IS WRITTEN IN BOTH CHINESE AND ENGLISH, AND THE CHINESE VERSION AND ENGLISH VERSION SHALL HAVE THE SAME LEGAL EFFECT. IN THE CASE OF DIVERGENCE BETWEEN THE CHINESE AND ENGLISH VERSIONS, THE CHINESE VERSION SHALL PREVAIL. END OF THE TERMS AND CONDITIONS How to Apply the Mulan Permissive Software License,Version 2 (Mulan PSL v2) to Your Software To apply the Mulan PSL v2 to your work, for easy identification by recipients, you are suggested to complete following three steps: i Fill in the blanks in following statement, including insert your software name, the year of the first publication of your software, and your name identified as the copyright owner; ii Create a file named “LICENSE” which contains the whole context of this License in the first directory of your software package; iii Attach the statement to the appropriate annotated syntax at the beginning of each source file. Copyright (c) [Year] [name of copyright holder] [Software Name] is licensed under Mulan PSL v2. You can use this software according to the terms and conditions of the Mulan PSL v2. You may obtain a copy of Mulan PSL v2 at: http://license.coscl.org.cn/MulanPSL2 THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT, MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE. See the Mulan PSL v2 for more details.

简介

WPS文档助手加载项安装页面,引导用户安装WPS文档助手,下载文档试用WPS加载项功能。 展开 收起
README
MulanPSL-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

不能加载更多了
马建仓 AI 助手
尝试更多
代码解读
代码找茬
代码优化
TypeScript
1
https://gitee.com/wpsoa/wpsoa.git
git@gitee.com:wpsoa/wpsoa.git
wpsoa
wpsoa
加载顶开发首页
master

搜索帮助