海关开发平台二次开发手册

金关工程二期

开发平台二次开发手册

目录

1引言1

1.1编写目的1

1.2文档范围1

2平台扩展分类1

3构件扩展开发2

3.1运算逻辑类构件开发2

3.1.1创建运算逻辑2

3.1.2导出JAR文件8

3.1.3导出构件源代码13

3.1.4导出Javadoc文件16

3.1.5导出CADP项目开发文档19

3.2服务类构件开发24

3.2.1启动Studio25

3.2.2创建项目25

3.2.3添加外部jar27

3.2.4添加CADP运行时需要的jar28

3.2.5创建构件包28

3.2.6根据WSDL生成客户端代码30

3.2.7封装调用客户端的接口类和实现类30

3.2.8定义Java构件服务31

3.2.9导出服务引用库37

3210导出构件源代码40

3.2.11导出Javadoc文件43

3.2.12导出CADP项目开发文档46

3.3SDK构件开发51

3.4组合类构件开发52

3.4.1创建构件包52

3.4.2导出ECD53

3.4.3导出源代码56

3.4.4导出项目开发文档59

3.4.5管理构件依赖64

4开发工具扩展开发65

4.1模板和向导开发65

4.1.1向导原型开发66

4.1.2新建功能向导66

4.1.3定义功能向导页68

4.1.4定义页面流模板70

4.1.5定义逻辑流模板78

4.1.6定义录入页面模板87

4.1.7定义返回页面模板89

4.1.8定义初始化模板91

4.1.9配置模板信息92

-II-

4.1.10部署运行93

4.1.11导出功能向导96

5NU1控件扩展开发98

5.1JS控件扩展98

5.2JSP选用板扩展104

5.3JSP代码提示扩展104

6框架扩展开发107

6.1配置类扩展107

6.1.1客户端接入拦截扩展107

6.1.2页面流拦截扩展110

6.1.3逻辑流拦截扩展115

6.1.4实体拦截扩展120

6.1.5命名SQL拦截扩展124

6.1.6构件包加载/卸载扩展128

6.1.7Web请求过滤扩展131

6.1.8Processor配置扩展134

6.1.9应用启动扩展137

6.1.10系统服务扩展140

6.2API扩展142

6.2.1数据库连接扩展142

6.2.2事务同步扩展148

-Hi-

1引言

1.1编写目的

本手册主要说明金关二期应用开发平台的扩展开发相关操作方法及使用，为用户使用海

关应用开发平台完成二次开发提供指导和参考。

1.2文档范围

本文档说明如何在开发平台进行相关的扩展开发。本手册主要包含构件扩展开发、开

发工具扩展开发、NUI控件扩展开发和框架扩展开发等，旨在为客户使用海关应用开发平台

进行二次开发提供帮助。

2平台扩展分类

全面考虑一个应用所需要的可复用资产，根据海关应用开发平台扩展的方式，平台扩展

开发主要包括：构件扩展开发、开发工具扩展开发、NUI控件扩展开发和框架扩展开发。

构件扩展的表现形式分为运算逻辑类构件、服务类构件、SDK构件、组合类构件。

>运算逻辑类构件：主要指把公用的java方法封装为可拖拽的运算逻辑。例如，将

数字格式转化为货币形式可以封装为运算逻辑类构件。

>服务类构件：主要指与第三方软件集成，通过服务装配，封装为服务引用库。

>SDK构件：主要指海关业务支撑平台和开发平台提供的SDK,封装为SDK构件。

>组合类构件：实现将上述构件如运算逻辑类构件等组合在一起，实现特定功能的组

合类构件。

开发工具扩展的表现形式为模板和向导。

>模板和向导：主要指将项目中可以重复利用的功能模块的开发过程配置成向导，一

方面提高了现有项目的开发效率，另一方面，也可以利用该向导在其它的项目中快

速开发出功能类似的模块。例如，单表维护向导可以作为模板和向导。

-1-

NUI控件扩展主要指用户使用NUI控件扩展的组件。例如，NUI的JS扩展、NUI的JSP

选用板扩展和JSP代码提示扩展。

框架扩展的内容包括配置类扩展和API扩展开发。

3构件扩展开发

构件扩展的开发主要包括运算逻辑类构件、服务类构件、SDK构件、组合类构件的开

