本文描述了 PageOffice 产品在（VUE+Springboot）前后端分离的项目中如何集成调用。

一、环境

前端：vue2

后端：springboot2、jdk1.8

如果是 springboot3，jdk17 及以上版本，用这个依赖：

<dependency>
  <groupId>com.zhuozhengsoft</groupId>   
  <artifactId>pageoffice</artifactId>   
  <version>6.3.3.1</version>
</dependency>

二、后端项目

1、新建 Springboot 后端项目：springboot-back，在配置文件 application.properties 中设置项目端口为：8081

2、在您项目的 pom.xml 中通过下面的代码引入 PageOffice 依赖。pageoffice.jar 已发布到Maven 中央仓库 (opens new window)，建议使用最新版本。

<dependency>
  <groupId>com.zhuozhengsoft</groupId>   
  <artifactId>pageoffice</artifactId>   
  <version>6.3.3.1-javax</version>
</dependency>

3、新建一个 pageoffice 文件夹，用来存放 PageOffice 的系统文件（如 license.lic、客户端安装包等），比如windows环境下创建：D:/pageoffice，linux 环境下创建:/root/pageoffice

4、拷贝 pageoffice 客户端安装程序到上一步创建的 pageoffice 文件夹下。

• 客户端是 windows 环境：拷贝 posetup_6.3.2.2.exe 到 pageoffice 文件夹下；
• 客户端是国产操作系统环境：拷贝对应芯片的 PageOffice 客户端 deb 安装包到 pageoffice 文件夹下；

PageOffice 客户端安装程序下载地址：pageoffice6-client 发行版 - Gitee.com 

5、打开 springboot-back 项目的配置文件 application.properties，添加一个 posyspath 变量，值为上一步创建的 pageoffice 文件夹的路径

server.port=8081
posyspath=D:/pageoffice

 6、在您项目的启动类 Application 类中添加一项 @Bean 配置，此为 PageOffice 服务器端的必要配置，代码如下：

@Value("${posyspath}")
private String poSysPath;
@Bean
public ServletRegistrationBean pageofficeRegistrationBean()  {
com.zhuozhengsoft.pageoffice.poserver.Server poserver
= new com.zhuozhengsoft.pageoffice.poserver.Server();
poserver.setSysPath(poSysPath);// 设置 PageOffice 注册成功后,license.lic 文件存放的目录
ServletRegistrationBean srb = new ServletRegistrationBean(poserver);
srb.addUrlMappings("/poserver.zz");
srb.addUrlMappings("/poclient");
srb.addUrlMappings("/sealsetup.exe");
return srb;
}

注意

注意：在实际开发中，您的后端项目中必须将 PageOffice 相关配置请求从后端拦截器 SpringSecurity 或者 Shiro 等授权认证校验框架中放出来。例如：

• SpringSecurity

.antMatchers("/poserver.zz","/poclient","/sealsetup.exe").permitAll()

• Shiro

filterChainDefinitionMap.put("/poserver.zz", "anon");
filterChainDefinitionMap.put("/poclient", "anon");
filterChainDefinitionMap.put("/sealsetup.exe", "anon");

7、新建 Controller 并调用 PageOffice 在线打开文件，例如 DocumentController 代码如下：

