【springMVC】SpringMVC的拦截器(Interceptor)和异常处理【附源码】

一、拦截器

1.SpringMVC的拦截器（Interceptor）
类似于Servlet中的过滤器（Filter），主要用于拦截用户请求（控制器方法）并做出相应的处理。例如：权限验证、判断用户是否登录等。
2.拦截器的定义
（1）实现HandlerInterceptor接口；
（2）继承HandlerInterceptorAdapter类。
3.拦截器的三个抽象方法
（1）preHandle：控制器方法执行之前执行preHandle()，其boolean类型的返回值表示是否拦截或放行，返回true为放行，即调用控制器方法;返回false表示拦截，即不调用控制器方法
（2）postHandle：控制器方法执行之后执行postHandle()
（3）afterComplation：处理完视图和模型数据，渲染视图完毕之后执行afterComplation()
4.拦截器的执行顺序
（1）单个拦截器的执行顺序
程序首先会执行拦截器类中的preHandler()方法，如果该方法的返回值会true，则会继续向下执行处理器中的方法，否则将不会再向下执行；在业务处理器（控制器Controller类）处理完请求后，会执行postHandler()方法，然后会通过DispatcherServlet向客户端返回响应；在DispatcherServlet处理完请求后，才会执行afterCompletion()方法。

（2）多个拦截器的执行顺序：
① 若每个拦截器的preHandle()都返回true
多个拦截器同时工作时，它们的preHandle()方法会按照配置文件中拦截器的配置顺序执行，而它们的postHandle和afterCompletion()方法会按照配置顺序的反序执行。
② 若某个拦截器的preHandle()返回了false
preHandle()返回false和它之前的拦截器的preHandle()都会执行，postHandle()都不执行，返回false的拦截器之前的拦截器的afterComplation()会执行
5.自定义拦截器
pom.xml依赖

<dependencies>
    <!--SpringMVC-->
    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-webmvc</artifactId>
        <version>5.3.1</version>
    </dependency>
    <!--日志-->
    <dependency>
        <groupId>ch.qos.logback</groupId>
        <artifactId>logback-classic</artifactId>
        <version>1.2.3</version>
    </dependency>
    <!--servletAPI-->
    <dependency>
        <groupId>javax.servlet</groupId>
        <artifactId>javax.servlet-api</artifactId>
        <version>3.1.0</version>
        <scope>provided</scope>
    </dependency>
    <!--Spring与Thymeleaf整合-->
    <dependency>
        <groupId>org.thymeleaf</groupId>
        <artifactId>thymeleaf-spring5</artifactId>
        <version>3.0.12.RELEASE</version>
    </dependency>
</dependencies>

（1）InterceptorController.java

@Controller
public class InterceptorController {
    
    
    @RequestMapping("/testInterceptor")
    public String testInterceptor(){
    
    
        return "success";
    }
}

（2）CustomerInterceptor.java

//若想配置多个拦截器，只需要复制该拦截器，改个类名就可
@Component
public class CustomerInterceptor implements HandlerInterceptor {
    
    
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
    
    
        System.out.println("InterceptorTest--->preHandle");
        //return false表示不拦截
        return true;
    }
    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
    
    
        System.out.println("InterceptorTest--->postHandle");
    }
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
    
    
        System.out.println("InterceptorTest--->afterCompletion");
    }
}

（3）springMVC.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 http://www.springframework.org/schema/context/spring-context.xsd
            http://www.springframework.org/schema/mvc http://www.springframework.org/schema/mvc/spring-mvc.xsd">

    <context:component-scan base-package="com.jd.mvc"/>
    <!--配置视图解析器-->
    <bean id="viewResolver" class="org.thymeleaf.spring5.view.ThymeleafViewResolver">
        <property name="order" value="1"/>
        <property name="characterEncoding" value="UTF-8"/>
        <property name="templateEngine">
            <bean class="org.thymeleaf.spring5.SpringTemplateEngine">
                <property name="templateResolver">
                    <bean class="org.thymeleaf.spring5.templateresolver.SpringResourceTemplateResolver">
                        <!--视图前缀-->
                        <property name="prefix" value="/WEB-INF/templates/"/>
                        <!--视图后缀-->
                        <property name="suffix" value=".html"/>
                        <property name="templateMode" value="HTML5"/>
                        <property name="characterEncoding" value="UTF-8"/>
                    </bean>
                </property>
            </bean>
        </property>
    </bean>
    <!--配置SpringMVC的视图控制器-->
    <mvc:view-controller path="/" view-name="index"></mvc:view-controller>
    <mvc:default-servlet-handler/>
    <!--开启SpringMVC的注解驱动-->
    <mvc:annotation-driven/>
    <!--配置拦截器-->
    <mvc:interceptors>
