本篇介绍在平台框架内使用脚手架工具 Vue-CLI 开发应用并部署到平台服务目录的做法:先安装工具并创建项目,接着在页面入口引入平台脚本、抽取全局对象,并把框架实例挂载放入脚本载入完成后的回调。随后修改根组件,嵌入指定数据应用下的视图,添加创建文档与打开主页的按钮,再自行编写组件包装平台视图对象。最后说明编译前需把资源路径设为相对路径、产物部署到服务目录,另有本地运行与自动化上传等做法。
提示:
本文介绍的方法已过时,建议查看文档:o2oa 开发平台前端源码级二次开发
介绍 O2OA 前端二次开发中创建 O2OA component 的方式,分别基于 React 和 Vue 模式。
Vue-CLI 是 Vue 官方提供的 CLI 工具,用于为应用快速搭建繁杂的脚手架。本章介绍如何在 Node,js 环境下使用 Vue-CLI 工具进行 Vue 和 O2 集成应用开发,并在 O2平台的 webServer 下运行。
本文适用于以下版本:
Vue CLI 需要 Node.js 8.9 或更高版本 (推荐 8.11.0+)。在正确安装好 Node.js 和 npm 或 yarn 后,可以使用下列任一命令全局安装 Vue-CLI:
安装完成后,你就可以在命令行中访问 vue 命令。运行 vue 命令,若展示出所有可用命令的帮助信息,即可验证它是否安装成功。
还可以用该命令检查其版本是否正确:
如果希望将应用部署在 O2服务器的 webServer 下,则可参考下面的例子。
运行以下命令创建一个名为 vue-app 的新项目:
根据提示选取所需特性,本例使用默认选项。安装完成后,Vue 会自动创建好整个目录结构:
本例中嵌入 O2平台数据中心中的一个视图,用于展现内容管理信息;并创建两个按钮,分别用于创建信息文档和打开主页。
添加 O2脚本引入:在 public/index.html 的 head 中添加 O2脚本引入:
为便于后续引入,在 src 下创建 o2.js 文件,添加以下代码:
修改 src/main.js 文件如下:
修改 src/App.vue 文件如下:
App.vue 是一个 Vue 组件,文件分为三部分:<template>部分定义组件模板,<style>部分定义组件样式,<script>部分实现组件逻辑。
模板中使用了<o2-view>标签,将由 o2-view 组件负责渲染,并向 o2-view 传入两个参数:app="内容管理数据"和name="所有信息",我们将在 o2-view 组件中使用这两个参数,用于展现"内容管理数据"这个数据应用下的"所有信息"视图。您需要现在 O2平台里创建好对应的视图,如果需要展现其他数据应用的其他视图,需要修改这两个值。
创建了两个 button,通过 @click 分别绑定 createDocument 和 openHomepage 两个方法,用于新建内容管理文档和打开主页应用
在 components 部分引用了 o2View 组件,下一步创建该组件。
删除 src/components/目录下的原有 .vue 文件,然后新建 o2-view.vue 文件,输入以下代码:
在 o2-view 组件中,我们主要做的事是,在 vue 组件挂载后,将 o2的视图组件,再挂载到 o2-view 组件的根 Dom 对象。
同时,需要在 O2服务器上创建好对应的数据应用和视图,本例中即“内容管理数据”应用下的“所有信息”视图。
完成上述开发工作后,即可编译并运行我们的应用。
由于我们要将 Vue 应用部署在 O2的 web 服务器目录下,而非根路径下,因此需要简单配置编译路径。在 vue 应用目录下创建 vue.config.js 文件,输入以下代码:
将编译后的路径引用设置为相对路径。
在当前项目路径下,使用以下任意一条命令编译项目:
出现类似下面的信息,表示编译成功:
编译后,将在项目路径下,生成 dist 目录,接着将dist目录部署到O2服务器的webServer下,并重命名为“vue-app”。然后通过浏览器访问:http://your-server/vue-app。如果未登录服务器,会出现登录页面,登录后即可查看应用运行的效果。
如果您将您的应用部署到服务器的其他目录,如 custom/vue-app 下,那么您需要在 src/o2.js 文件中增加一行代码:o2.base = "../";
至此,我们已经可以在 O2平台的框架内使用 Vue 开发应用了。
虽然可以使用 React 开发 O2应用,但上述模式在每次修改代码后,都需要运行 build 命令并手工上传到服务器,在开发较复杂的应用时效率较低。下面介绍两种应对方式。
可以在本地运行服务器,并直接在服务器的 webServer 目录下创建项目。然后必须修改 Vue 配置,使其编译到正确的路径,即修改项目目录下的 vue.config.js 文件:
然后每次运行编译后,Vue会将编译后的应用生成在webServer/vue-app/目录下,我们直接通过http://locahost/vue-app就可以查看运行结果。
当然,为了节省我们部署远程服务器的时间,可以使用 javascript 打包工具,自动完成这个过程,这里我们使用 gulp,通过 ftp 或 sftp 来进行自动化部署到远程服务器。
这种方式无需在本地运行 O2服务器,但需要准备一台远程服务器,并可通过 ftp 或 sftp 连接到服务器的 webServer。
按上述方式创建好应用后,安装 gulp 环境:
安装 gulp 以及 gulp 相关插件:
在项目根目录新建 gulpfile.js 文件:
当开发或修改代码完成后,执行以下命令:
即可自动编译 Vue 应用并上传到 O2服务器。通过浏览器访问:http://your-server/vue-app 即可查看结果。
这只是一个简单的示例,用于提供一种思路,也可以使用其他熟悉的工具实现相同或类似的功能。对于熟悉前端构建工具的用户,实现更便捷的功能也不困难,例如监控文件改动、实时部署并刷新浏览器等。
本章介绍了在 O2平台的框架内使用 Vue 开发应用,并将应用运行在 O2服务器的 webServer 中。该方式集成了 O2平台的全部功能,无需处理登录等繁琐事项,也可方便地调用 O2的后端服务,并提供了优化开发模式的思路。
相关内容