在开发现代Web应用程序时,异常处理是一个必不可少的组成部分。Spring Boot作为一个快速开发框架,提供了一种简单而强大的方式来处理应用程序中的异常情况。本文将介绍如何使用Spring Boot实现统一异常处理,使你的应用程序在出现异常时能够以一种优雅的方式响应。
一、为什么需要统一异常处理?
在传统的Java开发中,异常处理通常是分散在代码的各个部分中的。当应用程序出现异常时,开发者需要在每个可能抛出异常的地方编写相应的异常处理代码。这样做会导致代码冗余、可读性差,并且难以维护。
而使用统一异常处理可以将所有的异常情况集中处理,提高代码的可维护性和可读性。此外,还能够实现统一的异常响应,为前端或其他服务提供友好的错误信息。
二、Spring Boot统一异常处理的实现
在Spring Boot中,可以使用@RestControllerAdvice注解和@ExceptionHandler注解来实现统一异常处理。下面是一个简单的示例:
首先,创建一个全局异常处理类,使用@RestControllerAdvice注解标记它,然后在该类中定义各种异常的处理方法。
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.security.access.AccessDeniedException;
import org.springframework.validation.BindException;
import org.springframework.web.HttpRequestMethodNotSupportedException;
import org.springframework.web.bind.MethodArgumentNotValidException;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RestControllerAdvice;
import javax.servlet.http.HttpServletRequest;
/**
* 全局异常处理器
*
* @author xj
*/
@RestControllerAdvice
public class GlobalExceptionHandler
{
private static final Logger log = LoggerFactory.getLogger(GlobalExceptionHandler.class);
/**
* 权限校验异常
*/
@ExceptionHandler(AccessDeniedException.class)
public AjaxResult handleAccessDeniedException(AccessDeniedException e, HttpServletRequest request)
{
String requestURI = request.getRequestURI();
log.error("请求地址'{}',权限校验失败'{}'", requestURI, e.getMessage());
return AjaxResult.error(HttpStatus.FORBIDDEN, "没有权限,请联系管理员授权");
}
/**
* 请求方式不支持
*/
@ExceptionHandler(HttpRequestMethodNotSupportedException.class)
public AjaxResult handleHttpRequestMethodNotSupported(HttpRequestMethodNotSupportedException e,
HttpServletRequest request)
{
String requestURI = request.getRequestURI();
log.error("请求地址'{}',不支持'{}'请求", requestURI, e.getMethod());
return AjaxResult.error(e.getMessage());
}
/**
* 业务异常
*/
@ExceptionHandler(ServiceException.class)
public AjaxResult handleServiceException(ServiceException e, HttpServletRequest request)
{
log.error(e.getMessage(), e);
Integer code = e.getCode();
return StringUtils.isNotNull(code) ? AjaxResult.error(code, e.getMessage()) : AjaxResult.error(e.getMessage());
}
/**
* 拦截未知的运行时异常
*/
@ExceptionHandler(RuntimeException.class)
public AjaxResult handleRuntimeException(RuntimeException e, HttpServletRequest request)
{
String requestURI = request.getRequestURI();
log.error("请求地址'{}',发生未知异常.", requestURI, e);
return AjaxResult.error("未知异常,操作失败");
}
// 可以定义更多的异常处理方法...
}
在上面的示例中,handleException方法处理通用的Exception异常,handleNotFoundException方法处理自定义的NotFoundException异常。你可以根据自己的需求定义更多的异常处理方法。
在每个Controller中,如果有异常被抛出,会自动被全局异常处理类捕获,并调用对应的处理方法。
这样,无论在哪个Controller中抛出异常,都会经过统一的异常处理流程,返回统一的响应格式。
需要注意的是,为了使全局异常处理类生效,确保它在Spring Boot应用程序的组件扫描路径下。