激情久久久_欧美视频区_成人av免费_不卡视频一二三区_欧美精品在欧美一区二区少妇_欧美一区二区三区的

服務器之家:專注于服務器技術及軟件下載分享
分類導航

PHP教程|ASP.NET教程|Java教程|ASP教程|編程技術|正則表達式|C/C++|IOS|C#|Swift|Android|VB|R語言|JavaScript|易語言|vb.net|

服務器之家 - 編程語言 - Java教程 - SpringBoot中如何統一接口返回與全局異常處理詳解

SpringBoot中如何統一接口返回與全局異常處理詳解

2021-12-15 11:59l拉不拉米 Java教程

全局異常處理是個比較重要的功能,一般在項目里都會用到,這篇文章主要給大家介紹了關于SpringBoot中如何統一接口返回與全局異常處理的相關資料,文中通過示例代碼介紹的非常詳細,需要的朋友可以參考下

背景

在分布式、微服務盛行的今天,絕大部分項目都采用的微服務框架,前后端分離方式。前端和后端進行交互,前端按照約定請求URL路徑,并傳入相關參數,后端服務器接收請求,進行業務處理,返回數據給前端。維護一套完善且規范的接口是非常有必要的, 這樣不僅能夠提高對接效率,也可以讓我的代碼看起來更加簡潔優雅。

使用統一返回結果時,還有一種情況,就是程序的報錯是由于運行時異常導致的結果,有些異常是我們在業務中拋出的,有些是無法提前預知。

因此,我們需要定義一個統一的全局異常,在Controller捕獲所有異常,并且做適當處理,并作為一種結果返回。

 

統一接口返回

定義API返回碼枚舉類

public enum ResultCode {
/* 成功狀態碼 */
SUCCESS(200, "成功"),

/* 錯誤狀態碼 */
NOT_FOUND(404, "請求的資源不存在"),
INTERNAL_ERROR(500, "服務器內部錯誤"),
PARAMETER_EXCEPTION(501, "請求參數校驗異常"),

/* 業務狀態碼 */
USER_NOT_EXIST_ERROR(10001, "用戶不存在"),
 ;

private Integer code;
private String message;

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

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

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

定義正常響應的API統一返回體

@Data
public class Result<T> implements Serializable {
private Integer code;
private String message;
private boolean success = true;
private T data;
@JsonIgnore
private ResultCode resultCode;

private Result() {
 }

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

public Result(ResultCode resultCode, T data) {
  this.code = resultCode.code();
  this.message = resultCode.message();
  this.data = data;
 }

public static <T> Result<T> success() {
  Result<T> result = new Result<>();
  result.setResultCode(ResultCode.SUCCESS);
  return result;
 }

public static <T> Result<T> success(T data) {
  Result<T> result = new Result<>();
  result.setResultCode(ResultCode.SUCCESS);
  result.setData(data);
    return result;
 }
}

定義異常響應的API統一返回體

@Data
public class ErrorResult implements Serializable {
private Integer code;
private String message;
private boolean success = false;
@JsonIgnore
private ResultCode resultCode;

public static ErrorResult error() {
  ErrorResult result = new ErrorResult();
  result.setResultCode(ResultCode.INTERNAL_ERROR);
  return result;
 }

public static ErrorResult error(String message) {
  ErrorResult result = new ErrorResult();
  result.setCode(ResultCode.INTERNAL_ERROR.code());
  result.setMessage(message);
  return result;
 }

public static ErrorResult error(Integer code, String message) {
  ErrorResult result = new ErrorResult();
  result.setCode(code);
  result.setMessage(message);
  return result;
 }

public static ErrorResult error(ResultCode resultCode, String message) {
  ErrorResult result = new ErrorResult();
  result.setResultCode(resultCode);
  result.setMessage(message)
  return result;
 }
}

編寫包裝返回結果的自定義注解

@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE, ElementType.METHOD}) //作用于方法和類(接口)上
@Documented
public @interface ResponseResult {
}

定義返回結果攔截器

