SpringMVC拦截器的配置与使用详解

一、SpringMVC拦截器简介

Spring MVC的处理器拦截器类似于Servlet开发中的过滤器Filter，用于对处理器进行预处理和后处理。在springmvc中，定义拦截器要实现HandlerInterceptor接口

二、SpringMVC拦截器方法

preHandle

预处理回调方法，实现处理器的预处理（如登录检查），第三个参数为响应的处理器（如具体的Controller实现）；
返回值：true表示继续流程（如调用下一个拦截器或处理器）；false表示流程中断（如登录检查失败），不会继续调用其他的拦截器或处理器，此时我们需要通过response来产生响应；

postHandle

后处理回调方法，实现处理器的后处理（但在渲染视图之前），此时我们可以通过modelAndView（模型和视图对象）对模型数据进行处理或对视图进行处理，modelAndView也可能为null

afterCompletion

整个请求处理完毕回调方法，即在视图渲染完毕时回调，如性能监控中我们可以在此记录结束时间并输出消耗时间，还可以进行一些资源清理，类似于try-catch-finally中的finally，

但仅调用处理器执行链中preHandle返回true的拦截器的afterCompletion

三、SpringMVC拦截器实例

1）创建工程

Eclipse下新建一个web项目，File>New>Dynamic Web Project

2）配置web.xml

<?xml version="1.0" encoding="UTF-8"?>

<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

    xmlns="http://xmlns.jcp.org/xml/ns/javaee"

    xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_3_1.xsd"

    id="WebApp_ID" version="3.1">

    <display-name>springmvc_6_interceptor</display-name>

    <welcome-file-list>

        <welcome-file>index.jsp</welcome-file>

    </welcome-file-list>

    <servlet>

        <servlet-name>springDispatcherServlet</servlet-name>

        <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>

        <init-param>

            <param-name>contextConfigLocation</param-name>

            <param-value>classpath:spring-mvc.xml</param-value>

        </init-param>

        <load-on-startup>1</load-on-startup>

    </servlet>

    <servlet-mapping>

        <servlet-name>springDispatcherServlet</servlet-name>

        <url-pattern>/</url-pattern>

    </servlet-mapping>

</web-app>

3）添加首页面

<%@ page language="java" contentType="text/html; charset=UTF-8"

    pageEncoding="UTF-8"%>

<!DOCTYPE html>

<html>

<head>

<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">

<title>Insert title here</title>

</head>

<body>

    <form action="springmvc/testFileUpload" method="POST"

        enctype="multipart/form-data">

        File: <input type="file" name="file" /><br>

        <br> Desc: <input type="text" name="desc" /> <input

            type="submit" value="Submit" />

    </form>

    <br>

    <br>

</body>

</html>

4）添加控制器Controller

package com.yyx.handlers;

import java.io.IOException;

import org.springframework.stereotype.Controller;

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

import org.springframework.web.bind.annotation.RequestParam;

import org.springframework.web.multipart.MultipartFile;

@RequestMapping("/springmvc")

@Controller

/**

 *

 * @author yyx 2018年7月19日

 */

public class SpringMVCTest {

    private static final String SUCCESS = "success";

    /**

     * 常用:单个文件上传

     * 注意:需要在配置文件配置支持文件上传的bean

     * @param desc

     * @param file

     * @return

     */

    @RequestMapping("/testFileUpload")

    public String testFileUpload(

            @RequestParam(value = "desc", required = false) String desc,

            @RequestParam("file") MultipartFile file) {

        System.out.println("desc:" + desc);

        System.out.println("OriginalFilename:" + file.getOriginalFilename());

        try {

            System.out.println("InputStream:" + file.getInputStream());

        } catch (IOException e) {

            e.printStackTrace();

        }

        return SUCCESS;

    }

}

5）添加拦截器

package com.yyx.interceptors;

import javax.servlet.http.HttpServletRequest;

import javax.servlet.http.HttpServletResponse;

import org.springframework.web.servlet.HandlerInterceptor;

import org.springframework.web.servlet.ModelAndView;

/**

 * 拦截器一

 * @author yyx 2018年7月19日

 */

public class FirstInterceptor implements HandlerInterceptor {

    /**

     * 渲染视图之后被调用. 释放资源

     */

    @Override

    public void afterCompletion(HttpServletRequest request,

            HttpServletResponse response, Object obj, Exception ex)

            throws Exception {

        System.out.println("[FirstInterceptor] afterCompletion");

    }

    /**

     * 调用目标方法之后, 但渲染视图之前. 可以对请求域中的属性或视图做出修改.

     */

    @Override

    public void postHandle(HttpServletRequest request, HttpServletResponse response,

            Object obj, ModelAndView mv) throws Exception {

        System.out.println("[FirstInterceptor] postHandle");

    }

    /**

     * 该方法在目标方法之前被调用. 若返回值为 true, 则继续调用后续的拦截器和目标方法. 若返回值为 false,

     * 则不会再调用后续的拦截器和目标方法.

     *

     * 可以考虑做权限. 日志, 事务等.

     */

