Page tree
Skip to end of metadata
Go to start of metadata

本文希望通过解决以下疑问,从根本上告知大家如何调试的问题:

  • 1、Smartbi 是如何加载js、css文件的?
  • 2、是如何实现与服务端异步或同步沟通的?
  • 3、在Smartbi 中添加一个拥有复杂界面(有交互事件)的弹窗如何实现?
  • 4、面对异步请求、鼠标事件等存在多浏览器问题,smartbi是如何处理的,有没有提供一些工具类方法?
  • 5、Smartbi里面的每个交互界面,是如何衔接在一起的,每个界面是个独立的jsp还是通过js动态衔接的?
  • 6、当判断需要基于产品扩展功能时,如何入手找到对应位置插入项目特定功能?
  • 7、如果是为了做插件开发而了解这些内容,建议先看下”插件简述“及“插件开发快速入门“,然后再看本文会更有体会。

 

文档目录:

1、Smartbi 前端框架

1.1、前端组件框架

Smartbi 是典型的基于JavaScript的面向对象框架,整个系统只有几个入口jsp(譬如index.jsp、login.jsp),剩下基于AJAX按业务或操作逻辑按需动态加载或注销组件,譬如在系统中双击一张分析报表,系统就会调出报表组件(QueryView)并执行打开的操作。下图是简单的前端组件图,对于定制来说最常做的操作是编写或修改业务逻辑层的组件。

上图分为四层:

  • 底层组件:是工具类、抽象接口类性质,下面章节会重点介绍几个常用的。
  • 基础控件:类似下拉框、表格、树、tab、列表、弹窗等界面控件或对象。
  • 业务控件:基于基础控件又封装的一层具有业务意义的控件,譬如定制管理左侧的资源树就是资源树控件。
  • 业务逻辑:整个系统只有几个入口jsp,并不是说所有内容一次性加载,而是根据用户鼠标操作按需加载或注销内容,所以系统的每个功能,其实都会对应一个js组件,譬如电子表格、透视分析、多维分析等都会有自己对应的组件,通过定制给系统增加一个功能界面也相当于要创建一个业务逻辑组件。

1.2、前后端通信框架

这里分两类介绍前后端通信,文件类交互请求,譬如js、html、css,和操作或数据交互类请求,譬如刷新报表,新建报表之类。

  • JS文件: 使用 jsloader 方式按需加载js文件,jsloader 也是封装了请求gbk.jsp?name=jsname,见“第四课:如何修改Smartbi JS文件”里的说明;
  • CSS文件:为了减少css的请求,系统采用bof_merge.css.jsp将css合并一次性加载,同时提供了扩展点修改系统内的样式或新增样式,扩展点中配置的css文件,bof_merge.css.jsp会自动识别并加载;
  • HTML文件:html文件一般作为组件的布局和展现文件,下面介绍的“2.6 Module2:js组件基类”,如果使用了基类的init方法,默认会自动加载同名的.html文件,也可以使用domutils.doGet("相对于vision的html完整路径")方式加载指定的.html或.template文件,例如var html = domutils.doGet("template/freequery/query/QueryView.template");
  • 操作和数据交互:使用util.remoteInvokeEx/remoteInvoke与服务端module实现数据交互,如果是希望与jsp/servlet交互,可以使用domutils中提供的doPost/doGet方法交互。很多时候写js组件时,可能都会有与服务端交互的场景,这时候也是需要编写自定义module的,然后在js组件中使用util.remoteInvokeEx/remoteInvoke调用这个module。

2、关键组件介绍

2.1、JSLoader:提供加载js的方法

Smartbi 内置了一个全局对象jsloader, 就是通过这个脚本对象提供的几个方法异步加载js,如果很多地方重复加载一个js,系统会自动缓存,只会从服务器请求一次。jsloader本质是使用gbk.jsp加载要能让jsloader正常加载到js,需要遵循:

  1. 所有js文件必须置于“vision/js/”目录或其子目录下。
  2. js文件名(不含后缀)及其所有父目录的文件名都不能包括“.”字符。
  3. 模块内必须定义一个与文件名同名的全局变量。

