过滤器Filter
过滤器Filter是Web应用程序的组件,他可以在请求到达Servlet容器之前对请求进行拦截,也可以在响应信息返回到客户端之前进行拦截
Filter接口包含三个方法:
过滤器是一个链式处理,Filter链式调用流程
执行流程类似数据结构中的栈,先进后出
拦截器Interceptor
拦截器是AOP策略的一种实现策略,用于在某个方法或者字段被访问前对它进行拦截,然后在其之前或者之后加上某些操作,拦截器也是链式调用。
看源码
Filter实现日志记录
新建filter包,增加LogFilter过滤器类实现Filter接口
@Slf4j
@WebFilter(urlPatterns = "/*", filterName = "LogFilter")
public class LogFilter implements Filter {
@Override
public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
long startTime = System.currentTimeMillis();
chain.doFilter(request,response);
log.info("LogFilter Print Log: {} -> {}",((HttpServletRequest) request).getRequestURI(),(System.currentTimeMillis() - startTime));
}
}
使用@WebFilter注解标记该类为一个Filter注解,并设置对所有的URL都生效 在主启动类上增加扫描注解
@ServletComponentScan("com.citi.spring.traps")
HandlerInterceptor实现日志记录
新增interceptor包,在包中定义一个LogInterceptor
@Slf4j
@Component
public class LogInterceptor implements HandlerInterceptor {
long startTime = System.currentTimeMillis();
// 记录请求时间
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
startTime = System.currentTimeMillis();
HandlerMethod handlerMethod = (HandlerMethod) handler;
log.info("LogInterceptor:{}", handlerMethod.getBean().getClass().getName());
log.info("LogInterceptor:{}", handlerMethod.getMethod().getName());
return true;
}
@Override
public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
log.info("LogInterceptor Print Log:{} -> {}", request.getRequestURI(),System.currentTimeMillis() - startTime);
}
@Override
public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
}
}
增加WebInterceptorAdapter,注册LogInterceptor拦截器,并对所有的请求都进行拦截
@Component
@Configuration
public class WebInterceptorAdapter implements WebMvcConfigurer {
@Override
public void addInterceptors(InterceptorRegistry registry) {
registry.addInterceptor(new LogInterceptor()).addPathPatterns("/**").order(0);
}
}
启动应用并清空控制台的日志,执行spring_mvc_traps_date_transfer.http中的GET请求,控制台打印出LogFilter和LogInterceptor拦截请求生成的日志
LogInterceptor中startTime是全局变量,当多个线程同时请求时是线程非安全的。
在interceptor包中增加第二个日志拦截器SecondLogInterceptor
@Slf4j
@Component
public class SecondLogInterceptor implements HandlerInterceptor {
// 记录请求时间
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
request.setAttribute("startTime",System.currentTimeMillis());
return true;
}
@Override
public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
log.info("SecondLogInterceptor Print Log:{} -> {}", request.getRequestURI(),System.currentTimeMillis() - (long)request.getAttribute("startTime"));
}
@Override
public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
}
}
在WebInterceptorAdapter中注册SecondLogInterceptor
@Component
@Configuration
public class WebInterceptorAdapter implements WebMvcConfigurer {
@Override
public void addInterceptors(InterceptorRegistry registry) {
registry.addInterceptor(new LogInterceptor()).addPathPatterns("/**").order(0);
registry.addInterceptor(new SecondLogInterceptor()).addPathPatterns("/**").order(1);
}
}
这里定义了两个拦截器,LogInterceptor的优先级为0先执行,SecondLogInterceptor优先级为1后执行,但是拦截器也是链式执行的,执行的顺序也是类似栈这种数据结构,所以SecondInterceptor的postHandler会先执行,然后再执行LogInterceptor的postHandler方法。
重启应用,重启完成之后清空控制台的日志,再次执行GET请求
Filter VS Interceptor
Spring的拦截器Interceptor与Servlet的过滤器Filter有相似之处,两者都是AOP面向切面变成思想的体现,都可以针对request实现权限检查,日志记录等功能
不同之处体现在
总结:Spring项目中,几乎所有过滤器能实现的功能,拦截器都能实现,当然过滤器能实现的拦截器也能实现,但是建议优先考虑使用拦截器,可以被Spring所管理,可以更好的应用Spring容器。
流、输入流、输出流
一个流可以理解为一个数据的序列 输入流标识从一个源读取数据,输出流标识向一个目标写数据 在过滤器和拦截器中对HTTP Request请求中的数据进行校验,如果是json格式数据,就需要读取输入流
但是读取了Request中的输入流之后,请求数据就不见了
在entity包中新增User实体类
@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {
private Long id;
private String name;
private Integer age;
}