发。下面将详细介绍如何开发这些构件扩展。

3.1运算逻辑类构件开发

3.1.1创建运算逻辑

在Studio的“资源管理器"选中"bizlet/mon.helloworld/运算/运算逻辑

/com.mon.helloworld单击右键，在弹出菜单中选择"创建”，然后选择“运算

逻辑”，如下图所示：

-2-

文件更）编辑坦）浏览®搜索®项目也）运行®窗口戏）帮助®

口］回闽他▽。口'r

囹'abframe

BLbizlet

l-i&com.sdrcc.common,helloworld

QB〔j展现

ffi匠）构件

国s数据

日通运算

eca运算逻辑

ffilcom.sdrcc.common,helloworld

用豺Jav：创建►10运篁逻辑

田国服务8刷新但）F5

国Ijwl流程用包

由昌配置脑复制Ctrl+C

u文件

由0WEB的复制全名

ffi晶Jav推C3文件夹

:粘贴Ctrl+V

品system,sd^

箕删除Delete「土其他（Q）..

+—wizardConfigS

「，项目（£）..

国&XXXServiceLib电।导入9…

M导出@...

曰）打开WindowsExplorer...

刖数据库资源管理器验证

小妲也）►

比较对象0）►

+4连接

从本地历史记录复原（X）..,「雇性问题调试

h示的控制台.

Al♦+Fr»♦qy

图3-1选中创建运算逻辑

单击“运算逻辑”弹出创建运算逻辑窗口，如下图所示:

-3-

图3-2仓1J建Java类

输入名称（类名），单击【下一步】按钮，打开如下界面:

-4-

图3-3创建运算逻辑

输入运算逻辑显示名称，单击。按钮，弹出如下窗口:

图3-4修改运算逻辑的Annotation信息

输入“运算逻辑显示名称”，单击。按钮，增加运算逻辑方法，输入方法名，设置是

否静态方法，选择返回值类型。然后单击参数列表列的口按钮弹出，参数设置窗口，如

下图所示：

-5-

N参数设置

设置运尊逻辑的参数

参数设置件全0钳。阳X

参数名参数别名参数类型数组缺省值坡省值..参数描述

print要打卬输出的对象String□变量

二一IUT-J之

©[确定][取消]

图3-5设置运算逻辑的参数

输入参数名，参数别名，选择参数类型，单击【确定】按钮，返回运算逻辑方法设置页

面，如下图所示：

-6-

图3-6运算逻辑方法设置

单击【下一步】按钮，打开“预览运算逻辑信息”窗口，如下图所示:

图3-7预览生成运算逻辑的效果

单击【完成】按钮后，会生成下面的Java文件。

packagecom.sdrcc.helloworld;

import.customs.cadp.system.annotation.Bizlet;

import.customs.cadp.system.annotation.BizletParam;

@Bizlet（"输出打印"）

