实战应用WPS WebOffice开放平台服务

概述

根据公司的业务需要,主要功能是在线编辑文档,前端的小伙伴进行的技术调研,接入的是WPS WebOffice,这里只阐述技术介入的步骤、流程和遇到的坑进行的一些总结。

实践

WPS WebOffice 开放平台进行认证

在开始之前,需要在WPS WebOffice 开放平台进行注册和认证,添加应用,申请成功后如下图所示:

开发和接入

在开始编写代码之前,有三个关键概念要提前了解 webClient(前端客户端)、 WpsServers(Wps服务)、CrmServers(服务端),请求流程: 前端客户端请求Wps服务,Wps服务请求服务端,进行通知、回调操作。

具体实现,图中左侧是我们具体业务逻辑,右侧是Wps服务请求我们的服务端:

1.配置路由:WPS WebOffice

开放平台url都是官方定义好的,用路径拼接好的,服务端需要定义一个全局${file_id}来进行通信,强烈推荐在服务端配置自定义路由,这样的实现简单便捷,也可以在Nginx使用重定向进行解决,参数通过截取Url得到。

php 复制代码
/** wps 在线文档自定义路由 */
$route['v3/3rd/files/(:any)'] = 'wps/test/files/$1/$2/$3';
$route['v3/3rd/users'] = 'wps/test/users';
$route['v3/3rd/notify'] = 'wps/test/notify';

2.预览

在前端预览的时候,Wps服务文件信息、文件权限、文件下载地址、用户信息4个接口,返回格式要和文档上的一致,不然会产生权限不足的错误,查找起来也是很困难,在这里也说一下接口说明:

shell 复制代码
120.92.55.139 - - [24/Oct/2024:07:23:57 +0800] "GET /v3/3rd/users?user_ids=45 HTTP/1.1" 200 89 "-" "Go-http-client/1.1"
120.92.55.139 - - [24/Oct/2024:07:23:57 +0800] "GET /v3/3rd/files/HT4319/permission HTTP/1.1" 200 131 "-" "Go-http-client/1.1"
120.92.55.139 - - [24/Oct/2024:07:24:08 +0800] "GET /v3/3rd/files/HT4319 HTTP/1.1" 200 177 "-" "Go-http-client/1.1"
120.92.55.139 - - [24/Oct/2024:07:24:08 +0800] "GET /v3/3rd/files/HT4319/download HTTP/1.1" 200 137 "-" "Go-http-client/1.1"
  • /v3/3rd/users :获取用户信息接口,用于在线文件操作中的显示和记录。
  • /v3/3rd/files/HT4319/permission : 获取当前文件可以操作的权限
  • /v3/3rd/files/HT4319 :获取文件的基本信息、创建文件用户、大小等等
  • /v3/3rd/files/HT4319/download:最容易出错的是这个接口,这个接口中要返回的是文档可以下载的url路径,Wps服务要来这里获取文件数据流。

3.保存

在操作的过程中,每保存一次文件,他就会请求URL一次,我们使用的这个版本用的是三阶段提交,具体阐述如下:

shell 复制代码
120.92.55.139 - - [24/Oct/2024:07:37:56 +0800] "GET /v3/3rd/files/HT4319/upload/prepare HTTP/1.1" 200 86 "-" "Go-http-client/1.1"
120.92.55.139 - - [24/Oct/2024:07:37:56 +0800] "POST /v3/3rd/files/HT4319/upload/address HTTP/1.1" 200 186 "-" "Go-http-client/1.1"
120.92.55.139 - - [24/Oct/2024:07:37:56 +0800] "GET /v3/3rd/files/HT4319/permission HTTP/1.1" 200 131 "-" "Go-http-client/1.1"
120.92.55.139 - - [24/Oct/2024:07:37:56 +0800] "POST /v3/3rd/files/HT4319/upload/complete HTTP/1.1" 200 179 "-" "Go-http-client/1.1"
  • /v3/3rd/files/HT4319/upload/prepare : 这个接口的作用是Wps服务与本地服务端协商摘要算法,有 md5 sha1 sha256三个选项,多接口的交互需要保持一致。
  • /v3/3rd/files/HT4319/upload/address : 这个接口的作用是在编辑的过程中,告诉Wps服务保存文件的Api,Wps服务以文件流的形式来进行请求
  • /v3/3rd/files/HT4319/upload/complete:Wps服务保存完成后,回调这个接口

以我的/v3/3rd/files/HT4319/upload/address接口为例,返回的完整Json结构,作用是在文件在线编辑的过程中去同步请求url的指定接口。

JavaScript 复制代码
{
    "code": 0,
    "data": {
        "method": "PUT",
        "url": "https://www.stark.com/api/laborcontract_wps/save_wps",
        "params": {
            "file_id": "HT4308",
            "name": ""
        }
    },
    "message": ""
}

有两个注意的点,开发过程中,最大的难点就在这里了。 1、save_wps接收的参数是通过upload/address params 传递的,我的$this->posts是参数数组 2、接收到的文件流,重写到指定地址,覆盖之前的文件地址 $savePath

php 复制代码
public function save_wps()
{
    #接收参数
    $file_id = isset($this->posts['file_id']) ? $this->posts['file_id'] : '';
    
    //接收文件流,覆盖文件
    $stream = file_get_contents('php://input');
    file_put_contents($savePath, $con);
}

4.其他

文档重命名、水印、用户列表、会话通知其他接口就比较简单,不在这里一一赘述了,如果有需要的可以私信我,给我留言。

相关推荐
大只鹅21 分钟前
解决 Spring Boot 对 Elasticsearch 字段没有小驼峰映射的问题
spring boot·后端·elasticsearch
ai小鬼头24 分钟前
AIStarter如何快速部署Stable Diffusion?**新手也能轻松上手的AI绘图
前端·后端·github
IT_10241 小时前
Spring Boot项目开发实战销售管理系统——数据库设计!
java·开发语言·数据库·spring boot·后端·oracle
bobz9651 小时前
动态规划
后端
stark张宇1 小时前
VMware 虚拟机装 Linux Centos 7.9 保姆级教程(附资源包)
linux·后端
亚力山大抵2 小时前
实验六-使用PyMySQL数据存储的Flask登录系统-实验七-集成Flask-SocketIO的实时通信系统
后端·python·flask
超级小忍2 小时前
Spring Boot 中常用的工具类库及其使用示例(完整版)
spring boot·后端
CHENWENFEIc3 小时前
SpringBoot论坛系统安全测试实战报告
spring boot·后端·程序人生·spring·系统安全·安全测试
重庆小透明4 小时前
力扣刷题记录【1】146.LRU缓存
java·后端·学习·算法·leetcode·缓存
博观而约取4 小时前
Django 数据迁移全解析:makemigrations & migrate 常见错误与解决方案
后端·python·django