SpringMVC-----攔截器

時間  2019-11-12
標籤 springmvc 攔截 欄目 Spring 简体版
原文   原文鏈接

攔截器的定義

在 Spring MVC 框架中定義一個攔截器須要對攔截器進行定義和配置，定義一個攔截器能夠經過兩種方式：一種是經過實現 HandlerInterceptor 接口或繼承 HandlerInterceptor 接口的實現類來定義；另外一種是經過實現 WebRequestInterceptor 接口或繼承 WebRequestInterceptor 接口的實現類來定義。

本節以實現 HandlerInterceptor 接口的定義方式爲例講解自定義攔截器的使用方法。示例代碼以下：html

package interceptor;

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

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

public class TestInterceptor implements HandlerInterceptor {
@Override
public void afterCompletion(HttpServletRequest request,
HttpServletResponse response, Object handler, Exception ex)
throws Exception {
System.out.println("afterCompletion方法在控制器的處理請求方法執行完成後執行，即視圖渲染結束以後執行");

}

@Override
public void postHandle(HttpServletRequest request,
HttpServletResponse response, Object handler,
ModelAndView modelAndView) throws Exception {
System.out.println("postHandle方法在控制器的處理請求方法調用以後，解析視圖以前執行");
}

@Override
public boolean preHandle(HttpServletRequest request,
HttpServletResponse response, Object handler) throws Exception {
System.out.println("preHandle方法在控制器的處理請求方法調用以後，解析視圖以前執行");
return false;
}
}

 

在上述攔截器的定義中實現了 HandlerInterceptor 接口，並實現了接口中的 3 個方法。有關這 3 個方法的描述以下。java

  • preHandle 方法：該方法在控制器的處理請求方法前執行，其返回值表示是否中斷後續操做，返回 true 表示繼續向下執行，返回 false 表示中斷後續操做。
  • postHandle 方法：該方法在控制器的處理請求方法調用以後、解析視圖以前執行，能夠經過此方法對請求域中的模型和視圖作進一步的修改。
  • afterCompletion 方法：該方法在控制器的處理請求方法執行完成後執行，即視圖渲染結束後執行，能夠經過此方法實現一些資源清理、記錄日誌信息等工做。

攔截器的配置

讓自定義的攔截器生效須要在 Spring MVC 的配置文件中進行配置，配置示例代碼以下：web

<!-- 配置攔截器 -->
<mvc:interceptors>
<!-- 配置一個全局攔截器，攔截全部請求 -->
<bean class="interceptor.TestInterceptor" /> 
<mvc:interceptor>
<!-- 配置攔截器做用的路徑 -->
<mvc:mapping path="/**" />
<!-- 配置不須要攔截做用的路徑 -->
<mvc:exclude-mapping path="" />
<!-- 定義<mvc:interceptor>元素中，表示匹配指定路徑的請求才進行攔截 -->
<bean class="interceptor.Interceptor1" />
</mvc:interceptor>
<mvc:interceptor>
<!-- 配置攔截器做用的路徑 -->
<mvc:mapping path="/gotoTest" />
<!-- 定義在<mvc: interceptor>元素中，表示匹配指定路徑的請求才進行攔截 -->
<bean class="interceptor.Interceptor2" />
</mvc:interceptor>
</mvc:interceptors>

 

在上述示例代碼中，<mvc：interceptors> 元素用於配置一組攔截器，其子元素 <bean> 定義的是全局攔截器，即攔截全部的請求。

<mvc：interceptor> 元素中定義的是指定路徑的攔截器，其子元素 <mvc：mapping> 用於配置攔截器做用的路徑，該路徑在其屬性 path 中定義。

