springboot统一异常处理

最新推荐文章于 2025-07-06 01:08:28 发布

原创最新推荐文章于 2025-07-06 01:08:28 发布 · 5k 阅读

1 ·

CC 4.0 BY-SA版权

文章标签：

#spring-boot #异常处理

本文介绍如何在SpringBoot项目中实现全局异常处理，包括自定义异常处理类、使用@ControllerAdvice注解、@ExceptionHandler注解及返回不同类型的异常信息。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

springboot提供了一个默认映射 /error，当处理中抛出异常之后，会转到该请求中处理，并且该请求有一个全局的错误页面用来展示异常内容
也可以自己创建全局异常处理类，通过@ControllerAdvice定义统一异常处理类，@ExceptionHandler 用来定义函数针对的异常类型，最后将Exception对象和请求URL映射到error.html中

大体步骤：

一、新建一个springboot项目，选择依赖： web，thymeleaf

二、定义全局异常处理类
1.通过使用@ControllerAdvice定义统一的异常处理类，可以不用在每个Controller中逐个定义异常处理方式
2.@ExceptionHandler 用来定义函数针对的异常类型，controller通过抛出的异常类型匹配
3.异常处理后返回可以有两种方式：
返回异常提示页面：如将Exception对象和请求URL映射到 resource/templates/error.html中，可以有多个错误页面。
返回json格式异常信息：可以创建一个对象，用于封装json数据

@ControllerAdvice
public class GlobalExceptionHandler {

    //默认异常处理页面
    public static final String DEFAUL_ERROR_VIEW = "error";

    /**
     * 默认异常处理方法,返回异常请求路径和异常信息
     */
    @ExceptionHandler(value = Exception.class)
    public ModelAndView defaulErrorHandler(HttpServletRequest request,Exception e) throws  Exception{

        ModelAndView mav = new ModelAndView();
        mav.addObject("exception",e);                   //异常信息
        mav.addObject("url","请求路径：" + request.getRequestURI());   //异常请求路径
        mav.setViewName(DEFAUL_ERROR_VIEW);                          //返回异常处理页面
        return mav;
    }

    /**
     * @ExceptionHandler 匹配抛出自定义的异常类型 MyException
     * ErrorInfo<String> 为自定义的一个数据封装类，用于返回的json数据
     * 如果返回的是json格式，需要加上@ResponsBody
     */
    @ExceptionHandler(value = MyException.class)
    @ResponseBody
    public ErrorInfo<String> jsonErrorHandler(HttpServletRequest request,MyException e) throws Exception{

        ErrorInfo<String> error = new ErrorInfo<>();
        error.setCode(ErrorInfo.ERROR);
        error.setMessage(e.getMessage());
        error.setUrl(request.getRequestURI());
        error.setData("未知错误");
        return error;
    }

}

本质上，只需在@ExceptionHandler之后加入@ResponseBody，就能让处理函数return的内容转换为JSON格式。如果不加@ResponseBody会默认按页面方式跳转。

三、在controller中（捕获）抛出异常
通过实现上述内容之后，我们只需要在Controller中抛出Exception，当然我们可能会有多种不同的Exception，也可以自定义一些异常类用于处理不同的异常情况。然后在@ControllerAdvice类中，根据抛出的具体Exception类型匹配@ExceptionHandler中配置的异常类型来匹配错误映射和处理。

@RestController
public class TestController {

    /**
     * 异常错误处理返回错误页面
     */
    @RequestMapping("/returnHtml")
    public String testErrorReturn1() throws Exception{
        throw new Exception("请求出错!");
    }

    /**
     * 异常错误处理返回json格式
     * 根据抛出的异常类型匹配到对应的异常处理方法
     */
    @RequestMapping("/returnJson")
    public String testErrorReturn2() throws MyException {
        throw new MyException("请求出错2");
    }

    @RequestMapping("/")
    public String index(ModelMap map){
        map.addAttribute("host","http://baidu.com");
        return "index";
    }
}