拦截器与过滤器的区别

2020-02-24  本文已影响0人  天高云淡623

一.过滤器:

依赖于servlet容器。在实现上基于函数回调,可以对几乎所有请求进行过滤,用来做一些过滤操作,获取我们想要获取的数据,比如:在过滤器中修改HttpServletRequest的一些参数,过滤低俗文字、敏感信息等

二.拦截器:

依赖于web框架,在SpringMVC中就是依赖于SpringMVC框架。在实现上基于Java的反射机制,属于面向切面编程(AOP)的一种运用。由于拦截器是基于web框架的调用,因此可以使用Spring的依赖注入(DI)进行一些业务操作,同时一个拦截器实例在一个controller生命周期之内可以多次调用。但是缺点是只能对controller请求进行拦截,对其他的一些比如直接访问静态资源的请求则没办法进行拦截处理

三.过滤器和拦截器的区别:

1、拦截器是基于java的反射机制的,而过滤器是基于函数回调。

2、拦截器依赖web框架,过滤器依赖servlet容器。

3、拦截器只能对action请求起作用,而过滤器则可以对几乎所有的请求起作用。

4、拦截器可以访问action上下文、值栈里的对象,而过滤器不能访问。

5、在action的生命周期中,拦截器可以多次被调用,而过滤器只能在容器初始化时被调用一次。

6、拦截器可以获取IOC容器中的各个bean,而过滤器就不行,这点很重要,在拦截器里注入一个service,可以调用业务逻辑。

7、过滤器在servlet前后起作用,而拦截器能深入到方法前后、异常抛出前后等。因此拦截器的操作更有弹性,所以,在spring框架的程序中推荐优先使用拦截器。

四、Spring Boot中使用过滤器和拦截器

过滤器(Filter)和拦截器(Interceptor)是Web项目中常用的两个功能,本文将简单介绍在Spring Boot中使用过滤器和拦截器来计算Controller中方法的执行时长,并且简单对比两者的区别。

现有如下Controller:

@RestController

@RequestMapping("user")

publicclassUserController{

@GetMapping("/{id:\\d+}")

publicvoidget(@PathVariable String id){

        System.out.println(id);

    }

}

下面通过配置过滤器和拦截器来实现对get方法执行时间计算的功能。

过滤器

定义一个TimeFilter类,实现javax.servlet.Filter:

publicclassTimeFilterimplementsFilter{

@Override

publicvoidinit(FilterConfig filterConfig)throwsServletException{

System.out.println("过滤器初始化");

    }

@Override

publicvoiddoFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain)throwsIOException, ServletException{

System.out.println("开始执行过滤器");

Long start =newDate().getTime();

        filterChain.doFilter(servletRequest, servletResponse);

System.out.println("【过滤器】耗时 "+ (newDate().getTime() - start));

System.out.println("结束执行过滤器");

    }

@Override

publicvoiddestroy(){

System.out.println("过滤器销毁");

    }

}

TimeFilter重写了Filter的三个方法,方法名称已经很直白的描述了其作用,这里不再赘述。

要使该过滤器在Spring Boot中生效,还需要一些配置。这里主要有两种配置方式。

配置方式一

可通过在TimeFilter上加上如下注解:

@Component

@WebFilter(urlPatterns = {"/*"})

publicclassTimeFilterimplementsFilter{

  ...

}