jsloader 中三个加载js方法说明见下文:

  • resolve(name, useGlobal):按需加载并执行
    参数说明:
    name:要加载的js名称,是相对于vision/js目录的完整路径名,譬如加载vision/js/freequery/lang/CustomEvent,就是"freequery.lang.CustomEvent"
    useGlobal:是否全局,缺省为false,如果为true,就等同于使用<script>标签加载

    resolve示例
     // 全局加载,等同于在index.jsp中使用<script>标签引用,被加载脚本中的全局对象可以直接使用
     jsloader.resolve('thirdparty.jquery.jquery', true);    
     
     // 局部加载,等同于局部变量,另外一些不能引用这个变量的地方需要的话又得重新resolve
     var util=jsloader.resolve("freequery.common.util");
     var CustomEvent = jsloader.resolve("freequery.lang.CustomEvent"); //返回的只是freequery.lang.CustomEvent类,还没有实例化
     
  •  resolveMany(names):批量加载但不执行 ,意思是批量从服务端请求js,减少与服务端沟通时间                                       
    参数说明
    names:要加载的js名称数组,是相对于vision/js目录的完整路径名,如['freequery.common.util','bof.baseajax.common.Application']

    resolveMany示例
    jsloader.resolveMany(['freequery.common.util','bof.baseajax.common.Application','freequery.widget.Module' ]);
     
    // 后面如果再想使用具体的类时:
    var util=jsloader.resolve("freequery.common.util"); //这个时候实际不会发起服务端请求的,只是会从缓存里面拿到脚本并eval执行
     
  • imports(className):仅声明待用到再加载与执行
    参数说明
    className:要加载的js名称,是相对于vision/js目录的完整路径名,譬如:"freequery.lang.CustomEvent"

    imports示例
     var util = jsloader.imports("freequery.common.util");
     // 用的使用需要调用getInstance()去实例化对应的对象,例如: util.getInstance().remoteInvokeEx(...)
     

2.2、domutils:工具类

工具类,提供判断浏览器版本、异步请求、给dom元素增加css类等工具类方法,详细可以查看smartbi.war/vision/js/freequery/lang/domutils.js,这里列出几个常用的方法:
  • doGet(url,notUseGBKJSP) :使用get方式请求
    参数说明:
    url: 要请求的url地址,如果是系统内部资源,是相对于vision的url,譬如:template/freequery/query/QueryView.template
    notUseGBKJSP: 是否使用gbk.jsp加载,默认为false,gbk.jsp是系统用于加载js,.template,.html文件的一个jsp

    doGet示例
    var template = domutils.doGet("template/freequery/query/QueryView.template");
    this.panel = document.createElement("div");
    this.panel.innerHTML = template;
     
  • doPost(url, data, callback, errorHandler, scope, headers):使用post方式请求
    参数说明:
    url: 如果是系统资源,相对于vision地址的url
    data: post的数据,譬如:"A=xx&B=yy"
    callback: 请求成功返回的回调函数,如果传递了此方法就是异步请求,否则同步请求
    errorHandler: 请求异常的回调函数,只有传递了callback参数时,此参数才生效
    scope: callback函数内部的this对象
    headers: 请求头信息,json对象,譬如{If-Modified-Since:0}

    doPost示例片段
        // 以下示例示意说明doPost的用法,并不能真的运行
        var url = "RMIServlet"; //请求的url
        var data = null; //传递的数据
        data = "className=" + encodeURIComponent(className) +
            "&methodName=" + encodeURIComponent(methodName) +
            "&params=" + encodeURIComponent(paramsStr);
     
        domutils.doPost(url, data, function(responseText) {
            var export2FtpUtil = jsloader.resolve("aladdin.utils.Export2FtpUtil");
            export2FtpUtil.showExportResult(responseText);
        }, function(xhr) {
            alert("导出失败!");
        }, this, null);
     
  • addClassName/removeClassName/hasClassName(elem,value):给dom元素添加或删除css样式类
    参数说明:
    elem: dom元素对象
    value: 样式类名

    if (domutils.hasClassName(elem, 'awesomplete')) {
         domutils.addClassName(elem, 'search-wrapper'); //domutils.removeClassName(elem, 'search-wrapper');
    }
  • isIE():是否是IE
    is+浏览器英文名代表判断是否xx浏览器的方法,例如isFirefox、isIE、isIE6、isIE11、isEdge、isChrome、isQQBrowser、isSafari、isOpera、isIE7、isIOS 、isAndroid、isMobile。

2.3、util:工具类

