峰哥说技术系列-9 Spring Boot ControllerAdvice处理全局异常 - 副本
《峰哥说专栏》于2月26日正式开启,不管你是学生、还是职场人亦或者仅仅是喜欢互联网技术的人,都可以关注此专栏,大咖为您解说技术,也同样欢迎您来与我们一同探讨,用代码,改变世界,我们是认真的!
今日份主题
ControllerAdvice是Controller的增强版,主要用于全局数据的处理,一般和@ExceptionHandler、@InitBinder、@ModelAttribute搭配使用。它并不属于Spring Boot的内容,而是Spring框架中本身就有该注解。一般来说@ExceptionHandler和该注解用在全局异常处理的时候用的比较多。所以我们这里重点讲解该注解处理全局异常。后面的两个用法大家可以到官网去查看,这里不做介绍。
需求说明:我们使用文件上传案例,在application.properties中配置单个文件的上传大小的现在为1kb。当超过1kb图片的时候,抛出异常,我们进行全局异常的处理。
spring.servlet.multipart.max-file-size=1KB
这里的异常类型是FileSizeLimitExceededException。它含义是文件的大小超过极限异常。
现在采用ControllerAdvice来处理。这里讲解两种方式,一种是响应异常信息文本。第二种返回到视图或者说ModelAndView。
@ControllerAdvice
public class MyCustomException {
@ExceptionHandler(MaxUploadSizeExceededException.class)
public void FileUploadException(MaxUploadSizeExceededException e, HttpServletResponse response) throws IOException {
response.setContentType("text/html;charset=UTF-8");
PrintWriter writer = response.getWriter();
writer.write("上传文件大小超过限制");
writer.flush();
writer.close();
}
}
@ControllerAdvice添加到类后,当系统启动的时候会将对于的类扫描到Spring容器,MaxUploadSizeExceededException会处理上传的异常。当我们需要处理所有异常的时候可以将异常的类型换成Exception就可以了。
返回值可以有,也可以没有,可以是JSON,也可以是ModelAndView。也可以是其他类型,这都很灵活。
我们采用Thymeleaf作为视图组件,然后返回ModelAndView。
步骤如下
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-thymeleaf</artifactId>
</dependency>
<!DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org">
<head>
<meta charset="UTF-8">
<title>Title</title>
</head>
<body>
<h4 th:text="${error}"></h4>
</body>
</html>
编写MyCustomException,并编写代码。
@ControllerAdvice
public class MyCustomException {
@ExceptionHandler(MaxUploadSizeExceededException.class)
public ModelAndView FileUploadException(MaxUploadSizeExceededException e) throws IOException {
ModelAndView mv=new ModelAndView();
mv.addObject("error","上传的文件超过限制大小,请注意");
mv.setViewName("myerror");
return mv;
}
}
经过峰哥耐心的解说,估计大家对这个问题一定有了全新的认识。大家在平时的学习中如果有类似的疑问,都可以提出来,在后台留言即可。峰哥看到后,觉得有价值,会以文章的形式专门说明。
峰哥说技术专栏:
条件注解Spring Boot自动配置的基石
手撸Spring Boot自定义启动器,解密Spring Boot自动化配置原理
Sring Boot整合视图之Thymeleaf
Sring Boot整合视图之FreeMarkerSpring Boot整合FreeMarker视图
...
如果需要查看,后台留言回复“1”即可获取代码详情。
想获取更多请加小课领取哟!
=END=
往期精彩回顾: