SpringMVC拦截器

作者: 养码哥 | 来源:发表于2018-03-18 10:27 被阅读11次

Interceptor拦截器是Spring MVC中重要的功能，它的主要作用是拦截用户的请求并进行相应的处理。比如通过拦截器来进行用户权限验证，或者用来判断用户是否已经登录等。 Spring MVC拦截器是可插拔式的设计。如果需要使用某个拦截器，只需要在配置文件中
应用该拦截器即可；如果不需要使用该拦截器，只需要在配置文件中取消应用该拦截器。不管是否应用某个拦截器，对Spring MVC框架不会有任何影响。

Handlerlnterceptor 接口

Spring MVC中的Interceptor拦截器拦截请求是通过实现Handlerlnterceptor接口来完成的。在Spring MVC中定义一个Interceptor拦截器非常简单，通常在要定义的Interceptor拦截器类中实现 Spring 的 Handlerlnterceptor 接口，或者继承抽象类 HandlerlnterceptorAdapter。
Handlerlnterceptor接口中定义了三个方法，Spring MVC就是通过这三个方法来对用户的请求进行拦截处理的。

preHandle (HttpServletRequest request, HttpServletResponse response, Object handle)。顾名思义，该方法将在请求处理之前被调用。Spring MVC中的Interceptor 实行的是链式调用，即在一个应用中或者说在一个请求中可以同时存在多个 Interceptor。每个Interceptor的调用会依据它的声明顺序依次执行，而且最先执行的是 Interceptor中的preHandle方法，所以可以在这个方法中进行一些前置的初始化操作或者是对当前请求的一个预处理，也可以在这个方法中进行一些判断来决定请求是否要继续进行下去。该方法的返回值是Boolean类型的，当返回值为false时，表示请求结束，后续的Interceptor和Controller都不会再执行；当返回值为true时就会继续调用下一个Interceptor的preHandle方法；如果己经是最后一个Interceptor，就会调用当前请求的Controller方法。

void postHandle(HttpServletRequest request, HttpServletResponse response,Object handler, ModelAndView mv)。该方法和之后的afterCompletion方法都只能在当前所属的 Interceptor的preHandle方法的返回值为true时才能被调用。postHandle方法，顾名思义，就是在当前请求被处理之后，也就是Controller方法被调用之后执行，但是它会在DispatcherServlet进行视图返回渲染之前被调用，所以我们可以在这个方法中对 Controller处理之后的ModelAndView对象进行操作。postiHandle方法被调用的方向跟preHandle是相反的，也就是说先声明的Interceptor的postHandle方法反而会后执行，这和Struts2里面的Interceptor的执行过程类似。
void afterCompletion(HttpServletRequest request,HttpServletResponse response, Object handler, Exception exception). 该方法也是在当前所属的 Interceptor 的 preHandle 方法的返回值为true时才会执行。顾名思义，该方法将在整个请求结束之后，也就是在 DispatcherServlet渲染了对应的视图之后执行。这个方法的主要作用是进行资源清理。

拦截器实现用户权限验证:

核心代码：

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){
    // 模拟数据库根据登录名和密码查找用户，判断用户登录
    if(loginname != null && loginname.equals("fkit")
            && password!= null && password.equals("123456")){
        // 模拟创建用户
        User user = new User();
        user.setLoginname(loginname);
        user.setPassword(password);
        user.setUsername("管理员");
        // 登录成功，将user对象设置到HttpSession作用范围域
        session.setAttribute("user", user);
        // 转发到main请求
        mv.setViewName("redirect:main");
    }else{
        // 登录失败，设置失败提示信息，并跳转到登录页面
        mv.addObject("message", "登录名或密码错误，请重新输入!");
        mv.setViewName("loginForm");
    }
    return mv;
 }

}
`

UserController类的login方法用来处理登录请求，没有使用数据库存储数据，只是简单地模拟了用户登录，只要用户输入的登录名是“jack”，密码是“123456”，则验证通过，并创建一个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){
    // 模拟数据库获得所有图书集合
    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企业应用实战","李刚 编著",59.2));
    // 将图书集合添加到model当中
    model.addAttribute("book_list", book_list);
    // 跳转到main页面
    return "main";
  }

}
`

BookController类的main方法用来处理网站首页的请求，该方法获得所有图书信息，并将它们设置到Model当中，然后传递到main页面。没有使用数据库存储数据，只是简单地创建了一个集合模拟从数获取图书信息。

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;

/** 
 * 拦截器必须实现HandlerInterceptor接口
 * */ 
public class AuthorizationInterceptor  implements HandlerInterceptor {

// 不拦截"/loginForm"和"/login"请求
private static final String[] IGNORE_URI = {"/loginForm", "/login"};

 /** 
 * 该方法将在整个请求完成之后执行， 主要作用是用于清理资源的，
 * 该方法也只能在当前Interceptor的preHandle方法的返回值为true时才会执行。 
 */  
@Override
public void afterCompletion(HttpServletRequest request,
        HttpServletResponse response, Object handler, Exception exception)
        throws Exception {
    System.out.println("AuthorizationInterceptor afterCompletion --> ");
    
}
/** 
 * 该方法将在Controller的方法调用之后执行， 方法中可以对ModelAndView进行操作 ，
 * 该方法也只能在当前Interceptor的preHandle方法的返回值为true时才会执行。 
 */
@Override
public void postHandle(HttpServletRequest request, HttpServletResponse response,
        Object handler, ModelAndView mv) throws Exception {
    System.out.println("AuthorizationInterceptor postHandle --> ");
    
}

 /** 
 * preHandle方法是进行处理器拦截用的，该方法将在Controller处理之前进行调用，
 * 该方法的返回值为true拦截器才会继续往下执行，该方法的返回值为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.判断用户是否已经登录 
        if(user == null){
            // 如果用户没有登录，则设置提示信息，跳转到登录页面
             System.out.println("AuthorizationInterceptor拦截请求：");
             request.setAttribute("message", "请先登录再访问网站");
             request.getRequestDispatcher("loginForm").forward(request, response);
        }else{
            // 如果用户已经登录，则验证通过，放行
             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来响应静态文件 -->
<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

SpringMVC拦截器

相关文章

网友评论

延伸阅读

深度阅读

栏目导航

热点阅读

MyBatis+SpringMVC+SpringBoot

SpringBoot精选