跨平台Office文档预览原生插件，非腾讯X5，支持离线，稳定高可用

news/2024/7/20 20:48:38 标签: 文档预览, android, ios, Uni-App原生插件, 非X5内核

引言

2023年4月13日零时起，腾讯浏览服务内核文档能力正式下线，要实现真正离线文档预览，于是有了这边文章。

前面写了多篇关于<跨平台文件在线预览解决方案>，不管使用pdf.js、LibreOffice，还是永中DCS，各自都有自己的优缺点，比如：pdf.js不支持双指放大缩小，LibreOffice加载缓慢，永中DCS收费等等。

  • 跨平台（uni-app）文件在线预览解决方案
  • 跨平台文件在线预览解决方案（二）
  • 跨平台文件在线预览解决方案（三）- LibreOffice vs OpenOffice
  • 跨平台文件在线预览解决方案（四）-Android和IOS原生插件
  • 跨平台文档在线预览解决方案（五）-水印、防复制、在线编辑等

本文基于uni-app平台实现了Office文档在线预览原生插件Seal-OfficeOnline，同时支持Android和iOS，欢迎下载使用~,

另外单独抽离了图片预览和视频播放原生插件：Seal-ImageVideo，根据自己情况，选择使用~，Seal-ImageVideo插件下载使用地址，另附Github文档地址

Seal-OfficeOnline插件下载使用地址

各位同学，对于插件使用还有疑问的，可以加QQ群（170683293）咨询。

