@controllerAdvice 统一处理异常（spring-mvc)

墨蓝 2022-06-13 19:59 222阅读 0赞

# @controllerAdvice 统一处理异常（spring-mvc) #

如题，利用controllerAdvice注解进行异常的统一处理。

好，下面上货。

1、首先需要自定义异常。

package com.xueyou.demo.exp;
    
    
    public class CustomerException extends Exception {
        private String errCode;
        private String errMsg;
    
        public String getErrCode() {
            return errCode;
        }
    
        public void setErrCode(String errCode) {
            this.errCode = errCode;
        }
    
        public String getErrMsg() {
            return errMsg;
        }
    
        public void setErrMsg(String errMsg) {
            this.errMsg = errMsg;
        }
    
        public CustomerException(String errCode, String errMsg) {
            this.errCode = errCode;
            this.errMsg = errMsg;
        }
    
    }

2、然后需要统一处理异常：

package com.xueyou.demo.controller;
    
    import com.xueyou.demo.exp.CustomerException;
    import org.springframework.web.bind.annotation.ControllerAdvice;
    import org.springframework.web.bind.annotation.ExceptionHandler;
    import org.springframework.web.bind.annotation.RestController;
    
    import java.sql.SQLException;
    import java.util.HashMap;
    import java.util.Map;
    
    
    @RestController
    @ControllerAdvice
    public class ErrorController {
    
        @ExceptionHandler(CustomerException.class)
        public Map<String,String> customerExceptionHandler(CustomerException ex){
            Map<String,String> res = new HashMap<>();
            ex.printStackTrace();
            res.put("errCode",ex.getErrCode());
            res.put("errMsg",ex.getErrMsg());
            return res;
        }
    
        @ExceptionHandler(SQLException.class)
        public Map<String,String> sqlExceptionHandler(SQLException ex){
            Map<String,String> res = new HashMap<>();
            ex.printStackTrace();
            res.put("errorCode","3306");
            res.put("errorMsg",ex.getMessage());
            return res;
        }
    
        @ExceptionHandler(Exception.class)
        public Map<String,String> exceptionHandler(Exception ex){
            Map<String,String> res = new HashMap<>();
            ex.printStackTrace();
            res.put("errorCode","3000");
            res.put("errorMsg",ex.getMessage());
            return res;
        }
    }

这里需要注意的是，统一处理异常的controller需要放在和普通controller同级的包下，或者在ComponentScan的包下。在处理异常的时候可以使用System.out的方式，也可以使用logger.info，或者可以入到数据库中。

3、下面测试一下产生异常：

package com.xueyou.demo.controller;
    
    import com.xueyou.demo.exp.CustomerException;
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.RestController;
    
    import java.sql.SQLException;
    
    @RestController
    @RequestMapping("/error")
    public class ErrorTestController {
    
        @RequestMapping("/test")
        public String errorTest() throws Exception {
            throw new CustomerException("001", "001error,please fix it");
        }
    
        @RequestMapping("/test2")
        public String errorTest2() throws Exception {
            throw new SQLException("sql exception");
        }
    
        @RequestMapping("/test3")
        public String errorTest3() throws Exception {
            throw new Exception("this is a new Exception");
        }
    }

4、运行截图：

![Center][]

![Center 1][]

![Center 2][]

这样就能够把程序中异常统一处理了，无论是返回给前段，还是保存到数据库中进行异常统计，都是ok的。

[Center]: /images/20220614/da26a8f231d244f69288f02c3f38413b.png
[Center 1]: /images/20220614/4c20cb1840dd42a7bbb73af710d77a8e.png
[Center 2]: /images/20220614/9719ef496af84369b0bd8df2bea733f5.png