一种基于注解的配置化网关注册方法及系统技术方案

技术编号:37793994 阅读:21 留言:0更新日期:2023-06-09 09:24
本发明专利技术提供了一种基于注解的配置化网关注册方法及系统,方法包括:根据预设格式在业务应用的对应接口添加注解信息,并部署所述业务应用至网络服务器;所述网络服务器扫描所述业务应用的注解信息,并将根据注解信息组成的元数据推送至注册中心;通过网关监听所述注册中心中元数据的变更,并将变更后的元数据缓存至本地内存中。本发明专利技术能够基于注解信息完成网关自动化注册,提供了一种更好的外部请求路径与内部接口映射的匹配机制,既能解决当前的网关需要,还可以节省人力、时间以及接入的成本,降低出错的风险。降低出错的风险。降低出错的风险。

【技术实现步骤摘要】
一种基于注解的配置化网关注册方法及系统


[0001]本专利技术涉及网关注册
,具体涉及一种基于注解的配置化网关注册方法及系统。

技术介绍

[0002]网关的角色是作为一个API(Application Program Interface,应用程序界面)架构,用来保护、增强和控制对于API服务的访问,API网关是一个处于应用程序或服务(提供REST API接口服务,Representational State Transfer,表现层状态转移)之前的系统,用来管理授权、访问控制和流量限制等,这样REST API接口服务就被API网关保护起来,对所有的调用者透明。因此,隐藏在API网关后面的业务应用就可以专注于创建和管理服务,而不用去处理这些策略性的基础设施。
[0003]传统网关的实现方式是在多环境下通过手工配置的方式将业务应用的接口与访问路径做映射关系以达到对外提供服务的目的。比如当前系统中存在多套环境(测试、预发、灰度或正式环境),当新增一个接口时,需要打开不同环境的配置页面,通过手动配置把需要新增的接口加入到配置中,当服务启动时把新增的接口暴露出来,以达到可被外界请求的目的。但是手工配置方式存在如下问题:维护成本高,每次新增网址需要人为参与进行手工配置;出问题的概率高,人为配置可能出现配置错误或者漏配置的情况。

技术实现思路

