CN113391935B - 动态配置型WebService接口服务实现方法和装置 - Google Patents

Abstract

本发明提供了一种动态配置型WebService接口服务实现方法和装置，该方法包括：接收外部请求，解析出接口标识；根据接口标识验证接口服务状态；如果接口服务状态为发布状态，则判断请求Method方法；如果请求Method方法为GET请求，则获取接口服务发布时生成的示例请求报文并进行展示；如果请求Method方法为POST请求，则根据接口的鉴权方式来进行请求鉴权；如果鉴权通过，则调用XmlUtil.xml2Bean方法将报文体自动转换成相应目标处理类的方法的参数对象，以及通过Java反射机制获取并调用执行；使用try/catch代码块对执行方法进行异常捕获，并返回相应的异常捕获结果。能够实时发布或停用服务，设置有灵活配置的鉴权功能，提升了接口服务的安全性，同时有效实现日志审计的完备性。

Description

动态配置型WebService接口服务实现方法和装置

技术领域

本发明涉及远程服务调用技术领域，具体涉及一种动态配置型WebService接口服务实现方法和一种动态配置型WebService接口服务实现装置。

背景技术

伴随着信息技术的高速发展，越来越多的企事业单位将业务转移到互联网领域，为了能够将众多的业务打包成独立的、具有很强伸缩性的服务，人们提出了WebService的概念。 WebService提供一个建立分布式应用的平台，使得运行在不同操作系统和不同设备上的软件，或者是用不同的程序语言和工具开发的软件，所有可能的已开发和部署的软件，能够利用这一平台实现分布式计算的目的，使得应用程序也具有Web分布式编程模型的松散耦合性。

相关技术中，WebService框架有Apache Axis1、Apache Axis2、Codehaus XFire、Apache CXF等，通过这些框架简化了开发工作量，提升了开发效率。然而，由于需要为每个服务单独编写相应的服务类，编译发布成独立的WSDL，因此也不可避免的存在以下缺陷：（1）无法在不停服务的情况下动态创建新服务，必须为每个服务编写代码发布WSDL；（2）缺少统一完备的权限控制与日志审计功能，需要服务的开发人员自行编写实现。

发明内容

本发明为解决上述技术问题，提供了一种动态配置型WebService接口服务实现方法，能够实时发布或停用服务，定义与修改请求报文的校验规则，具有高度的灵活性，并且设置有灵活配置的鉴权功能，更好的提升接口服务的安全性，同时能够有效实现日志审计的完备性，为后续运维提供的可靠的数据支撑。

本发明采用的技术方案如下：

一种动态配置型WebService接口服务实现方法，包括以下步骤：在接收外部请求时，解析出接口标识；根据所述接口标识验证接口服务状态；如果所述接口服务状态为发布状态，则判断请求Method方法；如果所述请求Method方法为GET请求，则获取接口服务发布时生成的示例请求报文并进行展示；如果所述请求Method方法为POST请求，则根据接口的鉴权方式来进行请求鉴权；如果鉴权通过，则调用XmlUtil.xml2Bean方法将报文体自动转换成相应目标处理类的方法的参数对象，以及通过Java反射机制获取并调用执行；使用try/catch代码块对执行方法进行异常捕获，并返回相应的异常捕获结果。

在接收所述外部请求时，解析出所述接口标识，包括：统一拦截符合接口服务URL规则的请求地址；从所述接口服务URL规则中解析出所述接口标识。

动态配置型WebService接口服务实现方法，还包括以下步骤：如果所述接口服务状态为停用状态或者不存在的接口标识，则返回错误信息。

根据接口的鉴权方式来进行请求鉴权，包括：采用限定IP鉴权方式进行请求鉴权，或者采用Token验证方式进行请求鉴权。

使用try/catch代码块对执行方法进行异常捕获，并返回相应的异常捕获结果，包括：如果发生异常，则返回捕获到的异常错误信息；如果未发生异常，则返回所述执行方法的执行结果。

动态配置型WebService接口服务实现方法，还包括以下步骤：在最外层finally代码块中实现接口日志信息的异步记录，其中，所述接口日志信息包括接口标识、请求IP、请求时间、执行时长、请求报文和返回报文。

