CN107438112A - 基于xml的移动端接口地址管理方法 - Google Patents

Abstract

本发明提供一种基于xml的移动端接口地址管理方法，其特征在于包括以下步骤：通过移动端系统平台的xml解析工具，将服务器配置文件解析成网络服务配置实体集合，并且将移动端接口地址配置文件解析成网络项目配置实体集合(S1)；当移动端发起网络请求时，通过请求的接口的接口名称来匹配所述网络项目配置实体集合中的任一实例，作为项目A(S2)；从所述项目A中，获取所述接口的配置信息，并根据所获取的配置信息来映射所述网络服务配置集合中的任一实例，作为服务A(S3)；结合所述服务A与所述项目A来构成用于所述网络请求的请求串；以及基于所述请求串来发送所述网络请求(S4)。

Description

基于xml的移动端接口地址管理方法

技术领域

本发明涉及一种基于xml的移动端接口地址管理方法。

背景技术

移动端App(如：iOS、Android)进行网络请求时，是有其对应的网络请求接口的，通过网络请求接口来实现移动端App与服务端进行通信。

移动端App迭代速度快，产品需求变动快，移动端测试、预发布、灰度发布、优先区域发布等各种正式上线前的各种准备，会频换变更服务器地址，频换变更、增删网络请求接口(包含传递参数)，同时对于不同的服务器，相应的网络请求接口会有不同的配置(如：超时时间，是否加解密等)。普通的网络请求接口地址管理不能满足移动端精准化接口控制以及缺少接口规范化管理，因此需要一种可扩展的接口地址管理方案，来实现规范化并统一各个移动端平台的标准化管理。

其中，Android是一种基于Linux的自由及开放源代码的操作系统，主要使用于移动设备、如：手机、平板等，由Google公司和开放手机联盟领导及开发。App(全称：Application)指可执行的应用程序。xml(可扩展标记语言)，可用来标记数据、定义数据类型、存储数据，允许用户对自己的标记语言进行定义的源语言，提供统一的方法来描述和交互独立于应用程序、各个平台的结构化数据。

发明内容

本发明鉴于上述问题而开发，目的在于提供一种基于xml的移动端接口地址管理方法，能够独立于各个平台之上的对移动端接口地址进行规范化管理。

为了解决上述问题，本发明的一个方式涉及一种基于xml的移动端接口地址管理方法，其特征在于包括以下步骤：

通过移动端系统平台的xml解析工具，将服务器配置文件解析成网络服务配置实体集合，并且将移动端接口地址配置文件解析成网络项目配置实体集合；

当移动端发起网络请求时，通过请求的接口的接口名称来匹配所述网络项目配置实体集合中的任一实例，作为项目A；

从所述项目A中，获取所述接口的配置信息，并根据所获取的配置信息来映射所述网络服务配置集合中的任一实例，作为服务A；

结合所述服务A与所述项目A来构成用于所述网络请求的请求串；以及

基于所述请求串来发送所述网络请求。

此外，在本发明的方法中，优选：

所述服务器配置文件和所述移动端接口地址配置文件中分别包括各自的配置规范说明信息。

此外，在本发明的方法中，优选：

所述服务器配置文件中包括服务器编号、服务器域名、服务器端口和超时时间，

所述移动端接口地址配置文件中包括接口名称、接口说明、请求方式和接口部署的服务器。

此外，在本发明的方法中，优选：

所述移动端接口地址配置文件中还包括表示请求是否加密的信息，

在移动端进行网络请求时，根据所述表示请求是否加密的信息，对传递的数据进行加解密处理。

(发明效果)

根据本发明，能够提供一种基于xml的移动端接口地址管理方法，能够独立于各个平台之上的对移动端接口地址进行规范化管理。此外，可以定制服务器与其对应接口配置，可以定制接口精准化配置。根据本发明，有利于移动端接口地址规范化管理；有利于移动端灵活配置各服务器、各接口请求；有利于满足移动端开发网络请求接口频换变动的实际开发需要。