publicclassPrinter{

/**

*@paramprint

*@author王杰飞

*/

-7-

@Bizlet(params={@BizletParam(index=0,paramAlias="要打印输出的对象”)})

publicstaticvoidprint(Stringprint){

)

在print(Objectprint)方法中加入方法体代码，完成创建运算逻辑。

System.out.println(print);

3.1.2导出JAR文件

在Studio的“资源管理器”选中“bizlet/mon.helloworld/运算

/Java/mon.helloworld单击右键，在弹出菜单选择“导出”，打开如下窗

□：

-8-

图3-8导出JAR文件

选择“Java/JAR文件”，单击【下一步】按钮，打开如下界面:

-9-

图3-9定义导出到JAR中的资源

单击【浏览】按钮指定JAR文件的位置及名称，如下图所示:

-10-

另存为

保存在d）：lOprimeton6nx

apache-tomcaL5.5.20

eosserver

lOide

Ir^lxminstall

lOXXXServiceLibDoc

亡）XXXServiceLibJavaD。c

里面

意

思

忍

文件名国）：helloworldljar保存⑤）

保存类型复）：取消]

图3-10指定JAR文件的位置及名称

指定导出源代码的路径及名称，单击【保存】按钮，单击【下一步】按钮，打开“JAR

打包选项”窗口，如下图所示：

-11-

图3-11JAR打包选项

单击【下一步】按钮，打开“JAR清单规范”窗口，如下图所示:

图3-12JAR清单规范

单击【完成】按钮，完成导出。

3.1.3导出构件源代码

在Studio的“资源管理器”选中“bizlet/mon.helloworld/运算逻辑

/Java/mon.helloworld单击右键，在弹出菜单选择“导出”，打开如下窗

口：

-13-

图3-13导出源代码

选中CADP/导出源代码，单击【下一步】按钮，打开如下窗口:

-14-

图3-14选择要导出的内容

选择要导出的源代码所在的构件包，单击【浏览】按钮指定导出源代码的位置及名称,

如下图所示：

-15-

保存位置:0区］

保存在Q)：primetonBnxvJ夕"因，

pacc3

he-t

i1ocm

zetDDOw

tJa⑪

z1ewoc

我最近的文档r

ossve

al

devi

sWtl

-vl

m1nWIn

里面XXsLi

Mvice

XXsWcpeLi

&

我基int

sce

XXLi

我的电脑

网上邻居

文件名国）：helloworld保存⑤

保存类型复）:*.zip取消

图3-15指定导出源代码的位置及名称

指定导出源代码的路径及名称，单击【保存】按钮，单击【完成】按钮，提示导出成功,

单击【确定】按钮，完成源代码的导出。

3.1.4导出Javadoc文件

在Studio的"资源管理器"、选中"bizlet/mon.helloworld/运算逻辑

/Java/mon.helloworld单击右键，在弹出菜单选择"导出"，打开如下窗

□:

图3-16导出Javadoc

选中Java/Javadoc,单击【下一步】按钮，打开如下窗口:

-17-

图3-17选择要导出的Javadoc所在的项目

选择要导出的Javadoc所在的项目，单击【浏览】按钮指定导出Javadoc的位置，如

下图所示：

18

选择目标0B

选择Javadoc目标文件夹•

I口eos6

IOE0S6学习

1neossetup

I口primeton

primeton6nx

田百japache-tomcat-5.5.20

1bizletDoc

bzletJavaDoc

文件夹：bzletJavaDoc

新建文件夹血）

图3-18指定导出Javadoc的位置

指定导出Javadoc的路径，单击【确定】按钮，单击【完成】按钮，完成Javadoc的

导出。

3.1.5导出CADP项目开发文档

在Studio的“资源管理器"选中"bizlet/mon.helloworld/运算逻辑

/Java/mon.helloworld",单击右键，在弹出菜单选择"导出"，打开如下窗

口：

-19-

图3-19导出项目开发文档

选中CADP/导出CADP项目开发文档，单击【下一步】按钮，打开如下窗口:

-20-

导导出B

请选择要导出的文者内容

话指定输出目录.

话选择项目：bizlet

选择要导出的内容：

»回搦com.sdrcc.common,helloworld

回&WEB

E…全割选中"j|全部不选]

保存位置：v|[浏览⑥)…

|导入配置信息.|

©[一步.][取消

图3-20选择要导出的文档内容

单击【全部选中】选择要导出的内容，单击【浏览】按钮指定导出文档的位置，如下图

所示：

-21-

图3-21指定导出文档的位置

指定导出项目开发文档的路径，单击【确定】按钮，单击【下一步】按钮打开如下窗口:

-22-

导导出B

样式配置

样式配置

选择生成文档的格式

©HTML

PDF

选择生成文档的样式

G系统默认

O其他系统样式

O自定义样式

I编辑而：|

©[<1一步也）:卞二步®S…j[完成但）][取消

图3-22样式配置

单击【下一步】按钮打开如下窗口:

-23-

图3-23总结报告

填写“文档标题”和“总结报告”内容，单击【完成】按钮，完成项目开发文档导出。

3.2服务类构件开发

CADP平台和第三方软件或系统进行集成时可使用的协议有多种，例如SOAP、HTTP、

EJB、JMS等。其中基于SOAP标准的WebService方式是最常用的集成方式，因为Web

Service方式有以下三个特点：

1、松耦合，具有非侵入性。

2、跨平台，可以让异构的程序相互访问。

-24-

3、开放性，基于国际标准协议。

通过WebService方式集成常用的做法是由被调用方提供标准的WSDL文件，调用方

基于此文件生成客户端代码，从而实现松耦合、非侵入性的调用，在CADP中最终发布为

可部署服务包供构件使用者使用，下面对这种集成方式的开发步骤进行说明。

3.2.1启动Studio

在CADP安装成功后，即可启动CADPStudio。

在操作系统中，单击【开始/所有程序£人口「£人口「$1必0】菜单项，进入CADPStudio

系统，系统默认显示CADP开发视图，如下图所示。

图3-24CADP开发视图

3.2.2创建项目

1、选择【文件/新建/CADP项目】菜单，系统弹出“新建CADP项目”向导；

2、选择创建“空项目”，单击【下一步】按钮，弹出“新建CADP项目”界面，如下

图所示；

-25-

图3-25新建CADP项目

3、配置项目信息。

将“项目名称”修改为“XXXServiceLib”，其他的参数不需要修改。其中XXX为

集成软件或系统的缩写。

4、单击【完成】按钮。

系统返回CADP开发透视图，创建的项目显示在“资源管理器”视图中，如下图所

/J\o

-26-

目包%D

国旬abframe

s

田,0WEB

田晶Java^

品system,sdvx

图3-26资源管理器

3.2.3添加外部jar

在Studio的“资源管理器”选中“XXXServiceLib”项目，单击鼠标右键，选择“属性”,

在弹出窗口的左侧选项中选择“Java构建路径”，然后在右侧窗口中选择“库”标签，如下

图所示：

-27-

图3-27java构件路径

单击【添加外部JAR】按钮，选择要添加的JAR包，然后单击【确定】按钮。

3.2.4添加CADP运行时需要的jar

在CADP开发环境tomcat的commonMib下添加以下jar包，供CADP运行时使用。

3.2.5创建构件包

1、打开“创建构件包”向导。

在Studio的“资源管理器”选中“XXXServiceLib”项目，单击鼠标右键，选择【创

建/构件包】快捷菜单项。

系统弹出“新建构件包”界面，如下图所示：

-28-

图3-28新建构件包

2、修改配置信息。

将“构件包名"修改为"mon.xxx"，此时“显示名称”将和"构件

包名”保持一致。其中XXX为集成软件或系统的缩写。

3、单击【完成】按钮。

系统返回CADP开发透视图，创建的构件包列在“资源管理器”视图中，如下图所

示：

-29-

图3-29资源管理器

3.2.6根据WSDL生成客户端代码

利用ApacheAxis提供的工具(WSDL2JAVA),根据第三方软件或系统提供的WSDL

和Schema,产生调用服务客户端的JAVA类。

3.2.7封装调用客户端的接口类和实现类

在CADP中封装java构件服务构件需要两个类，一个是接口类(XXXApi.java),一个是

实现类(XXXApilmpl.java),其中XXX为集成软件或系统的缩写。

其中XXXApi.java接口类需要加上Javadoc注释，以便在服务构件中进行友好的帮助

提示，Javadoc注释结构如下：

/**

*功能：功能描述

*@paramfolderPath上传的文档所放的目的路径

*@paramdocName文档名称

*@paramfilename带绝对路径的文件名

-30-

*@return返回信息描述

7

其中功能描述用来说明接口的功能，返回信息描述用来说明返回的信息描述。

3.2.8定义Java构件服务

1、在构件“XXXComponent”右击，在弹出菜单中选择“添加服务”。

2、在打开的服务属性设置对话框中设置服务的名称为XXXService,如下图所示，其中

XXX为集成软件或系统的缩写。

图3-30服务属性设置

3、为构件服务指定接口描述。

在构件装配图XXXCompos让e中，双击构件的服务XXXService,在弹出的属性对话框

中通过【浏览】按钮，打开如下界面：

-31-

7选择接口

选择接口类型

话指定接口的类型：WSDL^Java

OWSDL

选择一个*SDL中的portType作为接口描述

@Java^

选择一个Jav或型作为接口描述

©U一步⑥I下一步®>]|完成国）I[取消I

图3-31选择接口类型

选择接口类型为java,用鼠标单击【下一步】按钮，打开如下窗口。

-32-

S选择接口B

选择一个Ja▼拿型作为接口搽述

输入或选择选择一个Jav或型

com.sdrcc.common.xxx.XXXAPi

匹配的类型⑥）：

©[让一步⑹）下一步直）一[完成9|[取消]

图3-32选择接口

输入接口实现类mon.xxx.XXXApi,选择接口类所在位置，单击【完成】

按钮，返回服务属性设置对话框，如下图所示：

-33-

图3-33服务属性设置

单击【确定】按钮，完成构件服务指定接口描述。

4、为构件指定构件实现。

在装配图中，双击“XXXComponent”构件，在弹出的构件属性设置对话框中选择

“实现"Tab页，如下图所示：

-34-

图3-33构件属性设置

单击【浏览】，在弹出框中输入“mon.xxx.XXXApVmpI”,设置如下图所

示：

图3-35选择打开类型

-35-

单击【确定】按钮，返回构件属性设置对话框，如下图所示:

图3-36构件属性设置

单击【确定】按钮，完成为构件指定构件实现。

4、对外暴露服务。

开发完成的服务可以很方便的以WebService方式对外暴露，供其他外部系统调

用。打开"XXXServiceLib\mon.xxx\服务'构件装配

\mon.xx\XXXComposite",在服务装配图编辑器中，从选用板中选择提

升.£>•promote,用鼠标选择源为构件xxXComponent的服务XXXService,然后向外

拖动形成提升服务。如下图所示：

-36-

图3-37服务装配

3.2.9导出服务引用库

在Studio的“资源管理器”选中“XXXServiceLib”项目，单击鼠标右键，选择“导出”

打开如下窗口：

-37-

图3-38导出服务引用库

选中CADP/导出服务引用库，单击【下一步】按钮，打开如下窗口:

-38-

图3-39选择需要导出服务的构件包

选择要导出的服务所在的构件包，单击【浏览】按钮指定导出服务引用库的位置及名称,

如下图所示：

-39-

图3-30指定导出服务引用库的位置及名称

指定导出服务引用库的路径及名称，单击【保存】按钮，单击【完成】按钮，提示导出

成功，单击【确定】按钮，完成服务引用库的导出。

3.2.10导出构件源代码

在Studio的“资源管理器”选中“XXXServiceLib”项目，单击鼠标右键，选择“导出”

打开如下窗口：

-40-

图3-41导出源代码

选中CADP/导出源代码，单击【下一步】按钮，打开如下窗口:

-41-

3导出源代码

导出源代码

①使用了相对路径,对应

[D：/eosapp/primeton6nx/ide/eclipse/workspace/XXXServiceLib/XXXServiceL

ib.zip]

谙选择项目：XXXServiceLib

选择要导出的内容：

0品

0com.sdrcc.common.XXX

2WEB

0品

system.sdvx

［全部选中］I全部不选］

保存位置：IxXXServiceLibvl浏览⑪.二

取消已选择的错误文件］

©[一步®]-T-［取消

图3-42选择要导出的内容

选择要导出的源代码所在的构件包，单击【浏览】按钮指定导出源代码的位置及名称,

如下图所示:

-42-

图3-43指定导出源代码的位置及名称

指定导出源代码的路径及名称，单击【保存】按钮，单击【完成】按钮，提示导出成功,

单击【确定】按钮，完成源代码的导出。

3.2.11导出Javadoc文件

在Studio的“资源管理器”选中“XXXServiceLib”项目，单击鼠标右键，选择“导出”

打开如下窗口：

-43-

图3-44导出Javadoc

选中Java/Javadoc,单击【下一步】按钮，打开如下窗口:

-44-

图3-45选择要导出的Javadoc所在的项目

选择要导出的Javadoc所在的项目，单击【浏览】按钮指定导出Javadoc的位置，如

下图所示：

-45-

选择目标0B

选择Javadoc目标文件夹•

田匕japache-tomcat-5.5.20

国ICeosserver

囹心ide

ffi13uninstall

XXXServiceLibjavaDoc

ffi1」primeton61

田liTprimetonBlab

+1primetonbps

文件夹：XXXServiceLibjavaDoc

新建文件夹述）

图3-46指定导出Javadoc的路径

指定导出Javadoc的路径，单击【确定】按钮，单击【完成】按钮，完成Javadoc的

导出。

3.2.12导出CADP项目开发文档

在Studio的“资源管理器”选中“XXXServiceLib”项目，单击鼠标右键，选择“导出”

打开如下窗口：

-46-

图3-47导出CADP项目开发文档

选中CADP/导出CADP项目开发文档，单击【下一步】按钮，打开如下窗口:

-47-

导导出

请选择要导出的文者内容

话指定输出目录.

话选择项目：XXXServiceLib

选择要导出的内容：

国回盘com.sdrcc.common.xxx

ffi回向WEB

E,…全割选中”…才|全部不选

保存位置:V[浏览回…

导入配置信息.

®[一步.][取消

图3-48选择要导出的内容

单击【全部选中】选择要导出的内容，单击【浏览】按钮指定导出文档的位置，如下图

所示：

-48-

图3-49指定导出文档的位置

指定导出项目开发文档的路径，单击【确定】按钮，单击【下一步】按钮打开如下窗口:

-49-

导导出B

样式配置

样式配置

选择生成文档的格式

©HTML

PDF

选择生成文档的样式

G系统默认

O其他系统样式

O自定义样式

I编辑而：|

©[<1一步也）:卞二步®S…j[完成但）][取消

图3-50样式配置

单击【下一步】按钮打开如下窗口:

-50-

图3-51总结报告

填写“文档标题”和“总结报告”内容，单击【完成】按钮，完成项目开发文档导出。

3.3SDK构件开发

SDK构件主要包括海关业务支撑平台的应用系统提供和发布的SDK,CADP平台和

SDK进行集成，封装为SDK构件。详见《金关工程二期项目SDK集成规范》。

-51-

3.4组合类构件开发

组合类构件将运算逻辑类构件，服务类构件和SDK构件组合在一起，提供特定功能的

构件。组合类构件的开发包括以上所述构件扩展开发。

3.4.1创建构件包

1、打开“创建构件包”向导。

在Studio的“资源管理器”选中“XXXServiceLib”项目，单击鼠标右键，选择【创

建/构件包】快捷菜单项。

系统弹出“新建构件包”界面，如下图所示：

图3-52新建构件包

2、修改配置信息。

将“构件包名”修改为“mon.xxx”，此时“显示名称”将和“构件

-52-

包名”保持一致。其中XXX为集成软件或系统的缩写。

3、单击【完成】按钮。

系统返回CADP开发透视图，创建的构件包列在“资源管理器”视图中，如下图所

示：

图3-53资源管理器

3.4.2导出ECD

在Studio的“资源管理器"选中"bizlet/mon.helloworld/运算逻辑

/Java/mon.helloworld",单击右键，在弹出菜单选择"导出"，打开如下窗

口：

-53-

..CADPJf发-CADPStudi。

文件(F)—(E)浏览(N)搜索(A)项目(P)运行(R)窗口(W)WBb(H)

图3-54导出部署包

选中CADP/导出部署包，单击【下一步】按钮，直到完成导出操作。

ECD导出一般是一个项目导出为一个ECD文件(后缀为.ecd),也可以在一个项目中

选择若干个构件包或者选择多个项目的构件包合并导出为一个ECD文件。导出后的ECD

部署包可以通过Governor部署到CADP的应用上。

执行pom.xml文件时，程序会依照pom.xml文件中配置的项目顺序将配置在构件包列

表中的所有构件包导出到部署包中。例如下图就是一个导出生成部署包的pom脚本文件中

的一段：

-54-

<plugin>

<groupld>com.primeton.ptp.build</groupld>

<artifactld>maven-eos-compile-plugin</artifactld>

<executions>

<execution>

<phase>compile</phase>

<goals>

<goal>eoscompile</goal>

〈configuration)

<otherProjects>

<otherProject>

nui-sample^

</otherProject>

</otherProjects>

<contributions>

com.primeton.nuisample,com.primeton.dependence,com.primeton.eos,

</contributions>

〈/configuration)

</execution>

</executions>

</plugin>

图中参数说明:

节点名称说明

<otherProjects/>该节点配置除主项目外其他需要导出到部署包中

的项目路径（绝对路径或参照主项目的项目路

径）；当存在项目依赖时，被依赖的项目的名称需

要写在依赖它的项目名称之前。

<contributions/>该节点配置了将要导入到部署包中的构件包名称

列表，以'，'分割；同理有多个构件包且存在构

件包依赖时，被依赖的构件包名称需要写在依赖