CN104636149A

CN104636149A - 一种接口信息的获取方法及装置

Info

Publication number: CN104636149A
Application number: CN201510106718.3A
Authority: CN
Inventors: 吴汇川; 盖金鹏; 李妍
Original assignee: Agricultural Bank of China
Current assignee: Agricultural Bank of China
Priority date: 2015-03-11
Filing date: 2015-03-11
Publication date: 2015-05-20
Anticipated expiration: 2035-03-11
Also published as: CN104636149B

Abstract

本申请提供了一种接口信息的获取方法及装置，该方法包括：在获得程序标识后，首先可获取该程序标识对应的接口的标识，进一步地，在结构体与字段关系表中，可获取到接口的字段，以及该接口的全部下级接口的字段，并且，还可在字段表中，获取到字段的详细信息。可见，本方法可以为开发人员提供接口的各项信息，包括接口的标识、接口包含的字段以及字段的详细信息，以供开发人员了解系统程序中的数据流向。

Description

一种接口信息的获取方法及装置

技术领域

本申请涉及软件技术领域，尤其是一种接口信息的获取方法及装置。

背景技术

在软件系统中，通常包括多个子程序，子程序之间具有调用关系。具体地，子程序之间通过接口调用，也就是说，一个子程序接口会调用另一子程序接口。一般地，调用类型可以是如图1A所示的平行调用或者如图1B所示的层级调用。

为了实现对系统的监控、维护或者进一步开发，程序开发人员需要了解系统中各个程序接口的信息，目前，尚无一种对程序接口信息的获取方法。

发明内容

有鉴于此，本申请提供了一种接口信息的获取方法及装置，用以实现对接口信息的获取。为实现所述目的，本申请提供的技术方案如下：

一种接口信息的获取方法，包括：

获取程序标识；

获取与所述程序标识对应的接口标识，所述接口包括：输入接口和输出接口中的至少一个；

在结构体与字段关系表中，获取所述接口标识的字段及所述接口标识的全部下层接口标识的字段；

在字段表中，获取各个所述字段的字段信息。

可选地，上述的接口信息的获取方法，所述在结构体与字段关系表中，获取所述接口标识的字段及所述接口标识的全部下层接口标识的字段包括：

在结构体与字段关系表中，查询所述接口标识的字段及所述接口的下层接口标识，若查询到字段，获取所述字段，若查询到下层接口，返回查询下层接口的字段及所述下层接口的下层接口。

可选地，上述的接口信息的获取方法，所述获取与所述程序标识对应的接口标识包括：

在程序与结构体关系表中，查询所述程序标识对应的接口标号；

在结构体表中，获取所述接口标号对应的接口名称。

可选地，上述的接口信息的获取方法，所述获取程序标识包括：

接收用户输入的程序名称；

在程序表中，获取所述程序名称对应的程序标识。

可选地，上述的接口信息的获取方法，所述字段信息包括字段长度，该方法还包括：

统计各个所述字段的字段长度的总值。

本申请还提供了一种接口信息的获取装置，包括：

程序标识获取单元，用于获取程序标识；

接口信息获取单元，用于获取与所述程序标识对应的接口标识，所述接口包括：输入接口和输出接口中的至少一个；

字段标识获取单元，用于在结构体与字段关系表中，获取所述接口标识的字段及所述接口标识的全部下层接口标识的字段；

字段信息获取单元，用于在字段表中，获取各个所述字段的字段信息。

可选地，上述的接口信息的获取装置中，所述字段标识获取单元包括：

字段标识获取子单元，用于在结构体与字段关系表中，查询所述接口标识的字段及所述接口的下层接口标识，若查询到字段，获取所述字段，若查询到下层接口，返回查询下层接口的字段及所述下层接口的下层接口。

可选地，上述的接口信息的获取装置中，所述接口信息获取单元包括：

接口标号获取子单元，用于在程序与结构体关系表中，查询所述程序标识对应的接口标号；

接口名称获取子单元，用于在结构体表中，获取所述接口标号对应的接口名称。

可选地，上述的接口信息的获取装置中，所述程序标识获取单元包括：

程序标识获取子单元，用于接收用户输入的程序名称，并在程序表中，获取所述程序名称对应的程序标识。