一种动态配置型WebService接口服务实现装置，包括：解析模块，所述解析模块用于在接收外部请求时，解析出接口标识；验证模块，所述验证模块用于根据所述接口标识验证接口服务状态；判断模块，所述判断模块用于在所述接口服务状态为发布状态时，判断请求Method方法；获取模块，所述获取模块用于在所述请求Method方法为GET请求时，获取接口服务发布时生成的示例请求报文并进行展示；鉴权模块，所述鉴权模块用于在所述请求Method方法为POST请求时，根据接口的鉴权方式来进行请求鉴权；调用模块，所述调用模块用于在鉴权通过时，调用XmlUtil.xml2Bean方法将报文体自动转换成相应目标处理类的方法的参数对象，以及通过Java反射机制获取并调用执行；异常捕获模块，所述异常捕获模块用于使用try/catch代码块对执行方法进行异常捕获，并返回相应的异常捕获结果。

一种计算机设备，包括存储器、处理器及存储在存储器上并可在处理器上运行的计算机程序，所述处理器执行所述计算机程序时，实现上述的动态配置型WebService接口服务实现方法。

一种非临时性计算机可读存储介质，其上存储有计算机程序，该程序被处理器执行时实现上述的动态配置型WebService接口服务实现方法。

本发明的有益效果：

本发明能够实时发布或停用服务，定义与修改请求报文的校验规则，具有高度的灵活性，并且设置有灵活配置的鉴权功能，更好的提升接口服务的安全性，同时能够有效实现日志审计的完备性，为后续运维提供的可靠的数据支撑。

附图说明

图1为本发明实施例的动态配置型WebService接口服务实现方法的流程图；

图2为本发明一个具体实施例的实现接口定义配置的模块的结构示意图；

图3为本发明一个具体实施例的动态配置型WebService接口服务实现方法的逻辑图；

图4为本发明实施例的动态配置型WebService接口服务实现装置的方框示意图。

具体实施方式

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

图1是根据本发明实施例的动态配置型WebService接口服务实现方法的流程图。

如图1所示，本发明实施例的动态配置型WebService接口服务实现方法可包括以下步骤：

S1，在接收外部请求时，解析出接口标识。

需要说明的是，可预先开发实现接口定义配置的模块，提供接口主要信息的配置、接口请求报文体的定义配置、接口权限控制相关配置、接口服务的发布与停用等功能，其中，结构图如图2所示，主要涉及接口定义表、请求报文体字段定义表。

使用配置模块，对要提供对外服务的服务类和方法进行接口定义，以及权限控制配置，依据方法参数结构定义接口请求体及相应校验规则。配置完成后，点击“发布”按钮，生成请求报文示例，并生效服务。

具体地，可开发实现一个接口定义配置的功能，所有配置信息写入数据库表中，主要包括：接口的定义以及接口的发布与停用。其中，接口的定义的主要信息有：接口标识、接口描述说明、后端目标处理类(Spring的BeanId，非Spring框架可使用完整的含包类路径)、后端目标处理类的处理方法、请求报文体结构定义（支持树状节点的配置，为每个节点定义字段类型是值类型还是数组类型、字段名、字段中文描述、字段校验正则表达式;需要保证定义的结构体最后能转换成目标执行类的相应方法的参数对象）；接口的发布与停用可提供已定义配置的接口查询列表。新定义的接口默认为停用状态，需要手工点击列表行中“发布”按钮进行发布；发布时根据接口标识与规则动态生成接口的服务地址（如：http://localhost/ws/[接口标识]）；根据请求报文体结构定义，生成相应的示例请求报文；列表中提供“停用”按钮，实现接口服务的停用功能。

根据本发明的一个实施例，在接收外部请求时，解析出接口标识，包括：统一拦截符合接口服务URL规则的请求地址；从接口服务URL规则中解析出接口标识。

S2，根据接口标识验证接口服务状态。

S3，如果接口服务状态为发布状态，则判断请求Method方法。

根据本发明的一个实施例，动态配置型WebService接口服务实现方法还包括以下步骤：如果接口服务状态为停用状态或者不存在的接口标识，则返回错误信息。

具体而言，如图3所示，可根据接口标识验证接口服务状态。其中，如果接口服务状态为停用状态或者不存在的接口标识，则直接返回错误信息，例如，返回404错误；如果接口服务状态为发布状态，则进一步判断请求Method方法。

S4，如果请求Method方法为GET请求，则获取接口服务发布时生成的示例请求报文并进行展示。

S5，如果请求Method方法为POST请求，则根据接口的鉴权方式来进行请求鉴权。

根据本发明的一个实施例，根据接口的鉴权方式来进行请求鉴权，包括：采用限定IP鉴权方式进行请求鉴权，或者采用Token验证方式进行请求鉴权。

具体而言，如图3所示，如果请求Method方法为GET请求，则获取接口服务发布时生成的示例请求报文并进行展示；如果如果请求Method方法为POST请求，则根据接口的鉴权方式来进行请求鉴权。