这个工具类最关键的一个功能是提供了客户端与服务端module直接沟通的方法,详细的方法可以查看smartbi.war/vision/js/freequery/common/util.js,这里只介绍几个关键方法:
  • remoteInvokeEx /remoteInvoke(className, methodName, paramArray, callback, that, headers) 
    与服务端module沟通方法,其中remoteInvokeEx如果同步请求出现异常会自动弹窗提示,参数说明:
    className:配置再applicationContext.xml中注册到rmi中的名称,譬如下面示例中就是ExtSample8Service
    methodName:要请求module中的哪个方法
    paramArray:上面方法接收的参数数组,数组中的第一个对应方法的第一个参数,依次类推
    callback:回调函数,请求返回执行,如果不传递此参数代表同步请求
    that:callback里的this对象
    headers:请求头信息,譬如:json对象,譬如{If-Modified-Since:0}

    可执行示例请见宏代码中执行sql语句

    module调用示例
    // 以下示例只是说明用法,实际缺少很多上下文环境,并不能运行
    // 同步请求方式
    var ret = util.remoteInvoke("DashboardService", "getParamValueFromDashboard", [this.clientId, paramId]);
    if (ret.succeeded) {
    	return ret.result;
    } else {
        modalWindow.showServerError(ret);
    }
     
    // 异步请求方式
    var ret = util.remoteInvoke("DashboardService", "getParamValueFromDashboard", [this.clientId, paramId], function(ret){
    	if(ret.succeeded){
    		var result = ret.result;  //getParamValueFromDashboard方法返回的结果,如果是服务端返回的是对象,这个就是个json对象
        }
    }, this);
  • getCookie(name)
    获取指定名称cookie值。
  • getSystemConfig(key)
    获取指定key的系统选项值。

2.4、lang:工具类

提供了类的继承方法、重写等功能。
  • extend (subclass, superclass) :类的继承

    继承示例
    var BaseDialogEx = jsloader.resolve("freequery.dialog.BaseDialogEx");
     
    var ExportResultDialog = function() {
        // 构造函数
    };
    lang.extend(ExportResultDialog, BaseDialogEx);
     
    ExportResultDialog.prototype.init = function(parent, data, fn, obj) {
        ExportResultDialog.superclass.init.call(this, parent, data, fn, obj);
        //BaseDialogEx.superclass.init.call(this, this.dialogBody, __url, true);
        var cookie = document.cookie;
        var cookieAry = cookie.split(';');
        var downloadSrcCookie;
        for (var i in cookieAry) {
            if (cookieAry[i].indexOf('download_src') != -1) {
                downloadSrcCookie = cookieAry[i];
                break;
            }
        }
        var info = "导出成功!";
        this.dialogBody.style.paddingTop = "30px";
        if (downloadSrcCookie) {
            var src = downloadSrcCookie.substring(downloadSrcCookie.indexOf('=') + 1);
            linkStr = '点击<a target="_blank" href="http:/ip:8080/secdoc/encrypt?file=' + src + '">此处</a>下载文件。';
            this.dialogBody.innerHTML = info + linkStr;
        } else {
            this.dialogBody.innerHTML = info;
        }
    }
     
    ExportResultDialog.prototype.destroy = function() {
        ExportResultDialog.superclass.destroy.call(this);
    }
  • parseJSON (jsonString) 
  • toJSONString(obj) 

    toJSONString和parseJSON调用示例
    jsloader.resolve("freequery.lang.lang");
    var testObj = {
    	name:"test",
    	age:"21"
    };
    var resultStr = lang.toJSONString(testObj);
    testObj = lang.parseJSON(resultStr);

2.5、CustomEvent:自定义事件

组件希望在某个点抛出事件,供外面调用组件的地方注册使用时,可以使用这个类,例如电子表格刷新完成抛出onAfterRefresh事件 :

 

CustomEvent应用示例
var util = jsloader.resolve('freequery.common.util');
var CustomEvent = resolve("freequery.lang.CustomEvent");
 
var SpreadsheetReport = function(container) {
	SpreadsheetReport.superclass.constructor.call(this, container);
	//组件中定义事件方法
	this.onAfterRefresh = new CustomEvent("AfterRefresh", this); 
	//触发事件方法:
    //this.onAfterRefresh.fire(this); //其中参数可以任意多个
    //注册事件方法
    //this.onAfterRefresh.subscribe(this.doParamChangeRefresh, this);
    //取消注册事件
    //this.onAfterRefresh.unsubscribe(this.doParamChangeRefresh, this);
}
lang.extend(SpreadsheetReport, "freequery.widget.Module2");
 
SpreadsheetReport.prototype.doParamChangeRefresh = function() {
	this.onAfterRefresh.unsubscribe(this.doParamChangeRefresh, this);
	this.doParamChangeNeedRefresh = false;
	var that = this;
	setTimeout(function() {
		//xx
	}, 1);
}

2.6、Module2:js组件基类

完整名称:freequery.widget.Module2,可以是所有业务逻辑组件的基类,一般情况,编写界面是同名js文件和html文件配套,前者是组件业务逻辑,一般会继承freequery.widget.Module2,后者是布局文件,Module2内置了如下逻辑:

     1)使用其中的addListener和removeListener方法给dom元素注册事件。

     2)使用其中的init方法,实现了界面逻辑和界面布局的分离,界面布局可以是与组件js文件同目录及同名的.html,这样系统会自动加载布局文件,同时会给布局html文件中定义了bofid的元素自动执行以下操作。

    • 定义了bofid的dom元素,可以在js组件中通过this.elem+bofid,其中首字母大写引用,譬如:<span bofid=“testSpan” />,则this.elemTestSpan可以引用该元素
    • js组件可以使用以下方法给元素添加事件:elem + bofid,其中首字母大写 + 事件名称+_handler,如果在组件中添加这类规则的方法,系统会自动给对应元素加上对应鼠标事件,譬如elemTestSpan_click_handler,就是给bofid为testSpan的元素添加click事件

     3)destroy方法,注销组件。

 

完整的示例见下面的2.7、BaseDialogEx:对话框组件基类

 

方法参数及示例说明
/**
 * 为一个DOM对象添加事件, 供子类调用
 * 示例:this.addListener(this.elem_btnQuery , "click", this.refreshData , this);
 * @modifier final, protected
 * @param element
 *            一个DOM对象
 * @param type
 *            待绑定的事件类型, 如'click', 'mouseup'. 注意: 不要加'on'前缀
 * @param handler
 *            处理函数
 * @param that
 *            [可选] 处理函数中this所指的对象
 * @param group
 *            [可选] 很少用到. 用于对"事件绑定"分组, 便于按组解除绑定. 见removeListenersByGroup()
 * @return void
 */
Module2.prototype.addListener = function(element, type, handler, that, group) {}

/**
 * 解除对一个DOM对象的事件绑定, 供子类调用
 * 示例:this.removeListener(this.elem_btnQuery,"click",this.refreshData);
 * @modifier final, protected
 * @param element
 *            一个DOM对象
 * @param type
 *            待绑定的事件类型, 如'click', 'mouseup'. 注意: 不要加'on'前缀
 * @param handler
 *            处理函数
 * @param that
 *            [可选] 处理函数中this所指的对象
 * @param group
 *            [可选] 绑定时给出的组名. 见addListener()
 * @return void
 */
Module2.prototype.removeListener = function(element, type, handler, that, group) {}

/**
 * @param container  父容器dom对象
 * @param url html模板路径或内容,传递__url 代表与当前js组件同目录同名的html文件
 * @param noWrapper  是否创建一个父容器,true or false,缺省是false, 意思是直接用第一个参数container作为第二个参数html内容的父容器,如果为true,会再创建一个父容器包装第二个参数HTML,最后再赋给第一个参数container
 * @param noDoGet 这个是说是否需要请求html内容, true代表不用请求,也就是第二个参数传递的是html内容,false代表需要,就是第二个参数传递的是html模板路径
 */
Module2.prototype.init = function(container, url, noWrapper, noDoGet) {}

 

2.7、BaseDialogEx:对话框组件基类

freequery.dialog.BaseDialogEx继承了freequery.widget.Module2,对话框内容组件基类,主要方法:
  • init(parent,data,fn,obj,win):初始化方法
    参数说明:
    parent:窗口内容的父容器
    data:调用弹窗时传递给弹窗的数据
    fn:可选参数,窗口关闭后回调函数
    obj:可选参数,上面fn回调函数的this对象
    win:可选参数,源窗口
  • destroy():注销方法

对话框内容组件需要配合dialogFactory.showDialog()配合使用,下面是其定义:

dialogFactory.showDialog定义
	/**
	 * 该方法显示一个对话框
	 * 
	 * @param dlgConf
	 *            对话框配置对象
	 *            {fullName,size[option],width[option],height[option],resizable[option],title[option],dialogType[option]}
	 *            fullName: 必须项,对话框的全名,例如freequery.dialog.OpenSaveDialog <br>
	 *            size: 可选项,对话框尺寸(指定该项将会忽略width和height) <br>
	 *            width: 可选项,对话框宽度 <br>
	 *            height: 可选项,对话框高度 <br>
	 *            resizable: 可选项,对话框大小是否可变, 合法值 'yes', 'no' <br>
	 *            title: 可选项,对话框标题 <br>
	 *            dialogType: 可选项,对话框模态,缺省值'modal', 合法值 'modal', 'modeless' <br>
	 * @param params
	 *            参数数组,对应对话框组件对象init方法的data参数
	 * @param fn
	 *            回调函数,对应对话框组件对象init方法的fn参数
	 * @param obj
	 *            回调函数内部的this对象
	 * @param opts
	 *            扩展配置,eg: {success:function(){}}
	 */
	showDialog : function(dlgConf, params, fn, obj, opts) {}

下面是系统中点击关于的弹窗实现,AboutDialog.js是关于js组件,其布局内容是AboutDialog.html,二者通过AboutDialog.js:BaseDialogEx.superclass.init.call(this, this.dialogBody, __url, true)组合在一起。

AboutDialog.js
var BaseDialogEx = jsloader.resolve("freequery.dialog.BaseDialogEx");
var domutils = jsloader.resolve("freequery.lang.domutils");
var util = jsloader.resolve("freequery.common.util");
var PagePanel = jsloader.resolve("freequery.control.PagePanel");
var Configuration = jsloader.resolve("Configuration");
 
var AboutDialog = function() {
};
lang.extend(AboutDialog, BaseDialogEx);
 
AboutDialog.prototype.init = function(parent, data, fn, obj) {
	AboutDialog.superclass.init.call(this, parent, data, fn, obj);
	BaseDialogEx.superclass.init.call(this, this.dialogBody, __url, true);
	this.dialogBody.style.border = 'none';
	this.dialogBody.style.backgroundColor = 'transparent';
	document.body.style.overflow = "";
	var companyName = data[0];
	var webAddress = data[1];
	var mailAddr = data[2];
	this.parentWindow = data[3]
	this.setButtonVisible("BTNCANCEL", false);
	this.lblCompanyName = domutils.findElementByClassName(this.parent, "_companyname");
	if (companyName)
		this.lblCompanyName.innerHTML = companyName;
	this.lblWebAddress = domutils.findElementByClassName(this.parent, "_webaddress");
	if (webAddress) {
		this.lblWebAddress.innerHTML = webAddress;
		this.lblWebAddress.href = webAddress;
	}
	if (mailAddr) {
		this.elemMailto.href = mailAddr;
	}
	this.buildDate = domutils.findElementByClassName(this.parent, "_buildDate");
	if (Configuration.isSpreadsheetEdition || Configuration.isXQueryEdition) {
		var trBuild = this.buildDate.parentNode.parentNode;
		var tbody = trBuild.parentNode;
		var trEdition = tbody.insertRow(trBuild.rowIndex);
		var tdEdition = trEdition.insertCell(-1);
		tdEdition.style.height = '20px';
		tdEdition.style.textAlign = 'center';
		var name = Configuration.isSpreadsheetEdition ? 'Spreadsheet' : 'xQuery';
		var text = 'Smartbi ' + name + ' Edition'
		tdEdition.innerText = text;
	}
	this.warBuildDate = domutils.doGet("version.txt");
	if (this.warBuildDate.indexOf("HTTP Status 404") >= 0) {
		this.warBuildDate = "${Mayisthedevelopmentversion}";
	}
	this.warPackageInfo = domutils.doGet("packageinfo.txt");
	this.warSourceVersion = "";
	this.warSourceTag = "";
	if (this.warPackageInfo.indexOf("HTTP Status 404") == -1) {
		var versionInfo = /\b(Version:.+)(\n|\r)/.exec(this.warPackageInfo);
		if (versionInfo != null) {
			this.warSourceVersion = versionInfo[0];
		}
		var tagInfo = /\b(TAG:.+)(\n|\r)/.exec(this.warPackageInfo);
		if (tagInfo != null) {
			this.warSourceTag = tagInfo[0];
		}
	}
	this.buildDate.innerHTML = this.warBuildDate + "<br />" + this.warSourceVersion + "<br />"
			+ this.warSourceTag;
	this.initTab();
}
 
