脚本之家 服务器常用软件
快捷导航
您的位置：首页 → 软件编程 → java → SpringBoot @ControllerAdvice 拦截异常

SpringBoot @ControllerAdvice 拦截异常并统一处理

 更新时间：2020年09月15日 10:46:08   作者：神奇Sam  
这篇文章主要介绍了SpringBoot @ControllerAdvice 拦截异常并统一处理，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧

在spring 3.2中，新增了@ControllerAdvice 注解，可以用于定义@ExceptionHandler、@InitBinder、@ModelAttribute，并应用到所有@RequestMapping中。参考：@ControllerAdvice 文档

一、介绍

创建 MyControllerAdvice，并添加 @ControllerAdvice注解。

package com.sam.demo.controller;

import org.springframework.ui.Model;
import org.springframework.web.bind.WebDataBinder;
import org.springframework.web.bind.annotation.*;
import java.util.HashMap;
import java.util.Map;

/**
 * controller 增强器
 * @author sam
 * @since 2017/7/17
 */
@ControllerAdvice
public class MyControllerAdvice {

 /**
  * 应用到所有@RequestMapping注解方法，在其执行之前初始化数据绑定器
  * @param binder
  */
 @InitBinder
 public void initBinder(WebDataBinder binder) {}

 /**
  * 把值绑定到Model中，使全局@RequestMapping可以获取到该值
  * @param model
  */
 @ModelAttribute
 public void addAttributes(Model model) {
  model.addAttribute("author", "Magical Sam");
 }

 /**
  * 全局异常捕捉处理
  * @param ex
  * @return
  */
 @ResponseBody
 @ExceptionHandler(value = Exception.class)
 public Map errorHandler(Exception ex) {
  Map map = new HashMap();
  map.put("code", 100);
  map.put("msg", ex.getMessage());
  return map;
 }

}

启动应用后，被 @ExceptionHandler、@InitBinder、@ModelAttribute 注解的方法，都会作用在 被 @RequestMapping 注解的方法上。

@ModelAttribute：在Model上设置的值，对于所有被 @RequestMapping 注解的方法中，都可以通过 ModelMap 获取，如下：

@RequestMapping("/home")
public String home(ModelMap modelMap) {
 System.out.println(modelMap.get("author"));
}

//或者 通过@ModelAttribute获取

@RequestMapping("/home")
public String home(@ModelAttribute("author") String author) {
 System.out.println(author);
}

@ExceptionHandler 拦截了异常，我们可以通过该注解实现自定义异常处理。其中，@ExceptionHandler 配置的 value 指定需要拦截的异常类型，上面拦截了 Exception.class 这种异常。

二、自定义异常处理（全局异常处理）

spring boot 默认情况下会映射到 /error 进行异常处理，但是提示并不十分友好，下面自定义异常处理，提供友好展示。

1、编写自定义异常类：

package com.sam.demo.custom;

/**
 * @author sam
 * @since 2017/7/17
 */
public class MyException extends RuntimeException {

 public MyException(String code, String msg) {
  this.code = code;
  this.msg = msg;
 }

 private String code;
 private String msg;

 // getter & setter
}

注：spring 对于 RuntimeException 异常才会进行事务回滚。

2、编写全局异常处理类

创建 MyControllerAdvice.java，如下：

package com.sam.demo.controller;

import org.springframework.ui.Model;
import org.springframework.web.bind.WebDataBinder;
import org.springframework.web.bind.annotation.*;

import java.util.HashMap;
import java.util.Map;

/**
 * controller 增强器
 *
 * @author sam
 * @since 2017/7/17
 */
@ControllerAdvice
public class MyControllerAdvice {

 /**
  * 全局异常捕捉处理
  * @param ex
  * @return
  */
 @ResponseBody
 @ExceptionHandler(value = Exception.class)
 public Map errorHandler(Exception ex) {
  Map map = new HashMap();
  map.put("code", 100);
  map.put("msg", ex.getMessage());
  return map;
 }
 
 /**
  * 拦截捕捉自定义异常 MyException.class
  * @param ex
  * @return
  */
 @ResponseBody
 @ExceptionHandler(value = MyException.class)
 public Map myErrorHandler(MyException ex) {
  Map map = new HashMap();
  map.put("code", ex.getCode());
  map.put("msg", ex.getMsg());
  return map;
 }

}

3、controller中抛出异常进行测试。