具体地，本发明在接口定义中，增加接口的“鉴权方式”，包含限定IP鉴权方式和Token验证方式。提供了统一的权限控制能力，增强权限控制的灵活性与接口服务的安全性。

也就是说，本发明提供了接口的权限控制修改功能，可随时对列表中的接口更换“鉴权方式”。若为Token验证方式，可重新生成随机令牌Token；若为限定IP范围方式，提供IP地址范围的录入能力。

其中，如果采用限定IP鉴权方式进行请求鉴权，则通过request获取客户端IP，若是非法IP，则直接返回错误信息，例如，返回404错误；如果采用Token验证方式进行请求鉴权，则从requestHeader中获取Token值，若获取的Token值为无效Token，则直接返回错误信息，例如，返回404错误。

S6，如果鉴权通过，则调用XmlUtil.xml2Bean方法将报文体自动转换成相应目标处理类的方法的参数对象，以及通过Java反射机制获取并调用执行。

具体而言，如图3所示，如果鉴权通过，则调用XmlUtil.xml2Bean方法先将报文体自动转换成相应目标处理类的方法的参数对象，进一步通过Java反射机制获取并调用执行相应的执行方法。

S7，使用try/catch代码块对执行方法进行异常捕获，并返回相应的异常捕获结果。

根据本发明的一个实施例，使用try/catch代码块对执行方法进行异常捕获，并返回相应的异常捕获结果，包括：如果发生异常，则返回捕获到的异常错误信息；如果未发生异常，则返回执行方法的执行结果。

具体地，如图3所示，使用try/catch代码块对执行方法进行异常捕获。其中，如果发生异常，则返回捕获到的异常错误信息；如果执行成功，则返回执行方法的执行结果，其中，可通过XmlUtil.xml2Bean方法转换成xml格式，进行返回。

综上所述，本发明创建一个继承javax.servlet.http.HttpServletRequestWrapper的自定义RequestWrapper类，提供可多次重复读取输入流的方法，解决原始输入流不能被重复读取的问题，同时，本发明继承Spring的HandlerInterceptorAdapter类，实现一个全局拦截器，重写preHandle方法，对符合规则的所有接口服务地址进行拦截处理（亦可继承javax.servlet.Filter来实现），根据接口服务URL规则，获取接口标识，并验证接口状态，停用状态或者不存在的接口标识则返回错误信息，发布状态则判定相应的请求method方法。若是GET方法，则获取接口发布时生成的示例报文进行展示，供服务请求开发方参考；若是POST方法，则认为是接口调用请求，首先使用RequestWrapper类包装原始请求request并获取请求体，然后对报文体中各字段逐个根据配置的正则规则执行校验，校验不通过则直接返回错误提示，校验通过则调用XmlUtil.xml2Bean方法先将报文体自动转换成相应目标处理类的方法的参数对象，进一步通过Java反射机制调用方法，完成相应接口的逻辑处理（捕获方法异常，无异常接口返回成功，否则返回失败及异常错误信息）。

根据本发明的一个实施例，动态配置型WebService接口服务实现方法还包括以下步骤：在最外层finally代码块中实现接口日志信息的异步记录，其中，接口日志信息包括接口标识、请求IP、请求时间、执行时长、请求报文和返回报文。

进一步而言，本发明还提供统一完备的日志记录与监控能力，为运维排查分析问题提供便利。其中，可采用数据库方式记录所有接口的请求报文、反馈报文、服务处理时间等。

具体地，在统一拦截器中，在拦截方法开始处可记录调用开始时间，并获取相应请求报文，同时，在拦截方法结束前记录调用结束时间，并取得返回报文，以及调用异步方法将接口调用相关信息全部写录到数据库中建立的接口日志表中（包括接口标识、请求IP、请求时间、执行时长、请求报文、返回报文等）。

需要说明的是，本发明还开发实现接口日志分页查询页面功能。支持通过接口标识、请求时间范围、请求IP等条件查询接口服务请求日志，以及查看详细的请求报文与返回报文。

由此，本发明提供的接口定义配置功能，可以在线动态灵活定义接口，并且根据需要，随时将符合规则的服务类的方法在零编码量的前提下，通过配置，在线实时发布成新的WebService接口服务，有效地节省了开发工作量，提升了WebService服务开发效率，同时，本发明支持在线实时发布或停用服务，定义与修改请求报文的校验规则，具有高度的灵活性，另外，本发明提供了可灵活配置的鉴权功能，可以更好的提升接口服务的安全性，此外，本发明通过统一实现了日志拦截并记录到数据库的功能，无需开发人员进行编码，有效的实现了日志审计的完备性，为后续运维提供的可靠的数据支撑。

