DEP扩展脚本编写指南

动态扩展平台扩展脚本编写指南EAS产品部技术架构部贺召军

导读

阐述基于动态扩展平台DEP开发的扩展脚本编写指南和相关注意事项，通过本规范指导开发工作。

适用读者

实施人员、现场二次开发人员、研发中心客户化开发人员。

适用范围

金蝶 EASV7.0SP1。

简介 (4)

指定作用域 (4)

变量 (5)

函数 (5)

使用扩展脚本 (6)

第一章上下文 (6)

1.1插件上下文（pluginCtx） (6)

1.1.1获取服务端上下文 (7)

1.1.2获取客户端上下文 (8)

1.1.3获取界面控件 (8)

1.2方法上下文（methodCtx） (9)

1.2.1获取方法参数 (9)

1.2.2获取方法返回值 (9)

1.2.3设置方法返回值 (9)

1.2.4方法上下文常用方法 (9)

1.3快速插入上下文脚本 (10)

第二章调用业务方法 (10)

2.1调用方式 (11)

2.1.1客户端调用业务方法方式 (12)

2.1.2服务器端调用业务方法方式 (14)

2.2快速插入业务方法调用 (14)

第三章自定义异常 (15)

3.1定义自定义异常 (15)

3.2脚本中调用自定义异常 (15)

3.2.1服务器端调用异常方式 (15)

3.2.2客户端异常调用方式 (16)

3.3快速插入自定义异常调用 (16)

第四章自定义基础资料或单据 (17)

4.1 获取自定义基础资料和单据远程接口 (17)

4.2 传入参数 (18)

4.3 返回值类型 (19)

4.4 示例脚本 (20)

第五章给常用控件添加事件 (21)

5.1 F7 (21)

5.2 CheckBox (22)

5.3 ComboBox (22)

5.4 Button (22)

5.5 TextFiled (22)

5.6 Tree (24)

5.7 TabledPane (24)

5.8 Table (24)

第六章使用函数库 (25)

6.1 定义函数库 (25)

6.2 使用函数库 (27)

第七章打点提示——快速编写脚本 (28)

7.1环境准备 (28)

7.2使用打点提示 (30)

第八章调试脚本 (30)

8.1 调试准备 (30)

8.1.1 客户端调试 (30)

8.1.2服务器端调试 (31)

8.2 进行调试 (32)

8.2.1 变量查看 (33)

8.2.2 使用脚本控制台 (33)

8.3 监听事件方法内部调试 (34)

8.4 调试完成 (34)

第九章常见问题 (35)

9.1 在脚本里添加里添加了监听器，在代码里删除监听器的时候的报中断错误 (35)

9.2 扩展脚本不能调用当前类的private方法，不能用super来调用父类方法 (36)

9.3 扩展脚本中不能使用强制类型转换 (36)

附录一关于Rhino (38)

Rhino语法简介 (38)

历史简介 (38)

JavaScript 中的"Java" (39)

Rhino和java语言的具体区别 (40)

数组 (40)

联合数组 (40)

通过属性进行循环 (41)

正则表达式 (41)

函数显式声明 (42)

添加方法 (43)

添加更多的方法 (43)

使用原型 (44)

无类编码 (44)

基于类的语言与基于原型的语言的比较 (45)

附录二案例脚本 (46)

简介

扩展脚本运行引擎为Rhino，基于javascript语法，运行期解释执行。jvm中的类的方法和属性均可应用于脚本中，调用方式类似于代码调试。

比如下面一段脚本：

//客户端设置编码规则脚本

//定义引入变量

var easNames = JavaImporter();

//引入指定包

