正文

springboot中web应用的统一异常处理

 2022-03-15  223

关键词：

我们在做Web应用的时候，请求处理过程中发生错误是非常常见的情况。Spring Boot提供了一个默认的映射：/error，当处理中抛出异常之后，会转到该请求中处理，并且该请求有一个全局的错误页面用来展示异常内容。

选择一个之前实现过的Web应用（Chapter3-1-2）为基础，启动该应用，访问一个不存在的URL，或是修改处理内容，直接抛出异常，如：

@RequestMapping("/hello")
public String hello() throws Exception {
throw new Exception("发生错误");
}

此时，可以看到类似下面的报错页面，该页面就是Spring Boot提供的默认error映射页面。

alt=默认的错误页面

统一异常处理

虽然，Spring Boot中实现了默认的error映射，但是在实际应用中，上面你的错误页面对用户来说并不够友好，我们通常需要去实现我们自己的异常提示。

下面我们以之前的Web应用例子为基础（Chapter3-1-2），进行统一异常处理的改造。

创建全局异常处理类：通过使用@ControllerAdvice定义统一的异常处理类，而不是在每个Controller中逐个定义。@ExceptionHandler用来定义函数针对的异常类型，最后将Exception对象和请求URL映射到error.html中

@ControllerAdvice
class GlobalExceptionHandler {
 
public static final String DEFAULT_ERROR_VIEW = "error";
 
@ExceptionHandler(value = Exception.class)
public ModelAndView defaultErrorHandler(HttpServletRequest req, Exception e) throws Exception {
ModelAndView mav = new ModelAndView();
mav.addObject("exception", e);
mav.addObject("url", req.getRequestURL());
mav.setViewName(DEFAULT_ERROR_VIEW);
return mav;
}
 
}

实现error.html页面展示：在templates目录下创建error.html，将请求的URL和Exception对象的message输出。

<!DOCTYPE html>
<html>
<head lang="en">
<meta charset="UTF-8" />
<title>统一异常处理</title>
</head>
<body>
<h1>Error Handler</h1>
<div th:text="${url}"></div>
<div th:text="${exception.message}"></div>
</body>
</html>

启动该应用，访问：http://localhost:8080/hello，可以看到如下错误提示页面。

alt=自定义的错误页面

通过实现上述内容之后，我们只需要在Controller中抛出Exception，当然我们可能会有多种不同的Exception。然后在@ControllerAdvice类中，根据抛出的具体Exception类型匹配@ExceptionHandler中配置的异常类型来匹配错误映射和处理。

返回JSON格式

在上述例子中，通过@ControllerAdvice统一定义不同Exception映射到不同错误处理页面。而当我们要实现RESTful API时，返回的错误是JSON格式的数据，而不是HTML页面，这时候我们也能轻松支持。

本质上，只需在@ExceptionHandler之后加入@ResponseBody，就能让处理函数return的内容转换为JSON格式。

下面以一个具体示例来实现返回JSON格式的异常处理。

创建统一的JSON返回对象，code：消息类型，message：消息内容，url：请求的url，data：请求返回的数据

public class ErrorInfo<T> {
 
public static final Integer OK = 0;
public static final Integer ERROR = 100;
 
private Integer code;
private String message;
private String url;
private T data;
 
// 省略getter和setter
 
}

创建一个自定义异常，用来实验捕获该异常，并返回json

public class MyException extends Exception {
 
public MyException(String message) {
super(message);
}
 
}

Controller中增加json映射，抛出MyException异常

@Controller
public class HelloController {
 
@RequestMapping("/json")
public String json() throws MyException {
throw new MyException("发生错误2");
}
 
}

为MyException异常创建对应的处理

@ControllerAdvice
public class GlobalExceptionHandler {
 
@ExceptionHandler(value = MyException.class)
@ResponseBody
public ErrorInfo<String> jsonErrorHandler(HttpServletRequest req, MyException e) throws Exception {
ErrorInfo<String> r = new ErrorInfo<>();
r.setMessage(e.getMessage());
r.setCode(ErrorInfo.ERROR);
r.setData("Some Data");
r.setUrl(req.getRequestURL().toString());
return r;
}
 
}

启动应用，访问：http://localhost:8080/json，可以得到如下返回内容：

{
code: 100，
data: "Some Data"，
message: "发生错误2"，
url: "http://localhost:8080/json"
}

至此，已完成在Spring Boot中创建统一的异常处理，实际实现还是依靠Spring MVC的注解，更多更深入的使用可参考Spring MVC的文档。

springboot全局异常统一处理(代码片段)

...ice&@ExceptionHandlerhttp异常ErrorControllerServlet异常Filter1.SpringBoot默认错误统一处理机制在基于SpringBoot的Web应用中，对于Http请求处理过程中发生的各种错误，如常见的400、404和500 查看详情

springboot-@controlleradvice拦截异常并统一处理

