Small Tools(2) api封装统一响应体

前言

封装的统一响应体格式如下：

{
    "code": 200,"msg": "SUCCESS","data": ["hello world"]
}

具体可参考源码：https://gitee.com/zhengqingya/small-tools

实现

1、封装返回值处理类

public class MyHandlerMethodReturnValueHandler implements HandlerMethodReturnValueHandler {
    private final HandlerMethodReturnValueHandler returnValueHandler;public MyHandlerMethodReturnValueHandler(HandlerMethodReturnValueHandler returnValueHandler) {
    this.returnValueHandler = returnValueHandler;}@Overridepublic boolean supportsReturnType(MethodParameter methodParameter) {
    return returnValueHandler.supportsReturnType(methodParameter);}@Overridepublic void handleReturnValue(Object returnValue, MethodParameter returnType, ModelAndViewContainer mavContainer, NativeWebRequest webRequest) throws Exception {
    HttpServletRequest nativeRequest = webRequest.getNativeRequest(HttpServletRequest.class);// 判断外层是否由ApiResult包裹if (returnValue instanceof ApiResult) {
    returnValueHandler.handleReturnValue(returnValue, returnType, mavContainer, webRequest);return;}// 判断该api是否需要是否处理返回值String servletPath = nativeRequest.getServletPath();boolean ifHandleReturnValue = true;for (String api : AppConstant.RETURN_VALUE_HANDLER_EXCLUDE_API_LIST) {
    if (servletPath.contains(api)) {
    ifHandleReturnValue = false;break;}}returnValueHandler.handleReturnValue(ifHandleReturnValue ? ApiResult.ok(returnValue) : returnValue, returnType, mavContainer, webRequest);}}

2、配置自定义Handler处理返回值

@Configuration
public class ReturnValueConfig implements InitializingBean {
    @AutowiredRequestMappingHandlerAdapter requestMappingHandlerAdapter;@Overridepublic void afterPropertiesSet() throws Exception {
    List<HandlerMethodReturnValueHandler> unmodifiableList = requestMappingHandlerAdapter.getReturnValueHandlers();List<HandlerMethodReturnValueHandler> list = new ArrayList<>(unmodifiableList.size());for (HandlerMethodReturnValueHandler returnValueHandler : unmodifiableList) {
    if (returnValueHandler instanceof RequestResponseBodyMethodProcessor) {
    list.add(new MyHandlerMethodReturnValueHandler(returnValueHandler));} else {
    list.add(returnValueHandler);}}requestMappingHandlerAdapter.setReturnValueHandlers(list);}}

api

在我们Controller层的api直接返回数据，然后会经过上面的配置统一处理响应体，由ApiResult包裹
这种全局统一响应配置好，小伙子们又可以happy了 ^_^

今日分享语句：
让我们将事前的忧虑，换为事前的思考和计划吧！