只需一步，在Spring Boot中統一Restful API返回值格式與統一處理異常

統一返回值

在先後端分離大行其道的今天，有一個統一的返回值格式不只能使咱們的接口看起來更漂亮，並且還可使前端能夠統一處理不少東西，避免不少問題的產生。

比較通用的返回值格式以下：

public class Result<T> {
    // 接口調用成功或者失敗
    private Integer code = 0;
    // 失敗的具體code
    private String errorCode = "";
    // 須要傳遞的信息，例如錯誤信息
    private String msg;
    // 須要傳遞的數據
    private T data;
    ...
}

最原始的接口以下：

@GetMapping("/test")
    public User test() {
        return new User();
    }

當咱們須要統一返回值時，可能會使用這樣一個辦法：

@GetMapping("/test")
    public Result test() {
        return Result.success(new User());
    }

這個方法確實達到了統一接口返回值的目的，可是卻有幾個新問題誕生了：

• 接口返回值不明顯，不能一眼看出來該接口的返回值。
• 每個接口都須要增長額外的代碼量。

所幸Spring Boot已經爲咱們提供了更好的解決辦法，只須要在項目中加上如下代碼，就能夠無感知的爲咱們統一全局返回值。

/**
 * 全局返回值統一封裝
 */
@EnableWebMvc
@Configuration
public class GlobalReturnConfig {

    @RestControllerAdvice
    static class ResultResponseAdvice implements ResponseBodyAdvice<Object> {
        @Override
        public boolean supports(MethodParameter methodParameter, Class<? extends HttpMessageConverter<?>> aClass) {
            return true;
        }

        @Override
        public Object beforeBodyWrite(Object body, MethodParameter methodParameter, MediaType mediaType, Class<? extends HttpMessageConverter<?>> aClass, ServerHttpRequest serverHttpRequest, ServerHttpResponse serverHttpResponse) {
            if (body instanceof Result) {
                return body;
            }
            return new Result(body);
        }
    }
}

而咱們的接口只須要寫成最原始的樣子就好了。

@GetMapping("/test")
    public User test() {
        return new User();
    }

統一處理異常

將返回值統一封裝時咱們沒有考慮當接口拋出異常的狀況。當接口拋出異常時讓用戶直接看到服務端的異常確定是不夠友好的，而咱們也不可能每個接口都去try/catch進行處理，此時只須要使用@ExceptionHandler註解便可無感知的全局統一處理異常。

@RestControllerAdvice
public class GlobalExceptionHandler {

    private static final Logger LOG = LoggerFactory.getLogger(GlobalExceptionHandler.class);

    /**
     * 全局異常處理
     */
    @ExceptionHandler
    public JsonData handleException(HttpServletRequest request, HttpServletResponse response, final Exception e) {
        LOG.error(e.getMessage(), e);
        if (e instanceof AlertException) {//能夠在前端Alert的異常
            if (((AlertException) e).getRetCode() != null) {//預約義異常
                return new Result(((AlertException) e).getRetCode());
            } else {
                return new Result(1, e.getMessage() != null ? e.getMessage() : "");
            }
        } else {//其它異常
            if (Util.isProduct()) {//若是是正式環境，統一提示
                return new Result(RetCode.ERROR);
            } else {//測試環境，alert異常信息
                return new Result(1, StringUtils.isNotBlank(e.getMessage()) ? e.getMessage() : e.toString());
            }
        }
    }

}

其中的AlertException爲咱們自定義的異常，所以當業務中須要拋出錯誤時，能夠手動拋出AlertException。

以上就是統一處理返回值和統一處理異常的兩步。