spring mvc inteceptor 拦截器实现计算controller 的执行时间(转载)

转载链接http://blog.csdn.net/tomcat_2014/article/details/51459925

什么是 spring inteceptor ， SpringMVC 中的Interceptor 拦截请求是通过HandlerInterceptor 来实现的。在SpringMVC 中定义一个Interceptor 非常简单，主要有两种方式，第一种方式是要定义的Interceptor类要实现了Spring 的HandlerInterceptor 接口，或者是这个类继承实现了HandlerInterceptor 接口的类，比如Spring 已经提供的实现了HandlerInterceptor 接口的抽象类HandlerInterceptorAdapter ；第二种方式是实现Spring的WebRequestInterceptor接口，或者是继承实现了WebRequestInterceptor的类。

HandlerInterceptor接口中定义了三个方法，我们就是通过这三个方法来对用户的请求进行拦截处理的。

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

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

public class SpringMVCInterceptor implements HandlerInterceptor {

/**
* preHandle方法是进行处理器拦截用的，顾名思义，该方法将在Controller处理之前进行调用，SpringMVC中的Interceptor拦截器是链式的，可以同时存在
* 多个Interceptor，然后SpringMVC会根据声明的前后顺序一个接一个的执行，而且所有的Interceptor中的preHandle方法都会在
* Controller方法调用之前调用。SpringMVC的这种Interceptor链式结构也是可以进行中断的，这种中断方式是令preHandle的返
* 回值为false，当preHandle的返回值为false的时候整个请求就结束了。
*/
@Override
public boolean preHandle(HttpServletRequest request,
HttpServletResponse response, Object handler) throws Exception {
// TODO Auto-generated method stub
return false;
}

/**
* 这个方法只会在当前这个Interceptor的preHandle方法返回值为true的时候才会执行。postHandle是进行处理器拦截用的，它的执行时间是在处理器进行处理之
* 后，也就是在Controller的方法调用之后执行，但是它会在DispatcherServlet进行视图的渲染之前执行，也就是说在这个方法中你可以对ModelAndView进行操
* 作。这个方法的链式结构跟正常访问的方向是相反的，也就是说先声明的Interceptor拦截器该方法反而会后调用，这跟Struts2里面的拦截器的执行过程有点像，
* 只是Struts2里面的intercept方法中要手动的调用ActionInvocation的invoke方法，Struts2中调用ActionInvocation的invoke方法就是调用下一个Interceptor
* 或者是调用action，然后要在Interceptor之前调用的内容都写在调用invoke之前，要在Interceptor之后调用的内容都写在调用invoke方法之后。
*/
@Override
public void postHandle(HttpServletRequest request,
HttpServletResponse response, Object handler,
ModelAndView modelAndView) throws Exception {
// TODO Auto-generated method stub

}

/**
* 该方法也是需要当前对应的Interceptor的preHandle方法的返回值为true时才会执行。该方法将在整个请求完成之后，也就是DispatcherServlet渲染了视图执行，
* 这个方法的主要作用是用于清理资源的，当然这个方法也只能在当前这个Interceptor的preHandle方法的返回值为true时才会执行。
*/
@Override
public void afterCompletion(HttpServletRequest request,
HttpServletResponse response, Object handler, Exception ex)
throws Exception {
// TODO Auto-generated method stub

}

}

这里我采用第一种方式来实现,首先实现HandlerInterceptor 接口:

package com.inteceptor;

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

import org.apache.log4j.Logger;
import org.springframework.web.servlet.ModelAndView;
import org.springframework.web.servlet.handler.HandlerInterceptorAdapter;
import org.springframework.web.servlet.HandlerInterceptor;

public class TimeInteceptor implements HandlerInterceptor{

private static final Logger logger = Logger.getLogger(TimeInteceptor.class);

//before the actual handler will be executed
public boolean preHandle(HttpServletRequest request,
HttpServletResponse response, Object handler)
throws Exception {

long startTime = System.currentTimeMillis();
request.setAttribute("startTime", startTime);

return true;
}

//after the handler is executed
public void postHandle(
HttpServletRequest request, HttpServletResponse response,
Object handler, ModelAndView modelAndView)
throws Exception {

long startTime = (Long)request.getAttribute("startTime");

long endTime = System.currentTimeMillis();

long executeTime = endTime - startTime;

//modified the exisitng modelAndView
modelAndView.addObject("executeTime",executeTime);

//log it
if(logger.isDebugEnabled()){
logger.debug("[" + handler + "] executeTime : " + executeTime + "ms");
}
}

public void afterCompletion(HttpServletRequest arg0,
HttpServletResponse arg1, Object arg2, Exception arg3)
throws Exception {
// TODO Auto-generated method stub

}
}

写了这个inteceptor 之后，怎么让它生效去拦截请求呢？ 需要在spring mvc 的配置文件中去配置:

