SpringMVC拦截器

时间 2019-12-06

标签 springmvc 拦截栏目 Spring 繁體版

原文原文链接

本节内容：html

SpringMVC拦截器
拦截器定义
拦截器配置
正常流程测试
中断流程测试
拦截器应用

1、SpringMVC拦截器

Spring Web MVC 的处理器拦截器相似于Servlet开发中的过滤器Filter，用于对处理器进行预处理和后处理。好比进入某个SpringMVC的某个方法前须要判断用户是否登陆，这个确定不可能在每一个方法里都写。java

2、拦截器定义

本身写类，实现HandlerInterceptor接口，以下：web

Interceptor1.javaspring

package com.wisedu.springmvc.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{

        // Controller执行前调用此方法
	// 返回true表示继续执行，返回false停止执行
	// 这里能够加入登陆校验、权限拦截等
	public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object arg2) throws Exception {

		System.out.println("方法前 1");
		return true; //true就是放过，false就是不经过
	}

        // controller执行后但未返回视图前调用此方法
	// 这里可在返回用户前对模型数据进行加工处理，好比这里加入公用信息以便页面显示
	public void postHandle(HttpServletRequest arg0, HttpServletResponse arg1, Object arg2, ModelAndView arg3)
			throws Exception {
		System.out.println("方法后 1");
		
	}

        // controller执行后且视图返回后调用此方法
	// 这里可获得执行controller时的异常信息
	// 这里可记录操做日志
	public void afterCompletion(HttpServletRequest arg0, HttpServletResponse arg1, Object arg2, Exception arg3)
			throws Exception {

		System.out.println("页面渲染后 1");
		
	}

}

Interceptor2.java浏览器

package com.wisedu.springmvc.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 Interceptor2 implements HandlerInterceptor{

	public boolean preHandle(HttpServletRequest arg0, HttpServletResponse arg1, Object arg2) throws Exception {
		System.out.println("方法前 2");
		return false;
	}
	public void postHandle(HttpServletRequest arg0, HttpServletResponse arg1, Object arg2, ModelAndView arg3)
			throws Exception {
		System.out.println("方法后 2");
		
	}
	public void afterCompletion(HttpServletRequest arg0, HttpServletResponse arg1, Object arg2, Exception arg3)
			throws Exception {
		System.out.println("页面渲染后 2");
		
	}

}

3、拦截器配置

在springmvc.xml中添加配置：session

	<!--springmvc拦截器-->
	<mvc:interceptors>
		<!--能够配置多个拦截器-->
		<mvc:interceptor>
			<!-- 全部的请求都进入拦截器 -->
			<mvc:mapping path="/**" />
			<!-- 配置本身编写的具体的拦截器 -->
			<bean class="com.wisedu.springmvc.interceptor.Interceptor1" />
		</mvc:interceptor>
		<mvc:interceptor>
			<!-- 全部的请求都进入拦截器 -->
			<mvc:mapping path="/**" />
			<!-- 配置具体的拦截器 -->
			<bean class="com.wisedu.springmvc.interceptor.Interceptor2" />
		</mvc:interceptor>
		<!--若是配置多个拦截器，好比上面配置了两个，每一个拦截器里有3个方法，那么执行的顺序是：
			拦截器1的方法前1 (前提时这个方法前1放行，若是方法前1不放行，下面全部的都不会执行，包括Controller层也进不去)
			拦截器2的方法前2
			拦截器2的方法后2
			拦截器1的方法后1
			拦截器2的页面渲染后2
			拦截器1的页面渲染后1

			若是方法前1放行，方法前2不放行，运行结果是
				方法前1
				方法前2
				页面渲染后1
		-->
	</mvc:interceptors>

4、正常流程测试

启动项目，浏览器访问地址：http://127.0.0.1:8080/itemList.actionmvc

控制台打印以下：app

方法前 1 
方法前 2
方法后 2
方法后 1
页面渲染后 2
页面渲染后 1

5、中断流程

1. Interceptor1的preHandler方法返回false，Interceptor2返回truejsp

