springboot全局异常处理实例——@ControllerAdvice+ExceptionHandler

系统管理员 2022-03-15 04:10 297阅读 0赞

### 文章目录 ###

*   *   *  一、全局捕获异常后，返回json给浏览器
         *   *  1、自定义异常类 MyException.java
             *  2、控制器 MyController.java
             *  3、全局异常处理类 MyControllerAdvice
             *  4、运行结果
         *  二、全局捕获异常后，返回页面给浏览器
         *   *  1、自定义异常类 MyException.java（同上）
             *  2、控制器 MyController.java（同上）
             *  3、全局异常处理类 MyControllerAdvice
             *  4、页面渲染 error.ftl（用freemarker渲染）
             *  5、运行结果

### 一、全局捕获异常后，返回json给浏览器 ###

项目结构：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hqdTIy_size_16_color_FFFFFF_t_70]

#### 1、自定义异常类 MyException.java ####

package com.gui.restful;
    
    /**
     * 自定义异常类
     */
    public class MyException extends RuntimeException{
        private String code;
        private String msg;
        public MyException(String code,String msg){
            this.code=code;
            this.msg=msg;
        }
    
        public String getCode() {
            return code;
        }
    
        public void setCode(String code) {
            this.code = code;
        }
    
        public String getMsg() {
            return msg;
        }
    
        public void setMsg(String msg) {
            this.msg = msg;
        }
    }

#### 2、控制器 MyController.java ####

package com.gui.restful;
    
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.ResponseBody;
    import org.springframework.web.bind.annotation.RestController;
    
    /**
     * controller抛出异常
     */
    @RestController
    public class MyController {
    
        @RequestMapping("hello")
        public String hello() throws Exception{
            throw new MyException("101","系统异常");
        }
    
    }

#### 3、全局异常处理类 MyControllerAdvice ####

package com.gui.restful;
    
    import org.springframework.web.bind.annotation.ControllerAdvice;
    import org.springframework.web.bind.annotation.ExceptionHandler;
    import org.springframework.web.bind.annotation.RequestBody;
    import org.springframework.web.bind.annotation.ResponseBody;
    
    import java.util.HashMap;
    import java.util.Map;
    
    /**
     * 全局异常捕获处理
     */
    @ControllerAdvice //controller增强器
    public class MyControllerAdvice {
    
        @ResponseBody
        @ExceptionHandler(value=MyException.class) //处理的异常类型
        public Map myExceptionHandler(MyException e){
            Map<String,String> map=new HashMap<>();
            map.put("code",e.getCode());
            map.put("msg",e.getMsg());
            return map;
        }
    
    }

#### 4、运行结果 ####

启动应用，访问 [http://localhost:8080/hello，出现以下结果，说明自定义异常被成功拦截][http_localhost_8080_hello]  
![在这里插入图片描述][20190228164002176.]

### 二、全局捕获异常后，返回页面给浏览器 ###

#### 1、自定义异常类 MyException.java（同上） ####

#### 2、控制器 MyController.java（同上） ####

#### 3、全局异常处理类 MyControllerAdvice ####

package com.gui.restful;
    
    import org.springframework.web.bind.annotation.ControllerAdvice;
    import org.springframework.web.bind.annotation.ExceptionHandler;
    import org.springframework.web.bind.annotation.RequestBody;
    import org.springframework.web.bind.annotation.ResponseBody;
    import org.springframework.web.servlet.ModelAndView;
    
    import java.util.HashMap;
    import java.util.Map;
    
    /**
     * 全局异常捕获处理
     */
    @ControllerAdvice //controller增强器
    public class MyControllerAdvice {
    
        @ExceptionHandler(value=MyException.class) //处理的异常类型
        public ModelAndView myExceptionHandler(MyException e){
            ModelAndView modelAndView=new ModelAndView();
            modelAndView.setViewName("error");
            modelAndView.addObject("code",e.getCode());
            modelAndView.addObject("msg",e.getMsg());
            return modelAndView;
        }
    
    }

#### 4、页面渲染 error.ftl（用freemarker渲染） ####

**pom.xml中引入freemarker依赖**

<dependency>
    			<groupId>org.springframework.boot</groupId>
    			<artifactId>spring-boot-starter-freemarker</artifactId>
    		</dependency>

**error.ftl**

<!DOCTYPE>
    <html>
    <head>
        <title>错误页面</title>
    </head>
    <body>
    <h1>code:${code}</h1>
    <h1>msg:${msg}</h1>
    </body>
    </html>

#### 5、运行结果 ####

启动应用，访问 [http://localhost:8080/hello，出现以下结果，说明自定义异常被成功拦截][http_localhost_8080_hello]  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hqdTIy_size_16_color_FFFFFF_t_70 1]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hqdTIy_size_16_color_FFFFFF_t_70]: /images/20220315/d2c8f42252f14770b23560c52f1e6d6b.png
[http_localhost_8080_hello]: http://localhost:8080/hello%EF%BC%8C%E5%87%BA%E7%8E%B0%E4%BB%A5%E4%B8%8B%E7%BB%93%E6%9E%9C%EF%BC%8C%E8%AF%B4%E6%98%8E%E8%87%AA%E5%AE%9A%E4%B9%89%E5%BC%82%E5%B8%B8%E8%A2%AB%E6%88%90%E5%8A%9F%E6%8B%A6%E6%88%AA
[20190228164002176.]: /images/20220315/916488dfe1b048f891305c8a06ff6538.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hqdTIy_size_16_color_FFFFFF_t_70 1]: /images/20220315/d3db011a672c4c3a95a346a7c1fba3ae.png