红皮书方案ncv60-界面发布.pdfVIP

NC60界面API的发布规范

概述

扩展按钮被添加到功能节点菜单上只是按钮扩展功能实现的第一步，更为重要的是在响应这

些菜单扩展按钮时，二次开发程序员往往需要调用到与该节点界面上相关的API，例如需要

获取节点界面上的某个控件，或者需要获取节点界面上的相关数据，等等。这些需求在以前

往往是当需要时，联系相关程序员，要求在功能节点代码上随意的提供某个方法，由二次开

发程序员调用。目前存在以下的一些问题：

二次开发程序员不清楚应该调用什么API来获取界面上的相关数据，总是需要询

问相关的程序员。

二次开发的代码和产品代码往往有较为紧密的耦合，产品一旦升级，往往会影响到

以前的二次开发结果。

对二次开发提供的接口难以维护。

二次开发的维护也很困难，特别是当人员变动时，很难接续以前的工作，

上诉的问题，总的说来是因为我们以前缺少了一个如何发布功能节点API的规范。为了解

决上诉的问题，我们提供下述规范来解决：

功能节点API对外发布为一个接口，由程序员来维护该接口和其实现类，每一个节点

可以发布一个或多个接口

每个接口的实现类需要提供一个以功能节点为参数的构建器，或者是提供一个

setFunclet方法，参数为功能节点，或者是提供一个funclet实例变量，系统会按此优先

次序注射功能节点实例

接口和实现类将在配置文件中进行配置，例如：

……

nodenodeclass”功能节点全类路径1”

apnterface”接口全类路径11”实现类全类路径11/api

apnterface”接口全类路径12”实现类全类路径12/api

/node

……

二次开发程序员使用接口来调用相关的API。在FuncletExtends类提供了一个方法来获

取接口的实例：publicTTlookupUIAPI(ClassTinterfaceCls)，例如：

接口为

publicinterfaceICorpUI{

publicJTreegetCorpTree();

}

二次开发的代码可能为

……

ICorpUIui=lookup(ICorpUI.class);

JTreecorpTree=ui.getCorpTree();

……

通过这样的规范，其好处在于：

解除了功能节点代码和二次开发代码的耦合

可以很方便的发布功能节点的api给二次开发使用，

发布的接口便于程序员维护，也便于二次开发程序员学习

便于二次开发代码的维护

发布uiapi接口的步骤

定义接口

对于一个具体的功能节点子类，可以提供一个或者多个节口给二次开发使用，一般来说，可

以按照内容或功能提供不同的接口。例如，获取界面控件的api定义在一个接口中，获取界

面数据的api定义在另外一个接口中。具体如何分配接口，完全由程序员决定，唯一需要考

虑的是在版本升级时，需要保证前后版本的兼容性，以保证产品升级后，以前二次开发成果

的有效性。

例如对于公司节点，提供如下接口：

publicinterfaceICorpUI{

publicUITreegetCorpTree();

}

publicinterfaceICorpData{

publicCorpVOgetCorpVOFromPanel();

}

实现接口

在定义完接口后，针对每一个接口，提供一个实现类（当然也可以在