    @Override

    public boolean preHandle(HttpServletRequest request, HttpServletResponse response,

            Object obj) throws Exception {

        System.out.println("[FirstInterceptor] preHandle");

        return true;

    }

}

package com.yyx.interceptors;

import javax.servlet.http.HttpServletRequest;

import javax.servlet.http.HttpServletResponse;

import org.springframework.web.servlet.HandlerInterceptor;

import org.springframework.web.servlet.ModelAndView;

/**

 * 拦截器二

 * @author yyx 2018年7月19日

 */

public class SecondInterceptor implements HandlerInterceptor {

    /**

     * 渲染视图之后被调用. 释放资源

     */

    @Override

    public void afterCompletion(HttpServletRequest arg0,

            HttpServletResponse arg1, Object arg2, Exception arg3)

            throws Exception {

        System.out.println("[SecondInterceptor] afterCompletion");

    }

    /**

     * 调用目标方法之后, 但渲染视图之前. 可以对请求域中的属性或视图做出修改.

     */

    @Override

    public void postHandle(HttpServletRequest arg0, HttpServletResponse arg1,

            Object arg2, ModelAndView arg3) throws Exception {

        System.out.println("[SecondInterceptor] postHandle");

    }

    /**

     * 该方法在目标方法之前被调用. 若返回值为 true, 则继续调用后续的拦截器和目标方法. 若返回值为 false,

     * 则不会再调用后续的拦截器和目标方法.

     *

     * 可以考虑做权限. 日志, 事务等.

     */

    @Override

    public boolean preHandle(HttpServletRequest arg0, HttpServletResponse arg1,

            Object arg2) throws Exception {

        System.out.println("[SecondInterceptor] preHandle");

        return true;

    }

}

6）配置spring-mvc.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:aop="http://www.springframework.org/schema/aop"

    xmlns:context="http://www.springframework.org/schema/context"

    xmlns:mvc="http://www.springframework.org/schema/mvc" xmlns:p="http://www.springframework.org/schema/p"

    xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd

        http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop.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">

    <mvc:annotation-driven />

    <!-- 配置自动扫描的包 -->

    <context:component-scan base-package="com.yyx.handlers"></context:component-scan>

    <!-- 配置视图解析器 :如何把 handlers 方法返回值解析为实际的物理视图 -->

    <bean

        class="org.springframework.web.servlet.view.InternalResourceViewResolver">

        <property name="prefix" value="/WEB-INF/views/"></property>

        <property name="suffix" value=".jsp"></property>

    </bean>

    <!-- 配置拦截器 -->

    <mvc:interceptors>

        <!-- 配置自定义的拦截器 -->

        <!-- <bean class="com.yyx.interceptors.FirstInterceptor"></bean> -->

        <!-- 配置拦截器(不)作用的路径 -->

        <mvc:interceptor>

            <mvc:mapping path="/springmvc/testFileUpload" />

            <!-- 拦截所有的请求，这个必须写在前面，也就是写在【不拦截】的上面 -->

            <!-- <mvc:mapping path="/**"/> -->

            <!-- 但是排除下面这些，也就是不拦截请求 -->

            <!-- <mvc:exclude-mapping path="/springmvc/testFileUpload"/> -->

            <bean class="com.yyx.interceptors.SecondInterceptor"></bean>

        </mvc:interceptor>

    </mvc:interceptors>

    <!-- 配置 MultipartResolver 文件上传 -->

    <bean id="multipartResolver"

        class="org.springframework.web.multipart.commons.CommonsMultipartResolver">

        <property name="defaultEncoding" value="UTF-8"></property>

        <property name="maxUploadSize" value="1024000"></property>

    </bean>

</beans>

7）添加目标页面

<%@ page language="java" contentType="text/html; charset=UTF-8"

    pageEncoding="UTF-8"%>

<!DOCTYPE html>

<html>

<head>

<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">

<title>Insert title here</title>

</head>

<body>

    <h2>Success Page</h2>

</body>

</html>

常见应用场景

日志记录：记录请求信息的日志，以便进行信息监控、信息统计、计算PV（Page View）等
权限检查：如登录检测，进入处理器检测检测是否登录，如果没有直接返回到登录页面
性能监控：有时候系统在某段时间莫名其妙的慢，可以通过拦截器在进入处理器之前记录开始时间，在处理完后记录结束时间，从而得到该请求的处理时间（如果有反向代理，如apache可以自动记录）
通用行为：读取cookie得到用户信息并将用户对象放入请求，从而方便后续流程使用，还有如提取Locale、Theme信息等，只要是多个处理器都需要的即可使用拦截器实现
OpenSessionInView：如Hibernate，在进入处理器打开Session，在完成后关闭Session

SpringMVC拦截器的配置与使用详解的更多相关文章

