后羿框架-公共子框架-报文封装

Posted 2023-05-13

tags:

篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了后羿框架-公共子框架-报文封装相关的知识，希望对你有一定的参考价值。

参考技术A 框架基于spring-web实现的REST服务接口，接口调用时可基于HTTP的url传递调用参数，也可以通过post方法在HTTP的body中传递参数。

如果基于url传递参数，可以使用spirng-web的@PathVariable注解获取参数，如下所示：

如果基于body传递参数，在后端可以基于@RequestParam来获取参数，如下所示：

如果body传递的参数为一个对象的Json数据结构,则可以使用@RequestBody直接转换为一个对象，如下所示：

以上基于不同的参数获取方式，提供了太多的注解方式，来基于不同的场景获取数据做数据类型转换。

扩展一个注解，如：@HouyiRequest，该注解使用在方法参数上，注解有两个属性：

一个name属性可以指定参数名称，name属性默认值为参数名称。
一个type属性可以指定参数对应的数据类型，type属性默认值为参数类型。
则以上的请求就可以改为：

在common-core中扩展一个注解@HouyiRequest
实现在common-web中实现Spring-web包中的HandlerMethodArgumentResolver接口

扩展Spring-web的WebMvcConfigurationSupport类，添加springmvc对扩展注解的支持，如下是基于SpringBoot的示例。

框架可用于单体应用或微服务网关开发时，前端应用调用后端接口需要获取一个统一的返回报文，方便前端作结果展示及展示逻辑处理。

比如：

一个REST-API的接口查询指定用户信息。

如果正常访问会返回一个用户的Json结构的数据信息，如：

但如果该用户不存在，可以返回一个空的Json结构，如：

或直接返回一条业务异常的消息提示：

这些返回结果都不方便前端封装展示逻辑。

通过统一返回一个接口报文，如下所示：

报文中有统一的状态码 "resp_code"，前端可以根据状态码判断接口调用是成功还是失败，比如resp_code值不为“200”则为异常，前端只要判断状态码不为“200”，则可以将resp_msg属性中的异常信息直接做异常提醒展示。

如果返回的状态码为“200”，则可以将datas中取出的约定好的数据格式进行解析并做相关的展示逻辑处理。

在common-core包中定义扩展注解@HouyiResponse,该注解可以使用在方法的返回类型上。
在common-web包中实现spring-web包中接口HandlerMethodReturnValueHandler

扩展Spring-web的WebMvcConfigurerAdapter类，添加springmvc对扩展注解的支持，如下是基于SpringBoot的示例。