SpringMVC 的拦截器

# 120.SpringMVC 的拦截器

Spring MVC 的处理器拦截器类似于 Servlet 开发中的过滤器 Filter，用于对处理器进行预处理和后处理。用户可以自己定义一些拦截器来实现特定的功能。 ‍

‍

# 相关术语

谈到拦截器，还要向大家提一个词——拦截器链（Interceptor Chain）。拦截器链就是将拦截器按一定的顺序联结成一条链。在访问被拦截的方法或字段时，拦截器链中的拦截器就会按其之前定义的顺序被调用。

说到这里，可能大家脑海中有了一个疑问，这不是我们之前学的过滤器吗？是的它和过滤器是有几分相似，但是也有区别，接下来我们就来说说他们的区别：

过滤器是 Servlet 规范中的一部分，任何 Java Web 工程都可以使用。
拦截器是 SpringMVC 框架自己的，只有使用了 SpringMVC 框架的工程才能用。
过滤器在 url-pattern 中配置了 /* 之后，可以对所有要访问的资源拦截。
拦截器它是只会拦截访问的控制器方法，如果访问的是 JSP，HTML/CSS/JS 或者 image，是不会进行拦截的。

拦截器也是 AOP 思想的具体应用。

我们要想自定义拦截器，要求必须实现：HandlerInterceptor 接口。接下来我们演示如何用

‍

# 搭建环境

我们可以删除之前的 Java 代码，并将配置文件中的异常处理的类删掉；

并且初始化 index.jsp 的内容为：

<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
    <head>
        <title>Title</title>
    </head>
    <body>
      <h3>拦截器</h3>
      <a href="user/testInterceptor">拦截器</a>
    </body>
</html>

1
2
3
4
5
6
7
8
9
10

‍

success.jsp

<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
    <head>
        <title>Title</title>
    </head>
    <body>
        <h3>执行成功</h3>

        <% System.out.println("执行成功"); %>
    </body>
</html>

1
2
3
4
5
6
7
8
9
10
11

‍

error.jsp

<%@ page contentType="text/html;charset=UTF-8" language="java" isELIgnored="false" %>
<html>
    <head>
        <title>Title</title>
    </head>
    <body>
      <h3>错误页面</h3>
    </body>
</html>

1
2
3
4
5
6
7
8
9

‍

# 新建 Controller

package com.peterjxl.controller;


import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;

@Controller
@RequestMapping("/user")
public class UserController {

    @RequestMapping("/testInterceptor")
    public String testInterceptor() {
        System.out.println("testInterceptor执行了...");
        return "success";
    }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

‍

# 编写拦截器

新建一个类，实现 HandlerInterceptor 接口；

package com.peterjxl.interceptor;
import org.springframework.web.servlet.HandlerInterceptor;
public class MyInterceptor implements HandlerInterceptor {}

1
2
3

‍

我们实现后，可以看到 IDE 没有报错，也就是我们不用实现里面的方法，也没有报错；我们可以看到其源码中，是有方法定义的，但是已经实现了，这是 Java8 的一个增强：

package org.springframework.web.servlet;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.springframework.lang.Nullable;

public interface HandlerInterceptor {
    default boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        return true;
    }

    default void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, @Nullable ModelAndView modelAndView) throws Exception {
    }

    default void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, @Nullable Exception ex) throws Exception {
    }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

‍

该接口的 3 个方法的作用：

preHandle 是在控制器之前执行，返回值为 true 则表示放行，执行下一个拦截器，如果没有，则执行 controller。如果 return false，则不放行，并且我们可以用方法中的 req 和 resp 对象，跳转到某个错误页面上。例如可以判断是否登录。
postHandle 是在控制器之后执行，可用于记录一些日志之类的
afterCompletion 是在返回页面之后执行，可用于释放一些资源

‍

我们实现一下其方法：

@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
    System.out.println("MyInterceptor执行了...");
    return true;
}

1
2
3
4
5

‍

# 配置拦截器

‍

在 springmvc.xml 中配置：

<!-- 配置拦截器 -->
    <mvc:interceptors>
        <!-- 拦截器第一个拦截器 -->
        <mvc:interceptor>
            <!-- 拦截的路径 -->
            <mvc:mapping path="/user/*"/>
            <!-- 排除不拦截的路径 -->
            <bean class="com.peterjxl.interceptor.MyInterceptor"/>
        </mvc:interceptor>
    </mvc:interceptors>

1
2
3
4
5
6
7
8
9
10

这样配置之后，就会拦截/user 路径的所有请求，而其他路径的请求不拦截。我们可以在 <mvc:interceptors> 中配置多个拦截器，每个 <mvc:interceptor> 标签中定义一个拦截器

‍

除了配置拦截的路径之外，还可以配置不拦截的路径，这样除了这些不拦截的路径，其他路径都拦截：


<!-- 配置拦截器 -->
    <mvc:interceptors>
        <!-- 拦截器第一个拦截器 -->
        <mvc:interceptor>
            <!-- 拦截的路径 -->
            <mvc:exclude-mapping path="/user/*"/> <!-- 排除拦截的路径 -->
            <!-- 排除不拦截的路径 -->
            <bean class="com.peterjxl.interceptor.MyInterceptor"/>
        </mvc:interceptor>
    </mvc:interceptors>

1
2
3
4
5
6
7
8
9
10
11
12

‍

# 测试

测试之前，我们可以先自己思考一下方法执行的顺序：

首先是拦截器中的方法会被执行
然后拦截器放行，执行控制器中的方法
然后是 success 中的 sout 输出“执行成功”

‍

运行结果：

‍

控制台输出：

MyInterceptor执行了...
testInterceptor执行了...
执行成功

1
2
3

‍

# 测试不放行

@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
    System.out.println("MyInterceptor执行了...");
//        return true;

    request.getRequestDispatcher("/WEB-INF/pages/error.jsp").forward(request, response);
    return false; // 拦截器拦截请求，不再执行controller方法
}

1
2
3
4
5
6
7
8

‍

测试完后，我们改为放行，方便后续的测试。

‍

# 后处理方法 `postHandle`

postHandle 方法是在控制器方法执行后，success.jsp 执行前，执行的方法。

‍

运行结果：

MyInterceptor执行了...
testInterceptor执行了...
MyInterceptor执行了...postHandle
执行成功

1
2
3
4

‍

其实在后处理方法中，跳转页面也是可以的：

@Override
public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
    System.out.println("MyInterceptor执行了...postHandle");
    request.getRequestDispatcher("/WEB-INF/pages/error.jsp").forward(request, response);
}

1
2
3
4
5

‍

# `afterCompletion` 方法

success.jsp 执行后，afterCompletion 方法会执行，我们实现一下：

@Override
public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
    System.out.println("MyInterceptor执行了...afterCompletion");
}

1
2
3
4

‍

运行结果：

MyInterceptor执行了...
testInterceptor执行了...
MyInterceptor执行了...postHandle
执行成功
MyInterceptor执行了...afterCompletion

1
2
3
4
5

‍

注意，此时页面已经响应完成，再设置跳转到其他页面是不会成功的。

‍

# 源码

本项目已将源码上传到 GitHub (opens new window) 和 Gitee (opens new window) 上。并且创建了分支 demo11，读者可以通过切换分支来查看本文的示例代码。

‍

上次更新: 2024/10/1 21:14:36

← SpringMVC 的异常处理 SSM 整合→

SpringMVC 的拦截器

# 120.SpringMVC 的拦截器

# 相关术语

# 搭建环境

# 新建 Controller

# 编写拦截器

# 配置拦截器

# 测试

# 测试不放行

# 后处理方法 postHandle

# afterCompletion 方法

# 源码

# 后处理方法 `postHandle`

# `afterCompletion` 方法