[0004]因此,本专利技术要解决的技术问题在于克服现有技术中手工配置网关的缺陷,从而提供一种基于注解的配置化网关注册方法及系统,能够提供一种更好的外部请求路径与内部接口映射的匹配机制,既能解决当前的网关需要,还可以节省人力、时间以及接入的成本,降低出错的风险。
[0005]本专利技术解决上述技术问题的技术方案如下:
[0006]第一方面,本专利技术提供了一种基于注解的配置化网关注册方法,包括以下步骤:
[0007]根据预设格式在业务应用的对应接口添加注解信息,并部署所述业务应用至网络服务器;
[0008]所述网络服务器扫描所述业务应用的注解信息,并将根据注解信息组成的元数据推送至注册中心;
[0009]通过网关监听所述注册中心中元数据的变更,并将变更后的元数据缓存至本地内存中。
[0010]本专利技术实施例提供的基于注解的配置化网关注册方法,通过在业务应用的对应接口添加注解信息,在业务应用进行项目部署时扫描其注解信息,并根据注解信息组成元数据推送至注册中心,通过网关监听注册中心元数据的变更,并将变更后的元数据缓存至本地内存中,完成网关注册。本专利技术能够基于注解信息完成网关自动化注册,提供了一种更好的外部请求路径与内部接口映射的匹配机制,既能解决当前的网关需要,还可以节省人力、
时间以及接入的成本,降低出错的风险。
[0011]可选地,所述注解信息,包括:网址、鉴权方式、请求方式、方法名称、验签字段、是否允许跨域、响应体格式及描述信息。
[0012]本专利技术通过在业务应用的对应接口添加注解信息,注解信息包括网关注册的详细信息,能够在新增业务应用接口时不需要手工配置接口信息,直接扫描详细的注解信息就可以完成自动注册。
[0013]可选地,当客户端请求访问网关时,网关通过网址找到所述本地内存中对应的元数据,基于元数据中的参数进行验签及鉴权,并将请求传递给对应的业务应用。
[0014]本专利技术在客户端请求访问网关时,直接通过网址找到本地内存中对应的元数据,基于元数据中的参数进行验签和鉴权,最后将请求传递给对应的业务应用,完成对网关的访问。此过程与基于注解的配置化网关注册过程相对应,保证了基于注解的配置化网关注册的可操作性。
[0015]可选地,所述元数据,包括:接口是否需要验签、验签字段、是否需要加密、网址、请求方式及响应体的格式。
[0016]本专利技术通过将扫描到的注解信息集合为元数据,元数据是描述数据属性的信息集合,根据描述和分类格式化了信息,经过结构化数据存储后,能让机器处理分析数据。
[0017]可选地,所述请求方式,包括:get或post;所述get,表征获取资源;所述post,表征向资源提交数据。
[0018]可选地,所述网络服务器扫描所述业务应用的注解信息的方式,包块:网络服务器通过AOP方式扫描业务应用的注解信息。
[0019]本专利技术通过AOP方式扫描业务应用的注解信息,AOP是面向切面编程,注解信息添加在业务应用的对应接口上,通过面向切面编程方式能够实现在不修改源代码的情况下完成对接口处注解信息的扫描。
[0020]第二方面,本专利技术实施例提供了一种基于注解的配置化网关注册系统,所述系统包括:
[0021]注解添加模块,用于根据预设格式在业务应用的对应接口添加注解信息,并部署所述业务应用至网络服务器;
[0022]注解扫描模块,用于所述网络服务器扫描所述业务应用的注解信息,并将根据注解信息组成的元数据推送至注册中心;
[0023]网关注册模块,用于通过网关监听所述注册中心中元数据的变更,并将变更后的元数据缓存至本地内存中。
[0024]本专利技术实施例提供的基于注解的配置化网关注册系统,通过在业务应用的对应接口添加注解信息,在业务应用进行项目部署时扫描其注解信息,并根据注解信息组成元数据推送至注册中心,通过网关监听注册中心元数据的变更,并将变更后的元数据缓存至本地内存中,完成网关注册。本专利技术能够基于注解信息完成网关自动化注册,提供了一种更好的外部请求路径与内部接口映射的匹配机制,既能解决当前的网关需要,还可以节省人力、时间以及接入的成本,降低出错的风险。
[0025]第三方面,本专利技术实施例提供了一种计算机设备,包括:存储器和处理器,所述存储器和所述处理器之间互相通信连接,所述存储器中存储有计算机指令,所述处理器通过
执行所述计算机指令,从而执行第一方面,或者第一方面任意一种可选实施方式中所述的方法。
[0026]第四方面,本专利技术实施例提供了一种计算机可读存储介质,所述计算机可读存储介质存储有计算机指令,所述计算机指令用于使所述计算机执行第一方面,或者第一方面任意一种可选实施方式中所述的方法。
附图说明
[0027]为了更清楚地说明本专利技术具体实施方式或现有技术中的技术方案,下面将对具体实施方式或现有技术描述中所需要使用的附图作简单地介绍,显而易见地,下面描述中的附图是本专利技术的一些实施方式,对于本领域普通技术人员来讲,在不付出创造性劳动的前提下,还可以根据这些附图获得其他的附图。
[0028]图1为本专利技术实施例提供的一种基于注解的配置化网关注册方法的流程示意图;
[0029]图2为本专利技术实施例提供的一种基于注解的配置化网关注册方法关键步骤的流程框图;
[0030]图3为本专利技术实施例提供的一种基于注解的配置化网关注册系统的结构示意图;
[0031]图4为本专利技术实施例提供的一种计算机设备的结构示意图。
具体实施方式
[0032]为使本专利技术实施例的目的、技术方案和优点更加清本文档来自技高网
...

【技术保护点】

【技术特征摘要】
1.一种基于注解的配置化网关注册方法,其特征在于,包括如下步骤:根据预设格式在业务应用的对应接口添加注解信息,并部署所述业务应用至网络服务器;所述网络服务器扫描所述业务应用的注解信息,并将根据注解信息组成的元数据推送至注册中心;通过网关监听所述注册中心中元数据的变更,并将变更后的元数据缓存至本地内存中。2.根据权利要求1所述的基于注解的配置化网关注册方法,其特征在于,所述注解信息,包括:网址、鉴权方式、请求方式、方法名称、验签字段、是否允许跨域、响应体格式及描述信息。3.根据权利要求2所述的基于注解的配置化网关注册方法,其特征在于,还包括:当客户端请求访问网关时,网关通过网址找到所述本地内存中对应的元数据,基于元数据中的参数进行验签及鉴权,并将请求传递给对应的业务应用。4.根据权利要求2所述的基于注解的配置化网关注册方法,其特征在于,所述元数据,包括:接口是否需要验签、验签字段、是否需要加密、网址、请求方式及响应体的格式。5.根据权利要求4所述的基于注解的配置化网关注册方法,其特征在于,所述请求方式,包括:get或post;所述get,表征获取资源;所述post,表征向资源提交数据。6.根...

【专利技术属性】
技术研发人员:于志杰
申请(专利权)人:北京白驹易行科技有限公司
类型:发明
国别省市:

网友询问留言 已有0条评论
  • 还没有人留言评论。发表了对其他浏览者有用的留言会获得科技券。

1