[原创]PageOffice最简集成代码(VUE3+Springboot)

转自：https://pageoffice.cn/pages/1c2c6e/
本文描述了PageOffice产品在（VUE3+Springboot）前后端分离的项目中如何集成调用。

假设开发环境电脑IP为：

192.168.1.100

后端Springboot项目

新建Springboot后端项目：springboot-back，在配置文件application.properties中设置项目端口为：8081
```
server.port=8081
```
在您项目的pom.xml中通过下面的代码引入PageOffice依赖。pageoffice.jar已发布到Maven中央仓库，建议使用最新版本。

如果使用Tomcat10及以上版本，使用下面的pom.xml配置

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

如果使用Tomcat9及以下的版本，使用下面的pom.xml配置

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

新建一个pageoffice文件夹，用来存放PageOffice的系统文件（如license.lic、客户端安装包等），比如windows环境下创建：D:/pageoffice，linux环境下创建:/root/pageoffice
拷贝pageoffice客户端安装程序到上一步创建的pageoffice文件夹下。
- 客户端是windows环境：拷贝posetup_6.3.3.1.exe到pageoffice文件夹下；
- 客户端是国产操作系统环境：拷贝对应芯片的PageOffice客户端deb安装包到pageoffice文件夹下；

PageOffice客户端安装程序下载地址：https://gitee.com/pageoffice/pageoffice6-client/releases

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

server.port=8081
posyspath=D:/pageoffice

在您项目的启动类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;
}

::: warning
注意：在实际开发中，您的后端项目中必须将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/";

	@RequestMapping(value="/openFile")
	public String openFile(HttpServletRequest request,int file_id,String file_name)  {
		//file_id和file_name是为了展示如何使用参数，我们这里只用到了file_name
		PageOfficeCtrl poCtrl = new PageOfficeCtrl(request);
		//webOpen的第一个参数支持能够输出下载文件的Url相对地址或者文件在服务器上的磁盘路径两种方式
		//查看详细，请在"https://www.pageoffice.cn/"搜索“PageOffice属性或方法中涉及到的URL路径或磁盘路径的说明”
		poCtrl.webOpen("file://"+dir+file_name, OpenModeType.docNormalEdit, "张三");
		return poCtrl.getHtml();//必须
	}

	@RequestMapping("/saveFile")
	public void saveFile(HttpServletRequest request, HttpServletResponse response,int file_id,String file_name)  {
		//file_id和file_name是为了展示如何使用参数，我们这里只用到了file_name
		FileSaver fs = new FileSaver(request, response);
		fs.saveToFile(dir + file_name);
		fs.close();
	}
}

前端vue3项目

新建Vue3前端项目：vue-front

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': ''   
        }
      },
    }
  }

引用js-pageoffice库。

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

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

在全局拦截器中添加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()设置更多的值，具体属性名称和属性值以您实际开发为准。
    }

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

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

 <script setup>
 import request from '@/utils/request';
 import { ref, onMounted } from 'vue'

 const poHtmlCode = ref('');
 const open_params = ref('');

 function OnPageOfficeCtrlInit() {
   // PageOffice的初始化事件回调函数，您可以在这里添加自定义按钮
   pageofficectrl.AddCustomToolButton("保存", "Save", 1);//其中"Save"对应function Save()函数，并且需要在onMounted中挂载。
 };

 function Save() {
   //使用SaveFilePage属性设置后端保存方法的Controller路由地址，这个地址必须从"/"开始，并且也可以向此路由地址传递json字符串参数，示例如下：
   let saveFileUrl = "/doc/saveFile";
   let paramValue = new URLSearchParams(open_params.value);//为了简单起见，这里直接使用打开时的参数。
   pageofficectrl.SaveFilePage = `${saveFileUrl}?${paramValue.toString()}`;
   //在这里写您保存前的代码
   pageofficectrl.WebSave();
   //在这里写您保存后的代码，比如判断保存结果pageofficectrl.CustomSaveResult
   //alert(pageofficectrl.CustomSaveResult);
 };

 function AfterDocumentOpened() {
   //在这里写您文档打开后自动触发的代码
 };

 function openFile() {
   // 发起GET请求到后端Controller的/doc/openFile路由
   return request({
     url: '/doc/openFile',
     method: 'get',
     params: open_params.value
   });
 };

 onMounted(() => {
   //使用pageofficectrl.WindowParams获取获取父页面(此项目中为：HomeView.vue)中POBrowser.openWindow()方法的第三个参数的值,获取到的值为string类型
   open_params.value = JSON.parse(pageofficectrl.WindowParams);
   // 请求后端打开文件
   openFile().then(response => {
     poHtmlCode.value = response;
   });
   //将需要回调的函数挂载到PageOffice控件，例如控件触发的事件、自定义按钮触发的函数。
   window.POPageMounted = { OnPageOfficeCtrlInit, AfterDocumentOpened, Save };//其中OnPageOfficeCtrlInit必须

 });
 </script>
 <template>
   <div class="doc">
     演示: 文档<br /><br />
     <!-- 此div用来加载PageOffice客户端控件，其中div的高宽及位置就决定了控件的大小及位置 -->
     <div style="width:auto; height:900px;" v-html="poHtmlCode"></div>
   </div>
 </template>

配置DocView.vue的访问路由。

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

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

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

 <script setup>
 import request from '@/utils/request';
 import { POBrowser } from "js-pageoffice";
 import { ref, onMounted } from 'vue';

 const titleText = ref('');
 const paramJson = {};
 paramJson.file_id = 1;
 paramJson.file_name = "test.doc";
 const paramString = JSON.stringify(paramJson);

 function open_pageoffice() {
   //openWindow()第三个参数用来向弹出的PageOffice浏览器（POBrowser）窗口传递参数(参数长度不限)，支持json格式字符串。
   //此处为了方便演示，我们传递了file_id和file_name两个参数，具体以您实际开发为准。
   POBrowser.openWindow('/showDoc', 'width=1150px;height=900px;', paramString);

 }
 </script>

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

posted @ 2024-12-09 09:05 大方无隅阅读(18) 评论(0) 编辑收藏举报

刷新页面返回顶部

[原创]PageOffice最简集成代码(VUE3+Springboot)

后端Springboot项目

前端vue3项目

公告