从零开始 Spring Boot 11：返回数据

图源：简书 (jianshu.com)

在之前文章中，已经展示了如何在前后端分离的Web应用中封装并返回统一格式的返回值，但之前展示的返回值封装的相当简单，只能用于简单示例，今天对返回值进行进一步封装和重构。

本篇文章会在从零开始 Spring Boot 9：Shiro - 魔芋红茶’s blog (icexmoon.cn)中最终代码的基础上进行修改。你可以从下面的链接获取对应的示例代码：

• learn_spring_boot/ch9 at main · icexmoon/learn_spring_boot (github.com)

为了说明之前设计的一些缺陷，这里为这个示例代码添加上Swagger文档支持，具体方法见从零开始 Spring Boot 8：Swagger - 魔芋红茶’s blog (icexmoon.cn)，这里不再详细说明。

因为这个示例程序使用Shiro做权限验证，所以需要将Swagger相关路径添加为例外，不经过Shiro验证：

        // 配置不会被拦截的链接 顺序判断
        map.put("/swagger-ui
    public static Result success() {
        return SUCCESS_RESULT;
    }

    
    public static Result success(Object data) {
        Result result = new Result();
        result.setData(data);
        return result;
    }

    
    public static Result fail(ErrorCode errorCode, String msg) {
        Result result = new Result();
        result.setSuccess(false);
        result.setCode(errorCode);
        result.setData(null);
        result.setMsg(msg);
        return result;
    }

    
    public static Result fail(ResultException exp) {
        Result result = new Result();
        result.setSuccess(false);
        result.setCode(exp.getCode());
        result.setData(null);
        result.setMsg(exp.getMessage());
        return result;
    }

    @Override
    public String toString() {
        JSONObject jsonObject = new JSONObject();
        jsonObject.put("success", success);
        jsonObject.put("msg", msg);
        jsonObject.put("data", data);
        jsonObject.put("code", code.getCode());
        return jsonObject.toString();
    }
}

这个新的Result类型除了包含基本的data和success等，更便利的是使用内嵌的枚举封装了系统错误类型，这样在编程的时候就无需使用类属性或者字符串来指定错误，并且枚举自带desc属性可以对错误进行说明。

就像前边说的，因为之后Controller层的方法会直接返回具体业务类型，所以我们需要添加拦截器来对具体类型统一封装：

package cn.icexmoon.demo.books.system;

import cn.icexmoon.demo.books.system.result.IResult;
import cn.icexmoon.demo.books.system.result.Result;
import com.fasterxml.jackson.databind.ObjectMapper;
import lombok.SneakyThrows;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.core.MethodParameter;
import org.springframework.http.MediaType;
import org.springframework.http.converter.HttpMessageConverter;
import org.springframework.http.server.ServerHttpRequest;
import org.springframework.http.server.ServerHttpResponse;
import org.springframework.web.bind.annotation.RestControllerAdvice;
import org.springframework.web.servlet.mvc.method.annotation.ResponseBodyAdvice;

@RestControllerAdvice
public class ResponseAdvice implements ResponseBodyAdvice