SpringBoot2.0学习第四篇之拦截器过滤器配置

举报
西魏陶渊明 发表于 2022/09/25 02:11:01 2022/09/25
【摘要】 对于JavaWeb开发,拦截器和过滤器无疑是两个非常重要的知识点,在传统SpringMVC的框架配置中,是令人很头疼的一个事情,因为需要在web.xml中配置,但是自从有了SpringBoot这一切都变得非常的简单,没有任何复杂点。任何人都能在1分钟内学会如何进行配置整合,下面跟着小编来一起配置拦截器和过滤器。 通读全文大概...

对于JavaWeb开发,拦截器和过滤器无疑是两个非常重要的知识点,在传统SpringMVC的框架配置中,是令人很头疼的一个事情,因为需要在web.xml中配置,但是自从有了SpringBoot这一切都变得非常的简单,没有任何复杂点。任何人都能在1分钟内学会如何进行配置整合,下面跟着小编来一起配置拦截器和过滤器。

通读全文大概需要1分钟

4279695-eda36a0a446b8f10
image

教程目录

4279695-d3dc0758b8118049
image

目标是什么?

  1. 过滤器和拦截器的根本区别
  2. 快速配置过滤器
  3. 快速配置拦截器

开发环境

  1. JDK1.8或更高版本
  2. Maven
  3. IntelliJ IDEA 开发工具
  4. 开发框架SpringBoot2.x

项目目录


  
  1. |____resources
  2. |____java
  3. | |____web
  4. | | |____WebApplication.java
  5. | | |____config
  6. | | | |____RestWebFilterConfig.java
  7. | | | |____InterceptorConfig.java
  8. | | | |____LogInterceptor.java
  9. | | | |____RestWebFilter.java
  10. | | |____controller
  11. | | | |____RestWebController.java

过滤器和拦截器的根本区别

  1. 过滤器是servlet规范规定的,只能用于web程序中,而拦截器是在spring容器中,它不依赖servlet容器。
  2. 拦截器属于Spring中的概念,可以在拦截器中使用任何Spring中的Bean信息,而过滤器不属于Spring中的概念点,所以过滤器不行.
  3. 过滤器可以拦截几乎所有的请求(包含对静态资源的请求),而拦截器只拦截Spring中的请求处理器(不拦截静态资源请求)
  4. 不管是过滤器还是拦截器都是AOP编程思想的体现。
  5. 过滤器的执行顺序在拦截器之前

快速配置过滤器

配置过滤器主要有两种方式

  1. servlet自代的注解@WebFilter
  2. 基于SpringBoot配置FilterRegistrationBean
Servlet自代的注解@WebFilter

先创建过滤器实现类,然后添加在SpringBoot main方法添加ServletComponentScan开启扫描Servlet注解


  
  1. @WebFilter(urlPatterns = "/*", filterName = "RestWebFilter")
  2. public class RestWebFilter implements Filter {
  3. @Override
  4. public void init(FilterConfig filterConfig) throws ServletException {
  5. }
  6. @Override
  7. public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
  8. long start = System.currentTimeMillis();
  9. filterChain.doFilter(servletRequest, servletResponse);
  10. System.out.println("Execute cost=" + (System.currentTimeMillis() - start));
  11. }
  12. @Override
  13. public void destroy() {
  14. }
  15. }

添加ServletComponentScan开启扫描Servlet注解


  
  1. //添加ServletComponentScan开启扫描Servlet注解
  2. @ServletComponentScan
  3. @SpringBootApplication
  4. public class WebApplication {
  5. public static void main(String[] args) {
  6. SpringApplication.run(WebApplication.class, args);
  7. }
  8. }
基于SpringBoot配置FilterRegistrationBean

通过Configuration的方式创建Bean,不清楚如何使用Configuration的同学可以看上一篇


  
  1. @Configuration
  2. public class RestWebFilterConfig {
  3. @Bean
  4. public FilterRegistrationBean filterRegistrationBean(){
  5. FilterRegistrationBean filterRegistrationBean = new FilterRegistrationBean();
  6. filterRegistrationBean.setFilter(new RestWebFilter());
  7. filterRegistrationBean.setName("RestWebFilter2");
  8. filterRegistrationBean.addUrlPatterns("/*");
  9. return filterRegistrationBean;
  10. }
  11. }

使用上面任何一种方式都可以实现过滤器的配置。

快速配置拦截器

在SpringBoot2.0及Spring 5.0 WebMvcConfigurerAdapter已被废弃。

拦截器的配置需要注意的是,在Spring5和之前版本有一点小小的区别。如果你之前使用SpringBoot1.x

那么拦截器的配置可能是下面这样。


  
  1. public class InterceptorConfig extends WebMvcConfigurerAdapter {
  2. @Override
  3. public void addInterceptors(InterceptorRegistry registry) {
  4. registry.addInterceptor(new LogCostInterceptor()).addPathPatterns("/**");
  5. super.addInterceptors(registry);
  6. }
  7. }

这种方式在SpringBoot2中已经被废弃了。建议使用最新方式。将继承WebMvcConfigurerAdapter换成实现WebMvcConfigurer


  
  1. @Configuration
  2. public class InterceptorConfig implements WebMvcConfigurer {
  3. @Override
  4. public void addInterceptors(InterceptorRegistry registry) {
  5. registry.addInterceptor(new LogInterceptor()).addPathPatterns("/*");
  6. }
  7. }

请求耗时拦截器实现

拦截器和过滤器都可以实现日志拦截的功能,也可以对执行类进行耗时的统计,同时也可以获取请求的信息。下面分享一个具有耗时统计的拦截器。


  
  1. public class LogInterceptor implements HandlerInterceptor {
  2. private final static Logger logger = LoggerFactory.getLogger(LogInterceptor.class);
  3. private final static ThreadLocal<Long> processor = new ThreadLocal<>();
  4. @Override
  5. public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
  6. //根据请求信息判断是否需要拦截
  7. return true;
  8. }
  9. @Override
  10. public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
  11. logger.info("请求信息打印...");
  12. processor.set(System.currentTimeMillis());
  13. }
  14. @Override
  15. public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
  16. Long startTime = processor.get();
  17. Long endTime = System.currentTimeMillis();
  18. processor.remove();
  19. // 处理完请求,返回内容
  20. logger.info("-----------------方法执行完毕,耗时:{}ms-------------------", (endTime - startTime));
  21. }
  22. }

获取本课程代码请关注头条号: 软件编程指南 ,私信: 004

更多了解可以点击小编博客: https://blog.springlearn.cn/posts/4135/

文章来源: springlearn.blog.csdn.net,作者:西魏陶渊明,版权归原作者所有,如需转载,请联系作者。

原文链接:springlearn.blog.csdn.net/article/details/102425356

【版权声明】本文为华为云社区用户转载文章,如果您发现本社区中有涉嫌抄袭的内容,欢迎发送邮件进行举报,并提供相关证据,一经查实,本社区将立刻删除涉嫌侵权内容,举报邮箱: cloudbbs@huaweicloud.com
  • 点赞
  • 收藏
  • 关注作者

评论(0

0/1000
抱歉,系统识别当前为高风险访问,暂不支持该操作

全部回复

上滑加载中

设置昵称

在此一键设置昵称,即可参与社区互动!

*长度不超过10个汉字或20个英文字符,设置后3个月内不可修改。

*长度不超过10个汉字或20个英文字符,设置后3个月内不可修改。