项目中出现异常怎么办?是时候学会SpringBoot全局异常处理

前言

  1. 我们日常的开发中,不管是对底层数据库操作,还是业务层或控制层操作,都会不可避免地遇到各种可预知的、不可预知的异常需要处理。
  2. 如果每个过程都单独处理异常,那么系统的代码耦合度高,工作量大且不好统一,以后维护的工作量也很大。
  3. 如果能将所有类型的异常处理从各层中解耦出来,这样既保证了相关处理过程的功能单一,又实现了异常信息的统一处理和维护。

上面阐述的问题,我们在使用SpringBoot之后都能解决,我们可以使用如下3种方式处理异常:

  1. 使用@ExceptionHandler注解
  2. 实现HandlerExceptionResolver接口
  3. 使用@ControllerAdvice注解+@ExceptionHandler注解

1. 使用@ExceptionHandler注解

假设前端发送请求后端,然后后端处理的时候发生异常,这时可以有三种方式通知前端:

  1. 返回异常页面(不包含错误信息)。下面返回”exception”为异常视图名称(我们自己编写的异常页面)。
@Controller
public class ExceptionHandlerController {

    @ExceptionHandler(RuntimeException.class)
    public String exception(Exception e){
        e.printStackTrace();
        return "exception";
    }

    @RequestMapping("/exception")
    public void exception(){
        int i = 5/0;
    }
}



    
    


    正在处理中,请稍等...


  1. 返回ModelAndView。既返回视图,也返回异常信息。
@ExceptionHandler(RuntimeException.class)
public ModelAndView exception(RuntimeException e){
    ModelAndView mv = new ModelAndView();
    mv.addObject("msg",e.getMessage());
    mv.setViewName("/exception");
    e.printStackTrace();
    return mv;
}

@RequestMapping("/exception")
public void exception(){
    int i = 5/0;
}



    
    
正在处理中,请稍等…



在上面我们把异常信息存储在Model,然后在异常页面显示异常信息。

在这里插入图片描述
  1. 返回JSON格式数据。在前后端分离的情况下,大多都是返回JSON格式数据,这里我们规定如果出现异常,也返回JSON格式数据。
    响应实体类
@Data
public class MyResponse {
    private Long statusCode;    //响应状态码
    private T data; //响应数据
}
@ExceptionHandler(RuntimeException.class)
//表示返回JSON格式数据
@ResponseBody
public MyResponse exception(RuntimeException e){
    //在控制台打印
    e.printStackTrace();
    MyResponse response = new MyResponse();
    //出现的异常都返回500状态码
    response.setStatusCode(500);
    response.setData(e.getMessage());
    return response;
}

@RequestMapping("/exception")
public void exception(){
    int i = 5/0;
}

这样我们在发生异常的时候,也能返回JSON数据了。

在这里插入图片描述

注意点

  1. 使用@ExceptionHandler注解有一个不好的地方就是:进行异常处理的方法必须与出错的方法在同一个Controller里面。
  2. 这种方式不能实现全局异常处理。

2.实现HandlerExceptionResolver接口

  1. 这种方式可以实现全局的异常控制,只要在系统运行中发生异常,它都会捕获到。
  2. 实现该接口,必须重写resolveException方法,该方法就是异常处理逻辑,只能返回ModelAndView 对象。
@Component
public class MyGlobalException implements HandlerExceptionResolver {

    @Override
    public ModelAndView resolveException(HttpServletRequest httpServletRequest,
                                         HttpServletResponse httpServletResponse, Object o, Exception e) {
        ModelAndView mv = new ModelAndView();
        mv.addObject("msg",e.getMessage());
        mv.setViewName("/exception");
        e.printStackTrace();
        return mv;
    }
}

3.使用@ControllerAdvice注解+@ExceptionHandler注解

  1. 上面说到@ExceptionHandler需要进行异常处理的方法必须与出错的方法在同一个Controller里面。那么当代码加入了 @ControllerAdvice,则不需要必须在同一个controller中了。
  2. 从名字上可以看出大体意思是控制器增强。 也就是说,@controlleradvice+@ExceptionHandler也可以实现全局的异常捕捉。
@Data
@AllArgsConstructor
@NoArgsConstructor
public class ExceptionResponse {
    private T data;
}
@ControllerAdvice
@ResponseBody
@Slf4j
public class GlobalExceptionHandle {

    /**
     *  捕获404异常
     * @return
     */
    @ResponseStatus(HttpStatus.NOT_FOUND)
    @ExceptionHandler(NoHandlerFoundException.class)
    public ExceptionResponse notFoundException(NoHandlerFoundException e){
        log.error("资源未找到",e);
        return new ExceptionResponse<>("你好,你要的资源找不到!");
    }