springmvc拦截器的配置、使用
springmvc拦截器的配置.使用:1.自定义拦截器,实现HandlerInterceptor接口. package com.bybo.aca.web.interceptor; import jav ...
springMVC 拦截器简单配置
在spring 3.0甚础上,起来越多的用到了注解,从前的拦截器在配置文件中需要这样配置 <beans...> ... <bean id="measurementInter ...
springMVC拦截器简单配置
 <mvc:interceptors> <mvc:interceptor> <!-- 拦截所 ...
【Spring】14、SpringMVC拦截器的配置
拦截器: com.zk.interceptors.MyInterceptor 实现了 HandlerInterceptor接口,可以拦截@RequestMapping注解的类和方法第一种方式 < ...
spring mvc拦截器和<mvc:annotation-driven />的详解
MVC的拦截器经本人在Spring mvc中对方案1和方案2的测试表明,并没有拦截静态资源,所以可以放心使用方案1和方案2,方案3可以放弃,并且可以放心使用<mvc:annotation-dr ...
JavaEE开发之SpringMVC中的路由配置及参数传递详解
在之前我们使用Swift的Perfect框架来开发服务端程序时,聊到了Perfect中的路由配置.而在SpringMVC中的路由配置与其也是大同小异的.说到路由,其实就是将URL映射到Java的具体类 ...
Springboot中SpringMvc拦截器配置与应用（实战）
一.什么是拦截器,及其作用拦截器(Interceptor): 用于在某个方法被访问之前进行拦截,然后在方法执行之前或之后加入某些操作,其实就是AOP的一种实现策略.它通过动态拦截Action调用的对 ...
SpringMVC拦截器详解[附带源码分析]
目录前言重要接口及类介绍源码分析拦截器的配置编写自定义的拦截器总结总结前言 SpringMVC是目前主流的Web MVC框架之一. 如果有同学对它不熟悉,那么请参考它的入门blog:h ...
SpringMVC拦截器详解
拦截器是每个Web框架必备的功能,也是个老生常谈的主题了. 本文将分析SpringMVC的拦截器功能是如何设计的,让读者了解该功能设计的原理. 重要接口及类介绍 1. HandlerExecution ...

随机推荐

Async.js解决Node.js操作MySQL的回调大坑
因为JavaScript语言异步特性.在使用Node.js运行非常多操作时都会使用到回调函数,当中就包含訪问数据库.假设代码中的业务逻辑略微复杂一点,回调一层层嵌套.那么代码非常easy进入Callb ...
eclipse svn插件删除原账号信息重新登录
1.通过删除SVN客户端的账号配置文件 1)查看你的Eclipse中使用的是什么SVN Interface(中文:svn接口)windows > preference > Team ...
php excel文件导出之二图像导出
PHP文件导出之图像和文字同一时候导出事实上之前写了个php文件导出.跟这个极为相似,由于项目须要对图像进行导出.查询一番.又写了一个, 这个能实现图像的导出(仅仅能是本地图像,不能使用远程图 ...
设置windows时间开机同步方法
本作品由Man_华创作,采用知识共享署名-非商业性使用-相同方式共享 4.0 国际许可协议进行许可.基于http://www.cnblogs.com/manhua/上的作品创作. 适用场景: 主板电池 ...
Hadoop2.2.0-64位编译
本作品由Man_华创作,采用知识共享署名-非商业性使用-相同方式共享 4.0 国际许可协议进行许可.基于http://www.cnblogs.com/manhua/上的作品创作. 实验环境:Ubunt ...
.net发布网站步骤
本文章分为三个部分: web网站发布.IIS6 安装方法.ASP.NET v4.0 安装方法一.web网站发布 1.打开 Visual Studio 2013 编译环境 2.在其解决方案上右击弹出重 ...
Chrome禁用NPAPI插件(包含 Silverlight、Java 和 Unity)
过去,很多插件都是使用一种称为NPAPI 的旧系统开发的. 现在,仅仅有少量站点在使用NPAPI 插件,由于这些插件有时会给站点带来安全风险. 为了让用户获得更安全.更高速且更稳定的 Chrome 浏 ...
FZU 2124 FOJ 2124 吃豆人【BFS】
Problem 2124 吃豆人 Accept: 134 Submit: 575 Time Limit: 1000 mSec Memory Limit : 32768 KB Probl ...
成长型思维模式Not yet
当做一件事失败了,要告诉他暂未成功,暂时没有成功,继续努力,下次就有可能成功. 不及格,暂未及格是两种思维模式,成长性的思维方式得到的是一个是努力型的人格
thinkphp5 (最棒的php开源框架)
tp5的唯一可访问目录是public,即项目根目录: http://localhost/tp5/public/ 开发规范: 类库.函数文件统一以.php为后缀类(命名和路径)和命名空间保持一致类文 ...

SpringMVC拦截器的配置与使用详解

常见应用场景

SpringMVC拦截器的配置与使用详解的更多相关文章

随机推荐

热门专题