Spring mvc Json 的正确返回姿势

我们经常都需要封装统一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;
9. public String getCode() {
10. return code;
11. }
13. public void setCode(String code) {
14. this.code = code;
15. }
17. public String getMsg() {
18. return msg;
19. }
21. public void setMsg(String msg) {
22. this.msg = msg;
23. }
25. public T getData() {
26. return data;
27. }
29. public void setData(T data) {
30. this.data = data;
31. }
32. }

而我们经常是这么做的 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 {
7. public static Logger logger = LoggerFactory.getLogger(GlobalMessageConverter.class);
9. /**
10. * 写出数据
11. *
12. * @param object
13. * @param type
14. * @param outputMessage
15. * @throws IOException
16. * @throws HttpMessageNotWritableException
17. */
18. @Override
19. protected void writeInternal(Object object, Type type, HttpOutputMessage outputMessage) throws IOException, HttpMessageNotWritableException {
20. //Result 类型的 不用处理
21. if (object instanceof Result ) {
22. super.writeInternal(object, type, outputMessage);
23. return;
24. }
25. Result<Object> baseRes = new Result<>();
26. baseRes.setData(object);
27. baseRes.setMsg("操作成功");
28. baseRes.setCode(0);
29. logger.info("输出参数：" + JsonUtil.toJson(baseRes));
30. super.writeInternal(baseRes, Result.class, outputMessage);
31. }
33. @Override
34. protected void init(ObjectMapper objectMapper) {
35. super.init(objectMapper);
36. getObjectMapper().setSerializationInclusion(JsonInclude.Include.NON_NULL);
37. }
39. @Override
40. protected boolean supports(Class<?> clazz) {
41. return super.supports(clazz);
42. }
44. @Override
45. public void setSupportedMediaTypes(List<MediaType> supportedMediaTypes) {
46. super.setSupportedMediaTypes(supportedMediaTypes);
47. }
48. }

spring boot 配置 HttpMessageConverter：

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

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