综上所述，根据本发明实施例的动态配置型WebService接口服务实现方法，在接收外部请求时，解析出接口标识，并根据接口标识验证接口服务状态，以及在接口服务状态为发布状态时，判断请求Method方法，并在请求Method方法为GET请求时，获取接口服务发布时生成的示例请求报文并进行展示，以及在请求Method方法为POST请求时，根据接口的鉴权方式来进行请求鉴权，并在鉴权通过时，调用XmlUtil.xml2Bean方法将报文体自动转换成相应目标处理类的方法的参数对象，以及通过Java反射机制获取并调用执行，并使用try/catch代码块对执行方法进行异常捕获，并返回相应的异常捕获结果。由此，能够实时发布或停用服务，定义与修改请求报文的校验规则，具有高度的灵活性，并且设置有灵活配置的鉴权功能，更好的提升接口服务的安全性，同时能够有效实现日志审计的完备性，为后续运维提供的可靠的数据支撑。

对应上述实施例，本发明还提出一种动态配置型WebService接口服务实现装置。

如图4所示，本发明实施例的动态配置型WebService接口服务实现装置可包括：解析模块100、验证模块200、判断模块300、获取模块400、鉴权模块500、调用模块600和异常捕获模块700。

其中，解析模块100用于在接收外部请求时，解析出接口标识；验证模块200用于根据接口标识验证接口服务状态；判断模块300用于在接口服务状态为发布状态时，判断请求Method方法；获取模块400用于在请求Method方法为GET请求时，获取接口服务发布时生成的示例请求报文并进行展示；鉴权模块500用于在请求Method方法为POST请求时，根据接口的鉴权方式来进行请求鉴权；调用模块600用于在鉴权通过时，调用XmlUtil.xml2Bean方法将报文体自动转换成相应目标处理类的方法的参数对象，以及通过Java反射机制获取并调用执行；异常捕获模块700用于使用try/catch代码块对执行方法进行异常捕获，并返回相应的异常捕获结果。

根据本发明的一个实施例，解析模块100具体用于：统一拦截符合接口服务URL规则的请求地址；从接口服务URL规则中解析出接口标识。

根据本发明的一个实施例，判断模块300还用于在接口服务状态为停用状态或者不存在的接口标识时，返回错误信息。

根据本发明的一个实施例，鉴权模块500具体用于：采用限定IP鉴权方式进行请求鉴权，或者采用Token验证方式进行请求鉴权。

根据本发明的一个实施例，异常捕获模块700具体用于：如果发生异常，则返回捕获到的异常错误信息；如果未发生异常，则返回执行方法的执行结果。

根据本发明的一个实施例，异常捕获模块700具体还用于：在最外层finally代码块中实现接口日志信息的异步记录，其中，接口日志信息包括接口标识、请求IP、请求时间、执行时长、请求报文和返回报文。

需要说明的是，本发明实施例的动态配置型WebService接口服务实现装置可参照上述动态配置型WebService接口服务实现方法的实施例，在此不再赘述。

根据本发明实施例的动态配置型WebService接口服务实现装置，通过解析模块在接收外部请求时，解析出接口标识，以及通过验证模块根据接口标识验证接口服务状态，并通过判断模块在接口服务状态为发布状态时，判断请求Method方法，以及通过获取模块在请求Method方法为GET请求时，获取接口服务发布时生成的示例请求报文并进行展示，并通过鉴权模块在请求Method方法为POST请求时，根据接口的鉴权方式来进行请求鉴权，以及通过调用模块用于在鉴权通过时，调用XmlUtil.xml2Bean方法将报文体自动转换成相应目标处理类的方法的参数对象，并通过Java反射机制获取并调用执行，以及通过异常捕获模块使用try/catch代码块对执行方法进行异常捕获，并返回相应的异常捕获结果。由此，能够实时发布或停用服务，定义与修改请求报文的校验规则，具有高度的灵活性，并且设置有灵活配置的鉴权功能，更好的提升接口服务的安全性，同时能够有效实现日志审计的完备性，为后续运维提供的可靠的数据支撑。

对应上述实施例，本发明还提出一种计算机设备。

本发明实施例的计算机设备包括存储器、处理器及存储在存储器上并可在处理器上运行的计算机程序，处理器执行程序时，实现上述实施例的动态配置型WebService接口服务实现方法。

根据本发明实施例的计算机设备，能够实时发布或停用服务，定义与修改请求报文的校验规则，具有高度的灵活性，并且设置有灵活配置的鉴权功能，更好的提升接口服务的安全性，同时能够有效实现日志审计的完备性，为后续运维提供的可靠的数据支撑。

