SpringBoot如何統(tǒng)一處理返回結果和異常情況

更新時間：2024年05月17日 14:55:17 作者：sw-code

這篇文章主要介紹了SpringBoot如何統(tǒng)一處理返回結果和異常情況問題,具有很好的參考價值,希望對大家有所幫助,如有錯誤或未考慮完全的地方,望不吝賜教

原因

在springboot項目里我們希望接口返回的數據包含至少三個屬性：

code：請求接口的返回碼，成功或者異常等返回編碼，例如定義請求成功。
message：請求接口的描述，也就是對返回編碼的描述。
data：請求接口成功，返回的結果。

{
  "code":20000,
  "message":"成功",
  "data":{
    "info":"測試成功"
  }
}

開發(fā)環(huán)境

工具：IDEA
SpringBoot版本：2.2.2.RELEASE

依賴

<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter</artifactId>
</dependency>
<!-- fastjson -->
<dependency>
  <groupId>com.alibaba</groupId>
  <artifactId>fastjson</artifactId>
  <version>1.2.62</version>
</dependency>
<!-- Spring web -->
<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-web</artifactId>
</dependency>
<!-- lombok -->
<dependency>
  <groupId>org.projectlombok</groupId>
  <artifactId>lombok</artifactId>
</dependency>
<!-- swagger3 -->
<dependency>
  <groupId>io.springfox</groupId>
  <artifactId>springfox-boot-starter</artifactId>
  <version>3.0.0</version>
</dependency>

創(chuàng)建 SpringBoot 工程#

新建 SpringBoot 項目common_utils，包名com.spring.utils

返回結果統(tǒng)一

創(chuàng)建code枚舉

在com.spring.utils中創(chuàng)建 pojo 包，并添加枚舉ResultCode

public enum ResultCode {

  /* 成功狀態(tài)碼 */
  SUCCESS(20000, "成功"),
  /* 參數錯誤 */
  PARAM_IS_INVALID(1001, "參數無效"),
  PARAM_IS_BLANK(1002, "參數為空"),
  PARAM_TYPE_BIND_ERROR(1003, "參數類型錯誤"),
  PARAM_NOT_COMPLETE(1004, "參數缺失"),
  /* 用戶錯誤 2001-2999*/
  USER_NOTLOGGED_IN(2001, "用戶未登錄"),
  USER_LOGIN_ERROR(2002, "賬號不存在或密碼錯誤"),
  SYSTEM_ERROR(10000, "系統(tǒng)異常，請稍后重試");

  private Integer code;
  private String message;

  private ResultCode(Integer code, String message) {
    this.code = code;
    this.message = message;
  }

  public Integer code() {
    return this.code;
  }
  public String message() {
    return this.message;
  }
}

**可根據項目自定義，結果返回碼

創(chuàng)建返回結果實體

在 pojo 包中添加返回結果類R**

@Data
@ApiModel(value = "返回結果實體類", description = "結果實體類")
public class R implements Serializable {

  private static final long serialVersionUID = 1L;

  @ApiModelProperty(value = "返回碼")
  private Integer code;

  @ApiModelProperty(value = "返回消息")
  private String message;

  @ApiModelProperty(value = "返回數據")
  private Object data;

  private R() {

  }

  public R(ResultCode resultCode, Object data) {
    this.code = resultCode.code();
    this.message = resultCode.message();
    this.data = data;
  }

  private void setResultCode(ResultCode resultCode) {
    this.code = resultCode.code();
    this.message = resultCode.message();
  }

  // 返回成功
  public static R success() {
    R result = new R();
    result.setResultCode(ResultCode.SUCCESS);
    return result;
  }
  // 返回成功
  public static R success(Object data) {
    R result = new R();
    result.setResultCode(ResultCode.SUCCESS);
    result.setData(data);
    return result;
  }

  // 返回失敗
  public static R fail(Integer code, String message) {
    R result = new R();
    result.setCode(code);
    result.setMessage(message);
    return result;
  }
  // 返回失敗
  public static R fail(ResultCode resultCode) {
    R result = new R();
    result.setResultCode(resultCode);
    return result;
  }
}

自定義一個注解

新建包annotation，并添加ResponseResult注解類

@Retention(RetentionPolicy.RUNTIME)
@Target({ ElementType.TYPE, ElementType.METHOD})
@Documented
public @interface ResponseResult {

}

定義攔截器

新建包interceptor，并添加ResponseResultInterceptorJava類

@Component
public class ResponseResultInterceptor implements HandlerInterceptor {
  //標記名稱
  public static final String RESPONSE_RESULT_ANN = "RESPONSE-RESULT-ANN";

