CN115237388A - 接口转译方法、同步方法、装置、系统、介质和设备 - Google Patents
接口转译方法、同步方法、装置、系统、介质和设备 Download PDFInfo
- Publication number
- CN115237388A CN115237388A CN202210814927.3A CN202210814927A CN115237388A CN 115237388 A CN115237388 A CN 115237388A CN 202210814927 A CN202210814927 A CN 202210814927A CN 115237388 A CN115237388 A CN 115237388A
- Authority
- CN
- China
- Prior art keywords
- interface
- type
- change
- file
- warehouse
- Prior art date
- Legal status (The legal status is an assumption and is not a legal conclusion. Google has not performed a legal analysis and makes no representation as to the accuracy of the status listed.)
- Pending
Links
Images
Classifications
-
- G—PHYSICS
- G06—COMPUTING; CALCULATING OR COUNTING
- G06F—ELECTRIC DIGITAL DATA PROCESSING
- G06F8/00—Arrangements for software engineering
- G06F8/30—Creation or generation of source code
- G06F8/31—Programming languages or programming paradigms
-
- G—PHYSICS
- G06—COMPUTING; CALCULATING OR COUNTING
- G06F—ELECTRIC DIGITAL DATA PROCESSING
- G06F16/00—Information retrieval; Database structures therefor; File system structures therefor
- G06F16/20—Information retrieval; Database structures therefor; File system structures therefor of structured data, e.g. relational data
- G06F16/25—Integrating or interfacing systems involving database management systems
- G06F16/252—Integrating or interfacing systems involving database management systems between a Database Management System and a front-end application
-
- G—PHYSICS
- G06—COMPUTING; CALCULATING OR COUNTING
- G06F—ELECTRIC DIGITAL DATA PROCESSING
- G06F8/00—Arrangements for software engineering
- G06F8/40—Transformation of program code
- G06F8/41—Compilation
Landscapes
- Engineering & Computer Science (AREA)
- Theoretical Computer Science (AREA)
- General Engineering & Computer Science (AREA)
- Software Systems (AREA)
- Physics & Mathematics (AREA)
- General Physics & Mathematics (AREA)
- Databases & Information Systems (AREA)
- Data Mining & Analysis (AREA)
- Computing Systems (AREA)
- Information Retrieval, Db Structures And Fs Structures Therefor (AREA)
Abstract
本公开涉及一种接口转译方法、同步方法、装置、系统、介质和设备,该接口转译方法包括:获取服务端的IDL文件中发生接口变更的变更接口代码,确定变更接口代码中每个变更接口的类型关键字;根据每个变更接口的类型关键字确定对应的抽象类型;确定转译映射规则,根据转译映射规则确定每个抽象类型对应的类型关键字,获得每个变更接口对应于目标前端语言的目标类型关键字;根据每个变更接口对应的目标类型关键字,生成针对目标前端语言的变更接口类型文件。本公开能够较高效率地实现IDL至任意前端语言的接口类型的自动转译,且结合自动转译,确保前端和服务端之间的接口类型进行自动化对齐。
Description
技术领域
本公开涉及计算机技术领域,具体地,涉及一种接口转译方法、同步方法、装置、系统、介质和设备。
背景技术
在当下,基于RESTful实现的前后端分离的开发模式已经十分成熟并被广泛应用到大部分的互联网Web应用服务内。在这个模式下,前端和后端(即服务端)可以各自根据自身的使用场景和成本选择使用最合适的语言,双方之间基于接口的形式进行数据交互即可。
目前,服务端通常使用接口描述语言(InterfaceDescriptionLanguage,IDL)来描述接口,而前端方向使用较多的是基于JavaScript拓展的TypeScript语言(简称TS),TS中引入了类型系统,可帮助开发者基于类型判断提早发现问题。但在引入类型系统的同时,也引入了类型同步问题。在接入TS后,每当服务端新增一个接口,或者对接口进行较大篇幅的修改时,除去服务端需要更新自身的IDL文件外,由于前端的TS也引入了类型系统,因此前端也需要根据服务端修改的接口类型,用TS重新写对应的接口类型,可见前端与服务端之间接口类型的同步十分不便。
发明内容
提供该发明内容部分以便以简要的形式介绍构思,这些构思将在后面的具体实施方式部分被详细描述。该发明内容部分并不旨在标识要求保护的技术方案的关键特征或必要特征,也不旨在用于限制所要求的保护的技术方案的范围。
第一方面,本公开提供一种接口转译方法,包括:
获取服务端的接口描述语言IDL文件中发生接口变更的变更接口代码,确定所述变更接口代码中每个变更接口的类型关键字;
根据每个变更接口的类型关键字确定对应的抽象类型,所述抽象类型表征所述类型关键字的数据类型和字节大小;
确定转译映射规则,所述转译映射规则包括不同抽象类型与目标前端语言的类型关键字间的映射关系;
根据每个变更接口的抽象类型,从所述转译映射规则中确定对应的目标类型关键字;
根据每个变更接口对应的所述目标类型关键字,生成针对所述目标前端语言的变更接口类型文件。
第二方面,本公开提供一种接口同步方法,包括:
服务端仓库响应于接收到服务端的变更后的IDL文件,向管理中台发送同步通知;
管理中台响应于所述同步通知,执行如第一方面所述的接口转译方法,生成针对目标前端语言的变更接口类型文件,并根据所述变更接口类型文件向前端仓库发起合并请求;
前端仓库响应于所述合并请求,将所述变更接口类型文件与前端代码合并。
第三方面,本公开提供一种接口转译装置,包括:
变更获取模块,用于获取服务端的接口描述语言IDL文件中发生接口变更的变更接口代码,确定所述变更接口代码中每个变更接口的类型关键字;
类型抽象模块,用于根据每个变更接口的类型关键字确定对应的抽象类型,所述抽象类型表征所述类型关键字的数据类型和字节大小;
规则确定模块,用于确定转译映射规则,所述转译映射规则包括不同抽象类型与目标前端语言的类型关键字间的映射关系;
类型转译模块,用于根据每个变更接口的抽象类型,从所述转译映射规则中确定对应的目标类型关键字;
转译输出模块,用于根据每个变更接口对应的所述目标类型关键字,生成针对所述目标前端语言的变更接口类型文件。
第四方面,本公开提供一种接口同步系统,包括:
服务端仓库,用于响应于接收到服务端的变更后的IDL文件,向管理中台发送同步通知;
管理中台,用于响应于所述同步通知,执行如第一方面所述的接口转译方法,生成针对目标前端语言的变更接口类型文件,并根据所述变更接口类型文件向前端仓库发起合并请求;
前端仓库,用于响应于所述合并请求,将所述变更接口类型文件与前端代码合并。
第五方面,本公开提供一种计算机可读介质,其上存储有计算机程序,该程序被处理装置执行时实现第一方面所述的方法。
第六方面,本公开提供一种电子设备,包括:
存储装置,其上存储有计算机程序;
处理装置,用于执行所述存储装置中的所述计算机程序,以实现第一方面所述的方法。
通过上述技术方案,当服务端的IDL文件中的接口发生变更时,可以将各个变更接口的接口类型由IDL使用的类型自动地转为目标前端语言使用的类型,得到变更接口类型文件,从而无需开发者用TS重新写对应的接口类型,此外,结合接口转译方法,当服务端对IDL文件中的接口作出修改时,管理中台自动向前端提交合并请求,使得前端能够及时获知服务端对IDL文件的修改,从而方便、快捷地实现前端和服务端之间接口和接口类型的对齐。
本公开的其他特征和优点将在随后的具体实施方式部分予以详细说明。
附图说明
结合附图并参考以下具体实施方式,本公开各实施例的上述和其他特征、优点及方面将变得更加明显。贯穿附图中,相同或相似的附图标记表示相同或相似的元素。应当理解附图是示意性的,原件和元素不一定按照比例绘制。在附图中:
图1示出了一示例性实施例提供的接口转译方法的流程图;
图2至图3示出了对变更接口的类型关键字进行抽象和不抽象,需要维护的规则数量的对照示意图;
图4示出了一示例性实施例提供的接口同步方法的流程图;
图5示出了一示例性实施例中接口同步方法的具体实施方式的示意图;
图6示出了一示例性实施例提供的接口转译装置的框图;
图7示出了一示例性实施例提供的电子设备的框图。
具体实施方式
下面将参照附图更详细地描述本公开的实施例。虽然附图中显示了本公开的某些实施例,然而应当理解的是,本公开可以通过各种形式来实现,而且不应该被解释为限于这里阐述的实施例,相反提供这些实施例是为了更加透彻和完整地理解本公开。应当理解的是,本公开的附图及实施例仅用于示例性作用,并非用于限制本公开的保护范围。
应当理解,本公开的方法实施方式中记载的各个步骤可以按照不同的顺序执行,和/或并行执行。此外,方法实施方式可以包括附加的步骤和/或省略执行示出的步骤。本公开的范围在此方面不受限制。
本文使用的术语“包括”及其变形是开放性包括,即“包括但不限于”。术语“基于”是“至少部分地基于”。术语“一个实施例”表示“至少一个实施例”;术语“另一实施例”表示“至少一个另外的实施例”;术语“一些实施例”表示“至少一些实施例”。其他术语的相关定义将在下文描述中给出。
需要注意,本公开中提及的“第一”、“第二”等概念仅用于对不同的装置、模块或单元进行区分,并非用于限定这些装置、模块或单元所执行的功能的顺序或者相互依存关系。
需要注意,本公开中提及的“一个”、“多个”的修饰是示意性而非限制性的,本领域技术人员应当理解,除非在上下文另有明确指出,否则应该理解为“一个或多个”。
本公开实施方式中的多个装置之间所交互的消息或者信息的名称仅用于说明性的目的,而并不是用于对这些消息或信息的范围进行限制。
可以理解的是,在使用本公开各实施例公开的技术方案之前,均应当依据相关法律法规通过恰当的方式对本公开所涉及个人信息的类型、使用范围、使用场景等告知用户并获得用户的授权。
例如,在响应于接收到用户的主动请求时,向用户发送提示信息,以明确地提示用户,其请求执行的操作将需要获取和使用到用户的个人信息。从而,使得用户可以根据提示信息来自主地选择是否向执行本公开技术方案的操作的电子设备、应用程序、服务器或存储介质等软件或硬件提供个人信息。
作为一种可选的但非限定性的实现方式,响应于接收到用户的主动请求,向用户发送提示信息的方式例如可以是弹窗的方式,弹窗中可以以文字的方式呈现提示信息。此外,弹窗中还可以承载供用户选择“同意”或者“不同意”向电子设备提供个人信息的选择控件。
可以理解的是,上述通知和获取用户授权过程仅是示意性的,不对本公开的实现方式构成限定,其它满足相关法律法规的方式也可应用于本公开的实现方式中。
同时,可以理解的是,本技术方案所涉及的数据(包括但不限于数据本身、数据的获取或使用)应当遵循相应法律法规及相关规定的要求。
在介绍本公开的技术方案之前,对本公开中的一些术语进行说明:
TypeScript:简称TS,一种基于JavaScript(JS)拓展的增强语言,其特点在于弥补了JS没有静态类型的痛点,增加了开发期间对接口类型的判断,使其在编写大型项目时更稳定。
HTTP:HyperTextTransferProtocol(超文本传输协议),是互联网中标准的传输协议,该传输协议已经被广大浏览器作为基准支持到自身中。
RPC:RemoteProcedureCall(远程过程调用),通常用于机房内的设备/容器之间直接调用对方的方法时使用。由于调用方法时的数据是基于二进制传输的,所以相比HTTP而言更快。
IDL:InterfaceDescriptionLanguage(接口描述语言),如Thrift、Protobuf等,主要用于服务端通信交互的字段定义语言。由于服务器之间的通信通常分散在内部机房内,而内部机房的跨进程通信不必遵循互联网标准的HTTP传输协议进行通信,通常使用RPC方式进行通信。但RPC方式通信也需要描述数据本身的解析方式,因此服务端通常使用IDL来进行接口格式定义。
Git仓库:开发者可将开发好的代码提交到Git仓库中,进行代码托管。Git仓库中可供设置各种钩子函数,用于给开发者进行函数挂载操作。
如背景技术所述,服务端使用IDL来描述接口格式,与前端使用的TS不相通,导致前端无法直接复用IDL中的接口格式。每当服务端新增一个接口,或者对接口进行较大篇幅的修改时,除去服务端需要更新自身的IDL文件外,前端也需要根据服务端新增或修改的接口类型,用TS重新写对应的接口类型。因此,为解决前端引入TS后,不便于维护与服务端交互的接口类型的问题,本公开实施例提供一种接口转译方法。
图1示出了一示例性实施例提供的接口转译方法的流程图,请参照图1,该方法包括:
S101,获取服务端的IDL文件中发生接口变更的变更接口代码,确定该变更接口代码中每个变更接口的类型关键字。
其中,接口的变更包括新增接口、删除、修改接口等。
在获取服务端的IDL文件中发生接口变更的变更接口代码后,解析该变更接口代码,得到变更接口代码中每个变更接口的类型关键字。例如Thrift使用类型关键字i32来描述某个接口的类型,Protobuf使用类型关键字int32来描述某个接口的类型。
S102,根据每个变更接口的类型关键字确定对应的抽象类型,该抽象类型表征该类型关键字的数据类型和字节大小。
在得到变更接口代码中每个变更接口的类型关键字后,对该类型关键字表征的类型进行抽象,得到对应的抽象类型,该抽象类型表征该类型关键字的数据类型和字节大小。例如类型关键字i32对应的抽象类型为32位整数类型,类型关键字int32对应的抽象类型为32位整数类型。
S103,确定转译映射规则,该转译映射规则包括不同抽象类型与目标前端语言的类型关键字间的映射关系。
S104,根据每个变更接口的抽象类型,从该转译映射规则中确定对应的目标类型关键字。
其中,转译映射规则中包括不同抽象类型与目标前端语言的类型关键字间的映射关系,可选地,还包括不同抽象类型与其他各种前端语言的类型关键字间的映射关系。例如,转译映射规则中包括不同抽象类型分别与TS、Python、C++、Golang等不同前端语言所使用的类型关键字间的映射关系。
在本公开中,目标前端语言可以是前端当前使用的语言,以目标前端语言为TS为例,对于32位整数类型,TS使用的接口类型是标准的number,对于64位整数类型,TS使用的接口类型则是bigint。因此在该转译映射规则中,抽象类型(32位整数类型)对应于TS的类型关键字是number,抽象类型(64位整数类型)对应于TS的类型关键字是bigint。从而,当某个变更接口的抽象类型为32位整数类型时,确定该变更接口对应于TS的目标类型关键字是number,当某个变更接口的抽象类型为64位整数类型时,确定该变更接口对应于TS的目标类型关键字为bigint。按照这种方式,最终确定出每个变更接口对应于目标前端语言的目标类型关键字。
当然,若前端当前使用的语言为其他语言,如Python,则目标前端语言也相应变化,从而根据转译映射规则,确定每个变更接口对应于Python的目标类型关键字。
S105,根据每个变更接口对应的目标类型关键字,生成针对目标前端语言的变更接口类型文件。
在确定每个变更接口对应于目标前端语言的目标类型关键字后,根据每个变更接口对应的目标类型关键字,生成针对目标前端语言的变更接口类型文件,如针对TS的变更接口类型文件。
通过以上步骤,当服务端的IDL文件中的接口发生变更时,可以将各个变更接口的接口类型由IDL使用的类型自动地转为目标前端语言使用的类型,得到变更接口类型文件,从而无需开发者用TS重新写对应的接口类型,极大方便了对前端的接口类型的维护,大大节省维护成本,开发者只需维护前端语言的转译映射规则即可。上述实施例中的接口转译方法具有通用性,可以通用化至任意的前端语言,包括但不限于TS。
此外,在上述步骤S102~S104中,对变更接口的类型关键字进行抽象,根据抽象类型来确定每个变更接口对应于目标前端语言的目标类型关键字,实现将IDL与前端语言进行解耦,有利于进一步降低维护成本。
如图2~图3所示,假设IDL共有M种且前端语言共有N种,通过对变更接口的类型关键字进行抽象,本方案需要维护的规则包括:M套由IDL的类型关键字映射到抽象类型的规则,和N套由抽象类型到具体前端语言的类型关键字的规则(即转译映射规则),共维护M+N套规则。如果不对变更接口的类型关键字进行抽象,则针对每种前端语言,需要维护由M种IDL的类型关键字分别映射到具体前端语言的类型关键字的规则,共需要维护M×N套规则。可见,本方案的维护成本明显较低。
进一步地,服务端的开发者对IDL文件中的接口进行新增、删除、修改等接口变更后,将变更后的IDL文件提交到服务端仓库,于是服务端仓库触发发送同步通知。
在步骤S101中,响应于服务端仓库发送的同步通知,确定该同步通知中携带的代码分支信息;其中,该同步通知为服务端仓库响应于接收到服务端的变更后的IDL文件后发送的,该代码分支信息用于指示发生接口变更的代码分支,然后根据该代码分支信息从服务端仓库中读取对应代码分支的IDL文件,将读取的IDL文件与自身记录的对应代码分支的IDL文件进行对比,获得发生接口变更的变更接口代码。此外,更新自身记录的对应代码分支的IDL文件,以便于下一次对比。
进一步地,为解决前端与服务端的接口类型的同步问题,本公开实施例提供接口同步系统。该接口同步系统包括服务端仓库、前端仓库和管理中台。服务端仓库用于存储服务端代码,前端仓库用于存储前端代码,服务端仓库和前端仓库可以是Git仓库。
基于上述接口同步系统,本公开实施例还提供相应的接口同步方法。图4示出了一示例性实施例提供的接口同步方法的流程图。请参照图4,该方法包括:
S201,服务端仓库响应于接收到服务端的变更后的IDL文件,向管理中台发送同步通知。
其中,服务端的开发者对IDL文件中的接口进行新增、删除、修改等接口变更后,将变更后的IDL文件提交到服务端仓库。服务端仓库响应于接收到变更后的IDL文件,向管理中台发送同步通知。
在具体的实施方式中,预先在服务端仓库中设置钩子函数,该钩子函数被构造为当捕获服务端仓库接收到变更后的IDL文件的目标事件,在系统中挂载通知方法。服务端仓库通过钩子函数捕获到目标事件后,在系统中挂载该通知方法,并通过该通知方法向管理中台发送同步通知。从而,一旦服务端的开发者将变更后的IDL文件提交到服务端仓库,服务端仓库可以及时向管理中台发送同步通知。
S202,管理中台响应于该同步通知,获得服务端的IDL文件中发生接口变更的变更接口代码,根据该变更接口代码生成针对目标前端语言的变更接口类型文件,并根据该变更接口类型文件向前端仓库发起合并请求。
具体地,管理中台响应于该同步通知,执行本公开前述提供的接口转译方法,从而生成针对目标前端语言的变更接口类型文件。在本公开中,目标前端语言可以是前端当前使用的语言,如TS。
具体地,管理中台响应于该同步通知,获得服务端的IDL文件中发生接口变更的变更接口代码,确定变更接口代码中每个变更接口的类型关键字,根据每个变更接口的类型关键字确定对应的抽象类型,然后确定转译映射规则,根据该转译映射规则确定每个抽象类型对应的类型关键字,获得每个变更接口对应于目标前端语言的目标类型关键字,最终根据每个变更接口对应的目标类型关键字,生成针对目标前端语言的变更接口类型文件。之后,向前端仓库发送变更接口类型文件和合并请求。
S203,前端仓库响应于该合并请求,将该变更接口类型文件与前端代码合并。
可选地,前端仓库响应于管理中台发起的合并请求,通知用户进行合并确认,该合并确认用于校验该变更接口类型文件的本次合并是否影响前端代码的业务逻辑,如果该变更接口类型文件的本次合并不影响前端代码的业务逻辑,则用户作出确认合并操作,如点击“确认合并”的按钮,前端仓库响应于该确认合并操作,将该变更接口类型文件与前端代码合并。
如果接口类型变更的合并会影响前端代码的业务逻辑,则需要由开发者处理本次合并引入的冲突后,再进行合并。例如,在服务端的IDL文件中,原本共有接口代码1、接口代码2和接口代码3,在将原本的接口代码3修改为接口代码4后,变更为接口代码1、接口代码2和接口代码4。于是管理中台获取到关于接口代码4的变更接口代码,生成相应的变更接口类型文件,并发送到前端仓库。前端仓库在收到变更接口类型文件后,如果直接将变更接口类型文件与前端代码进行合并,由于前端代码中仍然保留有依赖接口代码3的业务逻辑,那么此时因丢失了关于接口代码3的接口定义,可能导致代码运行出错,所以需要由开发者处理本次合并与原有业务逻辑间的冲突后,再进行合并。
按照以上步骤,即可完成服务端与前端之间接口的同步,后续服务端的接口再有新的变更,则重复以上步骤即可自动地将服务端的接口变更同步到前端。
上述方案中,通过管理中台对变更接口的类型进行自动转译,生成针对目标前端语言的变更接口类型文件,并主动向前端仓库推送变更接口类型文件和合并请求,使得服务端与前端的接口类型的同步基本不再需要通过人为通知的形式进行维护,而是能够以基本全自动化的方式进行维护,方便、快捷地实现了前端与服务端之间接口的对齐。此外,也可以按照半自动化的方式进行维护,前端仓库在收到变更接口类型文件和合并请求后,仅需要开发者确认变更接口类型文件的合并是否对业务逻辑产生影响,即可在不影响业务逻辑的情况下完成合并。
在具体的实施例中,服务端仓库和前端仓库采取多分支形式进行维护,不同分支的代码功能和代码版本可能不同。
在步骤S201中,当服务端的开发者将变更后的IDL文件提交到服务端仓库后,服务端仓库通过钩子函数捕获到接收到变更后的IDL文件的目标事件,在系统中挂载通知方法,通过该通知方法向管理中台发送同步通知,该同步通知中携带发生接口变更的代码分支信息,例如,发生接口变更的代码分支信息包括分支A、分支B和分支C。
在步骤S202中,管理中台在收到同步通知后,根据同步通知中携带的代码分支信息从服务端仓库中读取对应代码分支的IDL文件,获得分支A、分支B和分支C的IDL文件,将分支A的IDL文件与自身记录的分支A的IDL文件进行对比,获得分支A的变更接口代码,并按照相同方式获得分支B和C的变更接口代码,然后将分支A、B和C的变更接口代码整合为一个总变更接口代码。对总变更接口代码中的每个变更接口的类型进行转译,生成针对目标前端语言的总变更接口类型文件,并向前端仓库发送总变更接口类型文件和合并请求。
在步骤S203中,前端仓库在收到管理中台发送的总变更接口类型文件和合并请求后,响应于该合并请求,将总变更接口类型文件合并到前端代码的主分支上。
在一种示例性场景中,服务端开发者可能在三个分支上并行地进行三个需求的开发,以支持三个不同的新的特性,每个特性新增的接口字段都不相同,如分支A的特性新增字段e,分支B的特性新增字段f,分支C的特性新增字段g。管理中台对不同分支的变更接口代码进行整合,得到关于e、f和g的总变更接口代码,再对总变更接口代码进行转译,得到总变更接口类型文件,再将总变更接口类型文件合并到前端主分支上,相当于将服务端的三个特性的变更合集统一合并到前端主分支上。这样,无论后续前端开发者需要从这一个主分支中抽出一个子分支作为特性A,或者特性B,或者特性C的开发,都可以保证里面的接口类型文件是一定能够将A、B、C这三个特性所新增的接口囊括进去,有利于后续的开发过程。
图5示出了一示例性实施例中接口同步方法的具体实施方式的示意图,请参照图5,该具体实施方式包括:
①服务端注册
服务端仓库在管理中台中进行注册,管理中台在完成对服务端仓库的注册后,向服务端仓库请求仓库权限,并在获得仓库权限后,对服务端仓库内的IDL文件进行扫描,对扫描出的IDL文件进行记录。
②前端注册及订阅
前端仓库同样在管理中台中进行注册,在完成注册后,前端仓库可以从管理中台获取服务端仓库注册的项目,并且可以选择订阅项目,订阅后管理中台建立服务端仓库与前端仓库间关于该项目的依赖关系,当服务端仓库中,被订阅项目的IDL文件发生接口变更后,管理中台能够基于依赖关系将IDL文件中的接口变更自动转译为目标前端语言的变更接口类型文件,并同步到该前端仓库中。
③触发IDL更新
服务端开发者对服务端的IDL文件中的接口进行新增、删除、修改等接口变更后,将变更后的IDL文件提交到服务端仓库,从而触发IDL更新。
④通知中台
服务端仓库通过钩子函数捕获自身接收到变更后的IDL文件的目标事件后,在系统中挂载通知方法,并通过该通知方法向管理中台发送同步通知,该同步通知中携带发生接口变更的代码分支信息。
⑤转换语言,发起合并请求
管理中台响应于该同步通知,根据该同步通知中的代码分支信息获取服务端的IDL文件中发生接口变更的总变更接口代码,根据总变更接口代码生成针对目标前端语言的总变更接口类型文件,并根据总变更接口类型文件向前端仓库发起合并请求。
⑥通知开发者
前端仓库响应于管理中台发起的合并请求,通知前端开发者进行合并确认,以校验总变更接口类型文件的本次合并是否影响前端代码的业务逻辑。
⑦处理合并请求,触发合并
若前端开发者确认总变更接口类型文件的本次合并不影响前端代码的业务逻辑,则作出确认合并操作,前端仓库响应于该确认合并操作,将总变更接口类型文件合并到前端代码的主分支上。若前端开发者确认总变更接口类型文件的本次合并会影响前端代码的业务逻辑,则需要由前端开发者处理本次合并引入的冲突后,再作出确认合并操作。
基于上述步骤,完成整个接口同步流程,后续当服务端有新的接口变更,则重复上述步骤③~⑦即可自动完成服务端接口变更与前端接口的同步。
综上所述,本公开提供的接口转译方法,能够较高效率地实现IDL至任意前端语言的接口类型的自动转译。结合自动转译,本公开提供的接口同步方法,确保前端和服务端之间的接口类型进行自动化对齐,当服务端对IDL文件中的接口作出修改时,管理中台自动向前端提交变更接口类型文件和合并请求,使得前端能够及时获知服务端对IDL文件的修改,前端开发者仅需要基于合并请求确保业务稳定性后即可对变更接口类型文件进行合并,从而便捷实现前端和服务端之间接口和接口类型的对齐。
图6示出了一示例性实施例提供的接口转译装置的框图,请参照图6,该接口转译装置300包括:
变更获取模块301,用于获取服务端的IDL文件中发生接口变更的变更接口代码,确定所述变更接口代码中每个变更接口的类型关键字;
类型抽象模块302,用于根据每个变更接口的类型关键字确定对应的抽象类型,所述抽象类型表征所述类型关键字的数据类型和字节大小;
规则确定模块303,用于确定转译映射规则,所述转译映射规则包括不同抽象类型与目标前端语言的类型关键字间的映射关系;
类型转译模块304,用于根据每个变更接口的抽象类型,从所述转译映射规则中确定对应的目标类型关键字;
转译输出模块305,用于根据每个变更接口对应的所述目标类型关键字,生成针对所述目标前端语言的变更接口类型文件。
可选地,变更获取模块301包括:
通知响应模块,用于响应于服务端仓库发送的同步通知,确定所述同步通知中携带的代码分支信息;其中,所述同步通知为服务端仓库响应于接收到服务端的变更后的IDL文件后发送的,所述代码分支信息用于指示发生接口变更的代码分支;
变更获得模块,用于根据所述代码分支信息从所述服务端仓库中读取对应代码分支的IDL文件,将读取的IDL文件与自身记录的所述对应代码分支的IDL文件进行对比,获得发生接口变更的变更接口代码;
IDL更新模块,用于更新自身记录的所述对应代码分支的IDL文件。
关于上述实施例中的装置,其中各个模块执行操作的具体方式已经在有关该方法的实施例中进行了详细描述,此处将不做详细阐述说明。
在一示例性实施例中,提供一种计算机可读介质,其上存储有计算机程序,该程序被处理装置执行时实现本公开提供的接口转译方法。
在一示例性实施例中,提供一种电子设备,包括:
存储装置,其上存储有计算机程序;
处理装置,用于执行所述存储装置中的所述计算机程序,以实现本公开提供的接口转译方法。
下面参考图7,其示出了适于用来实现本公开实施例的电子设备600的框图。本公开实施例中的电子设备可以包括但不限于诸如服务器、服务器集群、笔记本电脑、PAD(平板电脑)、台式计算机等。图7示出的电子设备仅仅是一个示例,不应对本公开实施例的功能和使用范围带来任何限制。
如图7所示,电子设备600可以包括处理装置(例如中央处理器、图形处理器等)601,其可以根据存储在只读存储器(ROM)602中的程序或者从存储装置608加载到随机访问存储器(RAM)603中的程序而执行各种适当的动作和处理。在RAM 603中,还存储有电子设备600操作所需的各种程序和数据。处理装置601、ROM 602以及RAM 603通过总线604彼此相连。输入/输出(I/O)接口605也连接至总线604。
通常,以下装置可以连接至I/O接口605:包括例如触摸屏、触摸板、键盘、鼠标、摄像头、麦克风、加速度计、陀螺仪等的输入装置606;包括例如液晶显示器(LCD)、扬声器、振动器等的输出装置607;包括例如磁带、硬盘等的存储装置608;以及通信装置609。通信装置609可以允许电子设备600与其他设备进行无线或有线通信以交换数据。虽然图7示出了具有各种装置的电子设备600,但是应理解的是,并不要求实施或具备所有示出的装置。可以替代地实施或具备更多或更少的装置。
特别地,根据本公开的实施例,上文参考流程图描述的过程可以被实现为计算机软件程序。例如,本公开的实施例包括一种计算机程序产品,其包括承载在非暂态计算机可读介质上的计算机程序,该计算机程序包含用于执行流程图所示的方法的程序代码。在这样的实施例中,该计算机程序可以通过通信装置609从网络上被下载和安装,或者从存储装置608被安装,或者从ROM 602被安装。在该计算机程序被处理装置601执行时,执行本公开实施例的方法中限定的上述功能。
需要说明的是,本公开上述的计算机可读介质可以是计算机可读信号介质或者计算机可读存储介质或者是上述两者的任意组合。计算机可读存储介质例如可以是——但不限于——电、磁、光、电磁、红外线、或半导体的系统、装置或器件,或者任意以上的组合。计算机可读存储介质的更具体的例子可以包括但不限于:具有一个或多个导线的电连接、便携式计算机磁盘、硬盘、随机访问存储器(RAM)、只读存储器(ROM)、可擦式可编程只读存储器(EPROM或闪存)、光纤、便携式紧凑磁盘只读存储器(CD-ROM)、光存储器件、磁存储器件、或者上述的任意合适的组合。在本公开中,计算机可读存储介质可以是任何包含或存储程序的有形介质,该程序可以被指令执行系统、装置或者器件使用或者与其结合使用。而在本公开中,计算机可读信号介质可以包括在基带中或者作为载波一部分传播的数据信号,其中承载了计算机可读的程序代码。这种传播的数据信号可以采用多种形式,包括但不限于电磁信号、光信号或上述的任意合适的组合。计算机可读信号介质还可以是计算机可读存储介质以外的任何计算机可读介质,该计算机可读信号介质可以发送、传播或者传输用于由指令执行系统、装置或者器件使用或者与其结合使用的程序。计算机可读介质上包含的程序代码可以用任何适当的介质传输,包括但不限于:电线、光缆、RF(射频)等等,或者上述的任意合适的组合。
上述计算机可读介质可以是上述电子设备中所包含的;也可以是单独存在,而未装配入该电子设备中。
上述计算机可读介质承载有一个或者多个程序,当上述一个或者多个程序被该电子设备执行时,使得该电子设备:获取服务端的接口描述语言IDL文件中发生接口变更的变更接口代码,确定所述变更接口代码中每个变更接口的类型关键字;根据每个变更接口的类型关键字确定对应的抽象类型,所述抽象类型表征所述类型关键字的数据类型和字节大小;确定转译映射规则,所述转译映射规则包括不同抽象类型与目标前端语言的类型关键字间的映射关系;根据每个变更接口的抽象类型,从所述转译映射规则中确定对应的目标类型关键字;根据每个变更接口对应的所述目标类型关键字,生成针对所述目标前端语言的变更接口类型文件。
可以以一种或多种程序设计语言或其组合来编写用于执行本公开的操作的计算机程序代码,上述程序设计语言包括但不限于面向对象的程序设计语言—诸如Java、Smalltalk、C++,还包括常规的过程式程序设计语言——诸如“C”语言或类似的程序设计语言。程序代码可以完全地在用户计算机上执行、部分地在用户计算机上执行、作为一个独立的软件包执行、部分在用户计算机上部分在远程计算机上执行、或者完全在远程计算机或服务器上执行。在涉及远程计算机的情形中,远程计算机可以通过任意种类的网络——包括局域网(LAN)或广域网(WAN)——连接到用户计算机,或者,可以连接到外部计算机(例如利用因特网服务提供商来通过因特网连接)。
附图中的流程图和框图,图示了按照本公开各种实施例的系统、方法和计算机程序产品的可能实现的体系架构、功能和操作。在这点上,流程图或框图中的每个方框可以代表一个模块、程序段、或代码的一部分,该模块、程序段、或代码的一部分包含一个或多个用于实现规定的逻辑功能的可执行指令。也应当注意,在有些作为替换的实现中,方框中所标注的功能也可以以不同于附图中所标注的顺序发生。例如,两个接连地表示的方框实际上可以基本并行地执行,它们有时也可以按相反的顺序执行,这依所涉及的功能而定。也要注意的是,框图和/或流程图中的每个方框、以及框图和/或流程图中的方框的组合,可以用执行规定的功能或操作的专用的基于硬件的系统来实现,或者可以用专用硬件与计算机指令的组合来实现。
描述于本公开实施例中所涉及到的模块可以通过软件的方式实现,也可以通过硬件的方式来实现。其中,模块的名称在某种情况下并不构成对该模块本身的限定,例如,变更获取模块还可以被描述为“获取服务端的IDL文件中发生接口变更的变更接口代码的模块”。
本文中以上描述的功能可以至少部分地由一个或多个硬件逻辑部件来执行。例如,非限制性地,可以使用的示范类型的硬件逻辑部件包括:现场可编程门阵列(FPGA)、专用集成电路(ASIC)、专用标准产品(ASSP)、片上系统(SOC)、复杂可编程逻辑设备(CPLD)等等。
在本公开的上下文中,机器可读介质可以是有形的介质,其可以包含或存储以供指令执行系统、装置或设备使用或与指令执行系统、装置或设备结合地使用的程序。机器可读介质可以是机器可读信号介质或机器可读储存介质。机器可读介质可以包括但不限于电子的、磁性的、光学的、电磁的、红外的、或半导体系统、装置或设备,或者上述内容的任何合适组合。机器可读存储介质的更具体示例会包括基于一个或多个线的电气连接、便携式计算机盘、硬盘、随机存取存储器(RAM)、只读存储器(ROM)、可擦除可编程只读存储器(EPROM或快闪存储器)、光纤、便捷式紧凑盘只读存储器(CD-ROM)、光学储存设备、磁储存设备、或上述内容的任何合适组合。
根据本公开的一个或多个实施例,示例1提供了一种接口转译方法,包括:
获取服务端的接口描述语言IDL文件中发生接口变更的变更接口代码,确定所述变更接口代码中每个变更接口的类型关键字;
根据每个变更接口的类型关键字确定对应的抽象类型,所述抽象类型表征所述类型关键字的数据类型和字节大小;
确定转译映射规则,所述转译映射规则包括不同抽象类型与目标前端语言的类型关键字间的映射关系;
根据每个变更接口的抽象类型,从所述转译映射规则中确定对应的目标类型关键字;
根据每个变更接口对应的所述目标类型关键字,生成针对所述目标前端语言的变更接口类型文件。
根据本公开的一个或多个实施例,示例2提供了示例1的方法,所述获取服务端的接口描述语言IDL文件中发生接口变更的变更接口代码,包括:
响应于服务端仓库发送的同步通知,确定所述同步通知中携带的代码分支信息;其中,所述同步通知为服务端仓库响应于接收到服务端的变更后的IDL文件后发送的,所述代码分支信息用于指示发生接口变更的代码分支;
根据所述代码分支信息从所述服务端仓库中读取对应代码分支的IDL文件,将读取的IDL文件与自身记录的所述对应代码分支的IDL文件进行对比,获得发生接口变更的变更接口代码;
更新自身记录的所述对应代码分支的IDL文件。
根据本公开的一个或多个实施例,示例3提供了一种接口同步方法,包括:
服务端仓库响应于接收到服务端的变更后的IDL文件,向管理中台发送同步通知;
管理中台响应于所述同步通知,执行如示例1或示例2的接口转译方法,生成针对目标前端语言的变更接口类型文件,并根据所述变更接口类型文件向前端仓库发起合并请求;
前端仓库响应于所述合并请求,将所述变更接口类型文件与前端代码合并。
根据本公开的一个或多个实施例,示例4提供了示例3的方法,所述前端仓库响应于所述合并请求,将所述变更接口类型文件与前端代码合并,包括:
所述前端仓库响应于所述合并请求,通知用户进行合并确认,所述合并确认用于校验所述变更接口类型文件的合并是否影响前端代码的业务逻辑;
所述前端仓库响应于确认合并操作,将所述变更接口类型文件与前端代码合并,其中,所述确认合并操作是用户确认所述变更接口类型文件的合并不影响前端代码的业务逻辑后作出的。
根据本公开的一个或多个实施例,示例5提供了示例3的方法,还包括:
在所述服务端仓库中设置钩子函数,所述钩子函数被构造为当捕获所述服务端仓库接收到变更后的IDL文件的目标事件,在系统中挂载通知方法;
所述服务端仓库响应于接收到服务端的变更后的IDL文件,向管理中台发送同步通知,包括:
所述服务端仓库通过钩子函数捕获到所述目标事件后,在系统中挂载所述通知方法,并通过所述通知方法向所述管理中台发送所述同步通知。
根据本公开的一个或多个实施例,示例6提供了示例3的方法,还包括:
所述服务端仓库在所述管理中台中进行注册;
所述管理中台在完成对所述服务端仓库的注册后,向所述服务端仓库请求仓库权限,并在获得仓库权限后,对所述服务端仓库内的IDL文件进行扫描,对扫描出的IDL文件进行记录。
根据本公开的一个或多个实施例,示例7提供了一种接口转译装置,包括:
变更获取模块,用于获取服务端的接口描述语言IDL文件中发生接口变更的变更接口代码,确定所述变更接口代码中每个变更接口的类型关键字;
类型抽象模块,用于根据每个变更接口的类型关键字确定对应的抽象类型,所述抽象类型表征所述类型关键字的数据类型和字节大小;
规则确定模块,用于确定转译映射规则,所述转译映射规则包括不同抽象类型与目标前端语言的类型关键字间的映射关系;
类型转译模块,用于根据每个变更接口的抽象类型,从所述转译映射规则中确定对应的目标类型关键字;
转译输出模块,用于根据每个变更接口对应的所述目标类型关键字,生成针对所述目标前端语言的变更接口类型文件。
根据本公开的一个或多个实施例,示例8提供了一种接口同步系统,包括:
服务端仓库,用于响应于接收到服务端的变更后的IDL文件,向管理中台发送同步通知;
管理中台,用于响应于所述同步通知,执行如示例1或示例2的方法,生成针对目标前端语言的变更接口类型文件,并根据所述变更接口类型文件向前端仓库发起合并请求;
前端仓库,用于响应于所述合并请求,将所述变更接口类型文件与前端代码合并。
根据本公开的一个或多个实施例,示例9提供了一种计算机可读介质,其上存储有计算机程序,该程序被处理装置执行时实现示例1或示例2的方法。
根据本公开的一个或多个实施例,示例10提供了一种电子设备,包括:
存储装置,其上存储有计算机程序;
处理装置,用于执行所述存储装置中的所述计算机程序,以实现示例1或示例2的方法。
以上描述仅为本公开的较佳实施例以及对所运用技术原理的说明。本领域技术人员应当理解,本公开中所涉及的公开范围,并不限于上述技术特征的特定组合而成的技术方案,同时也应涵盖在不脱离上述公开构思的情况下,由上述技术特征或其等同特征进行任意组合而形成的其它技术方案。例如上述特征与本公开中公开的(但不限于)具有类似功能的技术特征进行互相替换而形成的技术方案。
此外,虽然采用特定次序描绘了各操作,但是这不应当理解为要求这些操作以所示出的特定次序或以顺序次序执行来执行。在一定环境下,多任务和并行处理可能是有利的。同样地,虽然在上面论述中包含了若干具体实现细节,但是这些不应当被解释为对本公开的范围的限制。在单独的实施例的上下文中描述的某些特征还可以组合地实现在单个实施例中。相反地,在单个实施例的上下文中描述的各种特征也可以单独地或以任何合适的子组合的方式实现在多个实施例中。
尽管已经采用特定于结构特征和/或方法逻辑动作的语言描述了本主题,但是应当理解所附权利要求书中所限定的主题未必局限于上面描述的特定特征或动作。相反,上面所描述的特定特征和动作仅仅是实现权利要求书的示例形式。
Claims (10)
1.一种接口转译方法,其特征在于,包括:
获取服务端的接口描述语言IDL文件中发生接口变更的变更接口代码,确定所述变更接口代码中每个变更接口的类型关键字;
根据每个变更接口的类型关键字确定对应的抽象类型,所述抽象类型表征所述类型关键字的数据类型和字节大小;
确定转译映射规则,所述转译映射规则包括不同抽象类型与目标前端语言的类型关键字间的映射关系;
根据每个变更接口的抽象类型,从所述转译映射规则中确定对应的目标类型关键字;
根据每个变更接口对应的所述目标类型关键字,生成针对所述目标前端语言的变更接口类型文件。
2.根据权利要求1所述的方法,其特征在于,所述获取服务端的接口描述语言IDL文件中发生接口变更的变更接口代码,包括:
响应于服务端仓库发送的同步通知,确定所述同步通知中携带的代码分支信息;其中,所述同步通知为服务端仓库响应于接收到服务端的变更后的IDL文件后发送的,所述代码分支信息用于指示发生接口变更的代码分支;
根据所述代码分支信息从所述服务端仓库中读取对应代码分支的IDL文件,将读取的IDL文件与自身记录的所述对应代码分支的IDL文件进行对比,获得发生接口变更的变更接口代码;
更新自身记录的所述对应代码分支的IDL文件。
3.一种接口同步方法,其特征在于,包括:
服务端仓库响应于接收到服务端的变更后的IDL文件,向管理中台发送同步通知;
管理中台响应于所述同步通知,执行如权利要求1或2所述的接口转译方法,生成针对目标前端语言的变更接口类型文件,并根据所述变更接口类型文件向前端仓库发起合并请求;
前端仓库响应于所述合并请求,将所述变更接口类型文件与前端代码合并。
4.根据权利要求3所述的方法,其特征在于,所述前端仓库响应于所述合并请求,将所述变更接口类型文件与前端代码合并,包括:
所述前端仓库响应于所述合并请求,通知用户进行合并确认,所述合并确认用于校验所述变更接口类型文件的合并是否影响前端代码的业务逻辑;
所述前端仓库响应于确认合并操作,将所述变更接口类型文件与前端代码合并,其中,所述确认合并操作是用户确认所述变更接口类型文件的合并不影响前端代码的业务逻辑后作出的。
5.根据权利要求3所述的方法,其特征在于,所述方法还包括:
在所述服务端仓库中设置钩子函数,所述钩子函数被构造为当捕获所述服务端仓库接收到变更后的IDL文件的目标事件,在系统中挂载通知方法;
所述服务端仓库响应于接收到服务端的变更后的IDL文件,向管理中台发送同步通知,包括:
所述服务端仓库通过钩子函数捕获到所述目标事件后,在系统中挂载所述通知方法,并通过所述通知方法向所述管理中台发送所述同步通知。
6.根据权利要求3所述的方法,其特征在于,所述方法还包括:
所述服务端仓库在所述管理中台中进行注册;
所述管理中台在完成对所述服务端仓库的注册后,向所述服务端仓库请求仓库权限,并在获得仓库权限后,对所述服务端仓库内的IDL文件进行扫描,对扫描出的IDL文件进行记录。
7.一种接口转译装置,其特征在于,包括:
变更获取模块,用于获取服务端的接口描述语言IDL文件中发生接口变更的变更接口代码,确定所述变更接口代码中每个变更接口的类型关键字;
类型抽象模块,用于根据每个变更接口的类型关键字确定对应的抽象类型,所述抽象类型表征所述类型关键字的数据类型和字节大小;
规则确定模块,用于确定转译映射规则,所述转译映射规则包括不同抽象类型与目标前端语言的类型关键字间的映射关系;
类型转译模块,用于根据每个变更接口的抽象类型,从所述转译映射规则中确定对应的目标类型关键字;
转译输出模块,用于根据每个变更接口对应的所述目标类型关键字,生成针对所述目标前端语言的变更接口类型文件。
8.一种接口同步系统,其特征在于,包括:
服务端仓库,用于响应于接收到服务端的变更后的IDL文件,向管理中台发送同步通知;
管理中台,用于响应于所述同步通知,执行如权利要求1或2所述的接口转译方法,生成针对目标前端语言的变更接口类型文件,并根据所述变更接口类型文件向前端仓库发起合并请求;
前端仓库,用于响应于所述合并请求,将所述变更接口类型文件与前端代码合并。
9.一种计算机可读介质,其上存储有计算机程序,其特征在于,该程序被处理装置执行时实现权利要求1或2所述的方法。
10.一种电子设备,其特征在于,包括:
存储装置,其上存储有计算机程序;
处理装置,用于执行所述存储装置中的所述计算机程序,以实现权利要求1或2所述的方法。
Priority Applications (1)
Application Number | Priority Date | Filing Date | Title |
---|---|---|---|
CN202210814927.3A CN115237388A (zh) | 2022-07-11 | 2022-07-11 | 接口转译方法、同步方法、装置、系统、介质和设备 |
Applications Claiming Priority (1)
Application Number | Priority Date | Filing Date | Title |
---|---|---|---|
CN202210814927.3A CN115237388A (zh) | 2022-07-11 | 2022-07-11 | 接口转译方法、同步方法、装置、系统、介质和设备 |
Publications (1)
Publication Number | Publication Date |
---|---|
CN115237388A true CN115237388A (zh) | 2022-10-25 |
Family
ID=83673976
Family Applications (1)
Application Number | Title | Priority Date | Filing Date |
---|---|---|---|
CN202210814927.3A Pending CN115237388A (zh) | 2022-07-11 | 2022-07-11 | 接口转译方法、同步方法、装置、系统、介质和设备 |
Country Status (1)
Country | Link |
---|---|
CN (1) | CN115237388A (zh) |
-
2022
- 2022-07-11 CN CN202210814927.3A patent/CN115237388A/zh active Pending
Similar Documents
Publication | Publication Date | Title |
---|---|---|
CN113220693B (zh) | 计算存储分离系统及其数据访问方法、介质和电子设备 | |
CN110019350A (zh) | 基于配置信息的数据查询方法和装置 | |
CN111291103B (zh) | 接口数据的解析方法、装置、电子设备及存储介质 | |
CN111679990B (zh) | 测试数据生成方法、装置、可读介质及电子设备 | |
CN111930534A (zh) | 数据调用方法、装置和电子设备 | |
CN111309747A (zh) | 数据同步方法、系统和装置 | |
CN111338944B (zh) | 远程过程调用rpc接口测试方法、装置、介质及设备 | |
CN112579928A (zh) | 页面跳转方法、装置、计算机设备及计算机可读存储介质 | |
CN111881216A (zh) | 一种基于共享模板的数据获取方法和装置 | |
CN109981546B (zh) | 获取应用模块间的远程调用关系的方法和装置 | |
CN111414161B (zh) | 一种生成idl文件的方法、装置、介质和电子设备 | |
CN115237388A (zh) | 接口转译方法、同步方法、装置、系统、介质和设备 | |
CN111460020B (zh) | 用于解析消息的方法、装置、电子设备和介质 | |
CN112783903B (zh) | 生成更新日志的方法和装置 | |
CN114115941A (zh) | 资源发送方法、页面渲染方法、装置、电子设备和介质 | |
CN113761075A (zh) | 切换数据库的方法、装置、设备和计算机可读介质 | |
CN118035594B (zh) | 生产文档访问方法、装置、电子设备与计算机可读介质 | |
CN114253520B (zh) | 接口代码生成方法和装置 | |
CN114356788B (zh) | 基于用户信息的应用程序检测方法、装置、设备和介质 | |
US20240152504A1 (en) | Data interaction method, apparatus, and electronic device | |
CN108984189B (zh) | 模块解析的方法和装置 | |
CN112286773A (zh) | 一种崩溃信息的收集方法、装置、介质和电子设备 | |
CN118012397A (zh) | 数据管理方法、介质以及电子设备 | |
CN116755796A (zh) | 插件管理方法、装置、介质和电子设备 | |
CN115705193A (zh) | 分布式编译方法、装置、设备及介质 |
Legal Events
Date | Code | Title | Description |
---|---|---|---|
PB01 | Publication | ||
PB01 | Publication | ||
SE01 | Entry into force of request for substantive examination | ||
SE01 | Entry into force of request for substantive examination |