@Component
public class ResponseResultInterceptor implements HandlerInterceptor {
/* 使用統一返回體的標識 */
private static final String RESPONSE_RESULT_ANNOTATION = "RESPONSE-RESULT-ANNOTATION";

@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) {
  // 正在處理請求的方法bean
  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_ANNOTATION, clazz.getAnnotation(ResponseResult.class));
     }
    // 判斷是否在方法上加了注解
    else if (method.isAnnotationPresent(ResponseResult.class)) {
      // 設置該請求返回體,需要包裝,往下傳遞,在ResponseBodyAdvice接口進行判斷
      request.setAttribute(RESPONSE_RESULT_ANNOTATION, method.getAnnotation(ResponseResult.class));
     }
   }
  return true;
 }
}

WebMvc配置類攔截器注冊者添加返回結果攔截器

@Configuration
public class WebMvcConfig implements WebMvcConfigurer {
/**
 * 添加自定義攔截器
 */
@Override
public void addInterceptors(InterceptorRegistry registry) {
  registry.addInterceptor(new ResponseResultInterceptor()).addPathPatterns("/**");
 }
}

編寫響應體處理器

/**
* 統一處理響應體,用Result.success靜態方法包裝,
* 在API接口使用時就可以直接返回原始類型
*/
@RestControllerAdvice
public class ResponseResultHandler implements ResponseBodyAdvice<Object> {
/* 使用統一返回體的標識 */
private static final String RESPONSE_RESULT_ANNOTATION = "RESPONSE-RESULT-ANNOTATION";

@Override
public boolean supports(MethodParameter methodParameter, Class<? extends HttpMessageConverter<?>> aClass) {
  ServletRequestAttributes sra = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
  HttpServletRequest request = Objects.requireNonNull(sra).getRequest();
  ResponseResult responseResult = (ResponseResult) request.getAttribute(RESPONSE_RESULT_ANNOTATION);
  // 判斷返回體是否需要處理
  return responseResult != null;
 }

@Override
public Object beforeBodyWrite(Object body, MethodParameter methodParameter, MediaType mediaType, Class<? extends HttpMessageConverter<?>> aClass, ServerHttpRequest serverHttpRequest, ServerHttpResponse serverHttpResponse) {
  // 異常響應體則直接返回code+message的消息體
  if (body instanceof ErrorResult) {
    return body;
   }
  // 正常響應體則返回Result包裝的code+message+data的消息體
  return Result.success(body);
 }
}

接口調用

@Api("用戶管理")
@RestController
@RequestMapping("user")
@ResponseResult // 作用于類上,對所有接口有效
public class UserController {

@Autowired
private UserService userService;

@ResponseResult // 作用于方法上
@ApiOperation("根據ID查詢用戶")
@GetMapping("one")
public User selectOne(Long id) {
  // 由于在ResponseResultHandler中已經統一將返回數據用Result.success包裝了,
  // 直接返回原始類型即可,代碼更簡潔
  return this.userService.queryById(id);
 }

@ResponseResult
@ApiOperation("查詢所有用戶")
@GetMapping("all")
public List<User> selectAll(Page page) {
  // 由于在ResponseResultHandler中已經統一將返回數據用Result.success包裝了,
  // 直接返回原始類型即可,代碼更簡潔
  return this.userService.queryAllByLimit(page);
 }
}

測試結果

SpringBoot中如何統一接口返回與全局異常處理詳解

SpringBoot中如何統一接口返回與全局異常處理詳解

 

全局異常處理

編寫自定義異常基類

