【SpringMVC】自定义拦截器和过滤器

一、闲话

五一假期明天结束了，咬咬牙把SpringMVC结束掉

二、基本要点

1、过滤器

除了之前我们提到的spring提供的过滤器之外，我们还可以自定义过滤器，使用步骤如下

• 编写java类实现Filter接口，并实现其doFilter方法。
• 在web.xml 文件中使用<filter>和<filter-mapping>元素对编写的filter类进行注册，并设置它所能拦截的资源

可以参考 Java三大器之过滤器（Filter）的工作原理和代码演示

2、拦截器

1）过滤器与拦截器的区别：拦截器是AOP思想的具体应用。

过滤器

• servlet规范中的一部分，任何java web工程都可以使用
• 在url-pattern中配置了/*之后，可以对所有要访问的资源进行拦截

拦截器

• 拦截器是SpringMVC框架自己的，只有使用了SpringMVC框架的工程才能使用
• 拦截器只会拦截访问的控制器方法， 如果访问的是jsp/html/css/image/js是不会进行拦截的

2）自定义拦截器必须要实现HandlerInterceptor接口
首先我们新建一个模块，将他设置成web项目

然后新建一个自定义拦截器类MyInterceptor

package com.decade.config;

import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

public class MyInterceptor implements HandlerInterceptor {

    // 在请求接口方法之前进入，如果放回true就放行，进入下一个拦截器或者控制器，如果返回false就不继续往下走
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        System.out.println("=========处理前=============");
        return true;
    }

    //调用前提：preHandle返回true
    //调用时间：Controller方法处理完之后，DispatcherServlet进行视图的渲染之前，也就是说在这个方法中你可以对ModelAndView进行操作
    //执行顺序：链式Interceptor情况下，Interceptor按照声明的顺序倒着执行。
    //备注：postHandle虽然post打头，但post、get方法都能处理
    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        System.out.println("=========处理后=============");
    }

    //调用前提：preHandle返回true
    //调用时间：DispatcherServlet进行视图的渲染之后
    //多用于清理资源
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        System.out.println("=========清理=============");
    }
}

以及控制器类TestController

package com.decade.controller;

import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class TestController {

    @RequestMapping("/test")
    public String test() {
        System.out.println("成功进入test()方法");
        return "test OK!";
    }
}

接着我们配置一下webx.ml

<?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">
    <servlet>
        <servlet-name>springmvc</servlet-name>
        <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
        <!-- 关联一个springmvc的配置文件 -->
        <init-param>
            <param-name>contextConfigLocation</param-name>
            <param-value>classpath:springmvc-servlet.xml</param-value>
        </init-param>
        <!-- 设置启动级别 -->
        <load-on-startup>1</load-on-startup>
    </servlet>


    <servlet-mapping>
        <servlet-name>springmvc</servlet-name>
        <url-pattern>/</url-pattern>
    </servlet-mapping>

</web-app>

和springmvc的配置文件springmvc-servlet.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">


    <!-- 开启自动扫描，让指定包下的注解生效,由IOC容器统一管理 -->
    <context:component-scan base-package="com.decade.controller"/>
    <!-- 让Spring MVC不处理静态资源 -->
    <mvc:default-servlet-handler />
    <!--
    支持mvc注解驱动
    我们一般采用@RequestMapping注解来完成url路径和具体控制器的映射
    要想使该注解生效，必须注册DefaultAnnotationHandlerMapping和一个AnnotationMethodHandlerAdapter实例
    这两个实例分别在类级别和方法级别处理。
    而annotation-driven配置帮助我们自动完成上述两个实例的注入。
     -->
    <mvc:annotation-driven />


    <!-- 视图解析器 -->
    <bean class="org.springframework.web.servlet.view.InternalResourceViewResolver"
          id="internalResourceViewResolver">
        <!-- 前缀 -->
        <property name="prefix" value="/WEB-INF/jsp/" />
        <!-- 后缀 -->
        <property name="suffix" value=".jsp" />
    </bean>
    
    <mvc:interceptors>
        <mvc:interceptor>
            <!--*代表值拦截一层，**代表拦截任意层
            如果是一个拦截器的配置，代表拦截 /target/下一层的请求
            如：http://localhost/target/123会进入此拦截器，而http://localhost/target/123/java拦截不到
            如果将*改为**,则前面的列举的两个地址都会被拦截
            -->
            <mvc:mapping path="/**"/>
            <!-- 配置拦截器 -->
            <bean class="com.decade.config.MyInterceptor"/>
        </mvc:interceptor>
    </mvc:interceptors>
</beans>

最后我们用index.jsp页面测试一下

<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
  <head>
    <title>拦截器测试</title>
  </head>
  <body>
  <a href="${pageContext.request.contextPath}/test">拦截器测试</a>
  </body>
</html>

测试结果如下，点击链接，成功调用接口，如果拦截器中设置为false，那么无法调用接口