SpringBoot是为了简化Spring应用的创建、运行、调试、部署等一系列问题而诞生的产物，自动装配的特性让我们可以更好的关注业务本身而不是外部的XML配置，我们只需遵循规范，引入相关的依赖就可以轻易的搭建出一个WEB工程 ... 查看详情

springboot1.5.4统一异常处理

上一篇：springboot1.5.4配置文件详解（八） 1 SpringBoot统一异常处理SpringBoot中实现了默认的error映射，但是在实际应用中，上面你的错误页面对用户来说并不够友好，我们通常需要去实现我们自己的异... 查看详情

统一异常处理的实现(代码片段)

前面介绍了SpringBoot如何整合定时任务已经SpringBoot如何创建异步任务和定时任务。不清楚的朋友可以看看之前的文章：《SpringBoot入门系列文章》接下来主要讲解如何在SpringBoot应用中使用统一异常处理。如何实现对异常数据与正... 查看详情

springboot全局异常统一处理(代码片段)

...ice&@ExceptionHandlerhttp异常ErrorControllerServlet异常Filter1.SpringBoot默认错误统一处理机制在基于SpringBoot的Web应用中，对于Http请求处理过程中发生的各种错误，如常见的400、404和500等错误，SpringBoot默认提供了一种映射... 查看详情

springboot的统一异常处理(代码片段)

SpringBoot的统一异常处理在SpringBoot应用开发中，不管是对底层数据库的操作，对业务层的操作，还是对控制层的操作，都会不可避免的遇到各种未知的异常需要处理，如果每个过程都单独处理异常，那么系... 查看详情

springboot中全局异常处理器

　　SpringBoot中全局异常处理器，就是把错误异常统一处理的方法。等价于Springmvc中的异常处理器。步骤一：基于前面的springBoot入门小demo修改步骤二：修改HelloController类　　修改HelloController，使得访问/hello一定会产生异常:someexce... 查看详情

springboot项目如何做到统一异常处理

...个项目中对于异常的处理就显得尤为重要.那么,小编就以SpringBoot框架,通过代码实例展示统一异常的处理方式.1.首先我们简单搭建一个SpringBoot框架的项目,项目名称是exceptionhandler(异常处理)2.导入查看详情

springboot初始教程之统一异常处理(代码片段)

SpringBoot初始教程之统一异常处理(三)1.介绍在日常开发中发生了异常，往往是需要通过一个统一的异常处理处理所有异常，来保证客户端能够收到友好的提示。SpringBoot在页面发生异常的时候会自动把请求转到/error，Spr... 查看详情

springboot初始教程之统一异常处理(代码片段)

基于springboot的统一异常处理设计

摘自：https://www.cnblogs.com/greyzeng/p/11733327.html Practitioner需要不断努力，才能毫不费力基于SpringBoot的统一异常处理设计基于SpringBoot的统一异常处理设计作者： Grey原文地址：https://www.cnblogs.com/greyzeng/p/11733327.htmlSpringBoot 查看详情

springboot中@controlleradvice注解(代码片段)

SpringBoot中@ControllerAdvice@ControllerAdvice是Spring3.2提供的新注解，应用在处理全局异常、全局数据绑定、全局数据预处理等方面。我在一个SpringBoot项目中，处理全局异常，Controller类中的异常统一由ControllerExceptionHandl... 查看详情

springboot中@controlleradvice注解(代码片段)

springboot中关于自定义异常处理的套路！

在SpringBoot项目中，异常统一处理，可以使用Spring中@ControllerAdvice来统一处理，也可以自己来定义异常处理方案。SpringBoot中，对异常的处理有一些默认的策略，我们分别来看。默认情况下，SpringBoot中的异常页面是这样的：我们从... 查看详情

springboot进阶之统一异常处理（含源码）

浅谈异常处理在J2EE项目的开发中，不管是对底层的数据库操作过程，还是业务层的处理过程，还是控制层的处理过程，都不可避免会遇到各种可预知的、不可预知的异常需要处理。每个过程都单独处理异常，... 查看详情

springboot2系列教程(十四)|统一异常处理

如题，今天介绍SpringBoot是如何统一处理全局异常的。SpringBoot中的全局异常处理主要起作用的两个注解是@ControllerAdvice和@ExceptionHandler，其中@ControllerAdvice是组件注解，添加了这个注解的类能够拦截Controller的请求，而ExceptionHandler... 查看详情

不是所有的springboot异常都能被统一异常处理｜javadebug笔记(代码片段)

通常我们在SpringBoot中设置的统一异常处理（@RestControllerAdvice配合@ExceptionHandler实现）只能处理Controller抛出的异常。有些请求还没到Controller就出异常了，而这些异常不能被统一异常捕获，例如Servlet容器的某... 查看详情

springboot中使用aop统一处理web请求日志

AOP为AspectOrientedProgramming的缩写，意为：面向切面编程，通过预编译方式和运行期动态代理实现程序功能的统一维护的一种技术。AOP是Spring框架中的一个重要内容，它通过对既有程序定义一个切入点，然后在其前后切入不同的执... 查看详情