Spring mvc中统一对ResponseBody进行封装

2024年1月9日 177次阅读 来源: 大神带我来搬砖

在一个前后端分离的项目中，需要对后端RestController里返回的ResponseBody进行统一的封装，让所有的API结果的都是json对象，带有是否成功的标志位，并且将实际的数据放到json的result字段中，例如：

{"result":["age","height"],"success":true}

如果在每个RestController中进行封装，重复的工作很多，因此需要自动封装，比如已经写好了如下Controller

@RestController()
@RequestMapping("bar")
public class BarController {

    @GetMapping("foo")
    public List<String> getSessionColumns() {
        List<String> result = new ArrayList<>();
        result.add("age");
        result.add("height");
        return result;
    }
}

自动将结果封装为

{"result":["age","height"],"success":true}

一开始试验了AOP，但是发现总是有ClassCastException的问题，后来又找到了ResponseBodyAdvice，才解决这个问题

public class NovaResponseBodyAdvice implements ResponseBodyAdvice {

    @Override
    public boolean supports(MethodParameter returnType, Class converterType) {
        return true;
    }

    @Override
    public Object beforeBodyWrite(Object body, MethodParameter returnType, MediaType selectedContentType,
                                  Class selectedConverterType, ServerHttpRequest request, ServerHttpResponse response) {
        Map<String, Object> result = new HashMap<>();
        result.put("result", body);
        result.put("success", true);
        return result;
    }

}
    原文作者：大神带我来搬砖
    原文地址: https://www.jianshu.com/p/23cb11fb816d
    本文转自网络文章，转载此文章仅为分享知识，如有侵权，请联系博主进行删除。
点赞