...
文件导出到服务器的自定义文件管理中心接口
背景说明
...
导出资源到简道云的需求，需要支持文件在【文件导出到服务器】系统选项中新增自定义的文件服务器类型。需要支持文件在【文件导出到服务器】系统选项中新增自定义的文件服务器类型，实现将导出的文件上传到第三方平台，如简道云等。
IFileManagerStore接口类定义
...
基本信息
位置 | smartbi.module.export.store.IFileManagerStore |
父类 | smartbi.module.export.offline.storer.IOfflineFileStorer smartbi.module.export.offline.downloader.IOfflineDownloader |
功能 | 定义一个文件服务器 |
接口方法说明
InputStream download(String filename)
...
功能 | 初始化服务器相关成员变量 |
参数说明 | serverConfig：服务器配置 |
返回值 | 无 |
PS. serverConfig调用者会获取系统选项【SPREAD注：serverConfig调用者会获取系统选项【SPREAD_SHEET_REPORT_WRITEBACK_FILE】中的单个json对象，然后往这个json对象中添加一个“offlineDirectory”键用于记录当前导出的目录，需要注意两个场景：
...
功能 | 上传文件前调用者会执行的服务器初始化动作，一般用于创建目录 |
参数说明 | 无 |
返回值 | 无 |
备注 | 继承自 smartbi.module.export.offline.downloader.IOfflineFileStorer |
...
不同场景下的接口调用情况
在线导出、离线导出后的下载
iFileManagerStore.initServer(config); iFileManagerStore.download(request, response, fileName, downloadName); |
...
iFileManagerStore.initServer(config); // 删除前，需要调用init方法 iFileManagerStore.unstore(filename); |
IFileManagerFactory容器类定义
...
位置：smartbi.module.export.store.IFileManagerStore
...
方法名 | 功能 | 输入 | 输出 |
getInstance() | 返回IFileManagerFactory单例. | 无 | IFileManagerFactory |
registerFileManagerStoreHandlerIfNotExist(String handlerName, IFileManagerStore handler) | 注册一个文件系统，handlerName为这IFileManagerStore 对应服务器类型的键名。如果注册时已经存在同名对象，则不进行注册。 | handlerName：服务器类型名 handler：自定义的服务器实现类 | 无 |
registerEncryptHandlerForce(String handlerName, IFileManagerStore handler) | 注册一个文件系统，handlerName为这IFileManagerStore 对应服务器类型的键名。如果注册时已经存在同名对象，会覆盖式注册。 | handlerName：服务器类型名 handler：自定义的服务器实现类 | 无 |
etEncryptHandler(String handlerName) | 根据handlerName从handlers 中获取一个对应的文件服务器对象。不存在时返回空。 | handlerName：服务器类型名 | IFileManagerStore |
getRegistedServerKeys() | 获取所有注册的键名。 | 无 | Set<String> |
前端JS改造
...
SpreadsheetReportWriteBackFileSettingDialog.js 新增两个方法
...
说明 | 测试连接前执行的操作，用于复制服务器配置信息。 |
入参 | configObj：服务器配置信息（对象形式） currentTableLine：当前行的原始数据（数组形式） |
输出 | 无 |
扩展包使用步骤
...
1、创建类实现IFileManagerStore接口
public class CustomManagerStore implements IFileManagerStore{ //实现接口相关方法处理服务器逻辑 } |
...
2、在Module的activate()方法中注册上述接口实现类，并指定一个String的类型名
IFileManagerFactory.getInstance().registerFileManagerStoreHandlerIfNotExist("MyFileSystem",new JDYFileManagerStore()); |
...
3、创建 js/smartbi/spreadsheetreport/ftpsetting/SpreadsheetReportWriteBackFileSettingDialog.js.patch处理国际化
SpreadsheetReportWriteBackFileSettingDialog.prototype.getType_SMS_61642 = SpreadsheetReportWriteBackFileSettingDialog.prototype.getType; SpreadsheetReportWriteBackFileSettingDialog.prototype.getType = function(options){ this.getType_SMS_61642(options); //遍历options，将指定键名国际化处理 for(var i=0;i<options.length;i++){ if(options[i].value === "MyFileSystem"){ options[i].text = "自定义文件系统"; options[i].value = "自定义文件系统"; break; } } } SpreadsheetReportWriteBackFileSettingDialog.prototype.handleBeforeWriteBack_SMS_61642 = SpreadsheetReportWriteBackFileSettingDialog.prototype.handleBeforeWriteBack SpreadsheetReportWriteBackFileSettingDialog.prototype.handleBeforeWriteBack = function (obj,ctl) { this.handleBeforeWriteBack_SMS_61642(obj,ctl) if(obj.addressType ==="自定义文件系统"){ obj.addressType ="MyFileSystem"; } } SpreadsheetReportWriteBackFileSettingDialog.prototype.handleBeforeShowUp_SMS_61642 = SpreadsheetReportWriteBackFileSettingDialog.prototype.handleBeforeShowUp SpreadsheetReportWriteBackFileSettingDialog.prototype.handleBeforeShowUp = function (array,tline){ this.handleBeforeShowUp_SMS_61642(array,tline); if(array[1]==="MyFileSystem"){ array[1]="自定义文件系统"; } } |
...
4、创建js/smartbi/spreadsheetreport/ftpsetting/FTPRemovableGrid.js.patch处理国际化
FTPRemovableGrid.prototype.handleBeforeTestConnection_SMS_61642 = FTPRemovableGrid.prototype.handleBeforeTestConnection FTPRemovableGrid.prototype.handleBeforeTestConnection = function(configObj,currentTableLine){ this.handleBeforeTestConnection_SMS_61642(configObj,currentTableLine); if("自定义文件系统" === configObj.serverType){ configObj.serverType = "MyFileSystem"; } } |
扩展包示例：View file
