springmvc-210807-02---一个拦截器实现

最新推荐文章于 2025-07-09 11:04:12 发布

原创最新推荐文章于 2025-07-09 11:04:12 发布 · 220 阅读

0 ·

CC 4.0 BY-SA版权

白光一

文章标签：

#springmvc #拦截器 #Interceptor

springmvc 专栏收录该内容

19 篇文章

订阅专栏

本文详细介绍了如何在Spring MVC中实现一个自定义拦截器MyInterceptor，包括preHandle、postHandle和afterCompletion方法的使用。preHandle方法用于预处理请求，如验证用户权限，返回false会转向tips.jsp，true则继续执行处理器；postHandle用于处理处理器方法后的修饰，如修改ModelAndView数据；afterCompletion则在请求完成后执行，常用于资源回收。通过一个实际例子展示了拦截器在处理用户请求流程中的作用。

MyInterceptor.java（自定义拦截器类）

package com.bgy.handler;

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

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.util.Date;

// 拦截器，拦截用户请求
public class MyInterceptor implements HandlerInterceptor {

    private long bTime;

    /**
     * preHandle叫做预处理方法
     * 参数：
     *    Object handler：被拦截的控制器对象MyController。
     *
     * 返回值：
     *    true：请求通过了拦截器验证，可以执行处理器方法。
     *      执行结果：
     *         ------这是MyInterceptor的preHandler()方法------
     *         这是MyController的doSome()方法
     *         ------这是MyInterceptor的postHandle()方法------
     *         ------这是MyInterceptor的afterCompletion()方法------
     *
     *    false：请求没有通过拦截器验证，请求被拦截器截断。
     *       执行结果：
     *         ------这是MyInterceptor的preHandler()方法------
     *
     * 特点：
     *    1. 方法在控制器方法执行（MyController的doSome）之前执行，用户请求先到达这里
     *
     *    2. 在这个方法可以获取请求的信息，验证请求是否符合要求，
     *       可以验证用户是否可以登录，验证用户是否有权访问某个连接地址（uri），
     *       如果验证失败，可以截断请求，请求就不能被处理，
     *       如果验证成功，可以放行请求，此时控制器方法才能被执行。
     */
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        System.out.println("------这是MyInterceptor的preHandler()方法------");
        bTime = System.currentTimeMillis();
//        return true;

        // 如果返回为false，给浏览器一个返回结果
        request.getRequestDispatcher("/tips.jsp").forward(request,response);
        return false;
    }

    /**
     * postHandle：后处理方法。
     *
     * 参数：
     *    Object handler：被拦截的控制器对象MyController。
     *    ModelAndView mv：处理器方法返回值。
     *
     * 特点：
     *    1. 在处理器方法执行之后执行。
     *    2. 能够获取到处理器方法的返回值ModelAndView，
     *       可以修改ModelAndView中的数据和视图，可以影响到最后的执行过程。
     *    3. 主要是对原来的执行结果做二次修正。
     */
    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView mv) throws Exception {
        System.out.println("------这是MyInterceptor的postHandle()方法------");

        // 对原来的doSome执行结果修改
        if (mv != null) {
            // 修改数据
            mv.addObject("mydate",new Date());
            // 修改视图
            mv.setViewName("other");
        }
    }

    /**
     * afterCompletion：最后执行的方法
     *
     * 参数：
     *    Object handler：被拦截的控制器对象MyController。
     *    Exception ex：程序中发生的异常。
     *
     * 特点：
     *    1. 在请求处理完成执行的，
     *       框架中规定是当你的视图处理完成之后，对视图执行了forward，就认为请求处理完成。
     *    2. 这个方法一般做资源回收的，程序请求中创建了一些对象，在这里就可以删除了，把占用的内存回收。
     */
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        System.out.println("------这是MyInterceptor的afterCompletion()方法------");

        long eTime = System.currentTimeMillis();
        System.out.println("程序从请求到结束完成时间为："+(eTime-bTime));
    }
}

MyController.java（处理器）

package com.bgy.controller;

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

@Controller
public class MyController {

    /**
     * 测试拦截器
     */
    @RequestMapping("/some.do")
    public ModelAndView doSome(String name,Integer age) {

        System.out.println("这是MyController的doSome()方法");

        ModelAndView mv = new ModelAndView();

        mv.addObject("uname",name);
        mv.addObject("uage",age);
        mv.addObject("msg","拦截器");

        mv.setViewName("show");

        return mv;
    }
}

dispatchServlet.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">

    <!-- springmvc配置文件，声明controller和其他web相关的对象 -->

    <context:component-scan base-package="com.bgy.controller"/>

    <bean class="org.springframework.web.servlet.view.InternalResourceViewResolver">
        <property name="prefix" value="/WEB-INF/view/"/>
        <property name="suffix" value=".jsp"/>
    </bean>

    <!-- 声明拦截器，拦截器可以有0个或多个 -->
    <mvc:interceptors>
        <mvc:interceptor>
            <!--
                指定拦截的请求uri地址
                    path：uri地址
                          **表示任意字符，文件或多级目录和目录中的文件。
                          / 代表根目录
            -->
            <mvc:mapping path="/**"/>
            <bean class="com.bgy.handler.MyInterceptor"/>
        </mvc:interceptor>
    </mvc:interceptors>

</beans>

index.jsp（主页面）

<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<%
    String basePath = request.getScheme() + "://" +
            request.getServerName() + ":" +
            request.getServerPort() +
            request.getContextPath() + "/";
%>
<html>
<head>
    <title>拦截器</title>
    <base href="<%=basePath%>"/>
</head>
<body>
    <form action="some.do" method="post">
        <span>拦截器</span>
        <br/>
        <span>姓名：</span><input type="text" name="name"/>
        <br/>
        <span>年龄：</span><input type="text" name="age"/>
        <br/>
        <input type="submit" value="提交"/>
    </form>

</body>
</html>

tips.jsp（拦截器preHandle返回false页面）

<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
    <title>tips.jsp</title>
</head>
<body>
    WEB-INF/view/tips.jsp
    <br/>
    拦截器返回false页面
</body>
</html>

show.jsp（拦截器preHandle返回true页面）

<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
    <title>show.jsp</title>
</head>
<body>
    WEB-INF/view/show.jsp
    <br/>
    ${msg}
    <br/>
    姓名：${uname}
    <br/>
    年龄：${uage}
</body>
</html>

other.jsp（拦截器的postHandle：后处理方法，返回页面）

<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
    <title>other.jsp</title>
</head>
    <body>
        WEB-INF/view/other.jsp
        <br/>
        ${msg}
        <br/>
        姓名：${uname}
        <br/>
        年龄：${uage}
        <br/>
        日期：${mydate}
    </body>
</html>

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">

    <!-- 注册中央调度器 -->
    <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:conf/dispatchServlet.xml</param-value>
        </init-param>

        <load-on-startup>1</load-on-startup>
    </servlet>
    <servlet-mapping>
        <servlet-name>dispatcherServlet</servlet-name>
        <url-pattern>*.do</url-pattern>
    </servlet-mapping>


    <!-- 注册字符集过滤器，解决post请求中文乱码问题 -->
    <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>
        <init-param>
            <param-name>forceRequestEncoding</param-name>
            <param-value>true</param-value>
        </init-param>
    </filter>
    <filter-mapping>
        <filter-name>characterEncodingFilter</filter-name>
        <url-pattern>/*</url-pattern>
    </filter-mapping>

</web-app>