Interceptor攔截器是Spring MVC中重要的功能谬哀,它的主要作用是攔截用戶的請求 并進行相應的處理兰英。比如通過攔截器來進行用戶權限驗證,或者用來判斷用戶是否已經(jīng)登錄等。 Spring MVC攔截器是可插拔式的設計。如果需要使用某個攔截器玻孟,只需要在配置文件中
應用該攔截器即可;如果不需要使用該攔截器鳍征,只需要在配置文件中取消應用該攔截器黍翎。不管 是否應用某個攔截器,對Spring MVC框架不會有任何影響艳丛。
Handlerlnterceptor 接口
Spring MVC中的Interceptor攔截器攔截請求是通過實現(xiàn)Handlerlnterceptor接口來完成的匣掸。 在Spring MVC中定義一個Interceptor攔截器非常簡單,通常在要定義的Interceptor攔截器類 中實現(xiàn) Spring 的 Handlerlnterceptor 接口质礼,或者繼承抽象類 HandlerlnterceptorAdapter旺聚。
Handlerlnterceptor接口中定義了三個方法织阳,Spring MVC就是通過這三個方法來對用戶的 請求進行攔截處理的眶蕉。
- preHandle (HttpServletRequest request, HttpServletResponse response, Object handle)。顧名思義唧躲,該方法將在請求處理之前被調用造挽。Spring MVC中的Interceptor 實行的是鏈式調用,即在一個應用中或者說在一個請求中可以同時存在多個 Interceptor弄痹。每個Interceptor的調用會依據(jù)它的聲明順序依次執(zhí)行饭入,而且最先執(zhí)行的是 Interceptor中的preHandle方法,所以可以在這個方法中進行一些前置的初始化操作 或者是對當前請求的一個預處理肛真,也可以在這個方法中進行一些判斷來決定請求是否 要繼續(xù)進行下去谐丢。該方法的返回值是Boolean類型的,當返回值為false時,表示請 求結束乾忱,后續(xù)的Interceptor和Controller都不會再執(zhí)行讥珍;當返回值為true時就會繼續(xù) 調用下一個Interceptor的preHandle方法;如果己經(jīng)是最后一個Interceptor窄瘟,就會調 用當前請求的Controller方法衷佃。
void postHandle(HttpServletRequest request, HttpServletResponse response,Object handler, ModelAndView mv)。該方法和之后的afterCompletion方法都只能在當前所屬的 Interceptor的preHandle方法的返回值為true時才能被調用蹄葱。postHandle方法氏义,顧名 思義,就是在當前請求被處理之后图云,也就是Controller方法被調用之后執(zhí)行惯悠,但是它 會在DispatcherServlet進行視圖返回渲染之前被調用,所以我們可以在這個方法中對 Controller處理之后的ModelAndView對象進行操作竣况。postiHandle方法被調用的方向 跟preHandle是相反的吮螺,也就是說先聲明的Interceptor的postHandle方法反而會后執(zhí) 行,這和Struts2里面的Interceptor的執(zhí)行過程類似帕翻。
void afterCompletion(HttpServletRequest request,HttpServletResponse response, Object handler, Exception exception). 該方法也是在當前所屬的 Interceptor 的 preHandle 方法 的返回值為true時才會執(zhí)行鸠补。顧名思義,該方法將在整個請求結束之后嘀掸,也就是在 DispatcherServlet渲染了對應的視圖之后執(zhí)行紫岩。這個方法的主要作用是進行資源清理。
攔截器實現(xiàn)用戶權限驗證:
核心代碼:
loginForm.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>登錄頁面</title>
</head>
<body>
<h3>登錄頁面</h3>
<form action="login" method="post">
<!-- 提示信息 -->
<font color="red">${requestScope.message }</font>
<table>
<tr>
<td><label>登錄名: </label></td>
<td><input type="text" id="loginname" name="loginname" ></td>
</tr>
<tr>
<td><label>密碼: </label></td>
<td><input type="password" id="password" name="password" ></td>
</tr>
<tr>
<td><input type="submit" value="登錄"></td>
</tr>
</table>
</form>
</body>
</html>
`
UserController.java
`
package org.fkit.controller;
import javax.servlet.http.HttpSession;
import org.fkit.domain.User;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.servlet.ModelAndView;
/**
* 處理用戶請求控制器
* */
@Controller
public class UserController {
/**
* 處理/login請求
* */
@RequestMapping(value="/login")
public ModelAndView login(
String loginname,String password,
ModelAndView mv,
HttpSession session){
// 模擬數(shù)據(jù)庫根據(jù)登錄名和密碼查找用戶睬塌,判斷用戶登錄
if(loginname != null && loginname.equals("fkit")
&& password!= null && password.equals("123456")){
// 模擬創(chuàng)建用戶
User user = new User();
user.setLoginname(loginname);
user.setPassword(password);
user.setUsername("管理員");
// 登錄成功泉蝌,將user對象設置到HttpSession作用范圍域
session.setAttribute("user", user);
// 轉發(fā)到main請求
mv.setViewName("redirect:main");
}else{
// 登錄失敗,設置失敗提示信息揩晴,并跳轉到登錄頁面
mv.addObject("message", "登錄名或密碼錯誤勋陪,請重新輸入!");
mv.setViewName("loginForm");
}
return mv;
}
}
`
UserController類的login方法用來處理登錄請求,沒有使用數(shù)據(jù)庫存儲數(shù)據(jù)硫兰,只是 簡單地模擬了用戶登錄诅愚,只要用戶輸入的登錄名是“jack”,密碼是“123456”劫映,則驗證通過违孝, 并創(chuàng)建一個Usei對象保存到HttpSession當中,同時將請求使用客戶端跳轉到main請求泳赋;如 果登錄失敗雌桑,則設置失敗提示信息到ModelAndView對象,同時將請求使用客戶端跳轉到 loginForm請求祖今,即登錄頁面校坑。
BookController.java
`
package org.fkit.controller;
import java.util.ArrayList;
import java.util.List;
import org.fkit.domain.Book;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.RequestMapping;
/**
* 處理圖書請求控制器
* */
@Controller
public class BookController {
/**
* 處理/main請求
* */
@RequestMapping(value="/main")
public String main(Model model){
// 模擬數(shù)據(jù)庫獲得所有圖書集合
List<Book> book_list = new ArrayList<Book>();
book_list.add(new Book("java.jpg","瘋狂Java講義","李剛 編著",74.2));
book_list.add(new Book("ee.jpg","輕量級JavaEE企業(yè)應用實戰(zhàn)","李剛 編著",59.2));
// 將圖書集合添加到model當中
model.addAttribute("book_list", book_list);
// 跳轉到main頁面
return "main";
}
}
`
BookController類的main方法用來處理網(wǎng)站首頁的請求拣技,該方法獲得所有圖書信息,并 將它們設置到Model當中耍目,然后傳遞到main頁面过咬。沒有使用數(shù)據(jù)庫存儲數(shù)據(jù),只是簡單地創(chuàng)建了一個集合模擬從數(shù)獲取圖書信息制妄。
main.jsp
`<%@ page language="java" contentType="text/html; charset=UTF-8"
pageEncoding="UTF-8"%>
<%@ taglib uri="http://java.sun.com/jsp/jstl/core" prefix="c" %>
<!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>首頁</title>
<style type="text/css">
table{border-collapse:collapse;border-spacing:0;border-left:1px solid #888;border-top:1px solid #888;background:#efefef;}
th,td{border-right:1px solid #888;border-bottom:1px solid #888;padding:5px 15px;}
th{font-weight:bold;background:#ccc;}
</style>
</head>
<body>
<h3>歡迎[${sessionScope.user.username }]訪問</h3>
<br>
<table border="1">
<tr>
<th>封面</th><th>書名</th><th>作者</th><th>價格</th>
</tr>
<c:forEach items="${requestScope.book_list }" var="book">
<tr>
<td><img src="images/${book.image }" height="60"></td>
<td>${book.name }</td>
<td>${book.author }</td>
<td>${book.price }</td>
</tr>
</c:forEach>
</table>
</body>
</html>
`
設計一個攔截器驗證用戶是否登錄掸绞,如果用戶沒有登錄,不可以訪問除登錄頁面 和登錄請求的所有Controller代碼:
`package org.fkit.interceptor;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.fkit.domain.User;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;
/**
* 攔截器必須實現(xiàn)HandlerInterceptor接口
* */
public class AuthorizationInterceptor implements HandlerInterceptor {
// 不攔截"/loginForm"和"/login"請求
private static final String[] IGNORE_URI = {"/loginForm", "/login"};
/**
* 該方法將在整個請求完成之后執(zhí)行耕捞, 主要作用是用于清理資源的衔掸,
* 該方法也只能在當前Interceptor的preHandle方法的返回值為true時才會執(zhí)行。
*/
@Override
public void afterCompletion(HttpServletRequest request,
HttpServletResponse response, Object handler, Exception exception)
throws Exception {
System.out.println("AuthorizationInterceptor afterCompletion --> ");
}
/**
* 該方法將在Controller的方法調用之后執(zhí)行俺抽, 方法中可以對ModelAndView進行操作 敞映,
* 該方法也只能在當前Interceptor的preHandle方法的返回值為true時才會執(zhí)行。
*/
@Override
public void postHandle(HttpServletRequest request, HttpServletResponse response,
Object handler, ModelAndView mv) throws Exception {
System.out.println("AuthorizationInterceptor postHandle --> ");
}
/**
* preHandle方法是進行處理器攔截用的磷斧,該方法將在Controller處理之前進行調用振愿,
* 該方法的返回值為true攔截器才會繼續(xù)往下執(zhí)行,該方法的返回值為false的時候整個請求就結束了弛饭。
*/
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response,
Object handler) throws Exception {
System.out.println("AuthorizationInterceptor preHandle --> ");
// flag變量用于判斷用戶是否登錄冕末,默認為false
boolean flag = false;
//獲取請求的路徑進行判斷
String servletPath = request.getServletPath();
// 判斷請求是否需要攔截
for (String s : IGNORE_URI) {
if (servletPath.contains(s)) {
flag = true;
break;
}
}
// 攔截請求
if (!flag){
// 1.獲取session中的用戶
User user = (User) request.getSession().getAttribute("user");
// 2.判斷用戶是否已經(jīng)登錄
if(user == null){
// 如果用戶沒有登錄,則設置提示信息侣颂,跳轉到登錄頁面
System.out.println("AuthorizationInterceptor攔截請求:");
request.setAttribute("message", "請先登錄再訪問網(wǎng)站");
request.getRequestDispatcher("loginForm").forward(request, response);
}else{
// 如果用戶已經(jīng)登錄档桃,則驗證通過,放行
System.out.println("AuthorizationInterceptor放行請求:");
flag = true;
}
}
return flag;
}
}
`
springMVC配置文件代碼:
`
<?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:p="http://www.springframework.org/schema/p"
xmlns:mvc="http://www.springframework.org/schema/mvc"
xmlns:context="http://www.springframework.org/schema/context"
xsi:schemaLocation="
http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans-4.2.xsd
http://www.springframework.org/schema/mvc
http://www.springframework.org/schema/mvc/spring-mvc-4.2.xsd
http://www.springframework.org/schema/context
http://www.springframework.org/schema/context/spring-context-4.2.xsd">
<!-- spring可以自動去掃描base-pack下面的包或者子包下面的java文件憔晒,
如果掃描到有Spring的相關注解的類藻肄,則把這些類注冊為Spring的bean -->
<context:component-scan base-package="org.fkit.controller"/>
<!-- 設置默認配置方案 -->
<mvc:annotation-driven/>
<!-- 使用默認的Servlet來響應靜態(tài)文件 -->
<mvc:default-servlet-handler/>
<!-- 視圖解析器 -->
<bean id="viewResolver"
class="org.springframework.web.servlet.view.InternalResourceViewResolver">
<!-- 前綴 -->
<property name="prefix">
<value>/WEB-INF/content/</value>
</property>
<!-- 后綴 -->
<property name="suffix">
<value>.jsp</value>
</property>
</bean>
<mvc:interceptors>
<mvc:interceptor>
<!-- 攔截所有的請求 -->
<mvc:mapping path="/*"/>
<!-- 使用bean定義一個Interceptor,直接定義在mvc:interceptors根下面的Interceptor將攔截所有的請求 -->
<bean class="org.fkit.interceptor.AuthorizationInterceptor"/>
</mvc:interceptor>
</mvc:interceptors>
</beans>`
User.java
`package org.fkit.domain;
import java.io.Serializable;
public class User implements Serializable{
private Integer id; // id
private String loginname; // 登錄名
private String password; // 密碼
private String username; // 用戶名
public User() {
super();
// TODO Auto-generated constructor stub
}
public Integer getId() {
return id;
}
public void setId(Integer id) {
this.id = id;
}
public String getLoginname() {
return loginname;
}
public void setLoginname(String loginname) {
this.loginname = loginname;
}
public String getPassword() {
return password;
}
public void setPassword(String password) {
this.password = password;
}
public String getUsername() {
return username;
}
public void setUsername(String username) {
this.username = username;
}
@Override
public String toString() {
return "User [id=" + id + ", loginname=" + loginname + ", password="
+ password + ", username=" + username + "]";
}
}
`
Book.java
`package org.fkit.domain;
import java.io.Serializable;
public class Book implements Serializable{
private Integer id; // id
private String name; // 書名
private String author; // 作者
private Double price; // 價格
private String image; // 封面圖片
public Book() {
super();
// TODO Auto-generated constructor stub
}
public Book( String image,String name, String author, Double price) {
super();
this.image = image;
this.name = name;
this.author = author;
this.price = price;
}
public Integer getId() {
return id;
}
public void setId(Integer id) {
this.id = id;
}
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public String getAuthor() {
return author;
}
public void setAuthor(String author) {
this.author = author;
}
public Double getPrice() {
return price;
}
public void setPrice(Double price) {
this.price = price;
}
public String getImage() {
return image;
}
public void setImage(String image) {
this.image = image;
}
@Override
public String toString() {
return "Book [id=" + id + ", name=" + name + ", author=" + author
+ ", price=" + price + ", image=" + image + "]";
}
}
`
部署應用:http://localhost:8090/InterceptorTest/main拒担,如果沒有登陸嘹屯,直接訪問main請求,攔截器會攔截請求从撼,驗證用戶是否登陸州弟,此時用戶如果沒有登陸,則跳轉到登陸 頁面谋逻。
demo結構圖:
- 郵箱:ithelei@sina.cn
- 技術討論群:687856230
- GoodLuck