可选地，上述的接口信息的获取装置中，所述字段信息获取单元获取到的字段信息包括字段长度，该装置还包括：

接口长度获取单元，用于统计各个所述字段的字段长度的总值。

由以上可知，本发明具有如下有益效果：

本发明提供的接口信息的获取方法为：在获得程序标识后，首先可获取该程序标识对应的接口的标识，进一步地，在结构体与字段关系表中，可获取到接口的字段，以及该接口的全部下级接口的字段，并且，还可在字段表中，获取到字段的详细信息。可见，本方法可以为开发人员提供接口的各项信息，包括接口的标识、接口包含的字段以及字段的详细信息，以供开发人员了解系统程序中的数据流向。

附图说明

为了更清楚地说明本发明实施例或现有技术中的技术方案，下面将对实施例或现有技术描述中所需要使用的附图作简单地介绍，显而易见地，下面描述中的附图仅仅是本发明的实施例，对于本领域普通技术人员来讲，在不付出创造性劳动的前提下，还可以根据提供的附图获得其他的附图。

图1A及图1B为系统中各个子程序的调用关系结构示意图；

图2为本发明实施例提供的接口信息获取方法的流程图；

图3为本发明实施例提供的获取到的接口信息示例图；

图4为本发明另一实施例提供的接口信息获取方法的流程图；

图5为本发明实施例提供的接口信息获取装置的结构示意图；

图6为本发明另一实施例提供的接口信息获取装置的结构示意图。

具体实施方式

下面将结合本发明实施例中的附图，对本发明实施例中的技术方案进行清楚、完整地描述，显然，所描述的实施例仅仅是本发明一部分实施例，而不是全部的实施例。基于本发明中的实施例，本领域普通技术人员在没有做出创造性劳动前提下所获得的所有其他实施例，都属于本发明保护的范围。

软件系统在开发过程中，使用的开发语言不同，则系统结构也可能会不同，其中，系统结构主要指的是各个子程序(程序、函数、结构体等)之间的调用与被调用的关系。例如，有些子程序的调用为如图1A所示的平行调用，而，有些子程序为如图1B所示的层级调用。以下各个实施例可以实现对该两种形式系统结构中接口信息的高效准确获取，该优点对第二种形式尤其明显。

参照图2，其示出了本发明实施例提供的接口信息的获取方法的流程，具体包括以下步骤：

步骤S101：获取程序标识。

其中，程序标识为某个系统的标识，该系统中包括多个子程序，子程序之间具有调用关系。

步骤S102：获取与所述程序标识对应的接口标识，所述接口包括：输入接口和输出接口中的至少一个。

其中，系统可能只包括输入接口，可能只包括输出接口，或者，可能两者都包括。输入接口即是上述的第一层子程序，输入接口可以调用下层输入接口，输出接口同理。也就是说，输入接口或输出接口各自之间的调用关系可以为上述两种形式中的任意一种。

步骤S103：在结构体与字段关系表中，获取所述接口标识的字段及所述接口标识的全部下层接口标识的字段。

其中，预先设置结构体与字段关系表，该表中保存有输入接口的字段及全部下层输入接口，输出接口的字段及全部下层输出接口。具体地，在结构体与字段关系表中，获取输入接口的字段及输入接口的全部下层输入接口的字段，或者，获取输出接口的字段及输出接口的全部下层输出接口的字段，或者以上两种方式的结合。

需要说明的是，下层输入接口并非指下一层输入接口，而是，输入接口的下一层输入接口，若该下一层输入接口仍有下一层输入接口，则该下一层输入接口也属于输入的输入接口，直至某个下一层输入接口并不具有新的下一层输入接口。简单而言，输入接口可以认为是树形结构的根节点，则该颗树中的所有非根节点均为该根节点的子节点。需要说明的是，某些下层输入接口可以具有自身的字段。因此，在本步骤中，除了要获取输入接口的字段外，若下层输入接口具有字段的话，则获取下层输入接口的字段。

另外，有关输出接口的下层输入接口的说明可参照输入接口，并不赘述。

步骤S104：在字段表中，获取各个所述字段的字段信息。

其中，字段表中记录有所有字段的详细信息，如字段信息包括字段类型、字段长度、字段精度、字段描述等。在字段表中，可以查询到步骤S103中获取到的各个字段的详细信息。