@RestController
@RequestMapping(value = "/doc")
public class DocumentController {
	// 获取 doc 目录的磁盘路径
	private String dir = GetDirPathUtil.getDirPath() + "static/";
<span class="hljs-meta">@RequestMapping(value="/openFile")</span>
<span class="hljs-keyword">public</span> String <span class="hljs-title function_">openFile</span><span class="hljs-params">(HttpServletRequest request,<span class="hljs-type">int</span> file_id,String file_name)</span>  {
	<span class="hljs-comment">//file_id和file_name是为了展示如何使用参数，我们这里只用到了file_name</span>
	<span class="hljs-type">PageOfficeCtrl</span> <span class="hljs-variable">poCtrl</span> <span class="hljs-operator">=</span> <span class="hljs-keyword">new</span> <span class="hljs-title class_">PageOfficeCtrl</span>(request);
	<span class="hljs-comment">//webOpen的第一个参数支持能够输出下载文件的Url相对地址或者文件在服务器上的磁盘路径两种方式</span>
	<span class="hljs-comment">//查看详细，请在"https://www.pageoffice.cn/"搜索“PageOffice属性或方法中涉及到的URL路径或磁盘路径的说明”</span>
	poCtrl.webOpen(<span class="hljs-string">"file://"</span>+dir+file_name, OpenModeType.docNormalEdit, <span class="hljs-string">"张三"</span>);
	<span class="hljs-keyword">return</span> poCtrl.getHtmlCode();<span class="hljs-comment">//必须</span>
}

<span class="hljs-meta">@RequestMapping("/saveFile")</span>
<span class="hljs-keyword">public</span> <span class="hljs-keyword">void</span> <span class="hljs-title function_">saveFile</span><span class="hljs-params">(HttpServletRequest request, HttpServletResponse response,<span class="hljs-type">int</span> file_id,String file_name)</span>  {
	<span class="hljs-comment">//file_id和file_name是为了展示如何使用参数，我们这里只用到了file_name</span>
	<span class="hljs-type">FileSaver</span> <span class="hljs-variable">fs</span> <span class="hljs-operator">=</span> <span class="hljs-keyword">new</span> <span class="hljs-title class_">FileSaver</span>(request, response);
	fs.saveToFile(dir + file_name);
	fs.close();
}

}

三、前端项目 

1、新建 Vue 前端项目：vue-front

2、Vue 配置代理。

  devServer: {
    proxy: {
      '/dev-api': { // "/dev-api" 对应后端项目 "http://192.168.1.100:8081" 地址 
        target: 'http://192.168.1.100:8081', 
        ws: true,
        changeOrigin: true, 
        pathRewrite: {
        '^/dev-api': ''   
        }
      },
    }
  }
 

3、引用 js-pageoffice 库。

注意：请确保安装的 js-pageoffice 库版本号与后端项目 pom.xml 文件中引用的 PageOffice JAR 包版本号的前三位相同。

​ 使用命令安装：npm install js-pageoffice@6.3.3 --save-exact

4、在全局拦截器中添加 PageOffice 相关配置。

import axios from "axios";
import { POBrowser } from "js-pageoffice";
// 创建 axios 实例
const service = axios.create({
baseURL: "/dev-api", // 设置你的基础 URL
timeout: 5000, // 设置请求超时时间
});
// 请求拦截器
service.interceptors.request.use(
(config) => {
// 在发送请求之前做些什么
//const token = Cookies.get('token'); // 假设你的 token 存储在 cookie 中
const token = "123";
if (token) {
config.headers["Authorization"] = "Bearer" + token; // 将 token 添加到请求头中
// PageOffice 全局配置，必须在此拦截器中定义
// 必须。设置后端代理, 具体属性值以您实际开发为准, 比如 POBrowser.setProxyBaseAPI(process.env.VUE_APP_BASE_API);
POBrowser.setProxyBaseAPI("/dev-api");
// 必须。向 PageOffice 后端请求设置 header，支持多次调用 setHeader() 设置更多的值，具体属性名称和属性值以您实际开发为准。
POBrowser.setHeader("Authorization", "Bearer" + token);
/**
* 前端存储 token 的方案
* 方案 1. 使用 Cookie
* 如果您的令牌 (token) 存储在 Cookie 中，PageOffice 会默认支持通过 Cookie 方式保存令牌，因此您无需编写任何额外的代码。
* 方案 2. 使用 Localstorage 或者 SessionStorage
* 如果令牌 (token) 是保存在 LocalStorage 或 SessionStorage 中，您必须调用 POBrowser.setStorage()方法。
*/
//POBrowser.setStorage("Admin-Token",getToken());// 支持多次调用 setStorage() 设置更多的值，具体属性名称和属性值以您实际开发为准。
}
<span class="hljs-keyword">return</span> config;

},
(error) => {
// 对请求错误做些什么
return Promise.reject(error);
}
);

5、新建一个 Vue 页面：src/views/DocView.vue，用来显示在线打开的文档。

 <template>
   <div class="doc">
     演示: 文档<br /><br />
     <!-- 此 div 用来加载 PageOffice 客户端控件，其中 div 的高宽及位置就决定了控件的大小及位置 -->
     <div style="width:auto; height:900px;" v-html="poHtmlCode"></div>
   </div>
 </template>