附图说明

通过参考以下组合附图对所采用的优选实施方式的详细描述，本发明的上述目的、优点和特征将变得更显而易见，其中：

图1是表示本发明的基于xml的移动端接口地址管理方法的一实施例的流程图。

图2是表示本发明的服务器配置文件的一例的图。

图3是表示本发明移动端接口地址配置文件的一例的图。

图4是表示本发明的接口规范化管理整体的流程图。

具体实施方式

下面将详细描述本公开的具体实施例，应当注意，这里描述的实施例只用于举例说明，并不用于限制本公开。在以下描述中，为了提供对本公开的透彻理解，阐述了大量特定细节。然而，对于本领域普通技术人员显而易见的是：不必采用这些特定细节来实行本公开。在其他实例中，为了避免混淆本公开，未具体描述公知的电路、材料或方法。

另外，可以理解的是，此处所描述的具体实施例仅仅用于解释相关发明，而非对该发明的限定。另外还需要说明的是，为了便于描述，附图中仅示出了与有关发明相关的部分。

此外，在整个说明书中，对“一个实施例”、“实施例”、“一个示例”或“示例”的提及意味着：结合该实施例或示例描述的特定特征、结构或特性被包含在本公开至少一个实施例中。因此，在整个说明书的各个地方出现的短语“在一个实施例中”、“在实施例中”、“一个示例”或“示例”不一定都指同一实施例或示例。此外，可以以任何适当的组合和/或子组合将特定的特征、结构或特性组合在一个或多个实施例或示例中。此外，本领域普通技术人员应当理解，在此提供的附图都是为了说明的目的，并且附图不一定是按比例绘制的。应当理解，当称部件“连接到”另一部件时，它可以是直接连接或连接到另一部件或者可以存在中间部件。相反，当称部件“直接连接到”另一部件时，不存在中间部件。相同的附图标记指示相同的元件。这里使用的术语“和/或”包括一个或多个相关列出的项目的任何和所有组合。

下面结合附图和实施例对本申请作进一步的详细说明。

需要说明的是，在不冲突的情况下，本申请中的实施例及实施例中的特征可以相互组合。下面将参考附图并结合实施例来详细说明本发明。

在本发明中，使用xml来存储网络请求接口，并提供各种配置规范说明，来实现定义、存储、跨平台使用的目的。

图1是表示本发明的基于xml的移动端接口地址管理方法的一实施例的流程图。

如图1所示，在本发明的基于xml的移动端接口地址管理方法的一实施例中，通过移动端系统平台的xml解析工具，将服务器配置文件解析成网络服务配置实体集合，并且将移动端接口地址配置文件解析成网络项目配置实体集合(步骤S1)。

此外，当移动端发起网络请求时，通过请求的接口的接口名称来匹配网络项目配置实体集合中的任一实例，作为项目A(步骤S2)。

此外，从项目A中，获取接口的配置信息，并根据所获取的配置信息来映射网络服务配置集合中的任一实例，作为服务A(步骤S3)。

此外，结合服务A与项目A来构成用于网络请求的请求串(正式请求串)(步骤S4)。

此外，基于请求串来发送网络请求(步骤S5)。

在本发明的一实施例中，在服务器配置文件和移动端接口地址配置文件中分别包括各自的配置规范说明信息。

此外，在本发明的一实施例中，在服务器配置文件中包括服务器编号、服务器域名、服务器端口和超时时间。在移动端接口地址配置文件中包括接口名称、接口说明、请求方式和接口部署的服务器。

此外，在本发明的一实施例中，在移动端接口地址配置文件中包括表示请求是否加密的信息，在移动端进行网络请求时，根据表示请求是否加密的信息，对传递的数据进行加解密处理。

当然，在服务器配置文件和移动端接口地址配置文件中还可以包括其他信息，这对本领域技术人员来说是不言而喻的。

图2是表示本发明的服务器配置文件的一例的图。