由以上的技术方案可知，本实施例提供的接口信息的获取方法，在获得程序标识后，首先可获取该程序标识对应的接口的标识，进一步地，在结构体与字段关系表中，可获取到接口的字段，以及该接口的全部下级接口的字段，并且，还可在字段表中，获取到字段的详细信息。可见，本方法可以为开发人员提供接口的各项信息，包括接口的标识、接口包含的字段以及字段的详细信息，以供开发人员了解系统程序中的数据流向。

上述实施例提供的接口信息获取方法可以但不限定应用在银行系统中，更具体地，可以应用在中国农行开发的业务系统中，如结构为图1B所示形式的BOEING系统。

需要说明，以上实施例在具体实现过程中，可以预先设置多个数据表，在数据表中分别存储程序的各项信息。具体地：

设置程序表(RULE表)，记录所有程序的基本信息，如表1所示，程序表中可以包含程序的名称(DESCRIPTION)及程序的标识(RULE_ID)等。

表1

列名称	数据类型	数据长度	中文名称
				RULE_ID	char	7	RULE SYSID
DESCRIPTION	char	30	RULE名称

设置程序与结构体关系表(R_USESVW表)，记录程序与结构体之间的调用关系，如表2所示，程序与结构体关系表中可以包含上一层实体的类型(Y_ENTITY_TYPE)、上一层实体的标识(Y_INSTANCE_ID)、下一层实体的类型(X_ENTITY_TYPE)、下一层实体的标号(X_INSTANCE_ID)以及下一层实体的数据方向类型(VIEW_USAGE)等。其中，上一级实体指的是程序(RULE)，下一级实体指的是结构体(VIEW)，结构体包括输入接口、输出接口及其他类型的接口，对应地，数据方向类型为输入、输出或其他。

表2

列名称	数据类型	数据长度	中文名称
				Y_ENTITY_TYPE	char	7	上一层实体类型(RULE)
Y_INSTANCE_ID	char	30	上一层实体SYSID(RULE SYSID)
				SEQNO	char	3	序号
X_ENTITY_TYPE	char	7	下一层实体类型(VIEW)
				X_INSTANCE_ID	char	30	下一层实体SYSID(VIEW SYSID)
SEP_ID	char	3
				VIEW_USAGE	char	5	VIEW类型(输入/输出/其他)

设置结构体表(E_VIEW表)，记录结构体VIEW的基本信息，如表3所示，结构体表中可以包含结构体的标号(VIEW_ID)、结构体的名称(DESCRIPTION)及结构体的数据方向类型(VIEW_NAME)等。

表3

列名称	数据类型	数据长度	中文名称
				VIEW_ID	char	8	VIEW的SYSID
DESCRIPTION	char	30	VIEW的名称
				VIEW_NAME	char	18	VIEW类别：输入/输出/其他

设置结构体与字段关系表(R_VUOWNS表)，记录结构体与字段之间的对应关系，更具体地讲，是结构体包含的各个字段。如表4所示，结构体与字段关系表中可以包含上一层实体类型(Y_ENTITY_TYPE)、上一层实体的标识(Y_INSTANCE_ID)、下一层实体的类型(X_ENTITY_TYPE)、下一层实体的标识(X_INSTANCE_ID)以及下一层实体被调用的次数(OCCURS_TIMES)等。其中，上一层实体类型指的是结构体VIEW，下一层实体类型指的是该结构体包含的字段FIELD或该结构体调用的结构体VIEW。

表4

列名称	数据类型	数据长度	中文名称
				Y_ENTITY_TYPE	char	7	上一层实体类型
Y_INSTANCE_ID	char	30	上一层实体SYSID
				SEQNO	char	3	顺序号
X_ENTITY_TYPE	char	7	下一层实体类型
				X_INSTANCE_ID	char	30	下一层实体SYSID
SEP_ID	char	3
				OCCURS_TIMES	char	6	出现次数即数组长度

设置字段表(E_FLD表)，记录字段的基本信息，如表5所示，字段表中可以包含字段的标识(FIELD_ID)、字段的名称(DESCRIPTION)、字段的数据类型(FIELD_TYPE)、字段的数据长度(FLD_LEN)及字段的数据精度(FLD_FRAC)等。

