我们经常都需要封装统一JSON格式 例如以下形式

  1. {
  2. “data”:“输出的数据”,
  3. “code”:“响应代码”,
  4. “msg”:“响应信息”
  5. }
  1. /**
  2. * Created by linli on 2017/7/31.
  3. */
  4. public class Result<T> {
  5. String code;
  6. String msg;
  7. T data;
  8. public String getCode() {
  9. return code;
  10. }
  11. public void setCode(String code) {
  12. this.code = code;
  13. }
  14. public String getMsg() {
  15. return msg;
  16. }
  17. public void setMsg(String msg) {
  18. this.msg = msg;
  19. }
  20. public T getData() {
  21. return data;
  22. }
  23. public void setData(T data) {
  24. this.data = data;
  25. }
  26. }

而我们经常是这么做的 new Result<>() 返回;

  1. @ResponseBody
  2. @RequestMapping("/test")
  3. public Result<BusinessResult> test() {
  4. //模拟业务成返回数据
  5. Result<BusinessResult> result = new Result<>();
  6. return result;
  7. }

这样做看起来好像没有什么不对,我已经通过 Result 封装了我的数据格式,返回去的结果是统一的。

但是我们仔细想想 ,我每个接口,每个Service ,每个业务实现类都要 返回一个 Result 这是不是重复的工作,可不可以统一封装呢?
重复的工作我们都应该想办法避免。
而且再仔细想想 们的业务Service ,注重点是完成我们的业务工作而不是花费大量的时间在 new Result() 上。

这样是三层架构的精髓。每一层都负责不一样的事情,尽可能的处理与自己关注点,避免无干的事情,
Service 的重点就是业务,而封装数据应该由Contrller 完成。
思想很重!!!!

于是我们想办法把他简化,正确的做法应该是这样的:

  1. @ResponseBody
  2. @RequestMapping("/test")
  3. public BusinessResult test() {
  4. //模拟业务成返回数据
  5. BusinessResult result = new BusinessResult();
  6. return result;
  7. }

我们的返回结果应该是我们的业务数据,封装数据 由spring mvc 控制层完成。

HttpMessageConverter 是 Spring3.0 新添加的一个接口,负责将请求信息转换为一个对象(类型为 T),将对象(类型为 T)输出为响应信息。

MappingJackson2HttpMessageConverter ,FastJsonHttpMessageConverter 等都是通过继承
HttpMessageConverter 达到json 转换效果, 有兴趣的同学可以看看源码。

我们也可以利用 重写 MappingJackson2HttpMessageConverter 或 FastJsonHttpMessageConverter 达到我们的 统一数据输出:

  1. /**
  2. * Created by Administrator on 2017/6/14.
  3. * 全局数据 统一输出
  4. */
  5. public class GlobalMessageConverter extends MappingJackson2HttpMessageConverter {
  6. public static Logger logger = LoggerFactory.getLogger(GlobalMessageConverter.class);
  7. /**
  8. * 写出数据
  9. *
  10. * @param object
  11. * @param type
  12. * @param outputMessage
  13. * @throws IOException
  14. * @throws HttpMessageNotWritableException
  15. */
  16. @Override
  17. protected void writeInternal(Object object, Type type, HttpOutputMessage outputMessage) throws IOException, HttpMessageNotWritableException {
  18. //Result 类型的 不用处理
  19. if (object instanceof Result ) {
  20. super.writeInternal(object, type, outputMessage);
  21. return;
  22. }
  23. Result<Object> baseRes = new Result<>();
  24. baseRes.setData(object);
  25. baseRes.setMsg("操作成功");
  26. baseRes.setCode(0);
  27. logger.info("输出参数:" + JsonUtil.toJson(baseRes));
  28. super.writeInternal(baseRes, Result.class, outputMessage);
  29. }
  30. @Override
  31. protected void init(ObjectMapper objectMapper) {
  32. super.init(objectMapper);
  33. getObjectMapper().setSerializationInclusion(JsonInclude.Include.NON_NULL);
  34. }
  35. @Override
  36. protected boolean supports(Class<?> clazz) {
  37. return super.supports(clazz);
  38. }
  39. @Override
  40. public void setSupportedMediaTypes(List<MediaType> supportedMediaTypes) {
  41. super.setSupportedMediaTypes(supportedMediaTypes);
  42. }
  43. }

spring boot 配置 HttpMessageConverter:

  1. @EnableFeignClients
  2. @SpringBootApplication
  3. @Configuration
  4. @EnableEurekaClient
  5. @EnableScheduling
  6. @EnableHystrix
  7. public class MicroBlogArticleCommentsServiceApplication {
  8. public static void main(String[] args) {
  9. SpringApplication.run(MicroBlogArticleCommentsServiceApplication.class, args);
  10. }
  11. @Bean
  12. @LoadBalanced
  13. public RestTemplate restTemplate() {
  14. return new RestTemplate();
  15. }
  16. @Bean
  17. public HttpMessageConverters fastJsonHttpMessageConverters() {
  18. GlobalMessageConverter converter = new GlobalMessageConverter();
  19. return new HttpMessageConverters(converter);
  20. }
  21. }