@Data
public class BaseException extends RuntimeException {

private static final int BASE_EXCEPTION_CODE = ResultCode.INTERNAL_ERROR.code();
private static final String BASE_EXCEPTION_MESSAGE = ResultCode.INTERNAL_ERROR.message();

private Integer code;
private String message;

public BaseException() {
  super(BASE_EXCEPTION_MESSAGE);
  this.code = BASE_EXCEPTION_CODE;
  this.message = BASE_EXCEPTION_MESSAGE;
 }

public BaseException(String message) {
  super(message);
  this.code = BASE_EXCEPTION_CODE;
  this.message = message;
 }

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

public BaseException(Throwable cause) {
  super(cause);
  this.code = BASE_EXCEPTION_CODE;
  this.message = BASE_EXCEPTION_MESSAGE;
 }

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

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

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

編寫自定義業務異常類

public class BizException extends BaseException {
public BizException(ResultCode resultCode) {
  super(resultCode);
 }
}

定義全局異常處理類

通過@ExceptionHandler注解來統一處理某一類異常

@Slf4j
@RestControllerAdvice
public class GlobalExceptionHandler {
/**
 * 統一處理自定義基礎異常
 */
@ExceptionHandler(BaseException.class)
public ErrorResult baseException(BaseException e) {
  if (StringUtils.isEmpty(e.getCode())) {
    return ErrorResult.error(e.getMessage());
   }
  return ErrorResult.error(e.getCode(), e.getMessage());
 }

/**
 * 統一處理自定義業務異常
 */
@ExceptionHandler(BizException.class)
public ErrorResult bizException(BizException e) {
  if (StringUtils.isEmpty(e.getCode())) {
    return ErrorResult.error(e.getMessage());
   }
  return ErrorResult.error(e.getCode(), e.getMessage());
 }

/**
 * 統一處理非自定義異常外的所有異常
 */
@ExceptionHandler(Exception.class)
public ErrorResult handleException(Exception e) {
  log.error(e.getMessage(), e);
  return ErrorResult.error(e.getMessage());
 }

/**
 * 兼容Validation校驗框架:忽略參數異常處理器
 */
@ExceptionHandler(MissingServletRequestParameterException.class)
public ApiResult<String> parameterMissingExceptionHandler(MissingServletRequestParameterException e) {
  log.error(e.getMessage(), e);
  return ErrorResult.error(PARAMETER_EXCEPTION, "請求參數 " + e.getParameterName() + " 不能為空");
 }

/**
 * 兼容Validation校驗框架:缺少請求體異常處理器
 */
@ExceptionHandler(HttpMessageNotReadableException.class)
public ErrorResult parameterBodyMissingExceptionHandler(HttpMessageNotReadableException e) {
  log.error(e.getMessage(), e);
  return ErrorResult.error(PARAMETER_EXCEPTION, "參數體不能為空");
 }

/**
 * 兼容Validation校驗框架:參數效驗異常處理器
 */
@ExceptionHandler(MethodArgumentNotValidException.class)
public ErrorResult parameterExceptionHandler(MethodArgumentNotValidException e) {
  log.error(e.getMessage(), e);
  // 獲取異常信息
  BindingResult exceptions = e.getBindingResult();
  // 判斷異常中是否有錯誤信息,如果存在就使用異常中的消息,否則使用默認消息
  if (exceptions.hasErrors()) {
    List<ObjectError> errors = exceptions.getAllErrors();
    if (!errors.isEmpty()) {
      // 這里列出了全部錯誤參數,按正常邏輯,只需要第一條錯誤即可
      FieldError fieldError = (FieldError) errors.get(0);
      return ErrorResult.error(PARAMETER_EXCEPTION, fieldError.getDefaultMessage());
     }
   }
  return ErrorResult.error(PARAMETER_EXCEPTION, "請求參數校驗異常");
 }
}

接口調用

  @ResponseResult
@GetMapping
public User update() {
  // 非自定義的運行時異常
  long id = 10 / 0;
  return userService.queryById(id);
 }

@ResponseResult
@PostMapping
public User insert() {
  // 拋出自定義的基礎異常
  throw new BaseException();
 }

@ResponseResult
@DeleteMapping
public boolean delete() {
  // 拋出自定義的業務異常
  throw new BizException(USER_NOT_EXIST_ERROR);
 }

測試結果

SpringBoot中如何統一接口返回與全局異常處理詳解

SpringBoot中如何統一接口返回與全局異常處理詳解

SpringBoot中如何統一接口返回與全局異常處理詳解

 

總結

到此這篇關于SpringBoot中如何統一接口返回與全局異常處理的文章就介紹到這了,更多相關SpringBoot統一接口返回內容請搜索服務器之家以前的文章或繼續瀏覽下面的相關文章希望大家以后多多支持服務器之家!

原文鏈接:https://juejin.cn/post/7002926832160866318

延伸 · 閱讀

精彩推薦
  • Java教程Java使用SAX解析xml的示例

