Spring mvc中统一对ResponseBody进行封装

作者: 大神带我来搬砖 | 来源:发表于2018-11-06 18:06 被阅读274次

    在一个前后端分离的项目中,需要对后端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;
        }
    
    }
    
    

    相关文章

      网友评论

      • HolloWord:自定义一个统一的返回对象,不是一样吗
        大神带我来搬砖:@HolloWord 对啊,那不是要手动封装嘛
        HolloWord:@HolloWord 不会啊,就像responseEntity 对象封装的一样,比如说 你这方法返回 list,那改成统一的返回对象,把list包装在对象里面
        大神带我来搬砖:@HolloWord 那样的话,每个controller都有很多重复的代码
      • wendell_dev:用ResponseEntity,充分利用http状态码来做是否成功的判断是不是更好一些?
        大神带我来搬砖:@wendell_dev 我们这里要求的
      • 风无羽:为什么AOP有问题啊?
        大神带我来搬砖:@风无羽 我感觉是调用时机的问题

      本文标题:Spring mvc中统一对ResponseBody进行封装

      本文链接:https://www.haomeiwen.com/subject/xoauxqtx.html