1. 创建项目工程

使用Eclipse 开发工具，通过"File -> New -> project…"创建一个扩展插件项目工程，该项目的目录结构如下：
Smartbi V6 帮助中心 > 第一课：扩展插件开发基础（内含目录及配置文件介绍） > worddav956b25eed7921322547c71d4878d6bd8.png

相关目录及文件说明如下：

web目录，是扩展插件的根目录。
META-INF目录，是扩展插件的配置文件和相关的类存放位置。
- classes：包含扩展插件中类文件编译后的class文件（可选）。
- lib目录：扩展插件引用到的类库。Smartbi已经包括的类库，不应该放在此目录中（可选）。
- applicationContext.xml：扩展插件Spring配置文件（可选）。
- extension.xml：扩展插件配置文件（必选）。
vision目录，是前端文件存放位置。
- img目录：资源图片存放目录（可选）。
- js目录：javascript前端文件存放目录（可选）。
- js\ext\ConfigurationPatch.js：前端配置文件，多个扩展插件会自动合并（可选）。

说明：vision目录中，同路径下的同名文件会替换Smartbi相关文件，因此定制开发的文件一般放到ext目录中。

文档目录：

2. 配置扩展插件

2.1 插件声明文件extension.xml（必要）

extension.xml文件是扩展插件的必要声明文件，存放于META-INF目录中。
Smartbi V6 帮助中心 > 第一课：扩展插件开发基础（内含目录及配置文件介绍） > worddav46bdbb840497c27b89082a8019946957.png
基本要素：

属性	描述	可选与否
name	扩展插件的名称。	必选
alias	扩展插件的别名。	必选
desc	扩展插件的描述。	必选
version	扩展插件的版本号。	必选
priority	扩展插件的优先级，默认100。值越小，优先级越高。	可选
enable-jsp-processor	支持在扩展插件中使用JSP文件。	可选
file-encoding	声明扩展插件中js、html等文件的编码，默认为UTF-8。	可选
servlet	声明扩展插件中的Servlet对象，请参考web.xml中的结构。	可选
servlet-mapping	声明Servlet的映射，请参考web.xml中的结构。	可选

<?xml version="1.0" encoding="GBK"?>
<extension name="KingbaseSmartbiExtension" alias="KingbaseSmartbiExtension" desc=" SmartbiExtension Samples" version="1.0">
     <enable-jsp-processor/>
     <file-encoding>GBK</file-encoding>
	<!--servlet定义和servlet-mapping可选-->
	<servlet>
		<servlet-name> TestServlet </servlet-name> 
		<servlet-class>bof.extension.test.TestServlet</servlet-class> 
		<init-param>
			<param-name>x</param-name> 
			<param-value>xv</param-value> 
		</init-param>
		<init-param>
			<param-name>y</param-name> 
			<param-value>yv</param-value> 
		</init-param>
		<!--启动该servlet的优先级-->
		<load-on-startup>1</load-on-startup> 
	</servlet>
	<servlet-mapping>
		<servlet-name> TestServlet </servlet-name> 
		<url-pattern>/TestServlet</url-pattern> 
	</servlet-mapping>
</extension>

2.2 Spring声明文件applicationContext.xml（可选）

applicationContext.xml文件是扩展插件中的Spring声明文件，存放于META-INF目录中。
Smartbi V6 帮助中心 > 第一课：扩展插件开发基础（内含目录及配置文件介绍） > worddav3fe3e265c4ea1e7a0abd861729229d8d.png
该文件是可选的。在java代码中调用服务器端SDK提供的接口时不需要本文件；仅当需要在扩展插件中使用Smartbi内部模块的方法，或将新增模块注册到Framework和RMIModule中时，才需要定义此文件。

应用说明：

Smartbi使用Spring加载服务器上的组件，因此当扩展插件需要使用到Smartbi原有功能时必须也使用Spring进行组件加载。
在Smartbi启动过程中会自动加载smartbi.war\WEB-INF\applicationContext.xml初始化内置组件，然后再按扩展插件顺序加载扩展插件中的applicationContext.xml。
在扩展插件中的applicationContext.xml可以直接引用Smartbi内置的对象，只需要通过相应的id引用就可以，例如下面示例中testExt可以直接引用dao而无需再声明daoModule。

Smartbi常用内置的对象说明如下：

ID	描述
dao	处理数据库相关操作。
state	处理会话操作。
catalogtree	处理资源树操作。
usermanager	处理用户管理操作。
rmi	声明前端请求对应的模块。
framework	处理模块的升级和激活POJO对象。