    /**
     * 400——Bad Request
     */
    @ResponseStatus(HttpStatus.BAD_REQUEST)
    @ExceptionHandler(HttpMessageNotReadableException.class)
     public ExceptionResponse handleHttpMessageNotReadableException(HttpMessageNotReadableException  e) {
        log.error("参数解析失败", e);
        return new ExceptionResponse<>("bad request");
    }

    /**
     *  405——Method Not Allowed
     * @param e
     * @return
     */
    @ResponseStatus(HttpStatus.METHOD_NOT_ALLOWED)
    @ExceptionHandler(HttpRequestMethodNotSupportedException.class)
    public ExceptionResponse handleHttpRequestMethodNotSupportedException(HttpRequestMethodNotSupportedException  e){
        log.error("不支持当前请求方法",e);
        return new ExceptionResponse<>("request_method_not_supported");
    }

    /**
     * 415——Unsupported Media Type
     * @param e
     * @return
     */
    @ResponseStatus(HttpStatus.UNSUPPORTED_MEDIA_TYPE)
    @ExceptionHandler(HttpMediaTypeNotSupportedException.class)
    public ExceptionResponse handleHttpMediaTypeNotSupportedException(HttpMediaTypeNotSupportedException e){
        log.error("不支持当前媒体",e);
        return new ExceptionResponse("content_type_not_supported");
    }

    /**
     * 500:服务器内部异常
     * @param e
     * @return
     */
    @ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)
    @ExceptionHandler
    public ExceptionResponse internalServerError(Exception e){
        log.error("服务器内部异常",e);
        return new ExceptionResponse("你好,请稍等会...");
    }
}
  1. 在上面代码中,定义了捕获各种异常处理方法,不同的类型异常由不同的异常处理方法进行处理。
  2. 需要注意一点,就是SpringBoot默认不支持捕获404异常,需要添加下面两行配置才能使捕获404异常生效。
#出现错误时, 直接抛出异常
spring.mvc.throw-exception-if-no-handler-found=true
#不要为我们工程中的资源文件建立映射
spring.resources.add-mappings=false

测试404异常以及500异常

  1. 在浏览器中输入:http://localhost:8888/exception/404exception,就会报404异常,由上面定义的异常处理方法捕获
    在这里插入图片描述
  2. 在浏览器输入:http://localhost:8888/exception,就会报500异常,也是由上面定义的异常处理方法捕获
    在这里插入图片描述

上面我们是具体的异常类型分别定义异常捕获方法,我们也可以不那样做,不区分类型捕获全部异常

@ControllerAdvice
public class GlobalExceptionHandler {

    @ExceptionHandler
    @ResponseBody
    String globalHandleException(Exception e){
        return "Exception Deal! " + e.getMessage();
    }
}

上面的全局异常处理方法我们都是返回JSON数据。我们只需要把方法返回值修改为ModelAndView,也能返回视图域与模型数据了。
这样介绍完了SpringBoot全局异常处理机制,上面所说的几乎包含了开发中常见的异常处理方式。

阅读全文
下载说明:
1、本站所有资源均从互联网上收集整理而来,仅供学习交流之用,因此不包含技术服务请大家谅解!
2、本站不提供任何实质性的付费和支付资源,所有需要积分下载的资源均为网站运营赞助费用或者线下劳务费用!
3、本站所有资源仅用于学习及研究使用,您必须在下载后的24小时内删除所下载资源,切勿用于商业用途,否则由此引发的法律纠纷及连带责任本站和发布者概不承担!
4、本站站内提供的所有可下载资源,本站保证未做任何负面改动(不包含修复bug和完善功能等正面优化或二次开发),但本站不保证资源的准确性、安全性和完整性,用户下载后自行斟酌,我们以交流学习为目的,并不是所有的源码都100%无错或无bug!如有链接无法下载、失效或广告,请联系客服处理!
5、本站资源除标明原创外均来自网络整理,版权归原作者或本站特约原创作者所有,如侵犯到您的合法权益,请立即告知本站,本站将及时予与删除并致以最深的歉意!
6、如果您也有好的资源或教程,您可以投稿发布,成功分享后有站币奖励和额外收入!
7、如果您喜欢该资源,请支持官方正版资源,以得到更好的正版服务!
8、请您认真阅读上述内容,注册本站用户或下载本站资源即您同意上述内容!
原文链接:https://www.shuli.cc/?p=12765,转载请注明出处。
0

评论0

显示验证码
没有账号?注册  忘记密码?