表5

列名称	数据类型	数据长度	中文名称
				FIELD_ID	char	30	FIELD SYSID
DESCRIPTION	char	30	FIELD名称
				DB_PIC	char	30
SCREEN_PIC	char	30
				SCREEN_LIT	char	24
FIELD_TYPE	char	1	FIELD数据类型
				FLD_LEN	char	5	FIELD数据长度
FLD_FRAC	char	2	FIELD数据精度

需要补充的是，上述说明中的VIEW是MRE(Mainframe Repository，主机资源)中的一种特定对象，用来描述结构体，可以包含子VIEW和具体字段(FIELD)。MRE，主要用于存放在开发过程中所用到的代码资源、开发对象资源及对象间关系资源等。

通过上述对五个数据表的说明可知，五个数据表中记录系统中各个程序之间的调用关系及各个程序的基本信息，利用这五个数据表，可以获取到系统中各个接口的信息，如输入接口的名称、字段、调用的全部下层输入接口的名称、各个下层输入接口的字段以及各个下层输入接口的出现次数，同理，输出接口的名称、字段、调用的全部下层输出接口的名称、各个下层输出接口的字段以及各个下层输出接口的出现次数。

进而，获取到的接口信息可以保存在数据集或者树形结构中，然后将导出为EXCEL或文档。当然，导出形式可以是现有技术中的任意一种形式，并不局限于上述两种。

下面以上述五个数据表为例，对上述实施例的获取过程进行举例说明。

接收用户输入的程序名称，例如，接收到的程序名称为：AM_CAN_DIV_TRN。

在RULE表中，查找该程序名称对应的程序标识，例如，查找到的程序标识为：ZGTNYWP。

在R_USESVW表中，查找上一层实体类型为RULE且上一层实体标识为ZGTNYWP对应的下一层实体的类型、标号及数据方向的类型。例如，查找到的下一层实体类型为VIEW，下一层实体的标号为ZGBFOV3及ZGBGNV3，其中，下一层实体标号ZGBFOV3的数据方向类型为输入，下一层实体标号ZGBGNV3的数据方向类型为输出，也就是说，查找的输入接口标号为ZGBFOV3，输出接口标号为ZGBGNV3。

在E_VIEW表中，分别查找输入接口标号ZGBFOV3的输入接口名称及输出接口标号ZGBGNV3的输出接口名称，例如查找的输入接口名称为：AM_CAN_DIV_TRN_I，查找的输出接口名称为：AM_CAN_DIV_TRN_O。进而，可以保存该输入接口名称及输出接口名称。如表6所示，AM_CAN_DIV_TRN包含的输入接口为AM_CAN_DIV_TRN_I、输出接口为AM_CAN_DIV_TRN_O。

表6

在R_VUOWNS表中，递归查询输入接口的类型为VIRW，输入接口的标号为ZGBFOV3的下层实体的类型、标识以及出现次数，直至某个下层实体并无新的下层实体。具体地，在该表中，查询ZGBFOV3的下一层实体的类型，若查询到的下一层实体类型为FIELD，则可以在E_FLD表中，查询该下一层实体类型的字段信息，若查询到的下一层实体类型为VIEW，则需要在本表中，继续查询该下一层实体的下一层实体的类型、标识及出现次数，这样继续查询，直至某个下一层实体不存在VIEW类型的下一层实体。同理，在该表中，递归查询输出接口ZGBGNV3的下层实体的类型、标识及出现次数。

例如，如图3所示，查询到的ZGBFOV3的下一层实体为三个，分别为FIELD类型的TXT_COMM_AREA_IN、VIEW类型的AM_CAN_PREP_REG_T以及VIEW类型的AM_CAN_DIV_OCC。其中，AM_CAN_PREP_REG_T包含40个FIELD，但并无新的VIEW类型的下一层实体；AM_CAN_DIV_OCC包含一个字段AMT_CAL，但并无新的VIEW类型的下一层实体。

例如，查询到的ZGBFOV3的下一层实体为三个，分别为FIELD类型的TXT_COMM_AREA_OUT、VIEW类型的AM_CAN_DIV_OCC_OUT以及VIEW类型的AM_CAN_DIV_OUT。其中，AM_CAN_DIV_OCC_OUT包含7个字段，但并无新的VIEW类型的下一层实体；AM_CAN_DIV_OUT包含8个字段，但并无新的VIEW类型的下一层实体。

