您现在的位置是：首页 >技术交流 >Spring MVC自定义拦截器--Spring MVC异常处理网站首页技术交流
Spring MVC自定义拦截器--Spring MVC异常处理
简介Spring MVC自定义拦截器--Spring MVC异常处理
目录
在 springDispatcherServlet-servlet.xml 配置拦截器
SimpleMappingExceptionResolver
修改 MyExceptionHandler.java , 增加方法test03
配置 springDispatcherServlet-servlet.xml
修改 MyExceptionHandler.java , 增加方法test04
自定义拦截器
什么是拦截器
● 说明
-
Spring MVC 也可以使用拦截器对请求进行拦截处理，用户可以自定义拦截器来实现特定的功能.
-
自定义的拦截器必须实现 HandlerInterceptor 接口
● 自定义拦截器的三个方法
-
preHandle()：这个方法在业务处理器处理请求之前被调用，在该方法中对用户请求request 进行处理。
-
postHandle()：这个方法在目标方法处理完请求后执行
-
afterCompletion()：这个方法在完全处理完请求后被调用，可以在该方法中进行一些资源清理的操作。
自定义拦截器执行流程分析图
● 自定义拦截器执行流程说明
-
如果 preHandle 方法 返回 false, 则不再执行目标方法, 可以在此指定返回页面
-
postHandle 在目标方法被执行后执行. 可以在方法中访问到目标方法返回的ModelAndView 对象
-
若 preHandle 返回 true, 则 afterCompletion 方法 在渲染视图之后被执行.
-
若 preHandle 返回 false, 则 afterCompletion 方法不会被调用
-
在配置拦截器时，可以指定该拦截器对哪些请求生效,哪些请求不生效
自定义拦截器应用实例
● 应用实例需求
完成一个自定义拦截器，学习一下如何配置拦截器和拦截器的运行流程
创建MyInterceptor01
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
解读
1. preHandle() 在目标方法执行前被执行
2. 如果preHandle() 返回false , 不再执行目标方法
3. 该方法可以获取到request, response, handler
4. 这里根据业务，可以进行拦截，并指定跳转到哪个页面
public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
解读
1. 在目标方法执行后，会执行postHandle
2. 该方法可以获取到 目标方法，返回的ModelAndView对象
public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception
解读
afterCompletion() 在视图渲染后被执行, 这里可以进行资源清理工作
@Component
public class MyInterceptor01 implements HandlerInterceptor {
/**
* 解读
* 1. preHandle() 在目标方法执行前被执行
* 2. 如果preHandle() 返回false , 不再执行目标方法
* 3. 该方法可以获取到request, response, handler
* 4. 这里根据业务，可以进行拦截，并指定跳转到哪个页面
* @param request
* @param response
* @param handler
* @return
* @throws Exception
*/
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
System.out.println("--MyInterceptor01--preHandle()---");
}
/**
* 解读
* 1. 在目标方法执行后，会执行postHandle
* 2. 该方法可以获取到 目标方法，返回的ModelAndView对象
* @param request
* @param response
* @param handler
* @param modelAndView
* @throws Exception
*/
@Override
public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
System.out.println("--MyInterceptor01--postHandle()--");
}
/**
* 解读
* 1. afterCompletion() 在视图渲染后被执行, 这里可以进行资源清理工作
* @param request
* @param response
* @param handler
* @param ex
* @throws Exception
*/
@Override
public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
System.out.println("--MyInterceptor01--afterCompletion()--");
}
}
创建FurnHandler类
@Controller
public class FurnHandler {
@RequestMapping(value = "/hi")
public String hi(User user) {
System.out.println("---FurnHandler--hi()---");
return "success";
}
@RequestMapping(value = "/hello")
public String hello() {
System.out.println("---FurnHandler--hello()---");
return "success";
}
}
在 springDispatcherServlet-servlet.xml 配置拦截器
<!--配置自定义拦截器-spring配置文件-->
<mvc:interceptors>
<!--
解读
1. 第一种配置方式
2. 使用ref 引用到对应的myInterceptor01
3. 这种方式，会拦截所有的目标方法
-->
<!--<ref bean="myInterceptor01"/>-->
<!--解读
1. 第二种配置方式
2. mvc:mapping path="/hi" 指定要拦截的路径
3. ref bean="myInterceptor01" 指定对哪个拦截器进行配置
-->
<!--<mvc:interceptor>-->
<!-- <mvc:mapping path="/hi"/>-->
<!-- <ref bean="myInterceptor01"/>-->
<!--</mvc:interceptor>-->
<!--解读
1. 第3种配置方式
2. mvc:mapping path="/h*" 通配符方式 表示拦截 /h 打头的路径
3. mvc:exclude-mapping path="/hello" /hello不拦截
4. ref bean="myInterceptor01" 指定对哪个拦截器配置
-->
<mvc:interceptor>
<mvc:mapping path="/h*"/>
<mvc:exclude-mapping path="/hello"/>
<ref bean="myInterceptor01"/>
</mvc:interceptor>
</mvc:interceptors>
第一种配置方式
使用ref 引用到对应的myInterceptor01
这种方式，会拦截所有的目标方法
<ref bean="myInterceptor01"/>
第二种配置方式
- mvc:mapping path="/hi" 指定要拦截的路径
- ref bean="myInterceptor01" 指定对哪个拦截器进行配置
<mvc:interceptor>
<mvc:mapping path="/hi"/>
<ref bean="myInterceptor01"/>
</mvc:interceptor>第3种配置方式
- mvc:mapping path="/h*" 通配符方式 表示拦截 /h 打头的路径
- mvc:exclude-mapping path="/hello" /hello不拦截
- ref bean="myInterceptor01" 指定对哪个拦截器配置
<mvc:interceptor>
<mvc:mapping path="/h*"/>
<mvc:exclude-mapping path="/hello"/>
<ref bean="myInterceptor01"/>
</mvc:interceptor>创建interceptor.jsp
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
<title>测试自定义拦截器</title>
</head>
<body>
<h1>测试自定义拦截器</h1>
<a href="<%=request.getContextPath()%>/hi">测试自定义拦截器-hi</a><br><br>
<a href="<%=request.getContextPath()%>/hello">测试自定义拦截器-hello</a><br/><br/>
</body>
</html>完成测试(页面方式)
浏览器 http://localhost:8080/springmvc/interceptor.jsp
完成测试(Postman 方式)
注意
拦截器需要配置才生效，不配置是不生效的.
如果 preHandler() 方法返回了 false, 就不会执行目标方法(前提是你的目标方法被拦截了), 程序员可以在这里根据业务需要指定跳转页面.
多个拦截器执行流程示意图
代码实现
创建MyInterceptor02
@Component
public class MyInterceptor02 implements HandlerInterceptor {
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
System.out.println("--MyInterceptor02--preHandle--");
return true;
}
@Override
public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
System.out.println("--MyInterceptor02--postHandle--");
}
@Override
public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
System.out.println("--MyInterceptor02--afterCompletion--");
}
}
配置xml
1.配置的第二个拦截器
2.多个拦截器在执行时，是顺序执行
<!--配置自定义拦截器-spring配置文件-->
<mvc:interceptors>
<!--
解读
1. 第一种配置方式
2. 使用ref 引用到对应的myInterceptor01
3. 这种方式，会拦截所有的目标方法
-->
<!--<ref bean="myInterceptor01"/>-->
<!--解读
1. 第二种配置方式
2. mvc:mapping path="/hi" 指定要拦截的路径
3. ref bean="myInterceptor01" 指定对哪个拦截器进行配置
-->
<!-- <mvc:interceptor>-->
<!-- <mvc:mapping path="/hi"/>-->
<!-- <ref bean="myInterceptor01"/>-->
<!-- </mvc:interceptor>-->
<!--解读
1. 第3种配置方式
2. mvc:mapping path="/h*" 通配符方式 表示拦截 /h 打头的路径
3. mvc:exclude-mapping path="/hello" /hello不拦截
4. ref bean="myInterceptor01" 指定对哪个拦截器配置
-->
<mvc:interceptor>
<mvc:mapping path="/h*"/>
<mvc:exclude-mapping path="/hello"/>
<ref bean="myInterceptor01"/>
</mvc:interceptor>
<!--解读
1.配置的第二个拦截器
2.多个拦截器在执行时，是顺序执行
-->
<mvc:interceptor>
<mvc:mapping path="/h*"/>
<ref bean="myInterceptor02"/>
</mvc:interceptor>
</mvc:interceptors>完成测试(页面方式)
浏览器 http://localhost:8080/springmvc/interceptor.jsp
完成测试(Post 方式)
注意事项和细节
1.如果第1个拦截器的preHandle()返回false,后面都不在执行
2.如果第2个拦截器的preHandle()返回false,就直接执行第1个拦截器的afterCompletion()方法,如果拦截器更多，规则类似
3.说明:前面说的规则，都是目标方法被拦截的前提
扩展需求
需求: 如果用户提交的数据有禁用词(比如 病毒)，则，在第 1 个拦截器就返回，不执行 目标方法, 功能效果示意图
创建warning.jsp
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
<title>警告</title>
</head>
<body>
<h1>不要乱讲话~</h1>
</body>
</html>
修改MyInterceptor01
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
System.out.println("--MyInterceptor01--preHandle()---");
//获取到用户提交的关键字
String keyword = request.getParameter("keyword");
if("病毒".equals(keyword)) {
//请求转发到warning
request.getRequestDispatcher("/WEB-INF/pages/warning.jsp")
.forward(request,response);
return false;
}
System.out.println("得到到keyword= "+ keyword);
return true;
}完成测试(使用 Postma）
异常处理
异常处理-基本介绍
1. Spring MVC 通过 HandlerExceptionResolver 处理程序的异常，包括 Handler 映射、数据
绑定以及目标方法执行时发生的异常
2. 主要处理 Handler 中用 -@ExceptionHandler 注解定义的方法。
3. ExceptionHandlerMethodResolver 内部若找不到--@ExceptionHandler 注解的话，会找
@ControllerAdvice 类的@ExceptionHandler 注解方法,这样就相当于一个全局异常处理器
局部异常
演示局部异常处理机制
如果不处理异常, 非常的不友好
创建MyExceptionHandler
@ExceptionHandler({ArithmeticException.class,NullPointerException.class})
public String localException(Exception ex, HttpServletRequest request){
System.out.println("局部异常信息是-" + ex.getMessage());
//如何将异常的信息带到下一个页面.
request.setAttribute("reason", ex.getMessage());
return "exception_mes";
}
/**
* 解读
* 1. 编写方法，模拟异常, 算术异常
* 2. 如果我们不做异常处理，是由tomcat默认页面显示
*
*/
@RequestMapping(value = "/testException01")
public String test01(Integer num) {
int i = 9 / num;
return "success";
}创建exception.jsp
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
<title>异常信息</title>
</head>
<body>
<h1>测试异常</h1>
<a href="<%=request.getContextPath()%>/testException01?num=0">点击测试局部异常</a><br><br>
</body>
</html>创建exception_mes.jsp
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
<title>异常信息提示</title>
</head>
<body>
<h1>朋友, 程序发生了异常...</h1>
异常信息- ${requestScope.reason}
</body>
</html>
测试(页面方式)
浏览器 http://localhost:8080/springmvc/exception.jsp
测试(Postman 方式）
全局异常
ExceptionHandlerMethodResolver 内部若找不到@ExceptionHandler 注解的话，会找
@ControllerAdvice 类的@ExceptionHandler 注解方法, 这样就相当于一个全局异常处理器
这个上面已经演示了这里只是补充说明
解读
1. 这里我们模拟了一个异常 NumberFormatException
2. 该异常没有在局部异常处理，按照异常处理机制，就会交给全局异常处理类处理
修改MyExceptionHandler增加方法
@RequestMapping(value = "/testGlobalException")
public String global(){
//解读
//1. 这里我们模拟了一个异常 NumberFormatException
//2. 该异常没有在局部异常处理，按照异常处理机制，就会交给全局异常处理类处理
int num = Integer.parseInt("hello");
return "success";
}修改exception.jsp增加语句
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
<title>异常信息</title>
</head>
<body>
<h1>测试异常</h1>
<a href="<%=request.getContextPath()%>/testException01?num=0">点击测试局部异常</a><br><br>
<a href="<%=request.getContextPath()%>/testGlobalException">点击测试全局异常</a><br><br>
</body>
</html>测试
如上面测试一样
异常优先级
异常处理时：局部异常 优先级高于 全局异常
需求
通过@ResponseStatus 注解, 可以自定义异常的说明
创建AgeException.java
@ResponseStatus(reason = "年龄需要在1-120之间", value = HttpStatus.BAD_REQUEST)
public class AgeException extends RuntimeException {
public AgeException() {
}
public AgeException(String message) {
super(message);
}
}
修改MyExceptionHandler增加方法
@RequestMapping(value = "/testException02")
public String test02(){
throw new AgeException("年龄必须在1-120之间~~~");
}修改 exception.jsp, 增加超链
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
<title>异常信息</title>
</head>
<body>
<h1>测试异常</h1>
<a href="<%=request.getContextPath()%>/testException01?num=0">点击测试局部异常</a><br><br>
<a href="<%=request.getContextPath()%>/testGlobalException">点击测试全局异常</a><br><br>
<a href="<%=request.getContextPath()%>/testException02">点击测试自定义异常</a><br/><br/>
</body>
</html>
完成测试（页面测是）
浏览器 http://localhost:8080/springmvc/exception.jsp
完成测试（postman）
SimpleMappingExceptionResolver
基本说明
1. 如果希望对所有异常进行统一处理，可以使用 SimpleMappingExceptionResolver
2. 它将异常类名映射为视图名，即发生异常时使用对应的视图报告异常
3. 需要在 ioc容器中配置
代码演示
对数组越界异常进行统一处理，使用 SimpleMappingExceptionResolver处理
修改 MyExceptionHandler.java , 增加方法test03
@RequestMapping(value = "/testException03")
public String test03(){
int[] arr = new int[]{3,9,10,190};
//抛出一个数组越界的异常 ArrayIndexOutOfBoundsException
System.out.println(arr[90]);
return "success";
}配置 springDispatcherServlet-servlet.xml
解释一下为什么只写arrEX因为我们前面配置了 prefix/WEB-INF/pages/和suffix .jsp所以默认会拼接
<bean class="org.springframework.web.servlet.handler.SimpleMappingExceptionResolver">
<property name="exceptionMappings">
<props>
<prop key="java.lang.ArrayIndexOutOfBoundsException">arrEx</prop>
</props>
</property>
</bean>
创建arrEx.jsp
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
<title>数组越界异常</title>
</head>
<body>
<h1><异常></异常>信息: 数组越界异常</h1>
</body>
</html>
修改 exception.jsp
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
<title>异常信息</title>
</head>
<body>
<h1>测试异常</h1>
<a href="<%=request.getContextPath()%>/testException01?num=0">点击测试局部异常</a><br><br>
<a href="<%=request.getContextPath()%>/testGlobalException">点击测试全局异常</a><br><br>
<a href="<%=request.getContextPath()%>/testException02">点击测试自定义异常</a><br/><br/>
<a href="<%=request.getContextPath()%>/testException03">点击测试统一处理异常</a><br/><br/>
</body>
</html>
并完成测试
(页面测试), 浏览器 http://localhost:8080/springmvc/exception.jsp
(postman) 测 http://localhost:8080/springmvc/testException03
页面就不展示了
对未知异常进行统一处理
对未知异常进行统一处理，使用 SimpleMappingExceptionResolver
<!--配置统一处理异常Bean-->
<bean class="org.springframework.web.servlet.handler.SimpleMappingExceptionResolver">
<property name="exceptionMappings">
<props>
<prop key="java.lang.ArrayIndexOutOfBoundsException">arrEx</prop>
<prop key="java.lang.Exception">allEx</prop>
</props>
</property>
</bean>
修改 MyExceptionHandler.java , 增加方法test04
//如果发生了没有归类的异常， 可以给出统一提示页面
@RequestMapping(value = "/testException04")
public String test04(){
String str = "hello";
//这里会抛出 StringIndexOutOfBoundsException
char c = str.charAt(10);
return "success";
}创建allEx.jsp
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
<title>未知异常信息</title>
</head>
<body>
<h1>朋友，系统发生了未知异常~, 请联系网站管理员</h1>
</body>
</html>
修改 exception.jsp , 增加超链接
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
<title>异常信息</title>
</head>
<body>
<h1>测试异常</h1>
<a href="<%=request.getContextPath()%>/testException01?num=0">点击测试局部异常</a><br><br>
<a href="<%=request.getContextPath()%>/testGlobalException">点击测试全局异常</a><br><br>
<a href="<%=request.getContextPath()%>/testException02">点击测试自定义异常</a><br/><br/>
<a href="<%=request.getContextPath()%>/testException03">点击测试统一处理异常</a><br/><br/>
<a href="<%=request.getContextPath()%>/testException04">点击测试未知异常</a><br/><br/>
</body>
</html>
并完成测试
(页面测试), 浏览器 http://localhost:8080/springmvc/exception.jsp
(postman) 测试http://localhost:8080/springmvc/testException04
异常处理的优先级梳理
● 异常处理的优先级
局部异常 > 全局异常 > SimpleMappingExceptionResolver > tomcat 默认机制
全部xml配置
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:context="http://www.springframework.org/schema/context"
xmlns:mvc="http://www.springframework.org/schema/mvc"
xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd http://www.springframework.org/schema/context https://www.springframework.org/schema/context/spring-context.xsd http://www.springframework.org/schema/mvc https://www.springframework.org/schema/mvc/spring-mvc.xsd">
<!--配置自动扫描包-->
<context:component-scan base-package="com.wyxdu.web"/>
<!--配置视图解析器[默认视图解析器]-->
<bean class="org.springframework.web.servlet.view.InternalResourceViewResolver">
<!--配置属性suffix 和 prefix-->
<property name="prefix" value="/WEB-INF/pages/"/>
<property name="suffix" value=".jsp"/>
<!--调整优先级-->
<property name="order" value="10"/>
</bean>
<!--
解读
1. 配置自定义视图解析器BeanNameViewResolver
2. BeanNameViewResolver可以去解析我们自定义的视图
3. 配置 属性 order, 表示视图解析器执行的顺序, 值越小, 优先级越高
4. 属性 order 的默认值是最低优先级 ，值为 Integer.MAX_VALUE
int LOWEST_PRECEDENCE = 2147483647
-->
<bean class="org.springframework.web.servlet.view.BeanNameViewResolver">
<property name="order" value="99"/>
</bean>
<!-- 配置国际化错误信息的资源处理bean -->
<bean id="messageSource" class=
"org.springframework.context.support.ResourceBundleMessageSource">
<!-- 配置国际化文件名字
如果你这样配的话，表示messageSource回到 src/i18nXXX.properties去读取错误信息
-->
<property name="basename" value="i18n"></property>
</bean>
<!--配置文件上传需要的bean-->
<bean class="org.springframework.web.multipart.commons.CommonsMultipartResolver"
id="multipartResolver"/>
<!--配置自定义拦截器-spring配置文件-->
<mvc:interceptors>
<!--
解读
1. 第一种配置方式
2. 使用ref 引用到对应的myInterceptor01
3. 这种方式，会拦截所有的目标方法
-->
<!--<ref bean="myInterceptor01"/>-->
<!--解读
1. 第二种配置方式
2. mvc:mapping path="/hi" 指定要拦截的路径
3. ref bean="myInterceptor01" 指定对哪个拦截器进行配置
-->
<!-- <mvc:interceptor>-->
<!-- <mvc:mapping path="/hi"/>-->
<!-- <ref bean="myInterceptor01"/>-->
<!-- </mvc:interceptor>-->
<!--解读
1. 第3种配置方式
2. mvc:mapping path="/h*" 通配符方式 表示拦截 /h 打头的路径
3. mvc:exclude-mapping path="/hello" /hello不拦截
4. ref bean="myInterceptor01" 指定对哪个拦截器配置
-->
<mvc:interceptor>
<mvc:mapping path="/h*"/>
<mvc:exclude-mapping path="/hello"/>
<ref bean="myInterceptor01"/>
</mvc:interceptor>
<!--解读
1.配置的第二个拦截器
2.多个拦截器在执行时，是顺序执行
-->
<mvc:interceptor>
<mvc:mapping path="/h*"/>
<ref bean="myInterceptor02"/>
</mvc:interceptor>
</mvc:interceptors>
<!--配置统一处理异常Bean-->
<bean class="org.springframework.web.servlet.handler.SimpleMappingExceptionResolver">
<property name="exceptionMappings">
<props>
<prop key="java.lang.ArrayIndexOutOfBoundsException">arrEx</prop>
<!--<prop key="java.lang.Exception">allEx</prop>-->
</props>
</property>
</bean>
<!--加入两个常规配置-->
<!--支持SpringMVC的高级功能，比如JSR303校验, 映射动态请求-->
<mvc:annotation-driven></mvc:annotation-driven>
<!-- 将springmvc不能处理的请求，交给tomcat处理,比如css, js-->
<mvc:default-servlet-handler/>
</beans>风语者！平时喜欢研究各种技术，目前在从事后端开发工作，热爱生活、热爱工作。
站长推荐
- U8W/U8W-Mini使用与常见问题解决
U8W/U8W-Mini使用与常见问题解决 - stm32使用HAL库配置串口中断收发数据（保姆级教程）
stm32使用HAL库配置串口中断收发数据（保姆级教程） - SpringSecurity实现前后端分离认证授权
SpringSecurity实现前后端分离认证授权 - 【社区图书馆】伴我前行的一本书《The C Programming Language》
【社区图书馆】伴我前行的一本书《The C Programming Language》 - 分享几个国内免费的ChatGPT镜像网址(亲测有效)
分享几个国内免费的ChatGPT镜像网址(亲测有效)