AboutDialog.prototype.destroy = function() {
	if (this.aboutTab) {
		this.aboutTab.destroy();
	}
	if (this.licenseInfoTab) {
		this.licenseInfoTab.destroy();
	}
	if (this.javaInfoTab) {
		this.javaInfoTab.destroy();
	}
	if (this.pagecontrol) {
		this.pagecontrol.destroy();
	}
	AboutDialog.superclass.destroy.call(this);
}
 
AboutDialog.prototype.initTab = function() {
	this.initLicenseInfo(this.elemLicenseInfoDiv);
	this.initJavaInfo(this.elemJavaInfoDiv);
	this.pagecontrol = new PagePanel(this.elemTabPanel);
	this.pagecontrol.contentBanner.style.backgroundColor = '#fff';
	this.aboutTab = this.pagecontrol.appendTab();
	this.aboutTab.setCaption("${About}");
	this.licenseInfoTab = this.pagecontrol.appendTab();
	this.licenseInfoTab.setCaption("License");
	this.javaInfoTab = this.pagecontrol.appendTab();
	this.javaInfoTab.setCaption("Java");
	this.aboutTab.appendItem(this.elemAboutDiv);
	if (this.aboutTab.itemParent) {
		this.aboutTab.itemParent.style.verticalAlign = 'middle';
	}
	this.licenseInfoTab.appendItem(this.elemLicenseInfoDiv);
	this.javaInfoTab.appendItem(this.elemJavaInfoDiv);
	this.pagecontrol.tabs[0].setActive();
	this.pagecontrol.autoFitResize();
}
 
AboutDialog.prototype.initLicenseInfo = function(elem) {
	var func = function(ret) {
		if (ret && ret.succeeded && ret.result) {
			var result = ret.result;
			if (result.hasLicense) {
				var html = [ '<table style="table-layout: fixed;" cellPadding="0" cellSpacing="0">' ];
				html.push('<col style="width:45%" /><col style="width:55%" />');
				html.push("<tr><td>${License.Type}${Colon}</td><td>"
						+ (result.type == 'evaluation' ? "${License.Evaluation}"
								: "${License.Formal}") + "</td></tr>");
				html.push("<tr><td>${License.Licensee}${Colon}</td><td>" + result.licensee + "</td></tr>");
				html.push("<tr><td>${License.Expiration}${Colon}</td><td>" + result.expiration
						+ "</td></tr>");
				html.push("<tr><td>${License.AuthorizedUsersCount}${Colon}</td><td>"
						+ this.parseCount(result.authorizedUsers) + "</td></tr>");
				html.push("<tr><td>${License.SessionCount}${Colon}</td><td>"
						+ this.parseCount(result.sessionCount) + "</td></tr>");
				html.push("<tr><td>${License.ReportCount}${Colon}</td><td>"
						+ this.parseCount(result.reportCount) + "</td></tr>");
				html.push("<tr><td>${License.MobileCount}${Colon}</td><td>"
						+ this.parseCount(result.mobile) + "</td></tr>");
				html.push("</table>");
				elem.innerHTML = html.join('');
				this.elemLicenseto.innerHTML = "${Licenseto} " + result.licensee;
			} else {
				elem.innerHTML("${License.NoLicense}");
			}
		}
	};
	util.remoteInvoke("CommonService", "getLicenseInfo", [], func, this);
}
 
AboutDialog.prototype.parseCount = function(count) {
	return (count == -1) ? "${License.Unlimited }" : count;
}
 
AboutDialog.prototype.initJavaInfo = function(elem) {
	var func = function(ret) {
		if (ret && ret.succeeded && ret.result) {
			var result = ret.result;
			var html = [];
			html.push('<div class="wrapper-outer"><div class="wrapper-inner">');
			html.push('<table style="empty-cells: show; width:100%; height:100%; table-layout: fixed;" cellPadding="0" cellSpacing="0">');
			html.push('<col style="width:35%" /><col />');
			var tdStyle = ' style="word-break: break-all; word-wrap:break-word;" ';
			for (var i = 0, len = result.length; i < len; i++) {
				var row = result[i];
				html.push('<tr><td ' + tdStyle + '>' + row[0] + '</td><td ' + tdStyle + '>'
						+ row[1] + '</td></tr>');
			}
			html.push('</table>');
			html.push('</div></div>');
			elem.innerHTML = html.join('');
		}
	};
	util.remoteInvoke("CommonService", "getSystemProperties", [], func);
}
 