  @Override
  public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)
    throws Exception {
    // TODO Auto-generated method stub
    if (handler instanceof HandlerMethod) {
      final HandlerMethod handlerMethod = (HandlerMethod) handler;
      final Class<?> clazz = handlerMethod.getBeanType();
      final Method method = handlerMethod.getMethod();
      // 判斷是否在類對象上添加了注解
      if (clazz.isAnnotationPresent(ResponseResult.class)) {
        // 設置此請求返回體，需要包裝，往下傳遞，在ResponseBodyAdvice接口進行判斷
        request.setAttribute(RESPONSE_RESULT_ANN, clazz.getAnnotation(ResponseResult.class));
      } else if (method.isAnnotationPresent(ResponseResult.class)) {
        request.setAttribute(RESPONSE_RESULT_ANN, method.getAnnotation(ResponseResult.class));
      }
    }
    return true;
  }
}

用于攔截請求，判斷 Controller 是否添加了@ResponseResult注解

注冊攔截器

新建包config，并添加WebAppConfig配置類

@Configuration
public class WebAppConfig implements WebMvcConfigurer {

    // SpringMVC 需要手動添加攔截器
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        ResponseResultInterceptor interceptor = new ResponseResultInterceptor();
        registry.addInterceptor(interceptor);
        WebMvcConfigurer.super.addInterceptors(registry);
    }
}

方法返回值攔截處理器

新建包handler，并添加ResponseResultHandler配置類，實現(xiàn)ResponseBodyAdvice重寫兩個方法

import org.springframework.web.method.HandlerMethod;
/**
 * 使用 @ControllerAdvice & ResponseBodyAdvice 
 * 攔截Controller方法默認返回參數，統(tǒng)一處理返回值/響應體
 */
@ControllerAdvice
public class ResponseResultHandler implements ResponseBodyAdvice<Object> {
   
   // 標記名稱
   public static final String RESPONSE_RESULT_ANN = "RESPONSE-RESULT-ANN";

   
   // 判斷是否要執(zhí)行 beforeBodyWrite 方法，true為執(zhí)行，false不執(zhí)行，有注解標記的時候處理返回值
   @Override
   public boolean supports(MethodParameter arg0, Class<? extends HttpMessageConverter<?>> arg1) {
      ServletRequestAttributes sra = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
      HttpServletRequest request = sra.getRequest();
      // 判斷請求是否有包裝標記
      ResponseResult responseResultAnn = (ResponseResult) request.getAttribute(RESPONSE_RESULT_ANN);
      return responseResultAnn == null ? false : true;
   }
   
   // 對返回值做包裝處理，如果屬于異常結果，則需要再包裝
   @Override
   public Object beforeBodyWrite(Object body, MethodParameter arg1, MediaType arg2,
                          Class<? extends HttpMessageConverter<?>> arg3, ServerHttpRequest arg4, ServerHttpResponse arg5) {
      if (body instanceof R) {
         return (R) body;
      }
      return R.success(body);
   }
}

實現(xiàn)ResponseBodyAdvice重寫兩個方法

添加@ControllerAdvice注解

測試#

新建包controller，并添加TestController測試類

@RestController
@ResponseResult
public class TestController {

  @GetMapping("/test")
  public Map<String, Object> test() {
    HashMap<String, Object> data = new HashMap<>();
    data.put("info", "測試成功");
    return data;
  }
}

添加@ResponseResult注解

啟動項目，在默認端口: 8080

瀏覽器訪問地址：localhost:8080/test

{"code":20000,"message":"成功","data":{"info":"測試成功"}}

總結

1、創(chuàng)建code枚舉和返回結果實體類

2、自定義一個注解@ResponseResult

3、定義攔截器，攔截請求，判斷Controller上是否添加了@ResponseResult注解。如果添加了注解在request中添加注解標記，往下傳遞

4、添加@ControllerAdvice注解，實現(xiàn)ResponseBodyAdvice接口，并重寫兩個方法，通過判斷request中是否有注解標記，如果有就往下執(zhí)行，進一步包裝。沒有就直接返回，不需包裝。

問題

1、如果要返回錯誤結果，這種方法顯然不方便

@GetMapping("/fail")
public R error() {
  int res = 0; // 查詢結果數
  if( res == 0 ) {
    return R.fail(10001, "沒有數據");
  }
  return R.success(res);
}

2、我們需要對錯誤和異常進行進一步的封裝

封裝錯誤和異常結果#

創(chuàng)建錯誤結果實體#

在包pojo中添加ErrorResult實體類

/**
 * 異常結果包裝類
 * @author sw-code
 *
 */