<!--        <bean class="com.jd.mvc.interceptor.CustomerInterceptor"/>-->
			<!--配置第2个拦截器-->
<!--        <bean class="com.jd.mvc.interceptor.CustomerInterceptor2"/>-->
<!--        <ref bean="firstInterceptor"/>-->
<!--        以上两种配置会对所有的请求尽心拦截-->
        <mvc:interceptor>
            <mvc:mapping path="/**"/>
            <mvc:exclude-mapping path="/"/>
            <ref bean="customerInterceptor"/>
        </mvc:interceptor>
    </mvc:interceptors>
</beans>

（4）index.html

<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
<body>
<h1>首页</h1><br>
<a th:href="@{/testInterceptor}">测试Interceptor</a>
</body>
</html>

（5）web.xml

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_4_0.xsd"
         version="4.0"
         metadata-complete="true">
    <!--1.配置编码过滤器，在此之前不能获取任何的请求参数，只要获取请求参数，设置编码方式就无用-->
    <filter>
        <filter-name>CharacterEncodingFilter</filter-name>
        <filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class>
        <!--设置请求的编码-->
        <init-param>
            <param-name>encoding</param-name>
            <param-value>UTF-8</param-value>
        </init-param>
        <!--设置响应的编码-->
        <init-param>
            <param-name>forceResponseEncoding</param-name>
            <param-value>true</param-value>
        </init-param>
    </filter>
    <!--表示对所有的都进行编码，过滤器的执行顺序是根据<filter-mapping>的顺序执行的-->
    <filter-mapping>
        <filter-name>CharacterEncodingFilter</filter-name>
        <url-pattern>/*</url-pattern>
    </filter-mapping>

    <!--2.配置HiddenHttpMethodFilter-->
    <filter>
        <filter-name>HiddenHttpMethodFilter</filter-name>
        <filter-class>org.springframework.web.filter.HiddenHttpMethodFilter</filter-class>
    </filter>
    <filter-mapping>
        <filter-name>HiddenHttpMethodFilter</filter-name>
        <url-pattern>/*</url-pattern>
    </filter-mapping>
    <!--3.配置SpringMVC的前端控制器-->
    <servlet>
        <servlet-name>DispatcherServlet</servlet-name>
        <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
        <init-param>
            <param-name>contextConfigLocation</param-name>
            <param-value>classpath:springMVC.xml</param-value>
        </init-param>
        <load-on-startup>1</load-on-startup>
    </servlet>
    <servlet-mapping>
        <servlet-name>DispatcherServlet</servlet-name>
        <url-pattern>/</url-pattern>
    </servlet-mapping>
</web-app>

将项目部署到tomcat服务器后运行，点击超链接

返回idea的控制台，就可以看到两个拦截器的执行顺序。

二、异常处理器

SpringMVC提供了一个处理控制器方法执行过程中所出现的异常接口：HandlerExceptionResolver
HandlerExceptionResolver接口的实现类有：DefaultHandlerExceptionResolver和
SimpleMappingExceptionResolver
SpringMVC提供了自定义的异常处理器SimpleMappingExceptionResolver，使用方式：

基于配置的异常处理

（1）在SpringMVC的配置文件中进行配置

<!--配置SpringMVC的异常映射-->
<bean class="org.springframework.web.servlet.handler.SimpleMappingExceptionResolver">
    <property name="exceptionMappings">
        <props>
            <!--properties的键表示处理器方法执行过程中出现的异常;
                properties的值表示若出现指定异常时，设置一个新的视图名称，跳转到指定页面-->
            <prop key="java.lang.ArithmeticException">error</prop>
        </props>
    </property>
    <!--exceptionAttribute属性设置一个属性名，将异常信息共享在请求域中-->
    <property name="exceptionAttribute" value="ex"/>
</bean>

（2）index.html

<!--设置将异常信息共享在请求域中的键-->
<a th:href="@{/testException}">测试Exception</a><br>

（3）error.html

<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
<body>
出现了错误！！！
<!--获取异常并输出-->
<p th:text="${ex}"></p>
</body>
</html>

（4）控制器方法

@RequestMapping("/testException")
public String testException(){
    
    
    int i = 10/0;
    return "error";
}

基于注解的异常处理

只需要创建一个java类，然后标注上相应的注解，即可免去了SpringMVC配置文件的配置。

@ControllerAdvice
public class ExceptionController {
    
    
    @ExceptionHandler(value = {
    
    ArithmeticException.class,NullPointerException.class})
    public String testException(Exception ex, Model model){
    
    
        model.addAttribute("ex",ex);
        return "error";
    }
}