AboutDialog.prototype.elemProductWeb_click_handler = function(e) {
	domutils.stopEvent(e);
	this.parentWindow.open(this.lblWebAddress.href || this.lblWebAddress.getAttribute("href"));
};
 
AboutDialog.prototype.elemReleaseNotes_click_handler = function(e) {
	domutils.stopEvent(e);
	this.parentWindow.open(this.elemReleaseNotes.href || this.elemReleaseNotes.getAttribute("href"));
};
 
AboutDialog.prototype.elemSupportWeb_click_handler = function() {
};
 
AboutDialog.prototype.elemCompareName_click_handler = function(e) {
	domutils.stopEvent(e);
	this.parentWindow.open(this.lblWebAddress.href || this.lblWebAddress.getAttribute("href"));
};
AboutDialog.html
<div align="center" style="width:100%; height:100%; line-height:22px;">
	<div bofid="tabPanel" class="_tabPanel" style="height:100%;width:100%;"></div>
	<table bofid="aboutDiv" class="_list_log_div tab-content system_color_white " style="overflow:auto;" width="100%" border="0">
	  <tr>
	    <td width="100%" valign="top">
	      <table width="100%" border="0" cellspacing="0" cellpadding="0" align="center">
	        <tr>
	          <td height="73px" align="center" style="background:url(img/about/logo${ImageSuffix}.png) no-repeat center center;"></td>
	        </tr>
	        <tr>
	          <td height="20" align="center">
	            <span bofid="licenseto"></span>
	          </td>
	        </tr>
	        <tr>
	          <td height="20" align="center">
	            <span>Build:&nbsp;</span><span class="_buildDate">2008-10-31</span>
	          </td>
	        </tr>
	        <tr>
	          <td height="20" align="center">
	            <span class="_companyname">${Smartbi}</span>&nbsp;
	          </td>
	        </tr>
	        <tr>
	        	<td height="20" align="center">
	        		<a class="_webaddress link-item" bofid="compareName" target="_blank" href="http://www.smartbi.com.cn">http://www.smartbi.com.cn</a>
	        	</td>
	        </tr>
	        <tr>
	          <td height="20" align="center">
	            <a class="link-item2" bofid="productWeb" target="_blank" href="http://www.smartbi.com.cn">${ProductWebsite}</a>&nbsp;
	            <a class="link-item2" bofid="releaseNotes" target="_blank" href="http://wiki.smartbi.com.cn/pages/viewpage.action?pageId=17956904">${ReleaseNotes}</a>&nbsp;
				<a class="link-item2" bofid="mailto" href="mailto:support@smartbi.com.cn">${Contactus}</a>
	          </td>
	        </tr>
	      </table>
	    </td>
	    <td>
	      <table width="100%" border="0" >
	        
	      </table>
	    </td>
	  </tr>
	</table>
	<div bofid="licenseInfoDiv" class="editblock _list_run_div tab-content system_color_white " style="overflow:auto; height:100%;width:100% "/>
	<div bofid="javaInfoDiv" class="editblock _list_run_div tab-content system_color_white " style="overflow:auto; height:100%; width:100% "/>
</div>

显示对话框方法:

显示AboutDialog
BannerView.prototype.showAbout = function() {
	var data = [ registry.get('CompanyName'), registry.get('WebAddress'), registry.get('MailAddr'), window ];
	var dialogConfig = {
		title : '${About} Smartbi',
		size : DialogFactory.getInstance().size.MIDDLE,
		fullName : 'freequery.main.AboutDialog'
	};
	DialogFactory.getInstance().showDialog(dialogConfig, data);  //因为关于窗口关闭时不用执行任何逻辑,所以不用传递第三第四个参数
};

3、如何调试定位

接到需求,如果判断产品不支持需要定制,首先得判断是在哪里插入什么功能,前面介绍过,系统是以js业务逻辑组件方式按需加载的,那理论需要在哪里插入对应功能,就需要先找到源功能对应的js组件,下面从几个常用场景说明如何调试定位修改。

  • 如果要调试smartbi,最好在url中增加debug=true参数(例如http://192.168.1.10:16000/smartbi/vision/index.jsp?debug=true),否则前后端交互是加密了的。
  • 说明调试定位之前,请选好一个前端调试工具,现在各浏览器实际都自带了调试工具,网上搜索:IE 开发者工具、Chrome 开发者工具、 火狐开发者工具等等,都会有大量的教程,各开发者工具的使用都大同小异,下文的截图都是以chrome 开发者工具为例(打开方式有两种:第一“按F12”,第二:ctrl+shift+i)。

3.1、更改样式、图片之类

如果用户需求是:我要把xx地方的文字颜色改为xx,我要把这个图片替换下,因为扩展包中提供了更改样式和替换图片方法,具体请见替换Smartbi文件,那是如何找到对应的样式或图片,从而进行修改的呢?

1)、样式查找方法