public class ErrorResult {

  private Integer code;

  private String message;

  private String exception;

  public Integer getCode() {
    return code;
  }

  public void setCode(Integer code) {
    this.code = code;
  }

  public String getMessage() {
    return message;
  }

  public void setMessage(String message) {
    this.message = message;
  }

  public String getException() {
    return exception;
  }

  public void setException(String exception) {
    this.exception = exception;
  }

  public static ErrorResult fail(ResultCode resultCode, Throwable e, String message) {
    ErrorResult errorResult = ErrorResult.fail(resultCode, e);
    errorResult.setMessage(message);
    return errorResult;
  }

  public static ErrorResult fail(ResultCode resultCode, Throwable e) {
    ErrorResult errorResult = new ErrorResult();
    errorResult.setCode(resultCode.code());
    errorResult.setMessage(resultCode.message());
    errorResult.setException(e.getClass().getName());
    return errorResult;
  }
  public static ErrorResult fail(Integer code, String message) {
    ErrorResult errorResult = new ErrorResult();
    errorResult.setCode(code);
    errorResult.setMessage(message);
    return errorResult;
  }    
}

自定義異常類

在包pojo中添加BizException實體類，繼承RuntimeException

@Data
public class BizException extends RuntimeException {

  /**
     * 錯誤碼
     */
  private Integer code;

  /**
     * 錯誤信息
     */
  private String message;

  public BizException() {
    super();
  }

  public BizException(ResultCode resultCode) {
    super(resultCode.message());
    this.code = resultCode.code();
    this.message = resultCode.message();
  }

  public BizException(ResultCode resultCode, Throwable cause) {
    super(resultCode.message(), cause);
    this.code = resultCode.code();
    this.message = resultCode.message();
  }

  public BizException(String message) {
    super(message);
    this.setCode(-1);
    this.message = message;
  }

  public BizException(Integer code, String message) {
    super(message);
    this.code = code;
    this.message = message;
  }

  public BizException(Integer code, String message, Throwable cause) {
    super(message, cause);
    this.code = code;
    this.message = message;
  }

  @Override
  public synchronized Throwable fillInStackTrace() {
    return this;
  }
}

全局異常處理類

在包handler中添加GlobalExceptionHandler，添加@RestControllerAdvice注解

/**
 * 全局異常處理類
 * @RestControllerAdvice(@ControllerAdvice)，攔截異常并統(tǒng)一處理
 * @author sw-code
 *
 */
@Slf4j
@RestControllerAdvice
public class GlobalExceptionHandler {

  /**
     * 處理自定義的業(yè)務異常
     * @param e    異常對象
     * @param request    request
     * @return    錯誤結果
     */
  @ExceptionHandler(BizException.class)
  public ErrorResult bizExceptionHandler(BizException e, HttpServletRequest request) {
    log.error("發(fā)生業(yè)務異常！原因是: {}", e.getMessage());
    return ErrorResult.fail(e.getCode(), e.getMessage());
  }

  // 攔截拋出的異常，@ResponseStatus：用來改變響應狀態(tài)碼
  @ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)
  @ExceptionHandler(Throwable.class)
  public ErrorResult handlerThrowable(Throwable e, HttpServletRequest request) {
    log.error("發(fā)生未知異常！原因是: ", e);
    ErrorResult error = ErrorResult.fail(ResultCode.SYSTEM_ERROR, e);
    return error;
  }

  // 參數校驗異常
  @ExceptionHandler(BindException.class)
  public ErrorResult handleBindExcpetion(BindException e, HttpServletRequest request) {
    log.error("發(fā)生參數校驗異常！原因是：",e);
    ErrorResult error = ErrorResult.fail(ResultCode.PARAM_IS_INVALID, e, e.getAllErrors().get(0).getDefaultMessage());
    return error;
  }

  @ExceptionHandler(MethodArgumentNotValidException.class)
  public ErrorResult handleMethodArgumentNotValidException(MethodArgumentNotValidException e, HttpServletRequest request) {
    log.error("發(fā)生參數校驗異常！原因是：",e);
    ErrorResult error = ErrorResult.fail(ResultCode.PARAM_IS_INVALID,e,e.getBindingResult().getAllErrors().get(0).getDefaultMessage());
    return error;
  }    
}

添加注解@RestControllerAdvice(@ControllerAdvice)，攔截異常并統(tǒng)一處理

修改方法返回值攔截處理器#

將錯誤和異常結果也進行統(tǒng)一封裝

/**
 * 使用 @ControllerAdvice & ResponseBodyAdvice 
 * 攔截Controller方法默認返回參數，統(tǒng)一處理返回值/響應體
 */
