1、在扩展插件中必须通过applicationContext.xml文件声明至少一个组件(见 自定义Module),该组件的类名为类似于 smartbi.extension.demo.KnowledgeBaseUpgrade,并必须将此组件向framework模块注册,例如:
<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE beans PUBLIC "-//SPRING//DTD BEAN 2.0//EN" "http://www.springframework.org/dtd/spring-beans-2.0.dtd"> <beans> <bean id="framework" class="smartbi.framework.Framework" factory-method="getInstance"> <property name="modules"> <map> <entry><key><value>KnowledgeBaseUpgradeModule</value></key><ref bean="KnowledgeBaseUpgradeModule" /></entry> </map> </property> </bean> <bean id="KnowledgeBaseUpgradeModule" class="bof.ext.KnowledgeBaseUpgrade.KnowledgeBaseUpgradeModule" factory-method="getInstance"> <property name="daoModule" ref="dao"/> </bean> </beans> |
2、升级类固定在module所在包的upgrade包中,上述示例中升级包名为 smartbi.extension.demo.upgrade。
3、编写继承 smartbi.repository.UpgradeTask类的升级类,,以UpgradeTask开头,后接New或者版本号(譬如UpgradeTask_0_0_1),第一个版本必须命名为UpgradeTask_New;
4、升级类有三个方法需要实现:
getDate返回值为String类型,需要返回正确时间格式的字符串,例如”2019-7-1 00:00:00”。
getDate是2019-7-1 00:00:00才新增的方法,在此之前都是按照模块顺序执行升级类,这可能会引起一个问题。
假设存在两个模块A和B,A模块比B模块优先级高:
B模块中有一个升级类:create table c ······…
A模块中有一个升级类:alter table c …
由于A模块优先级更高,会先执行A模块的升级类,此时会导致升级失败,而模块的优先级不好改变,因此引入了新的决定因素——时间,只要B模块升级类返回的时间小于A模块升级类返回的时间,即可使得B模块创表升级类比A模块改表升级类优先执行。
假设有两个模块A和B,A模块比B模块优先级高:
A模块中有三个升级类,分别是A1(date:2020-8-27 00:00:00,version:0.0.2),A2(date:2020-8-29 00:00:00,version:0.0.3),A3(date:2020-8-30 00:00:00,version:0.0.4)
B模块中有两个升级类,分别是B1(date:2020-8-28 00:00:00,version:0.0.2),B2(date:2020-8-30 00:00:00,version:0.0.3)
默认按照时间顺序升级,若时间相同则按模块顺序升级,因此上述例子执行顺序为,A1(时间优先)->B1(时间优先)-A2(时间优先)->A3(同时间,模块顺序优先)->B2
ps:A1(date:2020-8-27 00:00:00,version:0.0.2)为升级类名称(date:getDate返回值,versiion:getNewVersion返回值)
具体实现逻辑可参考:https://history.wiki.smartbi.com.cn/pages/viewpage.action?pageId=47486342
(1)单个模块内按getNewVersion确定执行顺序示例
在升级类"UpgradeTask_New.java"中创建了一个知识库表,该表与"KnowledgeBaseObject.java"中的描述相对应。另外还有两个升级类"UpgradeTask_0_0_1.java" 和 "UpgradeTask_0_0_2.java",其中前者仅仅是修改了模块的版本号,后者则往上述知识库表中增加一个字段。总共有3个升级类,该模块的当前版本为最后一个升级类(在此为"UpgradeTask_0_0_2.java")的"getNewVersion()"方法的返回值(源码中该值为"0.0.3")。测试链接为:http://localhost:18080/smartbi/vision/demo/knowledgeBaseUpgradeModuleDemo.html,测试界面如下:
示例代码下载:KnowledgeBaseUpgrade.rar |
(2)多模块根据getDate和getNewVersion确定执行顺序示例
在B模块的升级类"UpgradeTask_New.java"中创建了一个知识库表,该表与"KnowledgeBaseObject.java"中的描述相对应,并且该升级类返回日期为"2019-07-01 00:00:00"。
在A模块的升级类"UpgradeTask_New.java"中往上述知识库表中增加一个字段,并且该升级类返回日期为"2019-07-02 00:00:00"。
首先执行返回时间较小的B模块升级类,创建表” t_ext_knowledge_base_object”,接着执行A模块的升级类增加一个字段。
示例代码下载:KnowledgeBaseUpgrade2.rar |