@RequestMapping("/home")
public String home() throws Exception {

//  throw new Exception("Sam 错误");
 throw new MyException("101", "Sam 错误");

}

启动应用，访问：http://localhost:8080/home ，正常显示以下json内容，证明自定义异常已经成功被拦截。

{"msg":"Sam 错误","code":"101"}

* 如果不需要返回json数据，而要渲染某个页面模板返回给浏览器，那么MyControllerAdvice中可以这么实现：

@ExceptionHandler(value = MyException.class)
public ModelAndView myErrorHandler(MyException ex) {
 ModelAndView modelAndView = new ModelAndView();
 modelAndView.setViewName("error");
 modelAndView.addObject("code", ex.getCode());
 modelAndView.addObject("msg", ex.getMsg());
 return modelAndView;
}

在 templates 目录下，添加 error.ftl（这里使用freemarker） 进行渲染：

<!DOCTYPE html>
<html lang="en">
<head>
 <meta charset="UTF-8">
 <title>错误页面</title>
</head>
<body>
 <h1>$[code]</h1>
 <h1>${msg}</h1>
</body>
</html>

重启应用，http://localhost:8080/home 显示自定的错误页面内容。

补充：如果全部异常处理返回json，那么可以使用 @RestControllerAdvice 代替 @ControllerAdvice ，这样在方法上就可以不需要添加 @ResponseBody。

到此这篇关于SpringBoot @ControllerAdvice 拦截异常并统一处理的文章就介绍到这了,更多相关SpringBoot @ControllerAdvice 拦截异常内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

相关文章

  • java实现简单扫雷游戏

    java实现简单扫雷游戏

    这篇文章主要为大家详细介绍了java实现简单扫雷游戏，文中示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
    2020-04-04
  • Java与Kotlin互调原理讲解

    Java与Kotlin互调原理讲解

    这篇文章主要介绍了Java与Kotlin互调原理，分享内容有Kt调用-Java参数非null的处理、Java中使用kt关键字声明的变量和方法、Kt调用Java-SAM转换等内容，需要的小伙伴可以参考一下
    2022-02-02
  • Java Feign微服务接口调用方法详细讲解

    Java Feign微服务接口调用方法详细讲解

    现如今微服务架构十分流行，而采用微服务构建系统也会带来更清晰的业务划分和可扩展性。java如果使用微服务就离不开springcloud，我这里是把服务注册到nacos上，各个服务之间的调用使用feign
    2023-01-01
  • java基于UDP实现在线聊天功能

    java基于UDP实现在线聊天功能

    这篇文章主要为大家详细介绍了java基于UDP实现在线聊天功能，文中示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
    2022-09-09
  • 关于ireport中传入list的处理方式

    关于ireport中传入list的处理方式

    这篇文章主要介绍了关于ireport中传入list的处理方式，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
    2023-02-02
  • Java编写网上超市购物结算功能程序

    Java编写网上超市购物结算功能程序

    这篇文章主要为大家详细介绍了Java编写网上超市购物结算功能程序的具体代码，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
    2016-06-06
  • SpringBoot中熔断器的原理和使用详解

    SpringBoot中熔断器的原理和使用详解

    这篇文章主要介绍了SpringBoot中熔断器的原理和使用详解,熔断器是一种用于处理分布式系统中故障的设计模式，它可以防止出现故障的服务对整个系统造成连锁反应,需要的朋友可以参考下
    2023-07-07
  • 一文学透ApplicationContext继承接口功能及与BeanFactory区别

    一文学透ApplicationContext继承接口功能及与BeanFactory区别

    这篇文章主要为大家介绍了ApplicationContext继承接口功能及与BeanFactory区别示例解析，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步，早日升职加薪
    2023-04-04
  • Java Socket实现单线程通信的方法示例

    Java Socket实现单线程通信的方法示例

    这篇文章主要介绍了Java Socket实现单线程通信的方法,结合具体实例形式分析了java socket单线程通信的原理与客户端、服务器端相关实现技巧,需要的朋友可以参考下
    2017-06-06
  • JavaWeb实现用户登录注册功能实例代码(基于Servlet+JSP+JavaBean模式)

    JavaWeb实现用户登录注册功能实例代码(基于Servlet+JSP+JavaBean模式)

    这篇文章主要基于Servlet+JSP+JavaBean开发模式实现JavaWeb用户登录注册功能实例代码，非常实用，本文介绍的非常详细，具有参考借鉴价值，感兴趣的朋友一起看看吧
    2016-05-05

最新评论