<script>
import request from '@/utils/request'
export default {
name: 'DocView',
data() {
return {
poHtmlCode: '',
open_params: '',
}
},
created: function () {
// 使用 pageofficectrl.WindowParams 获取获取父页面 (此项目中为：HomeView.vue) 中 POBrowser.openWindow()方法的第三个参数的值, 获取到的值为 string 类型
this.open_params = JSON.parse(pageofficectrl.WindowParams);
// 请求后端打开文件
this.openFile().then(response => {
this.poHtmlCode = response;
}
);
},
methods: {
OnPageOfficeCtrlInit() {
//PageOffice 的初始化事件回调函数，您可以在这里添加自定义按钮
pageofficectrl.AddCustomToolButton("保存", "Save", 1);// 其中 "Save" 对应 methods 中的 Save() 函数，并且需要在 mounted 中挂载。
},
Save() {
// 使用 SaveFilePage 属性设置后端保存方法的 Controller 路由地址，这个地址必须从 "/" 开始，并且也可以向此路由地址传递 json 字符串参数，示例如下：
let saveFileUrl = "/doc/saveFile";
let paramValue = new URLSearchParams(this.open_params);// 为了简单起见，这里直接使用打开时的参数。
pageofficectrl.SaveFilePage = <span class="hljs-subst">${saveFileUrl}</span>?<span class="hljs-subst">${paramValue.toString()}</span>;
// 在这里写您保存前的代码
pageofficectrl.WebSave();
// 在这里写您保存后的代码，比如判断保存结果 pageofficectrl.CustomSaveResult
//alert(pageofficectrl.CustomSaveResult);
},
AfterDocumentOpened() {
// 在这里写您文档打开后自动触发的代码
},
openFile() {
// 发起 GET 请求到后端 Controller 的 /doc/openFile 路由
return request({
url: '/doc/openFile',
method: 'get',
params: this.open_params
})
}
},
mounted: function () {
// 将当前页面 methods 中定义的函数挂载到 PageOffice 控件，例如控件触发的事件、自定义按钮触发的函数。
window.POPageMounted = this;// 此行必须
}
}
</script>

6、配置 DocView.vue 的访问路由。

const routes = [
  // 其他路由配置项...
  // 下面添加 DocView.vue 的路由
  ,
  {
    path: '/showDoc',
    name: 'doc',
    component: () => import('../views/DocView.vue')
  }
]

7、在您的 Vue 页面（比如 HomeView.vue，PageOffice 中把这个页面称之为父页面）添加一个打开文件的超链接，点击超链接调用 POBrowser 对象的 openWindow 方法，弹出 PageOffice 浏览器（POBrowser）窗口访问 DocView.vue 在线打开文件，代码如下：

 <a  href="#" @click.prevent="open_pageoffice()">打开文件</a>

 <script>
 import request from '@/utils/request'
 import { POBrowser } from 'js-pageoffice'
 export default {
   name: 'HomeView',
   methods: {
     open_pageoffice() {
       let paramJson={};
       paramJson.file_id=1;
       paramJson.file_name="test.doc";
       let paramString=JSON.stringify(paramJson);
   <span class="hljs-comment">//openWindow()第三个参数用来向弹出的PageOffice浏览器（POBrowser）窗口传递参数(参数长度不限)，支持json格式字符串。</span>
   <span class="hljs-comment">//此处为了方便演示，我们传递了file_id和file_name两个参数，具体以您实际开发为准。</span>
   <span class="hljs-title class_">POBrowser</span>.<span class="hljs-title function_">openWindow</span>(<span class="hljs-string">'/showDoc'</span>, <span class="hljs-string">'width=1150px;height=900px;'</span>,paramString);
 },

}
}
</script>

 8、启动 springboot-back 和 vue-front 项目，点击“打开文件”超链接，查看在线打开编辑保存 Word 文件的效果。

参考文档：PageOffice 最简集成代码 (VUE+Springboot) | PageOffice 开发者中心