需要说明的是，在R_VUOWNS表中递归查询时，可以在每当查找到一个字段，则在E_FLD表中查找该字段的具体信息，也可以是在R_VUOWNS中查询到全部的字段，然后再在E_FLD表中查找每个字段的具体信息。

在E_FLD表中，查找以上各个字段的具体信息，如字段长度、字段类型、字段精度及字段描述等，例如，对于TXT_COMM_AREA_IN，查找到的字段类型为Vchar，字段长度为500，字段描述为COMMAREA输入信息。

例如，AM_CAN_DIV_TRN_I的接口信息如表7所示，为了简略，将AM_CAN_PREP_REG_T的部分字段省略。

表7

第1层级	第2层级	第3层级	第4层级
				[FIELD]TXT_COMM_AREA_IN	VChar(500)	COMMAREA输入信息
[VIEW]AM_CAN_PREP_REG_T	[FIELD]COD_FN_ENT	Char(4)	金融实体代码
					[FIELD]COD_PRO_COD	Char(2)	省市代码
	[FIELD]COD_BRCH_OU_TR	Char(6)	交易组织单元代码
					[FIELD]NUM_SEQ_AR_1	Char(17)	合约号_1
	[FIELD]COD_BAL_TYP_1	Char(5)	账户余额类型_1
					[FIELD]DATE_TR_1	Char(8)	交易日期_1
[VIEW]AM_CAN_DIV_OCC	[FIELD]AMT_CAL	Decimal(18,2)	计算金额

AM_CAN_DIV_TRN_O的接口信息如表8所示。

表8

第1层级	第2层级	第3层级	第4层级
				[FIELD]TXT_COMM_AREA_OUT	VChar(1000)	COMMAREA输出信息
[VIEW]AM_CAN_DIV_OCC_OUT	[FIELD]TXT_REM	Char(200)	备注
					[FIELD]NUM_SEQ_CAN	Char(2)	过渡核销顺序号
	[FIELD]TXT_REM_1	Char(50)	备注_1
					[FIELD]ID_INTL_USER_1	Char(9)	用户ID_1
	[FIELD]COD_ISO_CCY	Char(3)	货币代码
					[FIELD]NUM_SEQ_AR_2	Char(17)	合约号_2
	[FIELD]NUM_AR_SEM	Char(32)	合约外部服务标识号码
				[VIEW]AM_CAN_DIV_OUT	[FIELD]ID_INTL_USER_1	Char(9)	用户ID_1
	[FIELD]NUM_TR_VCH_1	Short Integer	交易凭证号_1
					[FIELD]NUM_JRN_NO_1	Integer	交易日志号_1

[FIELD]NUM_SEQ_CAN_1	Char(2)	过渡核销顺序号_1
			[FIELD]COD_ISO_CCY	Char(3)	货币代码
[FIELD]AMT_CAN_PREP	Decimal(18,2)	待核销金额
			[FIELD]NUM_SEQ_AR_2	Char(17)	合约号_2
[FIELD]NUM_AR_SEM	Char(32)	合约外部服务标识号码

通过以上说明可知，在结构体与字段关系表中，获取所述接口标识的字段及所述接口标识的全部下层接口标识的字段的具体实现方式为：

由于接口包括输入接口及输出接口中的至少一个，更具体地，上述步骤的实现过程为：

当包含输入接口时，在结构体与字段关系表中，查询所述输入接口的字段及所述输入接口的下层输入接口，若查询到字段，获取所述字段，若查询到下层输入接口，返回查询所述下层输入接口的字段及所述下层输入接口的下层输入接口，直至某个下层输入接口不再具有下层输入接口；

当包含输出接口时，在结构体与字段关系表中，查询所述输出接口的字段及所述输出接口的下层输出接口，若查询到字段，获取所述字段，若查询到下层输出接口，返回查询所述下层输出接口的字段及所述下层输出接口的下层输出接口，直至某个下层输出接口不再具有下层输出接口。

需要说明的是，为了提供更详细的接口信息，可以进一步获取接口的大小，接口大小是通过各个程序的字段长度体现的，因此，如图4所示，在上述各个实施例的基础上，可以包括：

