Spring MVC 例外を均一に処理する 3 つの方法

Spring には、統合例外処理の 3 つのメソッドがあります。つまり、

@ExceptionHandler アノテーションを使用する、HandlerExceptionResolver インターフェイスを実装する、および @controlleradvice アノテーションを使用する

#@ExceptionHandler アノテーションを使用する

このアノテーションを使用する場合の欠点の 1 つは、例外処理のメソッドがエラーの原因となったメソッドと同じコントローラー内に存在する必要があることです。次のように使用します。

@Controller      
public class GlobalController {
/**    
     * 用于处理异常的    
     * @return    
     */      
@ExceptionHandler({MyException.class})
public String exception(MyException e) {
System.out.println(e.getMessage());
e.printStackTrace();
return "exception";
}
@RequestMapping("test")
public void test() {
throw new MyException("出错了！");
}
}

ご覧のとおり、このメソッドの最大の欠点は、例外をグローバルに制御できないことです。各クラスは 1 回記述する必要があります。

HandlerExceptionResolver インターフェイスを実装する

このメソッドにより、グローバルな例外制御が可能になります。例:

@Component  
public class ExceptionTest implements HandlerExceptionResolver{
/**  
     * TODO 简单描述该方法的实现功能（可选）.  
     * @see org.springframework.web.servlet.HandlerExceptionResolver#resolveException(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, java.lang.Object, java.lang.Exception)  
     */  
public ModelAndView resolveException(HttpServletRequest request, HttpServletResponse response, Object handler,  
            Exception ex) {
System.out.println("This is exception handler method!");
return null;
}
}

@ControllerAdvice @ExceptionHandler アノテーションを使用します

@ExceptionHandler で説明したように、例外処理を必要とするメソッドは、例外処理を必要とするメソッドと同じコントローラー内に存在する必要があります。エラーが発生しました。コードで @ControllerAdvice を追加する場合、同じコントローラー内にある必要はありません。これも Spring 3.2 によってもたらされた新機能です。名前からわかるように、一般的にはコントローラーの強化を意味します。つまり、@controlleradvice @ExceptionHandler はグローバル例外キャッチを実装することもできます。

この WebExceptionHandle クラスをスキャンして Spring コンテナにロードできることを確認してください。

@ControllerAdvice
@ResponseBody
public class WebExceptionHandle {
private static Logger logger = LoggerFactory.getLogger(WebExceptionHandle.class);
/**
     * 400 - Bad Request
     */
@ResponseStatus(HttpStatus.BAD_REQUEST)
@ExceptionHandler(HttpMessageNotReadableException.class)
public ServiceResponse handleHttpMessageNotReadableException(HttpMessageNotReadableException e) {
logger.error("参数解析失败", e);
return ServiceResponseHandle.failed("could_not_read_json");
}
/**
     * 405 - Method Not Allowed
     */
@ResponseStatus(HttpStatus.METHOD_NOT_ALLOWED)
@ExceptionHandler(HttpRequestMethodNotSupportedException.class)
public ServiceResponse handleHttpRequestMethodNotSupportedException(HttpRequestMethodNotSupportedException e) {
logger.error("不支持当前请求方法", e);
return ServiceResponseHandle.failed("request_method_not_supported");
}
/**
     * 415 - Unsupported Media Type
     */
@ResponseStatus(HttpStatus.UNSUPPORTED_MEDIA_TYPE)
@ExceptionHandler(HttpMediaTypeNotSupportedException.class)
public ServiceResponse handleHttpMediaTypeNotSupportedException(Exception e) {
logger.error("不支持当前媒体类型", e);
return ServiceResponseHandle.failed("content_type_not_supported");
}
/**
     * 500 - Internal Server Error
     */
@ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)
@ExceptionHandler(Exception.class)
public ServiceResponse handleException(Exception e) {
if (e instanceof BusinessException){
return ServiceResponseHandle.failed("BUSINESS_ERROR", e.getMessage());
}
logger.error("服务运行异常", e);
e.printStackTrace();
return ServiceResponseHandle.failed("server_error");
}
}

処理される例外の型が @ExceptionHandler アノテーションで宣言されていない場合、デフォルトでパラメータ リスト内の例外の型が使用されます。したがって、次のように書くこともできます。

@ControllerAdvice
public class GlobalExceptionHandler {
@ExceptionHandler()
@ResponseBody
String handleException(Exception e){
return "Exception Deal! " + e.getMessage();
}
}

パラメータ オブジェクトは、コントローラー層によってスローされる例外オブジェクトです。

ResponseEntityExceptionHandler クラスを継承して、Rest インターフェイスのグローバル例外キャプチャを実装し、カスタム形式を返すことができます:

@Slf4j
@ControllerAdvice
public class ExceptionHandlerBean  extends ResponseEntityExceptionHandler {
/**
     * 数据找不到异常
     * @param ex
     * @param request
     * @return
     * @throws IOException
     */
@ExceptionHandler({DataNotFoundException.class})
public ResponseEntity<Object> handleDataNotFoundException(RuntimeException ex, WebRequest request) throws IOException {
return getResponseEntity(ex,request,ReturnStatusCode.DataNotFoundException);
}
/**
     * 根据各种异常构建 ResponseEntity 实体. 服务于以上各种异常
     * @param ex
     * @param request
     * @param specificException
     * @return
     */
private ResponseEntity<Object> getResponseEntity(RuntimeException ex, WebRequest request, ReturnStatusCode specificException) {
ReturnTemplate returnTemplate = new ReturnTemplate();
returnTemplate.setStatusCode(specificException);
returnTemplate.setErrorMsg(ex.getMessage());
return handleExceptionInternal(ex, returnTemplate,
new HttpHeaders(), HttpStatus.OK, request);
}
}

以上がSpring MVC 例外を均一に処理する 3 つの方法の詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。