springMVC:HandlerInterceptor拦截器的使用

2.HandlerInterceptor概述

在SpringMVC 中定义一个Interceptor是比较非常简单，主要有两种方式： 
第一种：实现HandlerInterceptor 接口，或者是继承实现了HandlerInterceptor 接口的类，例如HandlerInterceptorAdapter； 
第二种：实现Spring的WebRequestInterceptor接口，或者是继承实现了WebRequestInterceptor的类。 
现在主要结合一个例子说一下第一种方式：实现HandlerInterceptor接口。 
HandlerInterceptor接口主要定义了三个方法： 
1. boolean preHandle (HttpServletRequest request, HttpServletResponse response, Object handle)方法：该方法将在请求处理之前进行调用，只有该方法返回true，才会继续执行后续的Interceptor和Controller，当返回值为true 时就会继续调用下一个Interceptor的preHandle 方法，如果已经是最后一个Interceptor的时候就会是调用当前请求的Controller方法； 
2.void postHandle (HttpServletRequest request, HttpServletResponse response, Object handle, ModelAndView modelAndView)方法：该方法将在请求处理之后，DispatcherServlet进行视图返回渲染之前进行调用，可以在这个方法中对Controller 处理之后的ModelAndView 对象进行操作。 
3.void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handle, Exception ex)方法：该方法也是需要当前对应的Interceptor的preHandle方法的返回值为true时才会执行，该方法将在整个请求结束之后，也就是在DispatcherServlet 渲染了对应的视图之后执行。用于进行资源清理。

3.简单的一个例子：

1.xml需要配置：两种配置方式（对所有的请求记性拦截，对特定的请求进行拦截）

<mvc:interceptors>
        <!--对所有的请求记性拦截-->
        <!--<beans:bean class="com.sunp.common.interceptor.Myinterceptor"/>-->
        <!--对特定的请求进行拦截-->
        <mvc:interceptor>
            <mapping path="/kfc/brands/brand1/*"/>
            <beans:bean class="com.sunp.common.interceptor.Myinterceptor"/>
        </mvc:interceptor>
</mvc:interceptors>

2.interceptors类

package com.sunp.common.interceptor;
import com.alibaba.fastjson.JSON;
import com.alibaba.fastjson.JSONObject;
import com.mkyong.common.model.Shop;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;

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

import java.io.BufferedReader;
import java.io.IOException;

/**
 * Created by hzsunpeng on 2016/6/14.
 */
public class Myinterceptor implements HandlerInterceptor {

    public boolean preHandle(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o) throws Exception {
        System.out.println("preHandle run!");
        return true;
    }

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

        System.out.println("postHandle run!");
    }
    public void afterCompletion(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o, Exception e) throws Exception {

        System.out.println("afterCompletion run!");
    }
}

3.controller类(为了使用@Controller @PathVariable @ResponseBody注释等需要加一些配置文件，这里不再列出)

package com.sunp.common.controller;
import com.sunp.common.model.Shop;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.*;

import javax.servlet.http.HttpServletRequest;

/**
 * Created by hzsunpeng on 2016/6/7.
 */
@Controller
@RequestMapping("/kfc/brands")
public class JSONController {

    @RequestMapping(value = "/brand1/{name}",method = RequestMethod.GET)
    public @ResponseBody Shop getShopInJSON(@PathVariable String name)
    {
        Shop sp = new Shop();
        sp.setName(name);
        sp.setStaffName(new String[]{"Staffname1","Staffname2"});
        System
        return sp;
    }
    //测试用
    @RequestMapping(value = "/json",method = RequestMethod.POST)
    public String index(HttpServletRequest request)
    {
        return "index";
    }
}

4.model Shop类

package com.sunp.common.model;

import java.io.Serializable;

/**
 * Created by hzsunpeng on 2016/6/7.
 */
public class Shop implements Serializable {
    private String name;
    private String[] staffName;

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public String[] getStaffName() {
        return staffName;
    }

    public void setStaffName(String[] staffName) {
        this.staffName = staffName;
    }

}

运行结果：

 
控制台输出： 

转载自：springMVC:HandlerInterceptor拦截器的使用

=======================================

拦截器（比如用于：用户登录）

SpirngMVC 的处理器类似Servlet过滤器用于对处理器 
进行预处理和后处理

1，实现HandlerInterceptor接口

public class HandlerIntecepter2 implements HandlerInterceptor{
    /**
     * 执行时机，controller方法已经执行，ModleAndView已经返回
     * 使用场景，记录操作日志，记录用户登录的时间，日期等。
     */
    @Override
    public void afterCompletion(HttpServletRequest arg0, HttpServletResponse arg1, Object arg2, Exception arg3)
            throws Exception {

    }
    /**
     * 执行时机，controller方法已经执行，ModleAndView没有被返回
     * 使用场景，可以在此方法中可以设置全局的的数据处理业务
     */
    @Override
    public void postHandle(HttpServletRequest arg0, HttpServletResponse arg1, Object arg2, ModelAndView arg3)
            throws Exception {

    }
    /**
     * 返回boolean 如果返回true放行，返回false则被拦截
     * 执行时机，controller方法没有被执行，ModleAndView没有被返回
     * 使用场景，权限验证
     */
    @Override
    public boolean preHandle(HttpServletRequest arg0, HttpServletResponse arg1, Object arg2) throws Exception {
        return false;
    }

}

2，拦截器配置：

（1）针对某一种拦截器进行配置

<bean
    class="org.springframework.web.servlet.handler.BeanNameUrlHandlerMapping">
    <property name="interceptors">
        <list>
            <ref bean="handlerInterceptor1"/>
            <ref bean="handlerInterceptor2"/>
        </list>
    </property>
</bean>

<bean id="handlerInterceptor1" class="com.intercapter.HandlerInterceptor1"/>
<bean id="handlerInterceptor2" class="com.intercapter.HandlerInterceptor2"/>

(2), 针对所有mapping配置全局拦截器

<!--配置拦截器 -->
<mvc:interceptors>
<!-- 多个拦截器的执行顺序，等于配置文件中配置的顺序 -->

    <mvc:interceptor>

        <!-- 拦截请求路径，要拦截所有路径 配置成/**代表所有 -->
        <mvc:mapping path="/**" />
        <!-- 指定拦截器位置 -->
        <bean class="cn.itheima.intecepter.HandlerIntecepter"></bean>
    </mvc:interceptor>

    <mvc:interceptor>
        <!-- 拦截请求路径，要拦截所有路径 配置成/**代表所有 -->
        <mvc:mapping path="/**" />
        <!-- 指定拦截器位置 -->
        <bean class="cn.itheima.intecepter.HandlerIntecepter2"></bean>
    </mvc:interceptor>
</mvc:interceptors>

转载自：SpringMVC学习（二）高级参数绑定,拦截器，controller方法返回值