文章目录
- 全局异常处理
- 例子
- @ControllerAdvice的其他使用场景
全局异常处理
系统中异常包括:编译时异常和运行时异常RuntimeException ,前者通过捕获异常从而获取异常信息,后者主要通过规范代码开发、测试通过手段减少运行时异常的发生。在开发中,不管是dao层、service层还是controller层,都有可能抛出异常,在Springmvc中,能将所有类型的异常处理从各处理过程解耦出来,既保证了相关处理过程的功能较单一,也实现了异常信息的统一处理和维护。
SpringBoot全局异常处理方式主要两种:
使用@ControllerAdvice 和@ExceptionHandler 注解。
使用ErrorController类来实现
区别:
- @ControllerAdvice 方式只能处理控制器抛出的异常。此时请求已经进入控制器中。
- ErrorController类方式可以处理所有的异常,包括未进入控制器的错误,比如404,401等错误
- 如果应用中两者共同存在,则@ControllerAdvice 方式处理控制器抛出的异常,ErrorController类方式处理未进入控制器的异常。
- @ControllerAdvice 方式可以定义多个拦截方法,拦截不同的异常类,并且可以获取抛出的异常信息,自由度更大。
例子
GlobalException.java
例一
import com.xxxx.yebserver.pojo.RespBean;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RestControllerAdvice;
import java.sql.SQLException;
import java.sql.SQLIntegrityConstraintViolationException;
/**
* 全局异常
*
* @author zhoubin
* @since 1.0.0
*/
@RestControllerAdvice
public class GlobalExceptionHandler {
@ExceptionHandler(SQLException.class)
public RespBean mySQLException(SQLException e) {
if (e instanceof SQLIntegrityConstraintViolationException) {
return RespBean.error("(唯一的键值重复了,)操作失败!");
}
return RespBean.error("数据库异常,操作失败!");
}
}
@ControllerAdvice :表示这是一个控制器增强类,当控制器发生异常且符合类中定义的拦截异常类,将会被拦截
@ExceptionHandler :定义拦截的异常类
例二:
@ControllerAdvice
public class MyGlobalExceptionHandler {
@ExceptionHandler(Exception.class)
public ModelAndView customException(Exception e) {
ModelAndView mv = new ModelAndView();
mv.addObject("message", e.getMessage());
mv.setViewName("myerror");
return mv;
}
}
在该类中,可以定义多个方法,不同的方法处理不同的异常,例如专门处理空指针的方法、专门处理数组越界的方法…,也可以直接向上面代码一样,在一个方法中处理所有的异常信息。
@ExceptionHandler 注解用来指明异常的处理类型,即如果这里指定为 NullpointerException,则数组越界异常不会进到这个方法来。
@ControllerAdvice的其他使用场景
全局数据绑定功能可以用来做一些初始化的数据操作,我们可以将一些公共的数据定义在添加了@ControllerAdvice 注解的类中,这样,在每一个 Controller 的接口中,就都能够访问导致这些数据。
@ControllerAdvice
public class MyGlobalExceptionHandler {
@ModelAttribute(name = "md")
public Map<String,Object> mydata() {
HashMap<String, Object> map = new HashMap<>();
map.put("age", 99);
map.put("gender", "男");
return map;
}
}
使用 @ModelAttribute 注解标记该方法的返回数据是一个全局数据,默认情况下,这个全局数据的 key就是返回的变量名,value 就是方法返回值,当然开发者可以通过@ModelAttribute 注解的 name 属性去重新指定 key。
定义完成后,在任何一个Controller 的接口中,都可以获取到这里定义的数据:
@RestController
public class HelloController {
@GetMapping("/hello")
public String hello(Model model) {
Map<String, Object> map = model.asMap();
System.out.println(map);
int i = 1 / 0;
return "hello controller advice";
}
}