如上述示例代碼中，path 的屬性值「/**」表示攔截全部路徑，「/gotoTest」表示攔截全部以「/gotoTest」結尾的路徑。若是在請求路徑中包含不須要攔截的內容，能夠經過 <mvc：exclude-mapping> 子元素進行配置。

須要注意的是，<mvc：interceptor> 元素的子元素必須按照 <mvc：mapping.../>、<mvc：exclude-mapping.../>、<bean.../> 的順序配置。spring

 

單個攔截器的執行流程

在配置文件中若是隻定義了一個攔截器，程序將首先執行攔截器類中的 preHandle 方法，若是該方法返回 true，程序將繼續執行控制器中處理請求的方法，不然中斷執行。若是 preHandle 方法返回 true，而且控制器中處理請求的方法執行後、返回視圖前將執行 postHandle 方法，返回視圖後才執行 afterCompletion 方法。

下面經過一個應用 springMVCDemo06 演示攔截器的執行流程，具體步驟以下：spring-mvc

1）建立應用

建立一個名爲 springMVCDemo06 的 Web 應用，並將 Spring MVC 相關的 JAR 包複製到 lib 目錄中。
服務器

2）建立 web.xml

在 WEB-INF 目錄下建立 web.xml 文件，該文件中的配置信息以下：
mvc

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
xmlns="http://java.sun.com/xml/ns/javaee" 
xmlns:web="http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd" 
xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd" version="3.0">
<!--配置DispatcherServlet-->
<servlet>
<servlet-name>springmvc</servlet-name>
<servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
<load-on-startup>1</load-on-startup>
</servlet>
<servlet-mapping>
<servlet-name>springmvc</servlet-name>
<url-pattern>/</url-pattern>
</servlet-mapping>
</web-app>

 

3）建立控制器類

在 src 目錄下建立一個名爲 controller 的包，並在該包中建立控制器類 Interceptor Controller，代碼以下：app

package Controller;

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

@Controller
public class InterceptorController {
@RequestMapping("/gotoTest")
public String gotoTest() {
System.out.println("正在測試攔截器，執行控制器的處理請求方法中");
return "test";
}
}

 

4）建立攔截器類

在 src 目錄下建立一個名爲 interceptor 的包，並在該包中建立攔截器類 TestInterceptor，代碼與《攔截器的配置和使用》教程中的示例代碼相同。框架

5）建立配置文件 springmvc-servlet.xml

在 WEB-INF 目錄下建立配置文件 springmvc-servlet.xml，代碼以下：jsp

<?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:mvc="http://www.springframework.org/schema/mvc"
xmlns:p="http://www.springframework.org/schema/p" 
xmlns:context="http://www.springframework.org/schema/context"
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="controller" />
<!-- 配置視圖解析器 -->
<bean
class="org.springframework.web.servlet.view.InternalResourceViewResolver">
<property name="prefix" value="/WEB-INF/jsp/" />
<property name="suffix" value=".jsp" />
</bean>
<!-- 配置攔截器 -->
<mvc:interceptors>
<!-- 配置一個全局攔截器，攔截全部請求 -->
<bean class="interceptor.TestInterceptor" />
</mvc:interceptors>
</beans>

 

6）建立視圖 JSP 文件

在 WEB-INF 目錄下建立一個 jsp 文件夾，並在該文件夾中建立一個 JSP 文件 test.jsp，代碼以下：

<%@ page language="java" contentType="text/html; charset=UTF-8"
pageEncoding="UTF-8"%>
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Insert title here</title>
</head>
<body>
視圖
<%System.out.println("視圖渲染結束。"); %>
</body>
</html>

 

7）測試攔截器

首先將 springMVCDemo06 應用發佈到 Tomcat 服務器，並啓動 Tomcat 服務器，而後經過地址「http://localhost:8080/springMVCDemo06/gotoTest」測試攔截器。程序正確執行後控制檯的輸出結果如圖 1 所示。

　　　　　　　　　　　　　　　　　　　　　　　　　　　　 單個攔截器的執行過程
　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　圖 1  單個攔截器的執行過程

多個攔截器的執行流程

在 Web 應用中一般須要有多個攔截器同時工做，這時它們的 preHandle 方法將按照配置文件中攔截器的配置順序執行，而它們的 postHandle 方法和 afterCompletion 方法則按照配置順序的反序執行。

下面經過修改「單個攔截器的執行流程」小節的 springMVCDemo06 應用來演示多個攔截器的執行流程，具體步驟以下：

1）建立多個攔截器

在 springMVCDemo06 應用的 interceptor 包中建立兩個攔截器類 Interceptor1 和 Interceptor2。

package interceptor;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;

public class Interceptor1 implements HandlerInterceptor {
public boolean preHandle(HttpServletRequest request,
HttpServletResponse response, Object handler) throws Exception {
System.out.println("Interceptor preHandle 方法執行");
/** 返回true表示繼續向下執行，返回false表示中斷後續的操做 */
return true;
}

@Override
public void postHandle(HttpServletRequest request,
HttpServletResponse response, Object handler,
ModelAndView modelAndView) throws Exception {
System.out.println("Interceptor1 postHandle 方法執行");
}

@Override
public void afterCompletion(HttpServletRequest request,
HttpServletResponse response, Object handler, Exception ex)
throws Exception {
System.out.println("Interceptor1 afterCompletion 方法執行");
}
}

 

Interceptor2 類的代碼以下：

 

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;

public class Interceptor2 implements HandlerInterceptor {
public boolean preHandle(HttpServletRequest request,
HttpServletResponse response, Object handler) throws Exception {
System.out.println("Interceptor2 preHandle 方法執行");
/** 返回true表示繼續向下執行，返回false表示中斷後續的操做 */
return true;
}

@Override
public void postHandle(HttpServletRequest request,
HttpServletResponse response, Object handler,
ModelAndView modelAndView) throws Exception {
System.out.println("Interceptor2 postHandle 方法執行");
}

@Override
public void afterCompletion(HttpServletRequest request,
HttpServletResponse response, Object handler, Exception ex)
throws Exception {
System.out.println("Interceptor2 afterCompletion 方法執行");
}
}

 

 

 

2）配置攔截器

在配置文件 springmvc-servlet.xml 中的 <mvc：interceptors> 元素內配置兩個攔截器 Interceptor1 和 Interceptor2，配置代碼以下：

<mvc:interceptors>
<!-- 配置一個全局攔截器，攔截全部請求 -->
<!--<bean class="interceptor.TestInterceptor" />-->
<mvc:interceptor>
<!-- 配置攔截器做用的路徑 -->
<mvc:mapping path="/**"/>
<!--定義在<mvc:interceptor>元素中，表示匹配指定路徑的請求才進行攔截-->
<bean class="interceptor.Interceptor1"/>
</mvc:interceptor>
<mvc:interceptor>
<!-- 配置攔截器做用的路徑 -->
<mvc:mapping path="/gotoTest"/>
<!--定義在<mvc:interceptor>元素中，表示匹配指定路徑的請求才進行攔截-->
<bean class="interceptor.Interceptor2"/>
</mvc:interceptor>
</mvc:interceptors>

 

3）測試多個攔截器

首先將 springMVCDemo06 應用發佈到 Tomcat 服務器並啓動 Tomcat 服務器，而後經過地址「http://localhost：8080/springMVCDemo06/gotoTest」測試攔截器。程序正確執行後控制檯的輸出結果如圖 2 所示。

　　　　　　　　　　　　　　　　　　　　　　　　　　 多個攔截器的執行過程 　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　圖 2  多個攔截器的執行過程
相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程