WPSJS 插件开发离线部署方式

小咪咪 2022-10-07 07:49 574阅读 0赞

在没有网络情况下，单机离线部署方式应该使用**jsplugins.xml**方式。

## jsplugins.xml模式 ##

*  ### 模式介绍 ###
    
    jsplugins.xml模式是通过设置oem.ini配置文件的JSPluginsServer的值为加载项管理文件jsplugins.xml来控制加载项的加载（相当于WPS加载项列表文件），二次打包时，业务开发商需要告知我们JSPluginsServer的配置地址，，将起配置到oem.ini文件中，业务开发商再做安装包分发。
    
    后续的加载项的控制用，业务开发商可以自由的更改jsplugins.xml文件，实现加载项的新增，修改。
    
    [jsplugins.xml文件的配置][jsplugins.xml]
 *  ### 部署（以secretAddin辅助定密插件为例） ###
    
     *  使用wpsjs包的wpsjs build进行加载项打包，压缩包在`wps-addon-build/`文件夹下
     *  部署是将该压缩包拷贝到目标主机的某个文件夹下，我放在了wps插件配置jsplugins.xml所在的文件夹下`C:\Users\dulun\AppData\Roaming\kingsoft\wps\jsaddons`
     *  在上述文件夹下创建jsplugins.xml，配置**oem.ini**， **oem.ini**在wps.exe 程序同级目录cfgs文件夹中`D:\software\WPS Office\WPS Office\11.1.0.10495\office6\cfgs\oem.ini`，在cfgs文件夹下新建或打开oem.ini文件，在文档最后添加如下配置：
    
        [Setup]
        Silent=0
        LaunchWPS=1
        LaunchCenter=1
        CreateDesktopShortcut=1
        SendInstallSource=1
        LANG_ID=2052
        BUILD_VERSION=11.1.0.10495
        Industry=
        PipeNumber=12012.2019
        SourceDir=oeminfo
        
        [feature]
        xn3QfP-XIpyKSU9I2xbCubad10=hn3QfP-XIpyk99gTmjC7T6IF10
        
        [Support]
        ##启用加载项
        JsApiPlugin = true
        ##启用网页调试，详情请参考 WPS 基础接口说明
        JsApiShowWebDebugger=true
        [Server]
        ##指定加载项配置文件 jsplugins.xml 链接地址
        JSPluginsServer=C:\Users\username\AppData\Roaming\kingsoft\wps\jsaddons\jsplugins.xml
        
    
     *  配置jsplugins.xml
    
        <jsplugins>
          <jsplugin enable="true" version="1.0.0" name="secretAddin" url="file:///C:/Users/username/AppData/Roaming/kingsoft/wps/jsaddons/secretAddin.7z" type="wps"/>
        </jsplugins>
        
    
     *  将压缩包解压到`C:\Users\`username`\AppData\Roaming\kingsoft\wps\jsaddons`
     *  [wpsjs工具包使用][wpsjs]
 *  ### 加载项加载流程 ###
    
     *  启动WPS
     *  读取oem.ini，去下载JSPluginsServer对应地址的jsplugins.xml文件
        
         *  window：%appdata%/kingsoft/wps/jsaddons
         *  linux: ~/.local/share/Kingsoft/wps/jsaddons
     *  读取jsplugins.xml文件
     *  加载对应组件的所有加载项
     *  根据业务系统指定的加载项名称，使用该加载项来接收参数
 *  ### 适用场景 ###
    
     *  本来就需要做二次打包的项目
 *  ### 版本支持情况 ###
    
     *  Windows：2019版本，2020发的版本
     *  Linux：2019版本，2020年3月后发的版本

## 参考 ##

[wps 开放平台][wps]

[jsplugins.xml]: https://kdocs.cn/l/cBk8tsBIf
[wpsjs]: https://kdocs.cn/l/cASCu9B0G
[wps]: https://open.wps.cn/docs/office