@Component注解让TimeFilter成为Spring上下文中的一个Bean,@WebFilter注解的urlPatterns属性配置了哪些请求可以进入该过滤器,/*表示所有请求。

启动项目时可以看到控制台输出了过滤器初始化,启动后访问http://localhost:8080/user/1,控制台输出如下:

开始执行过滤器

1

【过滤器】耗时 31

结束执行过滤器

配置方式二

除了在过滤器类上加注解外,我们也可以通过FilterRegistrationBean来注册过滤器。

定义一个WebConfig类,加上@Configuration注解表明其为配置类,然后通过FilterRegistrationBean来注册过滤器:

@Configuration

publicclassWebConfig{

@Bean

publicFilterRegistrationBeantimeFilter(){

FilterRegistrationBean filterRegistrationBean =newFilterRegistrationBean();

TimeFilter timeFilter =newTimeFilter();

        filterRegistrationBean.setFilter(timeFilter);

List urlList =newArrayList<>();

urlList.add("/*");

        filterRegistrationBean.setUrlPatterns(urlList);

returnfilterRegistrationBean;

    }

}

FilterRegistrationBean除了注册过滤器TimeFilter外还通过setUrlPatterns方法配置了URL匹配规则。重启项目访问http://localhost:8080/user/1,我们可以看到和上面一样的效果。

通过过滤器我们只可以获取到servletRequest对象,所以并不能获取到方法的名称,所属类,参数等额外的信息。

拦截器

定义一个TimeInterceptor类,实现org.springframework.web.servlet.HandlerInterceptor接口:

publicclassTimeInterceptorimplementsHandlerInterceptor{

@Override

publicbooleanpreHandle(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o)throwsException{

System.out.println("处理拦截之前");

httpServletRequest.setAttribute("startTime",newDate().getTime());

        System.out.println(((HandlerMethod) o).getBean().getClass().getName());

        System.out.println(((HandlerMethod) o).getMethod().getName());

returntrue;

    }

@Override

publicvoidpostHandle(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o, ModelAndView modelAndView)throwsException{

System.out.println("开始处理拦截");

Long start = (Long) httpServletRequest.getAttribute("startTime");

System.out.println("【拦截器】耗时 "+ (newDate().getTime() - start));

    }

@Override

publicvoidafterCompletion(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o, Exception e)throwsException{

System.out.println("处理拦截之后");

Long start = (Long) httpServletRequest.getAttribute("startTime");

System.out.println("【拦截器】耗时 "+ (newDate().getTime() - start));

System.out.println("异常信息 "+ e);

    }

}

TimeInterceptor实现了HandlerInterceptor接口的三个方法。preHandle方法在处理拦截之前执行,postHandle只有当被拦截的方法没有抛出异常成功时才会处理,afterCompletion方法无论被拦截的方法抛出异常与否都会执行。

通过这三个方法的参数可以看到,相较于过滤器,拦截器多了Object和Exception对象,所以可以获取的信息比过滤器要多的多。但过滤器仍无法获取到方法的参数等信息,我们可以通过切面编程来实现这个目的。

要使拦截器在Spring Boot中生效,还需要如下两步配置:

1.在拦截器类上加入@Component注解;

2.在WebConfig中通过InterceptorRegistry注册过滤器:

@Configuration

publicclassWebConfigextendsWebMvcConfigurerAdapter{

@Autowired

privateTimeInterceptor timeInterceptor;

@Override

publicvoidaddInterceptors(InterceptorRegistry registry){

        registry.addInterceptor(timeInterceptor);

    }

}

启动项目,访问http://localhost:8080/user/1,控制台输出如下:

处理拦截之前

cc.mrbird.controller.UserController

get

1

开始处理拦截

【拦截器】耗时 24

处理拦截之后

【拦截器】耗时 24

异常信息 null

从输出中我们可以了解到三个方法的执行顺序,并且三个方法都被执行了。

我们在UserController的get方法中手动抛出一个异常:

@GetMapping("/{id:\\d+}")

publicvoidget(@PathVariable String id){

    System.out.println(id);

thrownewRuntimeException("user not exist");

}

重启项目后,访问http://localhost:8080/user/1,控制台输出如下:

处理拦截之前

cc.mrbird.controller.UserController

get

1

处理拦截之后

【拦截器】耗时 0

异常信息 java.lang.RuntimeException: user not exist

可看到,postHandle方法并没有被执行。

执行时机对比

我们将过滤器和拦截器都配置上,然后启动项目访问http://localhost:8080/user/1

开始执行过滤器

处理拦截之前

cc.mrbird.controller.UserController

get

1

开始处理拦截

【拦截器】耗时 25

处理拦截之后

【拦截器】耗时 25

异常信息 null

【过滤器】耗时 34

结束执行过滤器

可看到过滤器要先于拦截器执行,晚于拦截器结束。下图很好的描述了它们的执行时间区别:

参照文章:https://mrbird.cc/Spring-Boot-Filter-Interceptor.html

上一篇下一篇

猜你喜欢

热点阅读