细心的同学可能会发现,如果我发生错误需要返回错误类型的 Result 怎么办? 你这样只能返回正确结果的Result(业务正常的Result),要是业务失败,如密码错误,用户不存在等怎么处理?

Spring mvc Json 的正确返回姿势的更多相关文章

  1. spring mvc json 返回乱码问题解决(vestion:3.x.x)

    本文是转载文章,感觉比较好,如有侵权,请联系本人,我将及时删除. 原文网址:<spring mvc json 返回乱码问题解决(vestion:3.x.x)> 工程中用springmvc返 ...

  2. spring mvc: json练习

    spring mvc: json练习 本例需要用到的json包: 如下: jackson-databind jackson-core jackson-annotations <!-- https ...

  3. Spring MVC JSON自己定义类型转换(续)

    前面提到了两种转换类型的方法(Spring MVC JSON自己定义类型转换),这里针对Json转换提供一种更简便的方法. 通过配置全局的日期转换来避免使用麻烦的注解. 首先用到了一个简单的日期工具类 ...

  4. 160506、Spring mvc新手入门(11)-返回json 字符串的其他方式

    Spring MVC返回 json字符串的方式有很多种方法,这里介绍最简单,也是最常使用的两种方式 一.使用  PrintWriter printWriter  直接输出字符串到返回结果中    不需 ...

  5. Spring MVC全局异常后返回JSON异常数据

    问题: 当前项目是作为手机APP后台支持,使用spring mvc + mybaits + shiro进行开发.后台服务与手机端交互是发送JSON数据.如果后台发生异常,会直接返回异常页面,显示异常内 ...

  6. spring mvc json返回防止乱码

    乱码问题 乱码一直是编程的常见问题,spring mvc 返回json数据时可能导致乱码,需要在controller中添加如下代码: @RequestMapping("/test" ...

  7. [Spring MVC] - JSON

    Spring MVC中使用JSON,先必需引用两个包:jackson-core-asl-1.9.13.jar.jackson-mapper-asl-1.9.13.jar 因为需要使用到jquery测试 ...

  8. Spring MVC json配置

    接口类的Controller,一般返回的是json数据,而Spring MVC中默认返回的string,而jsp页面的话,会按配置中自己行匹配转义字符串为对应的jsp文件. @Controller @ ...

  9. Spring MVC JSON 实现JsonSerializer Date类型转换

    转载至:http://blog.csdn.net/lantianzhange/article/details/40920933 在Spring MVC中存在两大类的类型转换,一类是Json,一个是Sp ...

随机推荐

  1. cboss升级顺序

    1. sunboss去除cron.d ps.运营商cboss安装说明: 1. 先安装管理服务器,管理服务器安装所有包,安装顺序如下: (1)cdb20 (2)cboss (3)db (4)boss ( ...

  2. 前端解析websocket数据问题

    buf []byte //err = websocket.Message.Send(ws, buf) err = websocket.Message.Send(ws, string(buf[:])) ...

  3. Rodrigues(罗德里格斯)旋转公式推导

    1. 2.推导过程:我们的目的是求得vrot,所以应该求得v||和vrot在垂直于k方向的投影向量. 其中, 俯视图看: 此外,另一种表示方法为: R可以看作旋转矩阵.

  4. java关键字详解----static

    Java Static关键字详解   提起static关键字,相信大家绝对不会陌生,但是,想要完全说明白,猛的一想,发现自己好像又说不太明白... ...比方说,昨天被一个同学问起的时候... ... ...

  5. Echarts 绘图(饼图,中国地图)

    一个使用Javascript 实现的开源可视化库,可以流畅的运行在pc 和移动设备上,兼容当前绝大部分浏览器(Chrome ,firefox,IE8)等 底层依赖轻量级的矢量图形库ZRender,提供 ...

  6. Java中的关键字

    1)48个关键字:abstract.assert.boolean.break.byte.case.catch.char.class.continue.default.do.double.else.en ...

  7. acm 2044

    ////////////////////////////////////////////////////////////////////////////////#include<iostream ...

  8. Java 源码解析

    Object equals方法对比两个对象是否是内存中同一个物理地址 hashCode规定,当两个对象相等时,必须返回相等的hashCode,所以重写equals方法有必要重写hashCode方法 如 ...

  9. JSP中页面向Action传递参数的几种方式

    <form name="ThisForm" method="POST" action="index.jsp"> form是表单, ...

  10. day39机器学习

    2 Numpy快速上手 2.1. 什么是Numpy Numpy是Python的一个科学计算的库 主要提供矩阵运算的功能,而矩阵运算在机器学习领域应用非常广泛 Numpy一般与Scipy.matplot ...