Springboot全局异常处理Demo

通用信息返回json类

package com.example.demo.exception;

/**
 * @author shi
 * @created 2019/11/15
 */
public class GeneralResponse {

    private Integer code;
    private String msg;
    
    public Integer getCode() {
        return code;
    }
    public void setCode(Integer code) {
        this.code = code;
    }
    public String getMsg() {
        return msg;
    }
    public void setMsg(String msg) {
        this.msg = msg;
    }
    private GeneralResponse(Integer code, String msg) {
        this.code = code;
        this.msg = msg;
    }
    
    public static GeneralResponse success(String msg){
        return new GeneralResponse(1,msg);
    }
    public static GeneralResponse error(String msg){
        return new GeneralResponse(4,msg);
    }
}

自定义异常类

package com.example.demo.exception;

/**
 * @author shi
 * @created 2019/11/15
 * 自定义异常类
 */
public class CustomException extends RuntimeException {
    public CustomException(String message) {
        super(message);
    }
}

全局异常处理器

package com.example.demo.exception;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.servlet.ModelAndView;
import org.springframework.web.servlet.mvc.method.annotation.ResponseEntityExceptionHandler;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

/**
 * @author shi
 * @created 2019/11/15
 * 全局异常处理器
 */

//component，如果全部是json返回可用@RestControllerAdvice代替
@ControllerAdvice
public class GlobalExceptionHandler extends ResponseEntityExceptionHandler {

    private static final Logger logger = LoggerFactory.getLogger(GlobalExceptionHandler.class);

    @ResponseBody
    @ExceptionHandler(CustomException.class)//捕获目标异常类
    public GeneralResponse customExceptionHandler(HttpServletRequest request, final Exception e, HttpServletResponse response){

        logger.error("CustomException catch!");
        logger.error("first param",e);//异常放第二个参数才能打印异常栈
        return GeneralResponse.error(e.getMessage());//将异常的信息传入返回的信息
    }

    //此处返回自定义异常结果页面
    @ExceptionHandler(RuntimeException.class)
    public ModelAndView customExceptionHandler2(HttpServletRequest request, final Exception e, HttpServletResponse response){

        logger.error("CustomException catch!");
        logger.error("first param",e);
        ModelAndView mav = new ModelAndView();
        mav.addObject("errorMsg",e.getMessage());
        mav.setViewName("error.html");
        return mav;
    }
}

controller测试

	@RequestMapping("/exception")
    public String testException(){
        if(1==1)
            throw new CustomException("千万不能让1==1");
        return "error!";
    }

结果：

{“code”:4,“msg”:“千万不能让1==1”}

日志：

2019-11-15 18:01:25.715 ERROR 3934 — [nio-8081-exec-7] c.e.d.exception.GlobalExceptionHandler : CustomException catch!
2019-11-15 18:01:25.722 ERROR 3934 — [nio-8081-exec-7] c.e.d.exception.GlobalExceptionHandler : first param

com.example.demo.exception.CustomException: 千万不能让1==1
at sun.reflect.GeneratedConstructorAccessor114.newInstance(Unknown Source) ~[na:na]
at sun.reflect.DelegatingConstructorAccessorImpl.newInstance(DelegatingConstructorAccessorImpl.java:45005) ~[na:1.8.0_171]
at com.zeroturnaround.jrebelbase.facade.Forward.invokeNewConstructor(SourceFile:149) ~[na:1.8.0_171]
at com.example.demo.exception.CustomException.(CustomException.java:65534) ~[classes/:na]
at com.example.demo.controller.TestController.testException(TestController.java:43) ~[classes/:na]
at sun.reflect.GeneratedMethodAccessor86.invoke(Unknown Source) ~[na:na]
at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:45005) ~[na:1.8.0_171]
at java.lang.reflect.Method.invoke(Method.java:498) ~[na:1.8.0_171]