1、基础要求
本次环境配置,只需在 “扩展包开发环境” 的基础上增加二开扩展包环境即可,用户预先安装扩展包开发环境,部署方式请参考 扩展包开发环境部署。
(1)通过安装包:node-v16.14.2-win-x64.zip 安装node环境,详情可参考:node环境安装文档;
(2)此版本已经自带npm,对于二开人员:
2、环境配置
(1)V10.5以下版本不支持仪表盘二次开发;
(2)对于仪表盘二次开发:可在原有扩展包基础上加上包:webpack .zip;(包含下面两个示例的基础文件,下载后按说明可直接使用)
(1)进入扩展包根目录的src;
(2)解压webpack项目,打开终端控制台cd 到webpack目录,运行下载smartbi二开环境基础包命令:
npm install smartbi-ext-env
若执行npm install smartbi-ext-env失败,显示对应网址无法连接
可以检查下对应环境是否可以访问上对应的npm地址:https://www.npmjs.com/package/smartbi-ext-env
得到的目录结构如下:
在二开环境中,常用命令如下:
- 开发调试命令:
npm run dev //开发调试命令
- 打包命令:
npm run build //打包命令
1、若扩展包中的二开文件中js是引用的smartbi-ext-x"
import SmartBIExt from "smartbi-ext-x";
在这种情况下,在运行npm run dev或者是是打包npm run build的时候会在扩展包extension.xml中写入对应的文件目录声明
在extension.xml中有扩展文件的情况下,就会读取xml文件中的内容不会去自动读取其他文件,因此需要加载声明到extension.xml中的扩展文件都应该是引用smartbi-ext-x而不是smartbi-ext
因此要么都使用smartbi-ext,就不会在extension.xml中声明,就会按照目录读取
因此要么都使用smartbi-ext-x,就都在extension.xml中声明
2、存在有部分场景下载执行npm run dev或者npm run build时报错TypeError: Cannot read properties of undefined (reading 'elements')
在这种情况下主要是和上面的1有关系,若在扩展包中使用的是from smartbi-ext-x,就会在扩展包extension.xml中写入对应的文件目录声明,这个声明是写在<extension ></extension >标签中的
若对应的xml文件中不含有对应的extension 标签,则会报错
解决办法为手动在extension.xml中增加对应的extension 标签
3、开发调试
运行开发调试命令:
npm run dev
每当代码修改的时候,系统会帮你自动编译,刷新页面即可看到新的效果。
3.1 常见问题
问题:为什么改了代码,没有效果?
解决方法:请仔细查看以下几个步骤:
1、如果要调试smartbi,最好在url中增加debug=true参数(如:http://192.168.1.10:16000/smartbi/vision/index.jsp?debug=true),否则扩展包会有缓存,代码修改后不会更新。
2、配置extension.list;
3、修改SmartbiPluginApp/apache-tomcat-7.0.42/webapps/smartbi/WEB-INF下的web.xml文件:
- 在文件中加入 DevEnv 对应的四行代码;
- 在文件中找到 ProductName 的 <context-param>;
- 在其下面添加 DevEnv 对应的四行<context-param>,其值为 true。
修改同样是web.xml中如图所示的位置
具体调试技巧可参考:调试&定位技巧。
4、仪表盘组件新增和修改
4.1 功能修改示例
(1)需求场景
在仪表盘预览菜单栏,点击工具栏弹出hello。
(2)示例效果
(3)操作步骤
a.在根目录下的src/webpack/src/plugins/modifyExtenders下创建组件文件夹,下面以仪表盘预览菜单栏为例:
- 添加文件夹dashFlexMenuExtension;
- 在文件夹下创建index.js及FlexMenuExtension.js两个文件;
b.在index.js文件中实现provdieMetaInfo方法,FlexMenuExtension.vue导出的是一个FlexMenuExtension对象:
c.FlexMenuExtension.js:
说明
- BaseDashExtender是一个基类,系统提供了内置方法
- install是入口方法
- on方法是向系统添加某个事件的处理程序,系统在这个时机就会触发此方法回调。
4.2 组件新增示例
注意
组件新增场景仅支持仪表盘。
4.2.1 入门版
(1)需求场景
在仪表盘的组件选择器中,新增一个组件,组件中显示一个简单的文字hello。
(2)示例效果
(3)操作步骤
a.在根目录下的src/webpack/src/plugins/addExtenders中创建组件文件夹:
- 添加文件夹helloView
- 在文件夹下创建index.js及HelloView.vue
b.在index.js文件中实现providerMetaInfo方法,返回的是一个对象,具体对象的属性可以参考仪表盘组件接口文档;
c.在HelloView.vue中编写自己的业务代码
4.2.2 简单版
(1)需求场景
在仪表盘的组件选择器中,新增一个清单表组件,具备取数功能。
(2)示例效果
(3)操作步骤
a.在根目录下的src/webpack/src/plugins/addExtenders下创建组件文件夹:
- 添加文件夹newTableView;
- 在文件夹下创建index.js及NewTableView.vue;
b.在index.js文件中实现providerMetaInfo方法,返回的是一个对象,具体对象的属性可以参考仪表盘组件接口文档;
(说明:fieldRules:是字段区配置,可以理解为行列区和标记区规则配置)
c.在NewTableView.vue中编写自己的业务代码:
- Smartbi 节点下main节点下,refresh方法,是系统通知组件更新的一个时机
- this.pageProxy.api.fetchPortletData(queryFields)是组件主动调用系统取数api,进行取数。
5、打包部署
本地打包:系统会帮自动打包vue文件变成js,本地直接再打包成扩展包;
服务器打包:开发者要运行打包命令,将vue文件打包成js文件,然后开发者将扩展包代码提交到仓库,服务器打包的时候会运行build.xml 脚本进行打包;
两者区别:本地打包帮你直接打包扩展包,服务器打包是将你的编译后的js文件提交到服务器打包;
部署:将服务器打好的包,打开系统监控,扩展包管理页面进行上传。
5.1 服务器打包
(1)运行npm run build命令;
(2)将扩展包代码提交仓库;
(3)当服务器打包的时候会运行扩展包代码中的的build.xml 文件 打包成扩展包;
5.2 本地打包
本地打包非必要时候,不建议使用!
如果有需要本地打包的话,请配置添加localBuild.xml文件。
(1)复制原来的build.xml文件,修改名字为localBuild.xml;
(2)在taget标签下添加排除webpack路径下的内容;
<exclude name="**/webpack/" />
(3)添加webpack命令;
<target name="webpack" description="webpack npm build"> <exec executable="cmd.exe"> <arg line="/c "cd ${basedir}/src/webpack && npm run build " "/> </exec> </target>
(4)修改dist命令编译部分如下,添加webpack相关的编译;
<target name="dist" depends="init"> <parallel failonany="true"> <echo>==============</echo> <antcall target="webpack" /> <echo>webpack npm build</echo> <echo>${ant.project.name}: dist</echo> <echo>==============</echo> <antcall target="compile" /> </parallel> <antcall target="jar" /> </target>
(5)修改打包名称;
(6)效果如下:
5.3 部署
(1)打开系统监控
(2)上传扩展包
(3)选择扩展包
6、学习资料汇总
(1)node环境安装: https://www.cnblogs.com/xinaixia/p/8279015.html
(2)npm命令使用:https://www.jianshu.com/p/4643a8e43b79
(3)Vue框架开发:https://cn.vuejs.org/index.html