对应上述实施例，本发明还提出一种非临时性计算机可读存储介质。

本发明实施例的非临时性计算机可读存储介质上存储有计算机程序，该程序被处理器执行时实现上述的动态配置型WebService接口服务实现方法。

根据本发明实施例的非临时性计算机可读存储介质，能够实时发布或停用服务，定义与修改请求报文的校验规则，具有高度的灵活性，并且设置有灵活配置的鉴权功能，更好的提升接口服务的安全性，同时能够有效实现日志审计的完备性，为后续运维提供的可靠的数据支撑。

尽管上面已经示出和描述了本发明的实施例，可以理解的是，上述实施例是示例性的，不能理解为对本发明的限制，本领域的普通技术人员在本发明的范围内可以对上述实施例进行变化、修改、替换和变型。

Claims (6)

1.一种动态配置型WebService接口服务实现方法，其特征在于，包括以下步骤：

在接收外部请求时，解析出接口标识，其中，在接收所述外部请求时，解析出所述接口标识，包括：统一拦截符合接口服务URL规则的请求地址；从所述接口服务URL规则中解析出所述接口标识；

根据所述接口标识验证接口服务状态；

如果所述接口服务状态为发布状态，则判断请求Method方法；

如果所述请求Method方法为GET请求，则获取接口服务发布时生成的示例请求报文并进行展示；

如果所述请求Method方法为POST请求，则根据接口的鉴权方式来进行请求鉴权，其中，根据接口的鉴权方式来进行请求鉴权，包括：采用限定IP鉴权方式进行请求鉴权，或者采用Token验证方式进行请求鉴权；其中，随时对所述接口更换鉴权方式；

如果鉴权通过，则调用XmlUtil.xml2Bean方法将报文体自动转换成相应目标处理类的方法的参数对象，以及通过Java反射机制获取并调用执行；

使用try/catch代码块对执行方法进行异常捕获，并返回相应的异常捕获结果；其中，所述动态配置型WebService接口服务实现方法，还包括以下步骤：

在最外层finally代码块中实现接口日志信息的异步记录，其中，所述接口日志信息包括接口标识、请求IP、请求时间、执行时长、请求报文和返回报文。

2.根据权利要求1所述的动态配置型WebService接口服务实现方法，其特征在于，还包括以下步骤：

如果所述接口服务状态为停用状态或者不存在的接口标识，则返回错误信息。

3.根据权利要求1所述的动态配置型WebService接口服务实现方法，其特征在于，使用try/catch代码块对执行方法进行异常捕获，并返回相应的异常捕获结果，包括：

如果发生异常，则返回捕获到的异常错误信息；

如果未发生异常，则返回所述执行方法的执行结果。

4.一种动态配置型WebService接口服务实现装置，其特征在于，包括：

解析模块，所述解析模块用于在接收外部请求时，解析出接口标识，所述解析模块具体用于：统一拦截符合接口服务URL规则的请求地址；从所述接口服务URL规则中解析出所述接口标识；

验证模块，所述验证模块用于根据所述接口标识验证接口服务状态；

判断模块，所述判断模块用于在所述接口服务状态为发布状态时，判断请求Method方法；

获取模块，所述获取模块用于在所述请求Method方法为GET请求时，获取接口服务发布时生成的示例请求报文并进行展示；

鉴权模块，所述鉴权模块用于在所述请求Method方法为POST请求时，根据接口的鉴权方式来进行请求鉴权，其中，所述鉴权模块具体用于：采用限定IP鉴权方式进行请求鉴权，或者采用Token验证方式进行请求鉴权；其中，随时对所述接口更换鉴权方式；

调用模块，所述调用模块用于在鉴权通过时，调用XmlUtil.xml2Bean方法将报文体自动转换成相应目标处理类的方法的参数对象，以及通过Java反射机制获取并调用执行；

异常捕获模块，所述异常捕获模块用于使用try/catch代码块对执行方法进行异常捕获，并返回相应的异常捕获结果；其中，所述异常捕获模块具体还用于：在最外层finally代码块中实现接口日志信息的异步记录，其中，所述接口日志信息包括接口标识、请求IP、请求时间、执行时长、请求报文和返回报文。

5.一种计算机设备，包括存储器、处理器及存储在存储器上并可在处理器上运行的计算机程序，其特征在于，所述处理器执行所述计算机程序时，实现根据权利要求1-3中任一项所述的动态配置型WebService接口服务实现方法。

6.一种非临时性计算机可读存储介质，其上存储有计算机程序，其特征在于，该程序被处理器执行时实现根据权利要求1-3中任一项所述的动态配置型WebService接口服务实现方法。

Images