Spring Boot的异常统一处理实战(包括@ExceptionHandler注解和@ControllerAdvice注解附源码超详细）

最新推荐文章于 2024-05-21 14:37:52 发布

showswoller

最新推荐文章于 2024-05-21 14:37:52 发布

阅读量1.7k

点赞数 6

分类专栏： JAVA Web 文章标签： spring boot spring java java-ee eclipse

本文链接：https://blog.csdn.net/jiebaoshayebuhui/article/details/127481506

版权

JAVA Web 专栏收录该内容

34 篇文章 3 订阅

订阅专栏

需要源码或觉得有帮助请点赞关注收藏后评论区留言

在Spring Boot应用的开发中，不管是对底层数据库操作，对业务层操作，还是对控制层操作，都会不可避免的遇到各种可预知的，不可预知的异常需要处理，如果每个处理过程都单独处理异常，那么系统的代码耦合度会很高，工作量大且不好统一，以后维护的工作量也很大。

如果能将所有类型的异常处理从各层中解耦出来，则既保证了相关处理过程的功能较单一，也实现了异常信息的统一处理和维护。幸运的是，Spring框架支持这样的实现。接下来将从自定义error页面。@ExceptionHandler注解以及@ControllerAdvice3种方式讲解Spring Boot应用的异常统一处理

具体处理步骤如下：

自定义error页面

在Spring Boot Web应用的src/main/resources/templates 目录下添加error.html页面访问发生错误或异常时，Spring Boot将自动找到该页面作为错误页面。Spring Boot为错误页面提供了以下属性

：timestamp 错误发生时间

：status HTTP状态码

：error 错误原因

：exception 异常的类名

：message 异常消息

：errors BindingResult异常里的各种错误

：trace 异常跟踪信息

：path 错误发生时请求的URL路径

1：创建名为com.ch.ch5_3.exception的包并在该包中创建名为MyException 具体代码如下

package com.ch.ch5_3.exception;
public class MyException extends Exception {
	private static final long serialVersionUID = 1L;
	public MyException() {
		super();
	}
	public MyException(String message) {
		super(message);
	}
}

2：创建控制器类TestHandleExceptionController

创建名为com.ch,ch5_3.controller的包并在该包中创建名为TestHandleExceptionController的控制器类，在该控制器类中，在4个请求处理方法，一个是导航到index.html 另外三个分别抛出不同的异常部分代码如下

package com.ch.ch5_3.controller;
import java.sql.SQLException;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;


    public void db() throws SQLException { 
        throw new SQLException("数据库异常");
    }  
	@RequestMapping("/my")  
    public void my() throws MyException {  
        throw new MyException("自定义异常");
    }
	@RequestMapping("/no")  
    public void no() throws Exception {  
        throw new Exception("未知异常");
    } 
	
}

3：View视图页面

Thymeleaf模板默认将视图页面放在src/main/resources/templates目录下。因此我们在src/main/resources/templates 目录下新建html页面文件，index.html和error.html

在index.html页面中有4个超链接请求，3个请求在控制器中有对应处理，另一个请求是404错误

部分代码如下


<!DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org">
<head>
<meta charset="UTF-8">
<title>index</title>
<link rel="stylesheet" th:href="@{css/bootstrap.min.css}" />
<!-- 默认访问 src/main/resources/static下的css文件夹-->
<link rel="stylesheet" th:href="@{css/bootstrap-theme.min.css}" />
>
				<a th:href="@{db}">处理数据库异常</a><br>
				<a th:href="@{my}">处理自定义异常</a><br>
				<a th:href="@{no}">处理未知错误</a>
				<hr>
				<a th:href="@{nofound}">404错误</a>
			</div>
		</div>
	</div>
</body>
</html>

error.html页面部分代码如下


<!DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org">
<head>
<meta charset="UTF-8">
<title>error</title>
<link rel="stylesheet" th:href="@{css/bootstrap.min.css}" />
<!-- 默认访问 src/main/resources/static下的css文件夹-->
<link rel="stylesheet" th:href="@{css/bootstrap-theme.min.css}" />
</head>
<body>
 
            <div class="common-hint-word">
                <div th:text="${#dates.format(timestamp,'yyyy-MM-dd HH:mm:ss')}"></div>
                <div th:text="${message}"></div>
                <div th:text="${error}"></div>
            </div>
        </div>
    </div>
</body>
</html>

@ExceptionHandler注解

上面自定义页面并没有处理异常，可以使用@ExceptionHandler注解处理异常，如果有一个由该注解修饰的方法，那么当任何方法抛出异常时都由它来处理

添加一个注解修饰的方法具体代码如下

@ExceptionHandler(value=Excetption.class)
public String handlerException(Exception e){
if(e istanceof SQLException){
return "sql error";
}
else if(e instanceof MYException){
return"myError";
}
else{
return "noerror";
}
}

@ControllerAdvice注解

使用它注解的类时当前Spring Boot应用中所有类的统一异常处理类，该类中使用@ExceptionHandler注解的方法统一处理异常，不需要在每个Controller中逐一定义异常处理方法，这是因为对所有注解了@ControllerAdvice注解进行全局异常处理

创建GlobalExceptionHandlerController的类具体代码如下

package com.ch.ch5_3.controller;
import java.sql.SQLException;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import com.ch.ch5_3.exception.MyException;
@ControllerAdvice
public class GlobalExceptionHandlerController {
	@ExceptionHandler(value=Exception.class)
	public String handlerException(Exception e) {
		//数据库异常
		if (e instanceof SQLException) {
			return "sqlError";
		} else if (e instanceof MyException) {//自定义异常
			return "myError";
		} else {//未知异常
			return "noError";
		}
	}
}

showswoller

关注

6
点赞
踩
4

收藏

觉得还不错? 一键收藏
打赏
3
评论
Spring Boot的异常统一处理实战(包括@ExceptionHandler注解和@ControllerAdvice注解附源码超详细）

Spring Boot的异常统一处理实战(包括@ExceptionHandler注解和@ControllerAdvice注解附源码超详细）
复制链接

扫一扫