废话不多说,先贴代码:
package com.pinyu.system.exception;
import java.util.HashMap;
import java.util.Map;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.springframework.ui.Model;
import org.springframework.web.bind.WebDataBinder;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.InitBinder;
import org.springframework.web.bind.annotation.ModelAttribute;
import org.springframework.web.bind.annotation.ResponseBody;
/**
* @author ypp
* 创建时间:2018年10月15日 下午4:06:50
* @Description: TODO(全局异常处理)
*/
@ControllerAdvice
public class GlobalControllerAdvice {
protected static Logger log=LogManager.getLogger(GlobalControllerAdvice.class);
/**
* 应用到所有@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) {
String sOut = ex.getClass().getName()+"\r\n";
StackTraceElement[] trace = ex.getStackTrace();
for (StackTraceElement s : trace) {
sOut += "\tat " + s + "\r\n";
}
Map map = new HashMap();
map.put("code", 0);
map.put("msg", "服务器异常,请联系管理员");
log.error(sOut);
return map;
}
}
String sOut = ex.getClass().getName()+"\r\n";
StackTraceElement[] trace = ex.getStackTrace();
for (StackTraceElement s : trace) {
sOut += "\tat " + s + "\r\n";
}
以上小段代码是为了log4j2日志文件输出和控制台输出获取的异常信息,由于使用的spring boot 1.4.3,spring boot1.4版本以上不支持log4j,故使用log4j2.
以下是详细介绍:
启动应用后,被 @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。
拓展:既然能捕获异常,那发生异常之后,我们自定义异常需要进行业务逻辑处理呢?当系统需要比较多自定义异常的时候,if else过多代码很长,个人认为不太优雅吧。会用到一些策略模式的思路
自定义两个异常:AuthException和MemberException继承自抽象类BaseException
BaseException
package com.shinedata.exception;
public abstract class BaseException extends Exception {
public BaseException(String msg){
super(msg);
}
public abstract String operation(Object... params);
}
AuthException
package com.shinedata.exception;
public class AuthException extends BaseException {
public AuthException(String msg) {
super(msg);
}
@Override
public String operation(Object... params) {
System.out.println("authException.......");
return "";
}
}
MemberException
package com.shinedata.exception;
public class MemberException extends BaseException {
public MemberException(String msg) {
super(msg);
}
@Override
public String operation(Object... params) {
System.out.println("MemberException");
return "";
}
}
BaseExceptionOperation
package com.shinedata.exception;
public class BaseExceptionOperation {
private BaseException baseException;
private Object[] params;
public BaseExceptionOperation(Exception ex, Object... params) {
this.baseException=(BaseException) ex;
this.params=params;
}
public void operation(){
baseException.operation(params);
}
}
代码改造:
/**
* 全局异常捕捉处理
* @param ex
* @return
*/
@ResponseBody
@ExceptionHandler(value = Exception.class)
public Map errorHandler(Exception ex) {
boolean assignableFrom = BaseException.class.isAssignableFrom(ex.getClass());
//BaseException是当前ex的父类
if(assignableFrom){
new BaseExceptionOperation(ex, null).operation();
}
String sOut = ex.getClass().getName()+"\r\n";
StackTraceElement[] trace = ex.getStackTrace();
for (StackTraceElement s : trace) {
sOut += "\tat " + s + "\r\n";
}
Map map = new HashMap();
map.put("code", 0);
map.put("msg", "服务器异常,请联系管理员");
// log.error(sOut);
return map;
}
上面的思路的好处是不用在全局异常处理里面写if else这种代码。多一个自定义异常场景,直接在自定义异常继承BaseException复写业务逻辑方法即可。
最终测试结果: