过滤器(Fiter)与 拦截器(Interceptor)
概念:这两个都是进行对客户端向服务端进行请求时,将请求的数据进行拦截在拦截的这段时间内,是不会执行三层架构中的代码的,所以这就可以做到了过滤掉无效令牌的请求。
一、 过滤器(Fiter)
概念:
Fiter过滤器
,是JavaWeb三大组件(Servlet、Filter、Listener)之一。
过滤器可以吧资源的请求拦截下来,从而实现一些特殊的功能。
过滤器一般完成一些通用的操作,比如:登录校验,统一编码处理、敏感字符处理等。
定义Fiter
如何定义Fiter:你需要定义一个类,实现Fiter接口,并重写其中的是三个方法:doFilter()、init()、destroy()。
doFilter()、init()、destroy()
doFilter():拦截到请求时调用方法(可以多次调用)
注意:拦截完之后还需要过滤放行,不然将访问不到web资源
init():web服务启动,创建Filter时调用(只会调用一次)
destroy():销毁方法,服务器关闭时调用(只会调用一次)
代码实例
public class TestDemoFilter implements Filter {
@Override
public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
//拦截到请求时调用该方法,可多次调用
System.out.println("拦截成功");
//!!!注意!!!拦截完之后还需要过滤放行,不然将访问不到web资源
filterChain.doFilter(servletRequest,servletResponse);
}
@Override
public void init(FilterConfig filterConfig) throws ServletException {//初始化方法,web服务器启动,创建Filter时调用,只调用一次
System.out.println("into 已经初始化完成了");
}
@Override
public void destroy() {//销毁方法,服务器关闭时调用,只调用一次
System.out.println("destroy 已经销毁了方法");
}
}
配置Fiter
知道如何定义Fiter过滤器之后,接下来就需要知道如何去配置Filter(如何拦截指定的请求?如何去指定的去绑定指定的SpringBoot项目?)
如何去指定的去绑定指定的SpringBoot项目?
其实这个非常的简单,只需要在你SpringBoot项目的引导类上添加一个注释(@ServletComponentScan)即可
代码实例
@ServletComponentScan
@SpringBootApplication
public class SpringBootProject1Application {
public static void main(String[] args) {
SpringApplication.run(SpringBootProject1Application.class, args);
}
}
如何拦截指定的请求?
这个需要使用一个注解(@WebFilter)并给它里面的参数urlPatterns赋值(拦截路径)
Fiter拦截路径
概念:在去拦截请求时,一般会有一些请求不需要拦截,这时就需要知道如何设置拦截的请求路径
FIlter可以根据需求,配置不同的的拦截资源路径:
拦截路径 | urlPatterns值 | 含义 |
---|---|---|
拦截具体路径 | /login | 只访问/login路径时,才会被拦截 |
目录拦截 | /dept/* | 访问/dept下的所有资源,都会被拦截 |
拦截所有 | /* | 访问所有的路径,都会被拦截 |
代码实例
@WebFilter(urlPatterns = "/*")
public class TestDemoFilter implements Filter {...}
过滤链
介绍:一个web应用中,可以配置多个过滤器,该多个过滤器就形成了一个过滤器链
顺序:注解配置的Fiter,优先级是按照过滤器类名(字符串)的自然排序
图形化示意图:
疑问
放行后访问对应资源,资源访问完后,还会回到Fiter中吗?会
如果回到Fiter中,是重新执行还是执行放行之后的逻辑呢?执行放行后逻辑
二、 拦截器(Interceptor)
概念:拦截器是一种拦截方法调用的机制,类似与过滤器。Spring框架中提供的,用来动态拦截控制器方法的执行。
作用:拦截请求,在指定的方法调用前后,根据业务需要执行预定的代码。
定义拦截器
创建一个实现HandlerInterceptor接口的类,并更居自己的需要去重写指定的方法(preHandle、postHandle、afterCompletion)。
preHandle()、postHandle()、afterCompletion()
preHandle(): 此方法是在访问前执行。
postHandle(): 此方法是在访问后执行。
afterCompletion(): 此方法是在渲染完图像之后执行。
拦截器(Interceptor)中重写的方法返回值都是以boolean类型返回,所以放行与不放行的表达是直接在方法中直接放回true(放行)/false(不放行)
代码实现
public class LoginCheckInterceptor implements HandlerInterceptor {
@Override//目标资源方法执行前执行,返回true:放行,返回false:不放行。
public boolean preHandle(HttpServletRequest req, HttpServletResponse res, Object handler) throws Exception {
System.out.println("preHandle...");
return true;
}
@Override//目标方法执行后执行
public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, @Nullable ModelAndView modelAndView) throws Exception {
System.out.println("postHandle...");
}
@Override//视图渲染完毕之后,最后执行
public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, @Nullable Exception ex) throws Exception {
System.out.println("afterCompletion");
}
}
注册拦截器
概念:其实注册拦截器也就相当于过滤器中的配置Fiter,步骤和过滤器都差不多。
如何注册拦截器?
- 在定义拦截器的类中使用@Component,来将他存储在IOC容器中,方便后面的调用。
- 创建一个实现WebMvcConfigurer接口的类,并使用注解@Configuration进行标识此类,表明此类是配置类。
- 使用IOC容器中你所需要的调用的拦截器,并创建此变量。
- 在重写webMvcConfigurer中的方法addInterceptors,在方法中指定拦截路径。
代码实现
定义类代码
@Component//将定义的拦截器进行存储在IOC容器中
public class LoginCheckInterceptor implements HandlerInterceptor {
}
配置类代码
@Configuration//配置类
public class WebConfig implements WebMvcConfigurer {
@Autowired//调用存储在IOC容器中的拦截器
private LoginCheckInterceptor loginCheckInterceptor;
@Override
public void addInterceptors(InterceptorRegistry registry){
registry.addInterceptor(loginCheckInterceptor).addPathPatterns("/**").excludePathPatterns("/login");
}
}
拦截器(Interceptor)的拦截路径设置
如何设置拦截路径:这时需要在addInterceptor方法去调用形参(registry)的三个方法
.addInterceptor(HandlerInterceptor interceptor):此方法是用来去绑定需要调用的拦截器
.addPathPatterns(String… patterns):此方法使用来添加指定的拦截的路径(patterns)
.excludePathPatterns(String… patterns):此方法使用来排除指定请求的路径(patterns)
实例:registry.addInterceptor(loginCheckInterceptor).addPathPatterns("/**").excludePathPatterns("/login");
代码解释:标识绑定拦截器(loginCheckInterceptor)在添加链接路径"/**",且不不就会拦截路径为“/login”的请求。
拦截路径
拦截路径 | 含义 |
---|---|
/** | 任意级目录 |
/* | 一级路径 |
/Emps/* | /Emps下的一级目录 |
/Emps/** | /Emps下的任意目录 |
过滤器(Fiter)与 拦截器(Interceptor)的的关系
接口规范不同:过滤器需要实现Filter接口,而拦截器需要实现HandlerInterceptor接口。
拦截范围不同:过滤器Fiter会拦截所有的资源,而Interceptor只会拦截Spring环境中的资源。