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 拦截异常内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

datatables 带查询条件java服务端分页处理实例
本篇文章主要介绍了datatables 带查询条件java服务端分页处理实例，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2017-06-06
IDEA下使用Spring Boot热加载的实现
本文主要介绍了IDEA下使用Spring Boot热加载的实现，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2023-06-06
Java几个重要的关键字详析
这篇文章主要介绍了Java几个重要的关键字详析，文章围绕主题展开详细的内容介绍，具有一定的参考一下，需要的小伙伴可以参考一下，希望对你的学习有所帮助
2022-07-07
Java e.printStackTrace()案例讲解
这篇文章主要介绍了Java e.printStackTrace()案例讲解,本篇文章通过简要的案例,讲解了该项技术的了解与使用,以下就是详细内容,需要的朋友可以参考下
2021-08-08
基于Process#waitFor()阻塞问题的解决
这篇文章主要介绍了Process#waitFor()阻塞问题的解决，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2021-12-12
Java面试题冲刺第二十一天--JVM
这篇文章主要为大家分享了最有价值的三道关于JVM的面试题，涵盖内容全面，包括数据结构和算法相关的题目、经典面试编程题等，感兴趣的小伙伴们可以参考一下
2021-08-08
java多线程编程之使用Synchronized关键字同步类方法
JAVA中要想解决“脏数据”的问题，最简单的方法就是使用synchronized关键字来使run方法同步,看下面的代码，只要在void和public之间加上synchronized关键字
2014-01-01
JVM虚拟机的执行流程解析
这篇文章主要介绍了JVM虚拟机的执行流程图解,Java虚拟机的启动是通过引导类加载器创建一个初始类来完成的,这个类是由虚拟机的具体实现指定的,程序开始执行时他才运行,程序结束时他就停止,需要的朋友可以参考下
2023-08-08
解决ThingsBoard编译报错问题:Failure to find org.gradle:gradle-too
这篇文章主要介绍了ThingsBoard编译报错:Failure to find org.gradle:gradle-tooling-api:jar:6.3,本文给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下
2023-03-03
关于Java中代码块的执行顺序
这篇文章主要介绍了关于Java中代码块的执行顺序,构造代码块是给所有对象进行统一初始化,而构造函数是给对应的对象初始化,因为构造函数是可以多个的,运行哪个构造函数就会建立什么样的对象,但无论建立哪个对象,都会先执行相同的构造代码块,需要的朋友可以参考下
2023-08-08