Spring boot 异常处理
1 项目基础代码
1.1 在pom.xml文件中加入依赖
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>org.example</groupId>
<artifactId>springBoot</artifactId>
<version>1.0-SNAPSHOT</version>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.1.4.RELEASE</version>
</parent>
<dependencies>
<!-- springBoot的启动器 -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<!-- web启动器 -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-thymeleaf</artifactId>
</dependency>
</dependencies>
</project>
1.2 java代码
BrandController.java
package com.yctc.study.controller;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestMapping;
@Controller
@RequestMapping("/brand")
public class BrandController {
@PostMapping("/add")
public void addBrand(){
int error = 1/0;
}
}
1.3 application.yml配置
server:
error:
include-exception: true
2 SpringBoot中对于异常处理提供了五种处理方式
2.1 自定义错误页面
SpringBoot默认的处理异常的机制:SpringBoot默认的已经提供了一套处理异常的机制。一旦程序中出现了异常SpringBoot会像/error的url发送请求。在springBoot中提供了一个叫BasicExceptionController来处理/error请求,然后跳转到默认显示异常的页面来展示异常信息。
如果我们需要将所有的异常同一跳转到自定义的错误页面,需要再src/main/resources/templates目录下创建error.html页面。注意:名称必须叫error
error.html
<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.w3.org/1999/xhtml">
<head>
<meta charset="UTF-8"/>
<title>异常页面</title>
</head>
<body>
<table border="1" align="center">
<tr>
<th>timestamp:时间戳</th>
<th>status:状态码</th>
<th>error:错误提示</th>
<th>exception:异常对象</th>
<th>message:异常信息</th>
</tr>
<tr>
<td th:text="${timestamp}"></td>
<td th:text="${status}"></td>
<td th:text="${error}"></td>
<td th:text="${exception}"></td>
<td th:text="${message}"></td>
</tr>
</table>
</body>
</html>
- timestamp:时间戳
- status:状态码
- error:错误提示
- exception:异常对象
- message:异常信息
- eerrors:JSR303数据校验都在这里
2.2 @ExceptionHandle注解处理异常
BrandController.java 新增代码
/**
* java.lang.ArithmeticException
* 该方法需要返回一个ModelAndView:目的是可以让我们封装异常信息以及视图的指定
* 参数Exception e:会将产生异常对象注入到方法中
*/
@ExceptionHandler(value={java.lang.ArithmeticException.class})
public ModelAndView arithmeticExceptionHandler(Exception e){
ModelAndView mv = new ModelAndView();
mv.addObject("error", e.getMessage());
mv.setViewName("error");
return mv;
}
error.html
异常信息:<span th:text="${error}"></span>
2.3 @ControllerAdvice+@ExceptionHandler注解处理异常
package com.yctc.study.handler;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.servlet.ModelAndView;
/**
* 全局异常处理类
*/
@ControllerAdvice
public class GlobalExceptionHandler {
/**
* java.lang.ArithmeticException
* 该方法需要返回一个ModelAndView:目的是可以让我们封装异常信息以及视图的指定
* 参数Exception e:会将产生异常对象注入到方法中
*/
@ExceptionHandler(value={ArithmeticException.class})
public ModelAndView arithmeticExceptionHandler(Exception e){
ModelAndView mv = new ModelAndView();
mv.addObject("error", e.toString());
mv.setViewName("error1");
return mv;
}
}
error1.html
ControllerAdvice异常信息:<span th:text="${error}"></span>
2.4 配置SimpleMappingExceptionResolver处理异常
只能做异常信息和视图的映射
GlobalException.java
package com.yctc.study.exception;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.handler.SimpleMappingExceptionResolver;
import java.util.Properties;
/**
* 通过SimpleMappingExceptionResolver做全局异常处理
*/
@Configuration
public class GlobalException {
/**
* 该方法必须要有返回值。返回值类型必须是:SimpleMappingExceptionResolver
*/
@Bean
public SimpleMappingExceptionResolver getSimpleMappingExceptionResolver(){
SimpleMappingExceptionResolver resolver = new SimpleMappingExceptionResolver();
Properties mappings = new Properties();
/**
* 参数一:异常的类型,注意必须是异常类型的全名
* 参数二:视图名称
*/
mappings.put("java.lang.ArithmeticException", "error1");
//设置异常与视图映射信息的
resolver.setExceptionMappings(mappings);
return resolver;
}
}
error1.html
SimpleMappingExceptionResolver异常信息:<span th:text="${error}"></span>
2.5 自定义HandlerExceptionResolver类处理异常
GlobalException.java
package com.yctc.study.handler;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.servlet.ModelAndView;
/**
* 全局异常处理类
*/
@ControllerAdvice
package com.yctc.study.exception;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.HandlerExceptionResolver;
import org.springframework.web.servlet.ModelAndView;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
/**
* 通过实现HandlerExceptionResolver接口做全局异常处理
*/
@Configuration
public class GlobalException implements HandlerExceptionResolver {
@Override
public ModelAndView resolveException(HttpServletRequest request, HttpServletResponse response, Object handler,
Exception ex) {
ModelAndView mv = new ModelAndView();
//判断不同异常类型,做不同视图跳转
if(ex instanceof ArithmeticException){
mv.setViewName("error1");
}
mv.addObject("error", ex.toString());
return mv;
}
}
error1.html
HandlerExceptionResolver 异常信息:<span th:text="${error}"></span>