Spring Boot拦截器和过滤器实例解析
这篇文章主要介绍了spring boot拦截器和过滤器实例解析,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
一、拦截器与过滤器
在讲spring boot之前,我们先了解一下过滤器和拦截器。这两者在功能方面很类似,但是在具体技术实现方面,差距还是比较大的。在分析两者的区别之前,我们先理解一下aop的概念,aop不是一种具体的技术,而是一种编程思想。在面向对象编程的过程中,我们很容易通过继承、多态来解决纵向扩展。 但是对于横向的功能,比如,在所有的service方法中开启事务,或者统一记录日志等功能,面向对象的是无法解决的。所以aop——面向切面编程其实是面向对象编程思想的一个补充。而我们今天讲的过滤器和拦截器都属于面向切面编程的具体实现。而两者的主要区别包括以下几个方面:
1、filter是依赖于servlet容器,属于servlet规范的一部分,而拦截器则是独立存在的,可以在任何情况下使用。
2、filter的执行由servlet容器回调完成,而拦截器通常通过动态代理的方式来执行。
3、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 public void posthandle(httpservletrequest httpservletrequest, httpservletresponse httpservletresponse, object o, modelandview modelandview) throws exception { system.out.println("interceptor cost="+(system.currenttimemillis()-start)); } @override public void aftercompletion(httpservletrequest httpservletrequest, httpservletresponse httpservletresponse, object o, exception e) throws exception { } }
这里我们需要实现handlerinterceptor这个接口,这个接口包括三个方法,prehandle是请求执行前执行的,posthandler是请求结束执行的,但只有prehandle方法返回true的时候才会执行,aftercompletion是视图渲染完成后才执行,同样需要prehandle返回true,该方法通常用于清理资源等工作。除了实现上面的接口外,我们还需对其进行配置:
@configuration public class interceptorconfig extends webmvcconfigureradapter { @override public void addinterceptors(interceptorregistry registry) { registry.addinterceptor(new logcostinterceptor()).addpathpatterns("/**"); super.addinterceptors(registry); } }
这里我们继承了webmvcconfigureradapter,看过前面的文章的朋友应该已经见过这个类了,在进行静态资源目录配置的时候我们用到过这个类。这里我们重写了addinterceptors这个方法,进行拦截器的配置,主要配置项就两个,一个是指定拦截器,第二个是指定拦截的url。现在我们再启动系统访问任意一个url:
可以看到,我们通过拦截器实现了同样的功能。不过这里还要说明一点的是,其实这个实现是有问题的,因为prehandle和posthandle是两个方法,所以我们这里不得不设置一个共享变量start来存储开始值,但是这样就会存在线程安全问题。当然,我们可以通过其他方法来解决,比如通过threadlocal就可以很好的解决这个问题,有兴趣的同学可以自己实现。不过通过这一点我们其实可以看到,虽然拦截器在很多场景下优于过滤器,但是在这种场景下,过滤器比拦截器实现起来更简单。
四、总结
本文主要对基于spring boot对过滤器和拦截器的配置进行的讲解。无论是过滤器还是拦截器都属于aop(面向切面编程)思想的具体实现。除了这两种实现我们还见过另一种更灵活的aop实现技术,即aspect,我们可以通过aspect来完成更多更强大的功能。这个后续再给大家分享。
以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持。
推荐阅读
-
Spring Boot项目实战之拦截器与过滤器
-
Spring Boot @Scheduled定时任务代码实例解析
-
Spring Boot和Thymeleaf整合结合JPA实现分页效果(实例代码)
-
Spring Boot整合EasyExcel(完整版包含上传解析excel和下载模板)
-
spring中过滤器(filter)、拦截器(interceptor)和切面(aop)的执行顺序
-
Spring Boot 拦截器和过滤器
-
Spring boot 拦截器和过滤器
-
【原创】Spring Boot 过滤器、监听器、拦截器的使用
-
【Spring Boot实战与进阶】过滤器和拦截器的使用及其区别
-
Spring Boot拦截器和过滤器的使用