替换Smartbi文件中修改即席查询报表工具栏中的刷新图标为例子,使用浏览器开发者工具的审查元素,找到刷新按钮使用的样式为:queryview-toolbar-refresh

有时候一个样式控制,譬如颜色,也许是其父元素的样式继承下来的,您需要确定是哪个样式起作用,这时可以在开发者工具右侧styles视图启用、删除或增加样式确认的,确认好了以后再在样式文件中修改。

 

2)、图片查找方法

图片查找方法和样式查找方法类似,主要确认使用的是哪个图片,那遇到类似上面图片因为比较小,会被转成base64返回,压根不知道是哪个路径怎么办呢?

这时候,您可以点击上图中样式旁边的  bof_merge.css.jsp:1095(点开后效果见下图),这个意思是queryview-toolbar-refresh样式在bof_merge.css.jsp中的1095行,上文说过系统中的css都是通过这个jsp合并一起返回的,但是他会在合并文件前都会注明这段css存于哪个文件(譬如:/** /vision/css/base.css */),搜索css,只要找到1095行之前的css文件标记,就知道存在于哪个css文件,然后取到war包中找到对应css文件,搜索对应样式就知道图片存于哪个目录然后替换。

当然还有更简单粗暴的方法,直接在war包中全文搜索对应的样式(仅搜索*.css文件即可)。

3.2、更改js组件之类

如果要更改现有js组件的内容、逻辑、布局或布局上文字,那就需要找到对应的js组件,找到对应js之后就可以参考如何修改Smartbi JS文件修改,主要有以下几种定位方式:

  • 方法一:smartbi系统内提供了一些调试快捷键建议一定看下
  • 方法二:使用charles或开发者工具中的网络功能监控网络请求,根据请求js名称或html布局文件名称猜测,这里介绍使用chrome 开发者工具调试方法。

上文提过,smartbi是按需加载js组件的,且每个组件基本都会有对应的同名html或.template文件,并且命名都有规范,具有相应功能意义,那实际要看功能对应的js组件是哪个,只要在加载那个功能之前,监控网络请求,基本就能定位到对应的js组件。

譬如想查找业务主题编辑界面对应的js组件,那就可以打开chrome 开发者工具,切换到网络,在打开一个业务主题之前清空网络内容,然后再打开一个业务主题,从请求信息中就能大概猜出是哪个js(有时因为某个js组件太常用会事先加载网路请求中也许找不到(但布局html文件基本一定是要渲染时才加载的),这时可能需要依赖相应的布局html文件名猜测对应的js组件):

 

  • 方法三:类似想知道点击了某个按钮,会执行什么操作之类,利用chrome开发者工具中事件断点(在网页上发生鼠标交互其会断下来的原理)。

单步调试进去,这里需要看懂系统中EventAgent的原理,否则单步调试您可能会碰到困难,这里上两张图:

调试找到对应的代码后,回看堆栈:

 

  • 方法四:前面三种方式都不好找时,还有个笨办法,就是上面说的,系统很多元素都会命名一个bofid、class,这个bofid或class的名称有时都是有意义的,先使用上面查找css的方法查找到对应的bofid或class,再全文搜索(只需搜索.html或.template文件)

3.3、更改js组件布局(html)

有时希望在某个界面添加或删除一个属性,这时可能涉及到修改界面,查找界面对应html和上文的更改js组件之类类似,而且通常更改了布局相应也会修改对应的js,只是布局修改方式通常都是找到对应.html或.template,然后扩展包中同目录下放同名文件即可替换,不过如果改动比较少,这种方式也尽量少用,因为涉及到升级风险(升级了新产品,新产品布局或许已发生变化,结果因为扩展包优先,升后还是用扩展包的),所以能用js代码动态添加dom元素的也可以考虑。

回到一开始的问题,本文相应的都给了一些答案,这里还没有怎么介绍到扩展包的其他功能,仅作为接触扩展包开发后需要了解的一些基础信息,辅助解决项目特定需求问题。


  • No labels