在Spring Boot中統一Restful API返回值格式與統一處理異常怎么解決

這篇文章主要為大家分析了在Spring Boot中統一Restful API返回值格式與統一處理異常怎么解決的相關知識點，內容詳細易懂，操作細節合理，具有一定參考價值。如果感興趣的話，不妨跟著跟隨小編一起來看看，下面跟著小編一起深入學習“在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。

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

關于“在Spring Boot中統一Restful API返回值格式與統一處理異常怎么解決”就介紹到這了,更多相關內容可以搜索億速云以前的文章，希望能夠幫助大家答疑解惑，請多多支持億速云網站！