<?xml  version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/
17743
schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:context="http://www.springframework.org/schema/context"
xmlns:mvc="http://www.springframework.org/schema/mvc"
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" default-autowire="byName">

<mvc:interceptors>
<!-- 使用bean定义一个Interceptor，直接定义在mvc:interceptors根下面的Interceptor将拦截所有的请求 -->
<bean class="com.inteceptor.AllInteceptor"/>
<mvc:interceptor>
<mvc:mapping path="/**"/>
<!-- 需排除拦截的地址 -->
<mvc:exclude-mapping path="/" />
<mvc:exclude-mapping path="/test" />
<!-- 定义在mvc:interceptor下面的表示是对特定的请求才进行拦截的 -->
<bean class="com.inteceptor.TimeInteceptor"/>
</mvc:interceptor>
</mvc:interceptors>

</beans>

这样就能按配置的规则对URL 进行拦截，并打印出程序执行的时间。

除了用inteceptor做拦截来计算时间之外，还可以实现很多其他功能，比如定义时间在晚上23-24点之间服务器处于维护状态，转到维护界面等，都可以用这种方法实现，而且在 inteceptor 中还可以注入service 等查询数据库。很方便的。

====================自我实现案例===============================

拦截器代码：

import java.text.SimpleDateFormat;

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

import org.apache.log4j.Logger;
import org.springframework.core.NamedThreadLocal;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;

/**
* 日志拦截器
* @author ThinkGem
* @version 2014-8-19
*/
public class LogInterceptor implements HandlerInterceptor {

private static final ThreadLocal<Long> startTimeThreadLocal =
new NamedThreadLocal<Long>("ThreadLocal StartTime");
private static final Logger logger = Logger.getLogger(LogInterceptor.class);
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response,
Object handler) throws Exception {
if (logger.isDebugEnabled()){
long beginTime = System.currentTimeMillis();//1、开始时间
startTimeThreadLocal.set(beginTime);        //线程绑定变量（该数据只有当前请求的线程可见）
String start = "URI:" + request.getRequestURI() +
"\n开始计时:" + new SimpleDateFormat("hh:mm:ss.SSS").format(beginTime);
//记录开始
logger.debug(start);
}
return true;
}

@Override
public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler,
ModelAndView modelAndView) throws Exception {
if (modelAndView != null){
//记录请求视图
logger.info("ViewName: " + modelAndView.getViewName());
}
}

@Override
public void afterCompletion(HttpServletRequest request, HttpServletResponse response,
Object handler, Exception ex) throws Exception {

// 打印JVM信息。
if (logger.isDebugEnabled()){
long beginTime = startTimeThreadLocal.get();//得到线程绑定的局部变量（开始时间）
long endTime = System.currentTimeMillis();  //2、结束时间
new SimpleDateFormat("hh:mm:ss.SSS").format(endTime);
String result = "URI:" + request.getRequestURI() +
"\nController(handle):" + handler +
"\n开始计时:" + new SimpleDateFormat("hh:mm:ss.SSS").format(beginTime) +
"\n结束时间:"+  new SimpleDateFormat("hh:mm:ss.SSS").format(endTime) +
"\n耗时:" + (endTime - beginTime) + "ms" +
"\n最大内存:" + Runtime.getRuntime().maxMemory()/1024/1024 + "M" +
"\n已分配内存:" + Runtime.getRuntime().totalMemory()/1024/1024 + "M" +
"\n已分配内存的剩余空间:" + Runtime.getRuntime().freeMemory()/1024/1024 + "M" +
"\n最大可用内存:" + Runtime.getRuntime().freeMemory()/1024/1024 + "M";

logger.debug(result);
System.out.println(result);
}

}

}

springmvc配置拦截器：

<!-- 装配拦截器 -->
<mvc:interceptors>
<!-- 使用bean定义一个Interceptor，直接定义在mvc:interceptors根下面的Interceptor将拦截所有的请求 -->
<!-- <bean class="edu.hrbeu.platform.modeling.common.interceptor.LogInterceptor"/>   -->
<mvc:interceptor>
<!-- 在springmvc前端控制器DispatcherServlet的基础上缩小拦截范围 -->
<!-- 一级目录 -->
<mvc:mapping path="/*.do" />
<!-- 二级目录 -->
<!-- <mvc:mapping path="/*/*.do" /> -->
<!-- 不知道和 /*/*.do有什么区别-->
<mvc:mapping path="/**/*.do" />
<!--错误配置样例  -->
<!--
拦截失败
<mvc:mapping path="*.do" />
<mvc:mapping path="/**.do" />
-->

<!-- 需排除拦截的地址 -->
<!--  <mvc:exclude-mapping path="/" />
<mvc:exclude-mapping path="/test" />   -->
<!-- 定义在mvc:interceptor下面的表示是对特定的请求才进行拦截的 -->
<bean class="edu.hrbeu.platform.modeling.common.interceptor.LogInterceptor"/>
</mvc:interceptor>
</mvc:interceptors>