@ControllerAdvice
public class ResponseResultHandler implements ResponseBodyAdvice<Object> {

  // 標記名稱
  public static final String RESPONSE_RESULT_ANN = "RESPONSE-RESULT-ANN";


  // 判斷是否要執(zhí)行 beforeBodyWrite 方法，true為執(zhí)行，false不執(zhí)行，有注解標記的時候處理返回值
  @Override
  public boolean supports(MethodParameter arg0, Class<? extends HttpMessageConverter<?>> arg1) {
    ServletRequestAttributes sra = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
    HttpServletRequest request = sra.getRequest();
    // 判斷請求是否有包裝標記
    ResponseResult responseResultAnn = (ResponseResult) request.getAttribute(RESPONSE_RESULT_ANN);
    return responseResultAnn == null ? false : true;
  }


  // 對返回值做包裝處理，如果屬于異常結果，則需要再包裝
  @Override
  public Object beforeBodyWrite(Object body, MethodParameter arg1, MediaType arg2,
                                Class<? extends HttpMessageConverter<?>> arg3, ServerHttpRequest arg4, ServerHttpResponse arg5) {
    if (body instanceof ErrorResult) {
      ErrorResult error = (ErrorResult) body;
      return R.fail(error.getCode(), error.getMessage());
    } else if (body instanceof R) {
      return (R) body;
    }
    return R.success(body);
  }
}
測試#
Copy 
@GetMapping("/fail")
public Integer error() {
  int res = 0; // 查詢結果數
  if( res == 0 ) {
    throw new BizException("沒有數據");
  }
  return res;
}

返回結果

{"code":-1,"message":"沒有數據","data":null}

我們無需擔心返回類型，如果需要返回錯誤提示信息，可以直接拋出自定義異常(BizException)，并添加自定義錯誤信息。

總結

以上為個人經驗，希望能給大家一個參考，也希望大家多多支持腳本之家。

您可能感興趣的文章:

MybatisPlus BaseMapper 中的方法全部 Invalid bound statement (not f
這篇文章主要介紹了MybatisPlus BaseMapper 中的方法全部 Invalid bound statement (not found)的Error處理方法，本文給大家介紹的非常詳細，對大家的學習或工作具有一定的參考借鑒價值，需要的朋友可以參考下
2020-09-09
Java設計模式之狀態(tài)模式State Pattern詳解
這篇文章主要介紹了Java設計模式之狀態(tài)模式State Pattern，狀態(tài)模式允許一個對象在其內部狀態(tài)改變的時候改變其行為。這個對象看上去就像是改變了它的類一樣
2022-11-11
java中Servlet程序下載文件實例詳解
在本篇文章里小編給大家整理的是一篇關于java中Servlet程序下載文件實例內容，有興趣的朋友們可以學習參考下。
2021-02-02
詳談jpa中表的@OneToMany等關聯(lián)關系
這篇文章主要介紹了詳談jpa中表的@OneToMany等關聯(lián)關系，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教
2021-12-12
SpringCloud2020版本配置與環(huán)境搭建教程詳解
這篇文章主要介紹了SpringCloud2020版本配置與環(huán)境搭建教程詳解,本文給大家介紹的非常詳細，對大家的學習或工作具有一定的參考借鑒價值，需要的朋友可以參考下
2020-12-12
如何解決struts2日期類型轉換
在Struts2中，一般的內置類型都會在由系統(tǒng)自動進行轉換.但是Date類型好像有時候行，有時候不行。比如我這次，本地運行正常，一上測試服務器就不行了。這個轉換類是從網上看的：
2013-03-03
java區(qū)分絕對路徑和相對路徑的方法
這篇文章主要介紹了java區(qū)分絕對路徑和相對路徑的方法,實例分析了java針對路徑操作的相關技巧,需要的朋友可以參考下
2015-04-04
Java類加載器ClassLoader源碼層面分析講解
ClassLoader翻譯過來就是類加載器，普通的java開發(fā)者其實用到的不多，但對于某些框架開發(fā)者來說卻非常常見。理解ClassLoader的加載機制，也有利于我們編寫出更高效的代碼。ClassLoader的具體作用就是將class文件加載到jvm虛擬機中去，程序就可以正確運行了
2022-09-09
springboot-assembly自定義打包全過程
這篇文章主要介紹了springboot-assembly自定義打包全過程，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教
2023-06-06
SpringBoot?Security權限控制自定義failureHandler實例
這篇文章主要為大家介紹了SpringBoot?Security權限控制自定義failureHandler實例，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進步，早日升職加薪
2022-11-11