easNames.importPackage(https://www.360docs.net/doc/475773261.html,.kingdee.eas.base.codingrule);

//使用引入作用域

with(easNames){

//从上下文中获取编辑界面编辑对象

var editData = pluginCtx.getDataObject();

//取得ｆ７控件

var bizOrgUnit = pluginCtx.getKDBizPromptBox(

"prmtSaleOrgUnit").getValue();

//远程方法调用获取编码

var number = CodingRuleManagerFactory.getRemoteInstance()

.getNumber(editData, bizOrgUnit.getId());

//设置TextField编码

pluginCtx.getKDTextField("txtNumber").setText(number);

}

指定作用域

在示例代码中

和java中import类似，这里使用JavaImporter()的importPackage引入包com.kingdee.eas.base.codingrule，CodingRuleManagerFactory 属于该包中的内容，但其处在with(easNames){ … }中，所以不需要指定其全路径，即可调用getRemoteInstance()方法，如果需要引入其它包，则增加easNames.importPackage(Packages.包路径);即可。如果没使用with 指定作用域，则必须使用全名称（包名+类名）。

注意：当引入的不同包路径下有重复的类名称情况下，在with(easNames){作用域中，该类名在引用时也需要指定其全路径。

变量

使用var 声明变量，声明时无具体类型运行期确定类型。例如var editData = pluginCtx.getDataObject();声明editData为编辑界面的编辑对象。变量的定义声明遵循javascript语法。

函数

使用function 关键字开始函数的声明，在函数声明中看不到类型，包含参数和返回值，如下所示

增加监听器：

使用扩展脚本

扩展定义：针对扩展点编写扩展脚本。

扩展点：能够支持扩展脚本的公用业务方法，需要改变其执行效果预期的地方。

在实体或ui里扩展定义可编写扩展脚本，选择某个叶子节点即可编写针对该业务方法的前置脚本和后置脚本。前置脚本在业务方法被调用前被执行，后置脚本在业务方法返回后被执行。脚本中可以使用业务方法的参数，也可以设置业务方法的返回值。

第一章上下文

扩展脚本中封装了两种上下文，插件上下文（pluginCtx）和方法上下文（methodCtx）。这两种上下文为系统内置，无需额外的声明或获取。

pluginCtx主要存放当前执行环境的相关信息，比如服务端的Context，客户端的界面控件、界面状态、编辑对象等。methodCtx存放当前操作的相关信息，包含方法参数和方法返回值。

1.1插件上下文（pluginCtx）

客户端和服务端的插件上下文存储的内容不一样，实现方式上，其分别对应于两个java

类，com.kingdee.eas.ep.app.BeanParam和com.kingdee.eas.ep.client.UIParam。这两个类中的方法均可以在脚本中直接使用。

上下文都存在get和put方法。脚本中直接使用get(key)获取值，put(key,value)设置值。

1.1.1获取服务端上下文

1.1.2获取客户端上下文

客户端插件上下文封装了部分常用的内容，具体如下：

直接通过pluginCtx调用即可，比如pluginCtx.getUI即可获取当前界面实例。

1.1.3获取界面控件

界面的控件可以通过get + 控件类型+ ( + 控件名+)的方式获得，比如获取单据分录

1.2方法上下文（methodCtx）

方法上下文存放了方法的相关信息，包括方法参数和方法返回值。方法上下文提供如下

1.2.1获取方法参数

如果想获得方法的某个参数，比如delete(String pk)的参数，这可以通过methodCtx.getParamValue(0)来获得单据的pk。示例中以

var billId = methodCtx.getParamValue(0);来获取参数需要删除单据的id

1.2.2获取方法返回值

描述：可以通过methodCtx.getResultValue()来获得方法的返回值。

用法：一般在后置脚本中使用，如示例代码中，通过状态方法是否成功执行来判断是否需要删除对于表的纪录：var isDone = methodCtx. getResultValue();

1.2.3设置方法返回值

设置方法的返回值必须通过methodCtx.setResultValue(value)来设置，不可以用类似方法返回值的方式写（return value）。如示例代码中设置方法返回值为TRUE。

methodCtx.setResultValue(https://www.360docs.net/doc/475773261.html,ng.Boolean.TRUE)

1.2.4方法上下文常用方法

1.3快速插入上下文脚本

可以通过动态扩展平台的扩展定义中的上下文来快速编写一些常用脚本。

自动生成模板脚本

双击这里

如上图所示，当选择扩展点后，切换到上下文页签，选中前置或后置脚本，双击所需树结点，就可以自动生成模版脚本，例如双击当前用户生成模板脚本：

com.kingdee.eas.util.app.ContextUtil.getCurrentUserInfo(pluginCtx.getContext());

第二章调用业务方法

在实体或Fa?ade中新增一个业务方法后，如何调用该业务方法？自定义业务方法的调用是通过工具类来实现的，该实现方式同样适用标准产品中已有的业务方法调用，下面将说明。

2.1调用方式

调用自定义业务方法和标准产品已有的业务方法方式相同，下面我们在实体上新增一个自定义一个业务方法helloWord。

然后可到扩展定义中找到该新增方法的方法描述。返回值类型

方法名

拷贝可获取方法描述

2.1.1客户端调用业务方法方式

com.kingdee.bos.framework.BOClientTool.callCmethod(pk,methodSignature,args)

元数据PK（IMetaDataPK pk）

方法名称（String methodSignature）

参数对象数组（Object[] args）

其中元数据PK为实体的全名称，可从元数据检查获得：

复制这里获取元数据全路径

方法名称请从该业务方法的扩展点的描述信息中拷贝获得，否则容易出错，如果方法没有返回值，注意名称前有空格，不要删除。

比如：

2.1.2服务器端调用业务方法方式

com.kingdee.bos.framework.BOProxy.getProxy(pluginCtx.getContext(),pk ).callCmethod(method Signature ,args )

服务端上下文（Context ctx ） 元数据PK （IMetaDataPK pk ）

方法名称（String methodSignature ） 参数对象数组（Object[] args ）

参数获取方式参见客户端业务方法调用。

2.2快速插入业务方法调用

可以通过动态扩展平台的扩展定义中的上下文页签中“调用自定义业务方法节点”快速生成调用业务方法模版脚本，如下图所示：

com.kingdee.bos.framework.BOProxy.getProxy(pluginCtx.getContext(),pk ).callCmethod(method Signature ,args )然后替换相应参数即可。

小提示：使用快速插入业务方法调用方式，你不需要关心使用客户端方式还是服务端方式，平台会自动根据当前方法判断调用方式

双击这里

自动生成模板脚本

第三章自定义异常

3.1定义自定义异常

建立一个方案后，会自动创建一个异常，增加异常只需增加子异常即可。业务异常定义后，可以通过工具类抛出异常。在一个异常中子异常号不能重复。

3.2脚本中调用自定义异常

在脚本中使用工具类com.kingdee.eas.ep.plugin.ExceptionUtil调用自定义异常，该类中将根据异常名和子异常名获取异常并抛出.

3.2.1服务器端调用异常方式

服务器端调用方式：

com.kingdee.eas.ep.plugin.ExceptionUtil.throwOnServer(pluginCtx.getContext(),name,subName, args)

其中参数为：

Context ctx-服务器上下文

String name-异常名称

String subName-子异常名称

Object[] args-参数对象数组，可删去

args[i]中的内容将会替代对应的{i}中的内容，如果没有参数，可以省略该参数。

3.2.2客户端异常调用方式

客户端调用方式：

com.kingdee.eas.ep.plugin.ExceptionUtil.throwOnClient(name,subName,args)

参数含义

String name-异常名称

String subName-子异常名称

Object[] args-参数对象数组，可删去

args[i]中的内容将会替代对应的{i}中的内容，如果没有参数，可以省略该参数。

3.3快速插入自定义异常调用

可以通过动态扩展平台的扩展定义中的上下文页签中“异常工具”快速生成调用异常模版脚本，如下图所示：

自动生成模板脚本

双击

双击自动生成

com.kingdee.eas.ep.plugin.ExceptionUtil. throwOnClient (name,subName,args)，然后替换相应参数即可。已3.1中新建异常为例，则替换为：

com.kingdee.eas.ep.plugin.ExceptionUtil.throwOnClient("TesttException","ssssd",["参数1","参数2"]); 运行效果如下图所示。

注意一：异常信息中可以存在“{数字}”这种格式的内容，表示这部分需要在运行时替换为具体信息。比如异常定义为“测试异常；参数一:{0},参数二{1}”，调用该异常的时候，以数组形式传入参数：["参数1","参数2"]

第四章自定义基础资料或单据

动态扩展平台支持自定义基础资料和单据的实现原理是先通过内置的模板拷贝生成新的动态元数据，然后通过模板这个壳来运行。新生成的元数据可进行业务调整。所有对动态内容的操作，最终都转换为对模板的操作，模板根据具体元数据的信息，进行相应的转换后，再执行操作。

4.1 获取自定义基础资料和单据远程接口

首先新建自定义基础资料或单据，从模板复制，选择包名，输入名称，如：

路径：com.kingdee.eas.basedata.assistant名称：Termsofapply

创建完成后，客户端调用新增、修改、查询等动作首先需要一个远程接口，可通过如下方式获得：

其中entityPK 为自定义基础资料的路径+”.app.”+包名(实体的全名称)

，如示例中则为： com.kingdee.eas.basedata.assistant .app.Termsofapply

4.2 传入参数

获取远程接口需要传入entityPK ，为自定义基础资料的实体的全名称，如

” com.kingdee.eas.basedata.assistant.app.Termsofapply ”。其也可在自定义基础资料实体元数据检查中获得，如下图打开元数据检查

输入实体名称

选择模板

元数据检查

取其中entityObject属性获取实体全名。

复制获取实体全路径

4.3 返回值类型

返回值为com.kingdee.eas.ep.IDataBaseCustom类型，这是由于其从该模板生成所致。这样IDataBaseCustom上的所有操作，动态基础资料都有，也均可以通过该实例执行。

4.4 示例脚本

以新增操作为例，新增如下，首先获取entityPK（参见4.2.），元数据查获取BOSType，如下图：

复制获取实体bosType

//创建值对象

function createNewData(entityPK)

{

var objectValue = new com.kingdee.eas.ep.DataBaseCustomInfo();

var entityBosType = "9DD486DB"; //实体的bosType，可通过[元数据检查]获得

objectValue.setBOSType(new com.kingdee.bos.util.BOSObjectType(entityBosType));

//实体的PK，可通过[元数据检查]获得

objectValue.setPK(new com.kingdee.bos.metadata.MetaDataPK(entityPK));

return objectValue;

}

var entityPK = "com.kingdee.eas.basedata.assistant.app.Termsofapply";

var object = createNewData(entityPK);

//通过实体PK获取自定义基础资料或单据接口，所需参数为实体pk

var bizInterface = com.kingdee.bos.BOSObjectFactory.

createRemoteCommonBOSObject(

new com.kingdee.bos.metadata.MetaDataPK(entityPK));

bizInterface.addnew(object); //新增

((com.kingdee.eas.ep.DataBaseCustomInfo)object).setName(“TestName”);

object.setId(opk.getKeyValue("id"));

object.setName("myName");