启动项目，浏览器访问地址：http://127.0.0.1:8080/itemList.actionide

控制台打印以下：

方法前1

从日志看出第一个拦截器的preHandler方法返回false后第一个拦截器只执行了preHandler方法，其它两个方法没有执行，第二个拦截器的全部方法不执行，且Controller也不执行了。

2. Interceptor1的preHandler方法返回true，Interceptor2返回false

启动项目，浏览器访问地址：http://127.0.0.1:8080/itemList.action

控制台打印以下：

方法前 1
方法前 2
页面渲染后 1

从日志看出第二个拦截器的preHandler方法返回false后第一个拦截器的postHandler没有执行，第二个拦截器的postHandler和afterCompletion没有执行，且controller也不执行了。

【总结】：
preHandle按拦截器定义顺序调用
postHandler按拦截器定义逆序调用
afterCompletion按拦截器定义逆序调用

postHandler在拦截器链内全部拦截器返成功调用
afterCompletion只有preHandle返回true才调用

6、拦截器应用

1. 处理流程

（1）有一个登陆页面，须要写一个Controller访问登陆页面

（2）登陆页面有一提交表单的动做。须要在Controller中处理。

判断用户名密码是否正确（在控制台打印）
若是正确,向session中写入用户信息（写入用户名username）
跳转到商品列表

（3）拦截器。

拦截用户请求，判断用户是否登陆（登陆请求不能拦截）
若是用户已经登陆。放行
若是用户未登陆，跳转到登陆页面。

2. 编写登陆jsp

login.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>

    <form action="${pageContext.request.contextPath }/user/login.action">
        <label>用户名：</label>
        <br>
        <input type="text" name="username">
        <br>
        <label>密码：</label>
        <br>
        <input type="password" name="password">
        <br>
        <input type="submit">

    </form>

</body>
</html>

3. 用户登录Controller

UserController.java

package com.wisedu.springmvc.controller;

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

import javax.servlet.http.HttpSession;

/**
 * Created by jkzhao on 1/18/18.
 */
@Controller
@RequestMapping("user")
public class UserController {

    /**
     * 跳转到登陆页面
     *
     * @return
     */
    @RequestMapping(value = "login", method = RequestMethod.GET)
    public String login() {
        return "login";
    }

    /**
     * 用户登陆
     *
     * @param username
     * @param password
     * @param session
     * @return
     */
    @RequestMapping(value = "login", method = RequestMethod.POST)
    public String login(String username, String password, HttpSession session) {
        // 校验用户登陆
        System.out.println(username);
        System.out.println(password);

        // 把用户名放到session中
        session.setAttribute("username", username);

        return "redirect:/item/itemlist.action";
    }

}

4. 编写拦截器

LoginHandlerInterceptor.java

package com.wisedu.springmvc.interceptor;

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

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

/**
 * Created by jkzhao on 1/18/18.
 */
public class LoginHandlerInterceptor implements HandlerInterceptor {
    @Override
    public boolean preHandle(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o) throws Exception {

        // 从request中获取session
        HttpSession session = httpServletRequest.getSession();
        // 从session中获取username
        Object username = session.getAttribute("username");
        // 判断username是否为null
        if (username != null) {
            // 若是不为空则放行
            return true;
        } else {
            // 若是为空则跳转到登陆页面
            httpServletResponse.sendRedirect(httpServletRequest.getContextPath() + "/user/login.action");
        }

        return false;
    }

    @Override
    public void postHandle(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o, ModelAndView modelAndView) throws Exception {

    }

    @Override
    public void afterCompletion(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o, Exception e) throws Exception {

    }
}

5. 配置拦截器

只能拦截商品的url，因此须要修改ItemController，让全部的请求都必须以item开头，以下图：

在springmvc.xml配置拦截器：

<mvc:interceptor>
	<!-- 配置商品被拦截器拦截 -->
	<mvc:mapping path="/item/**" />
	<!-- 配置具体的拦截器 -->
	<bean class="com.wisedu.springmvc.interceptor.LoginHandlerInterceptor" />
</mvc:interceptor>