当需要在framework或者rmi模块中注册时，需要再次声明相应的组件。向rmi和framework注册testExt组件时，需要再次声明rmi和framework组件并添加到相应的属性中，Smartbi会自动合并内置对象中的List或Map属性。上述示例将testExt组件添加到rmi和framework原有List和Map中。

<?xml version="1.0" encoding="UTF-8" ?> 
<beans>
	<bean id="framework" class="bof.framework.Framework" factory-method="getInstance">
		<property name="modules">
			<map>
				<entry>
					<key>
						<value>TestExt</value> 
					</key>
					<ref bean="testExt" /> 
				</entry>
			</map>
		</property>
	</bean>
	<bean id="rmi" class="bof.framework.rmi.RMIModule" factory-method="getInstance">
		<property name="modules">
			<map>
				<entry>
					<key>
						<value>TestExt</value> 
					</key>
					<ref bean="testExt" /> 
				</entry>
			</map>
		</property>
	</bean>
	<bean id="testExt" class="bof.extension.test.TestExtensionModule" factory-method="getInstance" > 
		<property name="daoModule">
			<ref bean="dao" /> 
		</property>
	</bean>
</beans>

2.3 扩展点配置文件ConfigurationPatch.js（可选）

ConfigurationPatch.js存放于扩展插件中的vision\js\ext目录中。
Smartbi V6 帮助中心 > 第一课：扩展插件开发基础（内含目录及配置文件介绍） > worddav9b09fe08c43cdf5380e03489388a4ae3.png
该文件是扩展插件中前端JS扩展点配置文件。可以通过对此文件的配置，把扩展功能添加到相应的扩展点中；也可以对照Smartbi前端界面做一些相应的调整。
ConfigurationPatch.js包含两个属性，分别是extensionPoints、patches的属性：

extensionPoints是客户端扩展点内容的定义，客户端会根据扩展点内容的声明作出相应的处理，Smartbi会自动合并原有Configuration.js和所有扩展插件中的声明。extensionPoints对象支持以下常用属性：
属性
用途
MainFrame
可以在MainFrame.actions下添加一级菜单模块。
Custom、Manager等
在相应一级模块下添加二级模块、任务面板操作入口。
CatalogTree
添加右键菜单。

Patches提供了更丰富的属性定义，并且可以对extensionPoints中原有定义的属性进行修改。比如修改Smartbi原有扩展点内容，或在指定位置插入新的扩展点。每个Patch对象包含以下属性：

属性	描述
path	表示该path要修改的Configuration.js中的对象路径。
key	需要替换的键值，可以为数字或者字符串，当operation为appendObject时忽略此项。 0和正数：比如0，代表从左到右第一个键值负数：比如-1，代表从右到左第一个键值
operation	path的动作，共有以下几种： replace：替换原来的值。 append：添加到原有数组中，value可以为数组或对象。 appendObject：添加到原有对象中，value为是对象。 insert：插入原有数组中。 remove：删除原有对象中的值。
value	修改后的值，当operation为remove时忽略此项

extensionPoints、Patches均为数组，可以定义多个扩展点对象。

说明
Smartbi可供扩展的所有扩展点请参阅"系统扩展点"。

var ConfigurationPatch = {
	/*调整前端界面：移除一级模块中的定制模块*/
patches: [
		{
			path: "/extensionPoints/Custom/actions",
			key: 6,
			operation: "remove"
		}
	],
	extensionPoints : {
		/*添加一级模块：在一级模块未尾添加二个模块入口 */
MainFrame : {
			actions : [
				{
					className :"ext.b.FibonacciAction",
					groupId :"default"	
				},
				{
					className :"ext.b.NumberSeriesAction",
					groupId :"default"	
				}
			]
		},
        /*添加二级模块：在定制模块的二级模块未尾添加一个模块入口 */
		Custom: {
			actions: [
				{
					className :"ext.b.FibonacciAction",
					groupId :"default"	
				}
			],
             /*添加任务入口：在数据集定义任务面板中添加一个操作入口 */
			DatasetTaskPanel : {
				config: {
					handlers:[
						{className:"ext.Custom.CustomTaskPanel"}
					]
				}
			}
		},
         /*编辑菜单项：对"定制"->"展现定制"中资源树的右键菜单项进行编辑 */
		CatalogTree: {
	displayCustomHandler:[{className : "ext.b.DisplayCustom_TreePopupMenuHandler"}]
		}
	}
};