    Java使用SAX解析xml的示例

    這篇文章主要介紹了Java使用SAX解析xml的示例,幫助大家更好的理解和學習使用Java,感興趣的朋友可以了解下...

    大行者10067412021-08-30
  • Java教程Java8中Stream使用的一個注意事項

    Java8中Stream使用的一個注意事項

    最近在工作中發現了對于集合操作轉換的神器,java8新特性 stream,但在使用中遇到了一個非常重要的注意點,所以這篇文章主要給大家介紹了關于Java8中S...

    阿杜7482021-02-04
  • Java教程小米推送Java代碼

    小米推送Java代碼

    今天小編就為大家分享一篇關于小米推送Java代碼,小編覺得內容挺不錯的,現在分享給大家,具有很好的參考價值,需要的朋友一起跟隨小編來看看吧...

    富貴穩中求8032021-07-12
  • Java教程升級IDEA后Lombok不能使用的解決方法

    升級IDEA后Lombok不能使用的解決方法

    最近看到提示IDEA提示升級,尋思已經有好久沒有升過級了。升級完畢重啟之后,突然發現好多錯誤,本文就來介紹一下如何解決,感興趣的可以了解一下...

    程序猿DD9332021-10-08
  • Java教程20個非常實用的Java程序代碼片段

    20個非常實用的Java程序代碼片段

    這篇文章主要為大家分享了20個非常實用的Java程序片段,對java開發項目有所幫助,感興趣的小伙伴們可以參考一下 ...

    lijiao5352020-04-06
  • Java教程Java實現搶紅包功能

    Java實現搶紅包功能

    這篇文章主要為大家詳細介紹了Java實現搶紅包功能,采用多線程模擬多人同時搶紅包,文中示例代碼介紹的非常詳細,具有一定的參考價值,感興趣的小伙...

    littleschemer13532021-05-16
  • Java教程xml與Java對象的轉換詳解

    xml與Java對象的轉換詳解

    這篇文章主要介紹了xml與Java對象的轉換詳解的相關資料,需要的朋友可以參考下...

    Java教程網2942020-09-17
  • Java教程Java BufferWriter寫文件寫不進去或缺失數據的解決

    Java BufferWriter寫文件寫不進去或缺失數據的解決

    這篇文章主要介紹了Java BufferWriter寫文件寫不進去或缺失數據的解決方案,具有很好的參考價值,希望對大家有所幫助。如有錯誤或未考慮完全的地方,望...

    spcoder14552021-10-18
主站蜘蛛池模板: 日韩视频高清 | 久久中文字幕在线观看 | 亚洲精品av在线 | 日韩精品中文字幕一区二区 | 国产精品视频1区 | 亚洲99| 欧美交在线 | 91高清免费在线观看 | 久久精品一区二区三区不卡牛牛 | 爱逼爱操综合网 | 国产精品爱久久久久久久 | 久久久久99一区二区三区 | 欧美色淫| www.国产一区.com| 亚洲国产精品二区 | 看国产毛片 | 成人免费在线观看视频 | 91网页视频入口在线观看 | 一级毛片免费电影 | 麻豆国产一区 | 91久久精品一二三区 | lutube成人福利在线观看 | 黄色免费播放网站 | 国产精品免费一区二区三区都可以 | 国产亚洲精品久久777777 | 在线a亚洲视频播放在线观看 | 欧美另类在线视频 | 亚洲电影免费观看国语版 | 国产v综合v亚洲欧美久久 | 国产五区 | 水卜樱一区二区av | 在线成人av | h色网站免费观看 | 午夜生活理论片 | 国产精品一区二区在线 | 成人区一区二区三区 | 毛片免费看电影 | 久久99精品久久久久久久久久久久 | 久久99在线| 欧美日韩亚洲一区二区三区 | 久久午夜神器 |