作者:
liuxiaopeng
链接:http://www.cnblogs.com/paddix
一、拦截器与过滤器
在讲Spring boot之前,我们先了解一下过滤器和拦截器。这两者在功能方面很类似,但是在具体技术实现方面,差距还是比较大的。在分析两者的区别之前,我们先理解一下AOP的概念,AOP不是一种具体的技术,而是一种编程思想。在面向对象编程的过程中,我们很容易通过继承、多态来解决纵向扩展。
但是对于横向的功能,比如,在所有的service方法中开启事务,或者统一记录日志等功能,面向对象的是无法解决的。所以AOP——面向切面编程其实是面向对象编程思想的一个补充。而我们今天讲的过滤器和拦截器都属于面向切面编程的具体实现。
而两者的主要区别包括以下几个方面:
-
Filter是依赖于Servlet容器,属于Servlet规范的一部分,而拦截器则是独立存在的,可以在任何情况下使用。
-
Filter的执行由Servlet容器回调完成,而拦截器通常通过动态代理的方式来执行。
-
Filter的生命周期由Servlet容器管理,而拦截器则可以通过IoC容器来管理,因此可以通过注入等方式来获取其他Bean的实例,因此使用会更方便。
二、过滤器的配置
现在我们通过过滤器来实现记录请求执行时间的功能,其实现如下:
-
public
class
LogCostFilter
implements
Filter
{
-
@Override
-
public
void
init
(
FilterConfig
filterConfig
)
throws
ServletException
{
-
-
}
-
-
@Override
-
public
void
doFilter
(
ServletRequest
servletRequest
,
ServletResponse
servletResponse
,
FilterChain
filterChain
)
throws
IOException
,
ServletException
{
-
long
start
=
System
.
currentTimeMillis
();
-
filterChain
.
doFilter
(
servletRequest
,
servletResponse
);
-
System
.
out
.
println
(
"Execute cost="
+(
System
.
currentTimeMillis
()-
start
));
-
}
-
-
@Override
-
public
void
destroy
()
{
-
-
}
-
}
这段代码的逻辑比较简单,就是在方法执行前先记录时间戳,然后通过过滤器链完成请求的执行,在返回结果之间计算执行的时间。这里需要主要,这个类必须继承Filter类,这个是Servlet的规范,这个跟以前的Web项目没区别。
但是,有了过滤器类以后,以前的web项目可以在web.xml中进行配置,但是spring boot项目并没有web.xml这个文件,那怎么配置?在Spring boot中,我们需要FilterRegistrationBean来完成配置。其实现过程如下:
-
@Configuration
-
public
class
FilterConfig
{
-
-
@Bean
-
public
FilterRegistrationBean
registFilter
()
{
-
FilterRegistrationBean
registration
=
new
FilterRegistrationBean
();
-
registration
.
setFilter
(
new
LogCostFilter
());
-
registration
.
addUrlPatterns
(
"/*"
);
-
registration
.
setName
(
"LogCostFilter"
);
-
registration
.
setOrder
(
1
);
-
return
registration
;
-
}
-
-
}
这样配置就完成了,需要配置的选项主要包括实例化Filter类,然后指定url的匹配模式,设置过滤器名称和执行顺序,这个过程和在web.xml中配置其实没什么区别,只是形式不同而已。现在我们可以启动服务器访问任意URL:
大家可以看到上面的配置已经生效了。除了通过 FilterRegistrationBean 来配置以外,还有一种更直接的办法,直接通过注解就可以完成了:
-
@WebFilter
(
urlPatterns
=
"/*"
,
filterName
=
"logFilter2"
)
-
public
class
LogCostFilter2
implements
Filter
{
-
@Override
-
public
void
init
(
FilterConfig
filterConfig
)
throws
ServletException
{
-
-
}
-
-
@Override
-
public
void
doFilter
(
ServletRequest
servletRequest
,
ServletResponse
servletResponse
,
FilterChain
filterChain
)
throws
IOException
,
ServletException
{
-
long
start
=
System
.
currentTimeMillis
();
-
filterChain
.
doFilter
(
servletRequest
,
servletResponse
);
-
System
.
out
.
println
(
"LogFilter2 Execute cost="
+
(
System
.
currentTimeMillis
()
-
start
));
-
}
-
-
@Override
-
public
void
destroy
()
{
-
-
}
-
}
这里直接用@WebFilter就可以进行配置,同样,可以设置url匹配模式,过滤器名称等。这里需要注意一点的是@WebFilter这个注解是Servlet3.0的规范,并不是Spring boot提供的。除了这个注解以外,我们还需在配置类中加另外一个注解:@ServletComponetScan,指定扫描的包。
-
@SpringBootApplication
-
@MapperScan
(
"com.pandy.blog.dao"
)
-
@ServletComponentScan
(
"com.pandy.blog.filters"
)
-
public
class
Application
{
-
public
static
void
main
(
String
[]
args
)
throws
Exception
{
-
SpringApplication
.
run
(
Application
.
class
,
args
);
-
}
-
}
现在,我们再来访问一下任意URL:
可以看到,我们配置的两个过滤器都生效了。细心的读者会发现,第二个Filter我们并没有指定执行的顺序,但是却在第一个Filter之前执行。这里需要解释一下,@WebFilter这个注解并没有指定执行顺序的属性,其执行顺序依赖于Filter的名称,是根据Filter类名(注意不是配置的filter的名字)的字母顺序倒序排列,并且@WebFilter指定的过滤器优先级都高于FilterRegistrationBean配置的过滤器。有兴趣的朋友可以自己实验一下。
三、拦截器的配置
上面我们已经介绍了过滤器的配置方法,接下来我们再来看看如何配置一个拦截器。我们使用拦截器来实现上面同样的功能,记录请求的执行时间。首先我们实现拦截器类:
-
public
class
LogCostInterceptor
implements
HandlerInterceptor
{
-
long
start
=
System
.
currentTimeMillis
();
-
@Override
-
public
boolean
preHandle
(
HttpServletRequest
httpServletRequest
,
HttpServletResponse
httpServletResponse
,
Object
o
)
throws
Exception
{
-
start
=
System
.
currentTimeMillis
();
-
return
true
;
-
}
-
-
@Override
-