3 Star 8 Fork 10

wpsweboffice / weboffice-provider-v3-java

Create your Gitee Account
Explore and code with more than 12 million developers,Free private repositories !:)
Sign up
Clone or Download
Sync branch
Notice: Creating folder will generate an empty file .keep, because not support in Git

WebOffice 开放平台 Java SDK


在 pom.xml 中添加依赖:



WebOffice 的 SDK 项目目前还没有注册到 Maven Central。只能暂时通过将其添加到自建的 Maven 仓库中,或者像示例中这样,直接使用打包后的 jar 文件。

在项目中配置 Spring 发现依赖的项目下的 Bean,例如:

@SpringBootApplication(scanBasePackages = {"cn.wps.solution.weboffice.provider.v3", "your.project.class.path"})
public class Application implements ApplicationRunner { ... }


  • JDK 8+
  • Spring Framework 4.0+


├── java
│   └── cn
│       └── wps
│           └── solution
│               └── weboffice
│                   └── provider
│                       └── v3
│                           ├── controller # 接口层
│                           │   ├── ExtendCapacityController.java
│                           │   ├── FileStorageController.java
│                           │   ├── PreviewController.java
│                           │   ├── ProviderBaseController.java
│                           │   ├── ProviderJsonApi.java
│                           │   └── UserController.java
│                           ├── exception # 异常定义
│                           │   ├── CustomError.java
│                           │   ├── FileNameConflict.java
│                           │   ├── FileNotExist.java
│                           │   ├── FileUploadNotComplete.java
│                           │   ├── FileVersionNotExist.java
│                           │   ├── InternalError.java
│                           │   ├── InvalidArgument.java
│                           │   ├── InvalidToken.java
│                           │   ├── NotImplementException.java
│                           │   ├── PermissionDenied.java
│                           │   ├── ProviderException.java
│                           │   ├── StorageNoSpace.java
│                           │   └── UserNotExist.java
│                           ├── model # 值对象,包括请求参数、返回值等
│                           │   ├── DigestType.java
│                           │   ├── DownloadInfo.java
│                           │   ├── FileInfo.java
│                           │   ├── FileRenameRequest.java
│                           │   ├── FileUploadMultiPhase.java
│                           │   ├── FileUploadSinglePhase.java
│                           │   ├── LocalDateTimeDeserializer.java
│                           │   ├── LocalDateTimeSerializer.java
│                           │   ├── ProviderRequestAttribute.java
│                           │   ├── ProviderResponseEntity.java
│                           │   ├── UserInfo.java
│                           │   ├── UserPermission.java
│                           │   └── Watermark.java
│                           └── service # 需要接入方实现的接口
│                               ├── ExtendCapacityService.java # 扩展能力接口,包括历史版本、重命名等功能
│                               ├── MultiPhaseFileStorageService.java # 文档三阶段保存接口,非必须,且与 SinglePhaseFileStorageService 互斥,实现一个即可 
│                               ├── PreviewService.java # 预览服务接口,必须实现,包括获取文档信息、下载地址、当前用户权限接口
│                               ├── SinglePhaseFileStorageService.java # 文档保存接口,非必须,且与 MultiPhaseFileStorageService 互斥,实现一个即可
│                               └── UserService.java # 获取用户信息,非必须

文档预览接口 (必须)

如果仅使用开放平台提供的文档预览服务,可以只实现 PreviewService 接口,该接口是必须实现的,示例代码如下:

public class PreviewServiceImpl implements PreviewService {
    public FileInfo fetchFileInfo(String fileId) {
        return fetchFile(fileId).toFileInfo();

    public DownloadInfo fetchDownloadInfo(String fileId) {
        return fetchFileDownloadInfo(fileId);

    public UserPermission fetchUserPermission(String fileId) {
        return fetchFileUserPermission(fileId);

文档保存接口 (可选)

如果要使用开发平台提供的文档编辑能力,需要近一步实现文档保存接口,MultiPhaseFileStorageServiceSinglePhaseFileStorageService 这两个接口只需要实现一个即可,同时在开放平台配置您实现的是哪个接口

  • MultiPhaseFileStorageService 接口,其中包括如下三个步骤,该方式适用于文件元信息和文档内容是分开存储的,比如文档内容保存在某个云服务商,上传文件内容的流量直接走云服务商

    1. 准备阶段
    2. 获取上传地址
    3. 上传结果通知
  • SinglePhaseFileStorageService 接口,将三阶段上传中的参数,通过一个 Form 提交到接入方的服务端,包括文件的元信息和文档内容

MultiPhaseFileStorageService 实现示例:

public class MultiPhaseFileStorageServiceImpl implements MultiPhaseFileStorageService {
    // 准备阶段,获取校验文档内容的校验合计算方法,非必须,默认 SHA1
    public List<DigestType> uploadPrepare(String s) {
        return Collections.singletonList(DigestType.SHA1);

    // 获取上传地址,需要实现
    public FileUploadMultiPhase.FileUploadAddress.Response uploadAddress(FileUploadMultiPhase.FileUploadAddress.Request request) {
        return fetchUploadAddress(request.getFileId());

    // 通知上传结果
    public FileInfo uploadComplete(FileUploadMultiPhase.FileUploadComplete.Request request) {
        return fetchFile(request.getRequest().getFileId());

SinglePhaseFileStorageService 实现示例:

public class SinglePhaseFileStorageServiceImpl implements SinglePhaseFileStorageService {
    public FileInfo uploadFile(FileUploadSinglePhase.Request request) {
        return fetchFile(request.getFileId());

用户接口 (可选)

如果要显示当前用户信息(当前参与文档协作的用户等场景),需要实现 UserService 接口,示例代码如下:

public class UserServiceImpl implements UserService {
    public List<UserInfo> fetchUsers(List<String> userIds) {
        return fetchUserList(userIds);

扩展能力接口 (可选)

如果想使用更多开放平台提供的能力,需要选择性的实现 ExtendCapacityService 中的接口

接口定义中有默认实现(default 实现),方便接入方选择只实现其中的一部分功能,例如:

public interface ExtendCapacityService {
    // 要使用文档重命名功能,需要实现该接口
    default void renameFile(String fileId, String name) {
        throw new NotImplementException();

    // 如果要实现文档历史版本列表功能,要实现该接口
    default List<FileInfo> fileVersions(String fileId, int offset, int limit) {
        throw new NotImplementException();

    // 如果要实现预览文档历史版本
    default FileInfo fileVersion(String fileId, int version) {
        throw new NotImplementException();

    // 如果要实现预览文档历史版本,同上
    default DownloadInfo fileVersionDownload(String fileId, int version) {
        throw new NotImplementException();

    // 如果要在文档预览/编辑的时候显示水印,需要实现该接口
    default Watermark fileWatermark(String fileId) {
        throw new NotImplementException();



这里 这里有一个完整的 Demo 项目,供参考。

Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.


WPS WebOffice Provider V3 对接用 SDK。 expand collapse


No release




Load More
can not load any more
马建仓 AI 助手


344bd9b3 5694891 D2dac590 5694891