对于服务器配置文件(例如文件名：net_server_config.xml)中的各个配置参数，如图2所示，在本发明的服务器配置文件的一例中，包括服务器编号(即，serverNo)、服务器域名(即，domain)、服务器端口(即，port)和超时时间(即，timeout；单位：秒)。

并且，配置了服务器编号为“0”和服务器编号为“1”的两个项目。

具体而言，服务器编号为“0”，服务器域名为“http：//outer.com”，服务器端口为“80”，超时时间为“30”的项目；以及服务器编号为“1”，服务器域名为“http：//inner.com”，服务器端口为“80”，超时时间为“3”的项目。

此外，对于各个项目，可以全部包括这些配置参数，也可以仅包括这些配置参数中的一部分。

另外，对于移动端，接口可能会分别部署在不同的服务器，且不同服务器的超时时间可能不一致，例如：内外网服务器。

图3是表示本发明移动端接口地址配置文件的一例的图。

对于移动端接口地址配置文件(例如文件名：net_item_config.xml)中的各个配置参数，如图3所示，在本发明移动端接口地址配置文件的一例中，除了包括接口名称(即，action)、接口说明(即，info)、请求方式(即，method；其中，0：get，1：post；不填默认get请求)和接口部署的服务器(即，serverNo；不填为默认服务器)之外，还包括：请求参数拼接(即，params)、请求是否加密(即，encrypt；其中，0：不加密，1加密；默认不加密)、文件上传参数(即，files；不填不上传)、缓存时间(即，cacheTime；默认不缓存，单位：毫秒)和链接前缀(即，url)。

并且，在图3的示例中，配置了接口名称为“findAllJob”、“otherLogin”、“getCityList”的三个项目。

具体而言，接口名称为“findAllJob”，接口说明为“查找所有职位”，请求方式为“1”，接口部署的服务器为“0”，请求参数拼接为“page&amp；pageCount&amp；isHot”，请求是否加密为“1”，缓存时间为“0”，链接前缀为“/app/”的项目；接口名称为“otherLogin”，接口说明为“第三方登录”，请求方式为“1”，接口部署的服务器为“99”，请求是否加密为“0”，请求参数拼接为“qq”，链接前缀为“http：//www.otherServer.com/apiLogion”的项目；以及接口名称为“getCityList”，接口说明为“获取城市列表”，请求方式为“0”，接口部署的服务器为“0”，请求是否加密为“0”，缓存时间为“100000”，请求参数拼接为“username”，链接前缀为“/app/”的项目。

此外，对于各个项目，可以全部包括这些配置参数，也可以仅包括这些配置参数中的一部分。

移动端在进行网络请求时，对数据的传递，可以进行加解密处理，但加密与解密会消耗性能，可选择性进行处理。

图4是表示本发明的接口规范化管理整体的流程图。

下面，以Android平台为例进行说明。

首先，通过Android平台自带xml解析工具，将服务器配置文件即net_server_config.xml解析成网络服务配置实体集合即NetServerConfig实体集合。

接着，将移动端接口地址配置文件即net_item_config.xml解析成网络项目配置实体集合即NetItemConfig实体集合。

当移动端发起网络请求时(S41)，获取请求接口名称(S42)。

之后，判断缓存时间(S43)是否过期。

当缓存过期时，进入缓存子流程(S44)，设置缓存并在有效期内，转步骤S45，根据缓存时间进行缓存。

如果不需要缓存或缓存未过期，确定是否包含服务器处理(S51)、加解密处理(S52)、请求类型处理(S53)、拼接参数处理(S54)。当确定包含上述服务器处理、加解密处理、请求类型处理、拼接参数处理时，执行相应的服务器处理子流程(S61)、加解密处理子流程(S62)、请求类型处理子流程(S63)、拼接参数处理子流程(S64)。

之后，在步骤S70，生成正式请求串。之后，转步骤S45，处理请求并返回数据。

在上述操作中，通过请求的接口名称action匹配NetItemConfig实体的具体实例，记为项目A即ItemA；从NetItemConfigA中，获取该接口的具体配置信息，并映射具体的NetServerConfig实例，记为服务A即ServerA。