2.4 自定义Portlet声明文件portlet.xml（可选）

portlet.xml文件是扩展插件中的自定义portlet声明文件，存放于META-INF目录中。

Smartbi V6 帮助中心 > 第一课：扩展插件开发基础（内含目录及配置文件介绍） > worddav5aa0b51ac65bd65fbecb09d3c3fbea48.png
Smartbi本身提供web链接、灵活分析、仪表分析、地图分析、多维分析、复杂报表、指标报表、目录等多种portlet资源。自定义 portlet用于实现产品未支持的资源类型，它必须满足Portlet和PortletEdit的接口规范。

自定义Portlet基本要素：

属性	描述
Title	portlet的默认标题。
Icon	portlet在资源树节点上显示的图标,图标文件放在src/web/img/catalogtree目录下。
portlet-name	portlet名称，portlet的标识。
display-name	portlet显示名称，添加portlet时界面上显示的名称。
description	portlet描述信息。
is-bof-tree-node	是否是资源树上的节点对象。
portlet-viewer-js-class	展示界面对应的文件。
portlet-editor-js-class	编辑界面对应的文件。

<?xml version="1.0" encoding="UTF-8" ?>
<portlet-app>
	<portlet title="HelloWorld" icon="HelloWorld.gif">
        <portlet-name>HelloWorld</portlet-name>
        <display-name>HelloWorld</display-name>
        <description>HelloWorld</description>
   		<is-bof-tree-node>false </is-bof-tree-node>	
		<portlet-viewer-js-class>csdc.HelloWorldPortlet</portlet-viewer-js-class>
		<portlet-editor-js-class>csdc.HelloWorldPortletEdit</portlet-editor-js-class> 
	</portlet>
 </portlet-app>

3. 打包扩展插件

使用jar命令将扩展插件打包，以ext为扩展名。
操作步骤如下：

启动命令行提示符cmd；
通过cd命令进入到项目所在的src\web目录，例如：D:\HelloDemo\src\web\；
输入命令：c:\ jdk1.5.0_01\bin\jar.exe cvf HelloDemo.ext .
回车后，即将HelloDemo\src\web目录下的所有内容打包进HelloDemo.ext文件。

Smartbi V6 帮助中心 > 第一课：扩展插件开发基础（内含目录及配置文件介绍） > worddav97e88744c653f7053a1630188dca5ef7.png

4. 加载扩展插件

4.1 通过配置界面对扩展插件进行加载

加载单个插件：

启动Smartbi应用服务。
访问http://ip:host/smartbi/config页面。
设置扩展插件存放路径。如：D:\ Smartbi\Extensions。
保存设置。
重新启动Smartbi应用服务器。

加载多个插件：
为了能够同时加载多个扩展插件，把sample1.ext、sample2.ext和sample3三个扩展插件存放在D:\ Smartbi\Extensions目录中。在config页面，设置扩展包存放路径为：D:\ Smartbi\Extensions。
Smartbi V6 帮助中心 > 第一课：扩展插件开发基础（内含目录及配置文件介绍） > worddav55a71d00e3aa8bc7022691328d93a268.png
说明：

一般情况下建议将扩展插件打包为*.ext文件，但系统也支持直接将开发的扩展插件src\web目录直接拷贝到扩展包的加载目录，这样该扩展插件也能被加载。如上图所示，sample1和sample2分别打包为 ext 文件了，而sample3则直接拷贝的src\web目录，这三个扩展包都会被正确加载。
扩展插件加载顺序参看常见问题：扩展插件的加载策略是什么。

4.2 通过修改extensions.list文件对扩展插件进行加载

通过修改smartbi.war/WEB-INF/extensions/extensions.list文件，对扩展插件进行加载。文件中的每一行为一个扩展插件路径的声明。如图所示：
Smartbi V6 帮助中心 > 第一课：扩展插件开发基础（内含目录及配置文件介绍） > worddav4e73e99426bbf19d3f910a7b51f6e28e.png
说明：

扩展插件加载顺序参看常见问题：扩展插件的加载策略是什么。

4.3 列出已加载扩展插件

登录Smartbi，通过【定制管理】-【系统运维】-【调试工具集】-【列出已加载扩展插件】，查看所部署的扩展插件是否已正确加载。

属性	用途
MainFrame	可以在MainFrame.actions下添加一级菜单模块。
Custom、Manager等	在相应一级模块下添加二级模块、任务面板操作入口。
CatalogTree	添加右键菜单。