app模板、应用模板、组件模板、widget模板
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

155 lines
5.2 KiB

4 years ago
  1. # 迁移指南
  2. 迁移分为两种方案,一种是完全复用之间的旧代码,以组件的方式进行集成;一种是源码级别的集成,将之前的源码、依赖资源等迁移至新的开发工程,下面将具体介绍两种方案的实施步骤以及注意事项,优缺点。
  3. ## 源码级迁移
  4. 优势:源码级别的迁移有利于以后长期维护,并且可以完整的使用新框架提供的各种api接口,例如消息通告,应用间的事件通信等
  5. 缺点:迁移后的代码在原有的框架中只能以应用的方式运行,不能按照之前组件的方式进行集成,显示效果可以达到弹窗等效果,但具体需要额外的配置及处理。无法完全复用之前的配置
  6. 步骤:
  7. 1. 将源码拷贝至tis_app_frame/src下
  8. 2. 在tis_app_frame/src/main.js中初始化您之前main.js中的代码,在mount函数中完成您初始化的绝大部分工作
  9. ```js
  10. import tis, { setup } from "./tis";
  11. import App from "./App.vue";
  12. import store from './store'
  13. import * as utils from './utils'
  14. import './assets/font/css/font-awesome.min.css';
  15. // import rjyxjkBox from './components/rjyxjkBox';
  16. // import {registerApps} from './scriptsLoader/index'
  17. // 生命周期函数
  18. function bootstrap(params) {
  19. console.log(`[SubApp: ${tis.appId}] boostrap`, params, esapp);
  20. }
  21. //完成您大部分的初始化工作
  22. function mount(params) {
  23. Object.keys(utils).forEach(key => {
  24. window.esapp.Vue.prototype[key] = utils[key]
  25. });
  26. // vue.component('yxjk', () => import( /* webpackChunkName: "yxjk" */ './components/rjyxjkBox'));
  27. // window.esapp.Vue.component("tis_yxjk_xtyxjk", () => import(/* webpackChunkName: "tis_yxjk_xtyxjk" */ './components/rjyxjkBox'));
  28. if (window.esapp) {
  29. window.esapp.add_path("", store.name, store.obj)
  30. } else {
  31. console.log('添加路由失败')
  32. }
  33. console.log(`[SubApp: ${tis.appId}] mount`, params);
  34. }
  35. function show(params) {
  36. console.log(`[SubApp: ${tis.appId}] show`, params);
  37. }
  38. function hide(params) {
  39. console.log(`[SubApp: ${tis.appId}] hide`, params);
  40. }
  41. function unmount(params) {
  42. console.log(`[SubApp: ${tis.appId}] unmount`, params);
  43. }
  44. // 收到消息
  45. function onMessage(params, message) {
  46. console.log(`我是子应用[SubApp: ${tis.appId}] onMessage`, params, message);
  47. }
  48. //初始化全局组件
  49. function install(Vue) {
  50. }
  51. // 启动
  52. setup(App, {
  53. install,
  54. bootstrap,
  55. mount,
  56. hide,
  57. show,
  58. unmount,
  59. onMessage
  60. });
  61. export * from "./tis";
  62. ```
  63. 3. 入口组件的引入
  64. 您之间的工程应当有一个主入口组件将所有的组件集成为一个大的界面,如果没有需要您在tis_app_frame/src/App.vue文件中引入您的入口组件,或组成界面的组件集。
  65. tis_yxjk_xtyxjk就是一个示例组件,它的引入方式如下
  66. ```html
  67. <template>
  68. <div id="app">
  69. <tis_yxjk_xtyxjk></tis_yxjk_xtyxjk>
  70. </div>
  71. </template>
  72. <script>
  73. export default {
  74. name: "App",
  75. components: {
  76. "tis_yxjk_xtyxjk": () => import(/* webpackChunkName: "tis_yxjk_xtyxjk" */ './components/rjyxjkBox')
  77. },
  78. };
  79. </script>
  80. <style lang="scss" scoped>
  81. #app {
  82. text-align: center;
  83. height: 100%;
  84. position: absolute;
  85. width: 100%;
  86. color: yellow;
  87. }
  88. </style>
  89. ```
  90. 4. 静态资源的拷贝
  91. 您在之前项目的大部分静态资源应当拷贝至tis_app_frame/src/assets目录下,包括之前在static目录下被引用的资源
  92. eg:static/font----->assets/font
  93. 引入路径也要相应
  94. 5. 修改tis_app_frame为您的段名tis_app_xxxx
  95. 6. 下载您缺失的node_modules依赖
  96. ## 集成组件迁移
  97. 优点:您的旧代码不需要做任何改动,可以按照组件的形式集成到应用模板,然后在以应用的方式集成到框架当中
  98. 缺点:您的旧代码无法使用新框架的API,您可以通过访问window.esapp.tis得到新框架的大部分API,但是仅限于运行态,开发态下,您无法获取到tis对象,无法方便的进行调试工作
  99. 步骤
  100. 1. 将旧代码build后的产物拷贝至tis_app_frame/sdk目录下
  101. 2. 创建tisplatform.json,描述您index.html必须的资源
  102. ```json
  103. {
  104. "TIS_YXJK": {
  105. "cssFiles": [
  106. "/TIS_YXJK/css/styles.css",
  107. "/TIS_YXJK/css/app.css"
  108. ],
  109. "jsFiles": [
  110. "/TIS_YXJK/js/styles.js",
  111. "/TIS_YXJK/js/vendors~app.js",
  112. "/TIS_YXJK/js/app.js"
  113. ],
  114. "preload": false
  115. }
  116. }
  117. ```
  118. 3. 在tis_app_frame/pubic/esplug.json文件中进行组件的配置,name component segprefix为必填项
  119. ```json
  120. {
  121. "name": "应用框架示例",
  122. "components": [
  123. {
  124. "name": "kt运行监控",//名称
  125. "component": "tis_yxjk_xtyxjk",//组件名称
  126. "segprefix": "TIS_YXJK"//段名(资源存放的文件夹的名字)
  127. }
  128. ]
  129. }
  130. ```
  131. 4. 配置config.js
  132. 如果您想在开发态下预览集成效果,则需要您配置template/config.js,这个文件是一个代理文件,主要解决开发态下的接口、资源访问跨域的问题
  133. ```js
  134. module.exports = {
  135. "/TIS_YXJK": {//sdk目录下的组件存放文件夹名
  136. target: 'http://localhost:7000',//资源指向您的开发工程域名
  137. changeOrigin: true,
  138. },
  139. "/api/xtpz/xtpz/": {//您组件中需要访问的接口
  140. target: 'http://10.10.10.89:3806',//后端域名
  141. changeOrigin: true,
  142. }
  143. }
  144. ```
  145. 5. tis_app_frame下npm run serve启动项目,即可看到效果