7. SpringBoot 全局异常处理 Json+模板页面

你的名字 2022-08-29 09:37 176阅读 0赞

### 文章目录 ###

*  1.建项目 引依赖
 *  2. 统一返回结果
 *   *  2.1 统一结果返回类
     *  2.2 状态码
 *  3. 异常相关类
 *   *  3.1 自定义基本异常
     *  3.2 Json格式异常处理
     *  3.3 模板页面异常处理
 *  4. 核心：统一异常处理
 *   *  4.2 处理json+页面异常
     *  4.2 错误模板页面 error.html
 *  5. controller测试
 *   *  5.1 访问 http://localhost:8080/hello
     *  5.2 访问 http://localhost:8080/hello2
     *  5.3 访问 http://localhost:8080/hello3
 *  6.异常处理进阶

文章参考  
spring-boot-demo-exception-handler  
[github跳转][github]  
![在这里插入图片描述][108a9b1fbad34093a15ada8c98b02a94.png]

在我们的项目中 会遇到许多异常的情况 我们应及时的捕获异常 但是不可避免的，会有许多我们意想不到的异常出现，所以我们应自定义全局异常，然后统一处理这些异常信息

# 1.建项目 引依赖 #

新建SpringBoot项目 引入lombok，web，thymeleaf等依赖

<dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-web</artifactId>
            </dependency>
            <dependency>
                <groupId>org.projectlombok</groupId>
                <artifactId>lombok</artifactId>
                <optional>true</optional>
            </dependency>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-thymeleaf</artifactId>
            </dependency>
            
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-devtools</artifactId>
                <optional>true</optional>
            </dependency>

# 2. 统一返回结果 #

## 2.1 统一结果返回类 ##

稍微瞄几眼就行 用起来很简单 `Status`在下面

@Data
    public class ApiResponse { 
    	/** * 状态码 */
    	private Integer code;
    
    	/** * 返回内容 */
    	private String message;
    
    	/** * 返回数据 */
    	private Object data;
    
    	/** * 无参构造函数 */
    	private ApiResponse() { 
    
    	}
    
    	/** * 全参构造函数 * * @param code 状态码 * @param message 返回内容 * @param data 返回数据 */
    	private ApiResponse(Integer code, String message, Object data) { 
    		this.code = code;
    		this.message = message;
    		this.data = data;
    	}
    
    	/** * 构造一个自定义的API返回 * * @param code 状态码 * @param message 返回内容 * @param data 返回数据 * @return ApiResponse */
    	public static ApiResponse of(Integer code, String message, Object data) { 
    		return new ApiResponse(code, message, data);
    	}
    
    	/** * 构造一个成功且带数据的API返回 * * @param data 返回数据 * @return ApiResponse */
    	public static ApiResponse ofSuccess(Object data) { 
    		return ofStatus(Status.OK, data);
    	}
    
    	/** * 构造一个成功且自定义消息的API返回 * * @param message 返回内容 * @return ApiResponse */
    	public static ApiResponse ofMessage(String message) { 
    		return of(Status.OK.getCode(), message, null);
    	}
    
    	/** * 构造一个有状态的API返回 * * @param status 状态 {@link Status} * @return ApiResponse */
    	public static ApiResponse ofStatus(Status status) { 
    		return ofStatus(status, null);
    	}
    
    	/** * 构造一个有状态且带数据的API返回 * * @param status 状态 {@link Status} * @param data 返回数据 * @return ApiResponse */
    	public static ApiResponse ofStatus(Status status, Object data) { 
    		return of(status.getCode(), status.getMessage(), data);
    	}
    
    	/** * 构造一个异常且带数据的API返回 * * @param t 异常 * @param data 返回数据 * @param <T> {@link BaseException} 的子类 * @return ApiResponse */
    	public static <T extends BaseException> ApiResponse ofException(T t, Object data) { 
    		return of(t.getCode(), t.getMessage(), data);
    	}
    
    	/** * 构造一个异常且带数据的API返回 * * @param t 异常 * @param <T> {@link BaseException} 的子类 * @return ApiResponse */
    	public static <T extends BaseException> ApiResponse ofException(T t) { 
    		return ofException(t, null);
    	}
    }