一、注意事项

  • 本插件不需要其他任何配置，也不需要依赖其他任何库，不要在manifest.json->App模块配置中勾选Android X5 Webview`
  • 不要同时使用其他同类文档预览插件，否则，可能会引起包冲突
  • url或参数中是否含有中文字符串，请使用encodeURIComponent或encodeURI进行转码，详细说明见下面“问题一”

二、问题解决

问题一：

插件安装成功，但是文档预览失败。

解决方案：检查文档url或参数中是否含有中文字符串，如果有，请使用encodeURIComponent或encodeURI进行转码。

如果参数有http://链接，使用encodeURIComponent；如果要对整个url进行转码，使用encodeURI

encodeURIComponent和encodeURI区别

它们都是编码URL，唯一区别就是编码的字符范围，其中

encodeURI方法不会对下列字符编码 ASCII字母 数字 ~!@#$&*()=:/,;?+’

encodeURIComponent方法不会对下列字符编码 ASCII字母 数字 ~!*()’

所以encodeURIComponent比encodeURI编码的范围更大。

各位同学，对于插件使用还有疑问的，可以加QQ群（170683293）咨询。

三、快速上手

demo工程地址 或在右上角直接下载示例工程

开发工具：HBuilderX

Step1. 下载demo工程，使用HBuilderX打开

Step2. 添加本文插件

插件名称：Seal-OfficeOnline

点击右上角试用或者购买，选择你的云打包插件

Step3. 选择manifest.json->App原生插件配置中加载云端插件

Step4. 使用插件

  • 在vue或nvue组件中，导入插件
const sealOfficeOnlineModule = uni.requireNativePlugin("Seal-OfficeOnline")
  • openFile方法（推荐）：支持Android和IOS，预览Office文件，支持如下格式：pdf、txt、doc、docx、xls、xlsx、ppt、pptx、epub等近50种类型文件。
  • openFileWPS方法（推荐）：采用本机WPS客户端预览或编辑文档，支持pdf、txt、doc、xls、ppt等多种文件格式。
  • checkWps方法：检查本机WPS客户端是否已经安装。
  • openFileImage方法：仅支持IOS，预览图片，支持如下格式：jpg、jpeg、png、bmp、jpg、gif等，参数同openFile方法

接口使用方法，参考如下章节《四、使用方法》

Step5. 调试

  • 制作自定义调试基座：在开发工具中点击“运行到手机或模拟器-》制作自定义调试基座”
  • 选择自定义调试基座：然后“运行到手机或模拟器-》基座运行选择-》自定义调试基座”
  • 连接真机，运行到手机或模拟器-》运行到Android App基座，进行运行调试

四、使用方法

1、离线文档预览，非腾讯TBS，摆脱内核加载困扰，支持在线文档URL

使用接口：openFIle，参数参考章节《五、openFile接口参数说明》

离线文档预览，非腾讯TBS，无内核加载，摆脱腾讯X5内核加载失败的困扰。

同时支持在线文档URL或设备本地文档绝对路径。

两种使用方式，一，直接传递文档在线URL，二，先下载到设备本地，传递绝对路径，参考一下代码。

注意：添加参数isDeleteFile: false，否则退出预览，文件删除。

支持平台：Android、IOS

/**
* 打开文档，非腾讯TBS，无内核加载，真正离线
* @param {Object} fileUrl 文档url
*/
openFile(fileUrl) {
  // 方式一：直接传递文件在线url
  sealOfficeOnlineModule.openFile(
    {
      url: fileUrl, // 同时支持在线和本地文档，三种参数传递方式，具体查看文档说明
      // fileType: 'pdf',
      // fileName: 'example',
      title: 'Office文档在线预览', // 顶栏标题，默认为：APP名称
      topBarBgColor: '#3394EC', // 顶栏背景颜色，默认为：#3394EC（科技蓝）
      waterMarkText: '你好，世界\n准备好了吗？时刻准备着', // 水印文本
      docRequestHeaders: {
        'Authorization': 'Token xxxxxxxx',
        'Other': 'other'
      }, // 文档下载请求头
      isDeleteFile: false,
      topBarAutoHide: true,
      isTopBar: true,
    },
    res => {
      this.printInfo('打开在线文档事件结果：', res);
    }
  );

  // 方式二：先下载文件保存到手机目录，再获取文件绝对路径
  // uni.showLoading({
  // 	title: '正在下载文件，请稍后~'
  // });
  // uni.downloadFile({
  // 	url: fileUrl,
  // 	success: res => {
  // 		if (res.statusCode === 200) {
  // 			// 直接传递本地文件地址
  // 			// 传递本地文件绝对路径，res.tempFilePath的前缀是_doc，而实际目录为doc，没有下划线_，所以要substr取子串
  // 			// const url = '/storage/sdcard0/Android/data/APP包名/apps/APPID/' + res.tempFilePath.substr(1)
  // 			// 可以通过以下方式获取文件绝对路径
  // 			uni.saveFile({
  // 				// 需要保存文件的临时路径
  // 				tempFilePath: res.tempFilePath,
  // 				success: resSave => {
  // 					uni.hideLoading();
  // 					const savedFilePath = resSave.savedFilePath;
  // 					// 转换为绝对路径
  // 					const url = plus.io.convertLocalFileSystemURL(savedFilePath);
  // 					console.log('tempFilePath', res.tempFilePath);
  // 					console.log('savedFilePath', savedFilePath);
  // 					console.log('url', url);
  // 					// 预览本地文件
  // 					sealOfficeOnlineModule.openFile(
  // 						{
  // 							url: url,
  // 							isDeleteFile: false
  // 						},
  // 						res => {
  // 							this.printInfo('打开本地文档事件结果：', res);
  // 						}
  // 					);
  // 				}
  // 			});
  // 		}
  // 	}
  // });
},

2、组件嵌入预览

组件名：Seal-OfficeOnline

组件嵌入预览，是采用nvue原生组件的方式，嵌入页面预览，用于页面的局部文档预览。

在线文档URL和离线设备文档均可预览，也支持自定义水印。

注意：要采用nvue原生组件方式，不可以采用vue组件方式。

支持平台：Android、IOS

新建组件：seal-officeonline-component.nvue

<template>
	<div><Seal-OfficeOnline :options="options" style="width:600rpx;height:800rpx;border: 1px solid red;"></Seal-OfficeOnline></div>
</template>

<script>
export default {
	data() {
		return {
			options: {}
		}
	},
	onLoad(params) {
		console.log('params', params)
		this.options = {
			// 文档预览，传递url
			url: params.url,
			waterMarkText: '你好，世界\n准备好了吗？时刻准备着',
		}
	}
};
</script>

3、WPS预览或编辑文档

使用接口：openFileWPS，参数参考《六、openFileWPS接口参数说明》

WPS预览或编辑文档，是采用本机WPS客户端预览或编辑文档，支持pdf、txt、doc、xls、ppt等多种文件格式。

支持5种模式，包括文档编辑。前提，本地需要安装WPS客户端。

支持平台：Android、IOS（分享功能，第三方APP打开）

/**
* WPS预览或编辑文档
* @param {String} fileUrl 文档url
* @param {String} openMode 打开模式
* openMode取值：
* Normal：正常模式，正常打开，WPS默认打开方式
* ReadOnly：只读模式，以只读的方式打开，WPS会隐藏编辑按钮
* EditMode：编辑模式，可对文档进行编辑
* ReadMode：阅读器模式，支持左右翻页，仅Word、TXT文档支持
* SaveOnly：另存模式(打开文件,另存,关闭)，仅Word、TXT文档支持
*/
openOnlineFileWPS(fileUrl, openMode) {
    sealOfficeOnlineModule.openFileWPS(
        {
            url: fileUrl,
            openMode
        },
        res => {
            uni.showModal({
                content: 'WPS打开文档事件结果：' + JSON.stringify(res)
            });
        }
    );
},

4、检查本机是否安装WPS客户端

4.1、方法一（推荐）、使用原生接口：checkWps，无参数。

注意：返回结果格式：{ “hasWps”: true }

支持平台：Android、IOS

注意：IOS配置应用访问白名单：manifest.json—》App常用其他设置—》IOS设置—》应用访问白名单，

添加：KingsoftOfficeApp,KingsoftOfficeAppEnterprise,WPSOfficeApi

应用访问白名单 
/**
* 检查WPS客户端是否已经安装
* 返回结果：{ "hasWps": true }
*/
checkWps() {
    const checkWps = sealOfficeOnlineModule.checkWps();
    console.log('checkWps', checkWps);
    uni.showModal({
        content: 'WPS是否安装：' + JSON.stringify(checkWps)
    });
},
4.2、方法二、直接调用plus.runtime.isApplicationExist

参考链接：https://www.cnblogs.com/goloving/p/14384105.html

// 判断第三方程序(WPS) 是否安装
function checkApp() {
    if (plus.runtime.isApplicationExist({pname:'cn.wps.moffice_eng', action:'KingsoftOfficeApp://'})) {
      console.log("WPS应用已安装");
    } else {
      console.log("WPS应用未安装");
    }
}

5、图片预览

使用接口：openFile（Android）、openFileImage（IOS）

支持平台：Android、IOS

/**
* 图片预览，支持jpg、jpeg、png、bmp、jpg、gif等多种常用图片格式
* 图片可以来源于列表或九宫格，传递给imageUrls数组
* @param {Object} fileUrl 图片url
* @param {Object} imageCurrentIndex 当前图片位置下标，从0开始
*/
openImage(fileUrl, imageCurrentIndex) {
    if (this.platform === 'android') {
        // Android
        sealOfficeOnlineModule.openFile({
            imageUrls: this.imageList,
            imageCurrentIndex, // 当前点击图片在imageUrls中的下标，从0开始，默认为0
            imageIndexType: 'number', // 图片底部指示器类型，默认为'dot'，可选：'number':数字；'dot':点
            isSaveImg: true, // 是否长按保存图片
        });
    } else if (this.platform === 'ios') {
        // IOS
        sealOfficeOnlineModule.openFileImage(
            {
                url: fileUrl, // 同时支持在线和本地文档，三种参数传递方式，具体查看文档说明
                title: 'IOS图片预览', // 顶栏标题，默认为：APP名称
                topBarBgColor: '#3394EC' // 顶栏背景颜色，默认为：#3394EC（科技蓝）
            },
            res => {
                uni.showModal({
                    content: 'IOS图片预览事件结果：' + JSON.stringify(res)
                });
            }
        );
    }
},

6、视频播放

使用接口：openFile

支持平台：Android、IOS

/**
* 视频播放，支持市面上几乎所有的视频格式，包括mp4, flv, avi, 3gp, webm, ts, ogv, m3u8, asf, wmv, rm, rmvb, mov, mkv等18种视频格式
* 功能包括：全屏播放、锁屏、分享、画面比例调节、左边上下滑动调节亮度，右边上下滑动调节音量等
* 支持Android和IOS
* @param {Object} fileUrl 视频url
*/
openVideo(fileUrl) {
    sealOfficeOnlineModule.openFile(
        {
            videoUrl: fileUrl, // 视频在线url，此参数优先于图片预览和文档预览
            installOfflineCore: true, // 是否离线安装内核
            coreLocalPath: this.coreLocalPath // 离线安装内核本地路径
        },
        res => {
            uni.showModal({
                content: '播放视频事件结果：' + JSON.stringify(res)
            });
        }
    );
}

五、openFile接口参数说明

支持打开在线文档，本地文档

支持平台：Android、IOS

参数名说明类型是否必填默认值可选值
url支持如下三种地址方式：
（1）文件网络地址，如：http://113.62.127.199:8090/fileUpload/1.xlsx
（2）手机本地文件地址，如：/data/user/0/APP包名/files/1.xlsx 文件名，如：1.xlsx，
（3）访问默认目录文件，默认目录为：/data/user/0/APP包名，如：com.HBuilder.UniPlugin
注意：手机本地地址目录需要有权限访问
IOS端只支持在线地址		string是
docRequestHeaders文档下载请求头，如：
{ ‘Authorization’: ‘Token xxxxxxxx’, ‘Other’: ‘other’ }
，IOS端无此配置		object否
fileType可以指定文件类型，如：xlsx，在url参数无法判断文件类型时，可以指定文件类型string否
fileName指定文件名，如：file1，注意此处不带文件扩展名，如果同时指定fileName和fileType，那么最后的文件名通过这两个参数组合起来，即：fileName.fileTypestring否
isDeleteFile退出是否删除缓存的文件，IOS端无此配置bool否truefalse
initTitle初始化插件动画标题，IOS端无此配置string否插件初始化
initBody初始化插件动画内容，IOS端无此配置string否加载中…
docDownloadTitle文档下载进度框标题，IOS端无此配置string否加载文档
docDownloadBody文档下载进度框内容，IOS端无此配置string否请稍后…
waterMarkText水印文本，默认以**\n**作为分隔符换行string否null
waterMarkTextSep水印文本分隔符，注意：IOS端只支持\n换行string否\n
waterMarkFontSize水印字体大小，单位为sp
使用sp作为字体大小单位,会随着系统的字体大小改变		int否13
waterMarkFontColor水印字体颜色string否#40F3F5F9
waterMarkDegree水印旋转角度，IOS端无此配置string否-30（逆时针30度）
isTopBar是否显示顶栏，IOS端无此配置bool否truefalse
title顶栏标题，isTopBar为true时有效string否APP名称
topBarAutoHide顶栏是否自动隐藏，isTopBar=true时生效，IOS端无此配置bool否falsetrue
topBarHeight顶栏自定义高度，isTopBar为true时有效，类型为正整数，IOS端无此配置int否actionBarSize
topBarBgColor顶栏背景颜色，isTopBar为true时有效string否#3394EC（科技蓝）
topBarTextColor顶栏文本颜色（isTopBar为true时有效）string否#FFFFFF（白色）
topBarTextLength顶栏标题文字长度（isTopBar为true时有效），IOS端无此配置int否12
isBackArrow是否显示返回按钮（isTopBar为true时有效），IOS端无此配置bool否truefalse
videoUrl视频在线url，此参数优先于图片预览和文档预览string是
imageUrls图片url数组，此参数优先于文档预览；长按图片底部弹出保存图片菜单，保存图片至相册，IOS端无此配置array是
imageCurrentIndex当前点击图片在imageUrls中的下标，从0开始，IOS端无此配置int否0
imageIndexType图片底部指示器类型，IOS端无此配置string否‘dot’‘number’:数字；‘dot’:点
isSaveImg是否长按保存图片，IOS端无此配置bool否nulltrue/false

六、openFileWPS接口参数说明

本机WPS客户端预览或编辑文档

支持平台：Android、IOS（分享功能，第三方APP打开）

参数名说明类型是否必填默认值可选值
url支持如下三种地址方式：
（1）文件网络地址，如：http://113.62.127.199:8090/fileUpload/1.xlsx
（2）手机本地文件地址，如：/data/user/0/APP包名/files/1.xlsx 文件名，如：1.xlsx，
（3）访问默认目录文件，默认目录为：/data/user/0/APP包名，如：com.HBuilder.UniPlugin
注意：手机本地地址目录需要有权限访问
IOS端只支持在线地址		string是
fileType可以指定文件类型，如：xlsx，在url参数无法判断文件类型时，可以指定文件类型，IOS端无此配置string否
fileName指定文件名，如：file1，注意此处不带文件扩展名，如果同时指定fileName和fileType，那么最后的文件名通过这两个参数组合起来，即：fileName.fileType，IOS端无此配置string否
docDownloadTitle文档下载进度框标题，IOS端无此配置string否加载文档
docDownloadBody文档下载进度框内容，IOS端无此配置string否请稍后…
openMode打开模式：
* Normal：正常模式，正常打开，WPS默认打开方式
* ReadOnly：只读模式，以只读的方式打开，WPS会隐藏编辑按钮
* EditMode：编辑模式，可对文档进行编辑
* ReadMode：阅读器模式，支持左右翻页，仅Word、TXT文档支持
* SaveOnly：另存模式(打开文件,另存,关闭)，仅Word、TXT文档支持		string否Normal见说明

另，openMode打开模式说明：

打开模式说明
Normal正常模式，正常打开，WPS默认打开方式
ReadOnly只读模式，以只读的方式打开，WPS会隐藏编辑按钮
EditMode编辑模式，可对文档进行编辑
ReadMode阅读器模式，支持左右翻页，仅Word、TXT文档支持
SaveOnly（不常用）另存模式(打开文件,另存,关闭)，仅Word、TXT文档支持

七、回调结果

1、回调结果格式：

// openFile、OpenFileBS接口
{
    "code": 200,
    "msg": "文档预览成功",
    "result": {
        // 本地文件名
        "fileName": "test.docx",
        // 本地文件路径，前提，参数isDeleteFile=false，否则预览预览结束，本地文件被删除
        "filePath": "/storage/sdcard0/Android/data/com.seal.uniplugin/files/file/test.docx"
    }
}

// OpenFileWPS接口
{
    "code": 1021,
    "msg": "WPS动作事件",
    "result": {
        // 本地文件名
        "fileName": "test.docx",
        // 本地文件路径，前提，参数isDeleteFile=false，否则预览预览结束，本地文件被删除
        "filePath": "/storage/sdcard0/Android/data/com.seal.uniplugin/files/file/test.docx",
        // WPS动作类型：back，返回键；home，Home键；save，保存文件；close，关闭文件
        "actionType": "back",
        // 文件另存为本机路径
        "fileSavePath": "/storage/sdcard0/Android/Download/test2.docx"
    }
}

2、回调结果状态码说明：

状态码说明
200文档预览成功
301文档下载失败
302内核下载失败，自动重新下载
303内核安装失败，自动重新安装
304内核加载失败，可忽略该错误
305内核下载失败，可忽略该错误
1001文档下载成功
1002开始初始化内核
1003开始离线安装内核
1004开始在线安装内核
1005内核下载成功
1006内核安装成功
1007内核初始化成功
1008缓存文档删除成功
1021WPS动作事件

3、WPS动作事件类型actionType说明

支持平台：Android

动作类型说明
back返回键
homeHome键
save保存文件
close关闭文件

八、后续计划

  • 添加水印
  • 支持小窗口模式
  • 支持右上角自定义菜单
  • 支持当前页面回调

九、Android预览效果

预览docx

预览pptx

预览xlsx

预览pdf

预览txt

iOS预览效果

预览docx

预览pptx

预览xlsx

预览pdf

预览txt

转载请注明：我的技术分享 » 跨平台文件在线预览解决方案（四）-Android和IOS原生插件


http://www.niftyadmin.cn/n/274389.html

相关文章

【操作系统复习】第6章 虚拟存储器 1

【操作系统复习】第6章 虚拟存储器 1

前面所介绍的各种存储器管理方式&#xff0c;有一个共同特点&#xff1a;作业全部装入内存后方能运行 问题&#xff1a; ➢ 大作业装不下 ➢ 少量作业得以运行 解决办法&#xff1a; ➢ 方法一&#xff1a;从物理上增加内存容量&#xff0c;成本高 ➢ 方法二&#xff1a;…
阅读更多...
第二部分——长难句——第二章——复合句——第一节——名词性从句

第二部分——长难句——第二章——复合句——第一节——名词性从句

首先复合句是什么呢&#xff1f; 多件事一样重要就叫并列句&#xff0c;如果不一样重要就叫并列句。 复合句主句从句 下面我们来看一个例句&#xff1a; 找到从句之后剩下来的不就是主句吗&#xff1f; 一&#xff0c;宾语从句 &#xff08;一&#xff09;宾语从句的含义 一…
阅读更多...
Qt 信号与槽机制

Qt 信号与槽机制

Qt 信号与槽机制 信号与槽机制的连接方式信号与槽机制的优点信号与槽机制的效率 QT提供了信号与槽机制用于完成界面操作的响应&#xff0c;信号与槽机制是完成任意两个QT对象之间的通信机制。 信号&#xff08;Signal&#xff09; 就是在特定情况下被发射的事件&#xff0c;例…
阅读更多...
创建NAT模式KVM虚拟机

创建NAT模式KVM虚拟机

创建NAT模式KVM虚拟机 1 添加脚本执行权限&#xff08;上传脚本文件至root目录&#xff09;。 首先需要给脚本赋予执行权限。 # chmod x qemu-ifup-NAT 2 启动虚拟机。 通过命令启动虚拟机。(记得安装net-tools) # yum install net-tools -y # qemu-kvm -m 1024 -drive fi…
阅读更多...
JAVASE的全面总结

JAVASE的全面总结

&#xff08;未完待续&#xff09; 五、子类与继承 5.1 子类与父类 继承是一种由已有的类创建新类的机制。利用继承&#xff0c;我们可以先创建一个共有属性的一般类&#xff0c;根据该一般类再创建具有特殊属性的新类&#xff0c;新类继承一般类的状态和行为&#xff0c;并…
阅读更多...
对顶堆模板！！【DS对顶堆】ABC281 E - Least Elements

对顶堆模板！！【DS对顶堆】ABC281 E - Least Elements

我想的思路和正解是差不多的 就是滑动窗口&#xff0c;每过去一个用DS维护一下前k个元素和sum 本来想的是用优先队列维护前k个 然后想着multiset维护前k个&#xff0c;但是具体不知道怎么操作 这里用的是multiset维护对顶堆 关于对顶堆&#xff0c;我在寒假的时候总结过 …
阅读更多...
如何学习数据结构和算法

如何学习数据结构和算法

背景&#xff1a; 对待数据结构与算法的态度可能大多数人就是觉得晦涩难懂。这节课我们跟随老师看看老师是如何带领我们入门的。 定义&#xff1a; 首先我们了解数据结构和算法的定义&#xff1a; 从广义上讲&#xff0c;数据结构就是指一组数据的存储结构。算法就是操作数…
阅读更多...
java数据结构之HashMap

java数据结构之HashMap

目录 前言 1、初始化 1.1、初始化 1.2、插入第一条数据 2、数组 链表 2.1、插入数据&#xff1a;没有hash冲突 2.2、插入数据&#xff1a;Key不同&#xff0c;但产生hash冲突 2.3、插入数据&#xff1a;Key相同 3、数组 红黑树 3.1、链表如何转化为红黑树&#xff1f; 3.…
阅读更多...
最新文章

Copyright @ 2022~2023