然后，结合ServerA与ItemA，来拼接用于网络请求的请求串。

最后，基于该请求串来发送网络请求，并处理请求返回内容。

此外，通过ItemA来进行参数、加密等环节处理。

由此，根据本发明，能够独立于各个平台之上的对移动端接口地址进行规范化管理。此外，可以定制服务器与其对应接口配置，可以定制接口精准化配置。根据本发明，有利于移动端接口地址规范化管理；有利于移动端灵活配置各服务器、各接口请求；有利于满足移动端开发网络请求接口频换变动的实际开发需要。

以上的详细描述通过使用方框图、流程图和/或示例，已经阐述了基于xml的移动端接口地址管理方法的众多实施例。在这种方框图、流程图和/或示例包含一个或多个功能和/或操作的情况下，本领域技术人员应理解，这种方框图、流程图或示例中的每一功能和/或操作可以通过各种硬件、软件、固件或实质上它们的任意组合来单独和/或共同实现。在一个实施例中，本公开的实施例所述主题的若干部分可以通过专用集成电路(ASIC)、现场可编程门阵列(FPGA)、数字信号处理器(DSP)、或其他集成格式来实现。然而，本领域技术人员应认识到，这里所公开的实施例的一些方面在整体上或部分地可以等同地实现在集成电路中，实现为在一台或多台计算机上运行的一个或多个计算机程序(例如，实现为在一台或多台计算机系统上运行的一个或多个程序)，实现为在一个或多个处理器上运行的一个或多个程序(例如，实现为在一个或多个微处理器上运行的一个或多个程序)，实现为固件，或者实质上实现为上述方式的任意组合，并且本领域技术人员根据本公开，将具备设计电路和/或写入软件和/或固件代码的能力。此外，本领域技术人员将认识到，本公开所述主题的机制能够作为多种形式的程序产品进行分发，并且无论实际用来执行分发的信号承载介质的具体类型如何，本公开所述主题的示例性实施例均适用。信号承载介质的示例包括但不限于：可记录型介质，如软盘、硬盘驱动器、紧致盘(CD)、数字通用盘(DVD)、数字磁带、计算机存储器等；以及传输型介质，如数字和/或模拟通信介质(例如，光纤光缆、波导、有线通信链路、无线通信链路等)。

尽管以上已经结合本发明的优选实施例示出了本发明，但是本领域的技术人员将会理解，在不脱离本发明的精神和范围的情况下，可以对本发明进行各种修改、替换和改变。因此，本发明不应由上述实施例来限定，而应由所附权利要求及其等价物来限定。

Claims (4)

1.一种基于xml的移动端接口地址管理方法，其特征在于包括以下步骤：

通过移动端系统平台的xml解析工具，将服务器配置文件解析成网络服务配置实体集合，并且将移动端接口地址配置文件解析成网络项目配置实体集合；

当移动端发起网络请求时，通过请求的接口的接口名称来匹配所述网络项目配置实体集合中的任一实例，作为项目A；

从所述项目A中，获取所述接口的配置信息，并根据所获取的配置信息来映射所述网络服务配置集合中的任一实例，作为服务A；

结合所述服务A与所述项目A来构成用于所述网络请求的请求串；以及

基于所述请求串来发送所述网络请求。

2.根据权利要求1所述的方法，其特征在于，

所述服务器配置文件和所述移动端接口地址配置文件中分别包括各自的配置规范说明信息。

3.根据权利要求1所述的方法，其特征在于，

所述服务器配置文件中包括服务器编号、服务器域名、服务器端口和超时时间，

所述移动端接口地址配置文件中包括接口名称、接口说明、请求方式和接口部署的服务器。

4.根据权利要求1所述的方法，其特征在于，

所述移动端接口地址配置文件中还包括表示请求是否加密的信息，

在移动端进行网络请求时，根据所述表示请求是否加密的信息，对传递的数据进行加解密处理。