## 2.2 状态码 ##

可以自己拓展 暂时就这两个

@Getter
    public enum Status { 
        /** * 操作成功 */
        OK(200, "操作成功"),
    
        /** * 未知异常 */
        UNKNOWN_ERROR(500, "服务器出错啦");
        /** * 状态码 */
        private Integer code;
        /** * 内容 */
        private String message;
    
        Status(Integer code, String message) { 
            this.code = code;
            this.message = message;
        }
    }

# 3. 异常相关类 #

## 3.1 自定义基本异常 ##

继承了`RuntimeException` 为后面的自定义异常服务的

对于@EqualsAndHashCode 不清楚的同学

可以看一下这篇文章的解释

[Lombok 的 @EqualsAndHashCode(callSuper = false) 的使用][Lombok _ _EqualsAndHashCode_callSuper _ false_]

@Data
    @EqualsAndHashCode(callSuper = true)
    public class BaseException extends RuntimeException { 
        private Integer code;
        private String message;
    
        public BaseException(Status status) { 
            super(status.getMessage());
            this.code = status.getCode();
            this.message = status.getMessage();
        }
    
        public BaseException(Integer code, String message) { 
            super(message);
            this.code = code;
            this.message = message;
        }
    }

## 3.2 Json格式异常处理 ##

`用于前后端分离 推荐使用`

@Getter
    public class JsonException extends BaseException { 
    
        public JsonException(Status status) { 
            super(status);
        }
    
        public JsonException(Integer code, String message) { 
            super(code, message);
        }
    }

## 3.3 模板页面异常处理 ##

用于thymeleaf页面处理 返回静态页面

@Getter
    public class PageException extends BaseException { 
    
        public PageException(Status status) { 
            super(status);
        }
    
        public PageException(Integer code, String message) { 
            super(code, message);
        }
    }

# 4. 核心：统一异常处理 #

@ControllerAdvice+@ExceptionHandler 两个是绝配

前一个是加在类上 指定该类为异常处理类

后一个加在方法上 制定捕获的异常类型是什么

ps：你当然可以加 `Exception` 类 处理所有的异常

## 4.2 处理json+页面异常 ##

@ControllerAdvice
    @Slf4j
    public class DemoExceptionHandler { 
    	private static final String DEFAULT_ERROR_VIEW = "error";
    
    	/** * 统一 json 异常处理 * * @param exception JsonException * @return 统一返回 json 格式 */
    	@ExceptionHandler(value = JsonException.class)
    	@ResponseBody
    	public ApiResponse jsonErrorHandler(JsonException exception) { 
    		log.error("【JsonException】:{}", exception.getMessage());
    		return ApiResponse.ofException(exception);
    	}
    
    	/** * 统一 页面 异常处理 * * @param exception PageException * @return 统一跳转到异常页面 */
    	@ExceptionHandler(value = PageException.class)
    	public ModelAndView pageErrorHandler(PageException exception) { 
    		log.error("【DemoPageException】:{}", exception.getMessage());
    		ModelAndView view = new ModelAndView();
    		view.addObject("code", exception.getCode());
    		view.addObject("message", exception.getMessage());
    		view.setViewName(DEFAULT_ERROR_VIEW);
    		return view;
    	}
    }

## 4.2 错误模板页面 error.html ##

位置别放错了  
在 `src/main/resources/templates`目录下

<!DOCTYPE html>
    <html xmlns:th="http://www.thymeleaf.org">
    <head lang="en">
        <meta charset="UTF-8"/>
        <title>统一页面异常处理</title>
    </head>
    <body>
    <h1>统一页面异常处理</h1>
    <div th:text="'错误码：'+${code}"></div>
    <div th:text="'错误信息：'+${message}"></div>
    </body>
    </html>

# 5. controller测试 #