步骤S105：统计各个所述字段的字段长度的总值。

也就是说，结构体与字段关系表中，可以获取到的多个字段，进而计算全部字段的长度和值，从而获得接口的大小。例如，AM_CAN_DIV_TRN_I的长度为1152，AM_CAN_DIV_TRN_O的长度为7347。

下面对本发明实施例提供的接口信息的获取装置进行介绍，需要说明的是，有关接口信息的获取装置的说明可参照上文提供的接口信息的获取方法，以下并不做赘述。

如图5所示，本发明实施例提供了一种接口信息的获取装置，具体包括：

程序标识获取单元100，用于获取程序标识；

接口信息获取单元200，用于获取与所述程序标识对应的接口标识，所述接口包括：输入接口和输出接口中的至少一个；

字段标识获取单元300，用于在结构体与字段关系表中，获取所述接口标识的字段及所述接口标识的全部下层接口标识的字段；

字段信息获取单元400，用于在字段表中，获取各个所述字段的字段信息。

上述的接口信息的获取装置中，字段标识获取单元300具体包括：

上述的接口信息的获取装置中，接口信息获取单元200具体包括：

上述的接口信息的获取装置中，程序标识获取单元100具体包括：

字段信息获取单元获取到的字段信息包括字段长度，如图6所示，接口信息的获取装置，还包括可以：

接口长度获取单元500，用于统计各个所述字段的字段长度的总值。

需要说明的是，本说明书中的各个实施例均采用递进的方式描述，每个实施例重点说明的都是与其他实施例的不同之处，各个实施例之间相同相似的部分互相参见即可。

还需要说明的是，在本文中，诸如第一和第二等之类的关系术语仅仅用来将一个实体或者操作与另一个实体或操作区分开来，而不一定要求或者暗示这些实体或操作之间存在任何这种实际的关系或者顺序。而且，术语“包括”、“包含”或者其任何其他变体意在涵盖非排他性的包含，从而使得包括一系列要素的过程、方法、物品或者设备不仅包括那些要素，而且还包括没有明确列出的其他要素，或者是还包括为这种过程、方法、物品或者设备所固有的要素。在没有更多限制的情况下，由语句“包括一个……”限定的要素，并不排除在包括上述要素的过程、方法、物品或者设备中还存在另外的相同要素。

对所公开的实施例的上述说明，使本领域专业技术人员能够实现或使用本发明。对这些实施例的多种修改对本领域的专业技术人员来说将是显而易见的，本文中所定义的一般原理可以在不脱离本发明的精神或范围的情况下，在其它实施例中实现。因此，本发明将不会被限制于本文所示的这些实施例，而是要符合与本文所公开的原理和新颖特点相一致的最宽的范围。

Claims

1.一种接口信息的获取方法，其特征在于，包括：

获取程序标识；

在字段表中，获取各个所述字段的字段信息。

2.根据权利要求1所述的接口信息的获取方法，其特征在于，所述在结构体与字段关系表中，获取所述接口标识的字段及所述接口标识的全部下层接口标识的字段包括：

3.根据权利要求1所述的接口信息的获取方法，其特征在于，所述获取与所述程序标识对应的接口标识包括：

在结构体表中，获取所述接口标号对应的接口名称。

4.根据权利要求1所述的接口信息的获取方法，其特征在于，所述获取程序标识包括：

接收用户输入的程序名称；

在程序表中，获取所述程序名称对应的程序标识。

5.根据权利要求1至4任意一项所述的接口信息的获取方法，其特征在于，所述字段信息包括字段长度，该方法还包括：

统计各个所述字段的字段长度的总值。

6.一种接口信息的获取装置，其特征在于，包括：

程序标识获取单元，用于获取程序标识；

7.根据权利要求6所述的接口信息的获取装置，其特征在于，所述字段标识获取单元包括：

8.根据权利要求6所述的接口信息的获取装置，其特征在于，所述接口信息获取单元包括：

9.根据权利要求6所述的接口信息的获取装置，其特征在于，所述程序标识获取单元包括：

10.根据权利要求6至9任意一项所述的接口信息的获取装置，其特征在于，所述字段信息获取单元获取到的字段信息包括字段长度，该装置还包括：