@Controller
    @Slf4j
    public class BbController { 
    
        @GetMapping("hello")
        @ResponseBody
        public ApiResponse hello() { 
        	// 正常返回结果 我们就不需要抛出异常了 直接用 ApiResponse
            return ApiResponse.ofStatus(Status.OK,"hello bb");
        }
        @GetMapping("hello2")
        @ResponseBody
        public ApiResponse hello2() { 
        	// 直接返回不了解的错误 json格式
            throw new JsonException(Status.UNKNOWN_ERROR);
        }
        @GetMapping("hello3")
        //不需要加@ResponseBody
        public String hello3() { 
        	//返回的是静态页面error.html
            throw new PageException(Status.UNKNOWN_ERROR);
        }
    }

`非常需要注意的一点 如果你返回的是模板页面 那么需要引入thymeleaf依赖 且不需要加@ResponseBody`

## 5.1 访问 http://localhost:8080/hello ##

![在这里插入图片描述][6fcdf83b08074f0eabb48e6acce0d4da.png]

## 5.2 访问 http://localhost:8080/hello2 ##

![在这里插入图片描述][b798930008d94dc59efb94917c02a9a5.png]

可以看到控制台打印的信息 方便我们排查错误

2021-08-01 11:41:00.355 ERROR 3284 --- [nio-8080-exec-1] c.b.e.exception.DemoExceptionHandler     : 【JsonException】:服务器出错啦
    2021-08-01 11:41:00.372  WARN 3284 --- [nio-8080-exec-1] .m.m.a.ExceptionHandlerExceptionResolver : Resolved [BaseException(code=500, message=服务器出错啦)]

## 5.3 访问 http://localhost:8080/hello3 ##

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDM1MzUwNw_size_16_color_FFFFFF_t_70]  
控制台打印的信息是一样的 这里就不截图了

# 6.异常处理进阶 #

对于自定义异常 我们直接向上面那样 抛出即可 但还是会有我们意想不到的异常出现 所以统一返回服务器繁忙的友好信息

修改后的代码如下

还要注意`log.warn(String s,Thorwable t)`方法 后面填写某个异常 将会打印出对应的堆栈轨迹 方便定位 并不是说这个方法有报错

@RestControllerAdvice
    @Slf4j
    public class Demo2ExceptionHandler { 
    
        @ExceptionHandler(value = Exception.class)
        public ApiResponse jsonErrorHandler(HttpServletRequest req, HandlerMethod method, Exception ex) { 
            //这里是我们自定义的异常
            if (ex instanceof JsonException) { 
                JsonException exception = (JsonException) ex;
                log.warn(String.format("访问 %s -> %s 出现业务异常！", req.getRequestURI(), method.toString()), ex);
                return ApiResponse.ofException(exception);
            } else { 
                //输出一下请求参数
                log.info("请求参数：" + req.getQueryString());
                log.error(String.format("访问 %s -> %s 出现系统异常！", req.getRequestURI(), method.toString()), ex);
                return ApiResponse.of(444, "服务器繁忙", null);
            }
        }
    }

最后强调一点  
统一异常处理只能处理 Controller层面的异常  
而对于mapper service引起的异常 要么往controller 层抛  
要么就 try-catch 捕获 自己处理

[github]: https://github.com/xkcoding/spring-boot-demo/tree/master/demo-exception-handler
[108a9b1fbad34093a15ada8c98b02a94.png]: /images/20220829/683c3a3191f4413cbdc741b84bbde779.png
[Lombok _ _EqualsAndHashCode_callSuper _ false_]: https://blog.csdn.net/qq_27093465/article/details/90056695
[6fcdf83b08074f0eabb48e6acce0d4da.png]: /images/20220829/f91bb5d396ca4345aac11f959ba5fa65.png
[b798930008d94dc59efb94917c02a9a5.png]: /images/20220829/2c116e7fac1247f685f49cb601341025.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDM1MzUwNw_size_16_color_FFFFFF_t_70]: /images/20220829/c03346c7443346579a881bd0f0218d77.png