SpringBoot中的过滤器和拦截器的实现

一、过滤器    

SpringBoot中使用过滤器不需要在web.xml中配置filter,只需要添加注解@WebFilter同时实现Filter接口

import java.io.IOException;

import javax.servlet.Filter;
import javax.servlet.FilterChain;
import javax.servlet.FilterConfig;
import javax.servlet.ServletException;
import javax.servlet.ServletRequest;
import javax.servlet.ServletResponse;
import javax.servlet.annotation.WebFilter;
import javax.servlet.http.HttpServletRequest;

import org.springframework.stereotype.Component;

@Component
@WebFilter(urlPatterns = "/*", filterName = "test")
public class TestFilter implements Filter {

	@Override
	public void init(FilterConfig arg0) throws ServletException {
		System.out.println("过滤器初始化");
	}

	@Override
	public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain)
			throws IOException, ServletException {
		System.out.printf("过滤器实现");
		System.out.println(((HttpServletRequest) servletRequest).getRequestURI());
		filterChain.doFilter(servletRequest, servletResponse);
	}

	@Override
	public void destroy() {
		System.out.println("过滤器销毁了");
	}

}

启动项目后查看日志:

INFO 6780 --- [ost-startStop-1] o.s.b.w.servlet.FilterRegistrationBean   : Mapping filter: 'characterEncodingFilter' to: [/*]
INFO 6780 --- [ost-startStop-1] o.s.b.w.servlet.FilterRegistrationBean   : Mapping filter: 'hiddenHttpMethodFilter' to: [/*]
INFO 6780 --- [ost-startStop-1] o.s.b.w.servlet.FilterRegistrationBean   : Mapping filter: 'httpPutFormContentFilter' to: [/*]
INFO 6780 --- [ost-startStop-1] o.s.b.w.servlet.FilterRegistrationBean   : Mapping filter: 'requestContextFilter' to: [/*]
INFO 6780 --- [ost-startStop-1] o.s.b.w.servlet.FilterRegistrationBean   : Mapping filter: 'webStatFilter' to urls: [/*]
INFO 6780 --- [ost-startStop-1] o.s.b.w.servlet.FilterRegistrationBean   : Mapping filter: 'testFilter' to: [/*]
过滤器初始化

可以看到过滤器已经被初始化了,接下来再访问一下


日志:过滤器实现/test

说明过滤器已经正常执行(刚开始发现被调用了两次,第二次url打印的是/favicon.ico,这是浏览器在请求网站图标


二、拦截器

首先创建拦截器实现HandlerInterceptor

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;

/**
 * 拦截器
 */
public class MyInterceptor implements HandlerInterceptor{
	 //在请求处理之前进行调用(Controller方法调用之前
    @Override
    public boolean preHandle(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o) throws Exception {
        System.out.printf("preHandle被调用\n");
        return true;   
    }

    //请求处理之后进行调用,但是在视图被渲染之前(Controller方法调用之后)
    @Override
    public void postHandle(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o, ModelAndView modelAndView) throws Exception {
        System.out.println("postHandle被调用\n");
    }

    //在整个请求结束之后被调用,也就是在DispatcherServlet 渲染了对应的视图之后执行(主要是用于进行资源清理工作)
    @Override
    public void afterCompletion(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o, Exception e) throws Exception {
        System.out.println("afterCompletion被调用\n");
    }
}

然后创建一个配置类,用于注册拦截器

@Configuration
public class WebMvcConfig implements WebMvcConfigurer {

	/**
	 * 注册拦截器
	 */
	@Override
	public void addInterceptors(InterceptorRegistry registry) {
		registry.addInterceptor(new MyInterceptor()).addPathPatterns("/**").excludePathPatterns("/a.do");
	}
	
	
}

addPathPatterns和excludePathPatterns可以分别指定要拦截的请求和排除的请求,参数也可以是一个List<String>

好了,访问一下


需要注意的是,拦截器是基于spring的,且只有通过DispatcherServlet的请求才能被拦截。


### Spring Boot 过滤器拦截器的区别及使用场景 #### 一、定义与功能 过滤器(Filter)拦截器(Interceptor)都属于Spring框架中的组件,主要用于对HTTP请求进行预处理或后处理。然而,两者的本质不同在于其作用范围技术实现。 - **过滤器** 是基于Servlet规范的一部分,在Spring容器之外运行。它通过`javax.servlet.Filter`接口实现,可以对所有的Web请求进行统一的前置后置操作[^1]。 - **拦截器** 则是Spring MVC特有的机制,依赖于Spring容器管理。它是基于AOP(面向切面编程)的思想设计的,主要针对Controller层的方法调用进行拦截并执行额外逻辑[^2]。 #### 二、触发时机差异 - **过滤器** 的生命周期由Servlet容器控制,因此它可以应用于整个应用层面的操作,比如日志记录、性能监控或者安全验证等。它的执行顺序是在DispatcherServlet之前之后[^3]。 - **拦截器** 只能在Spring MVC上下文中生效,通常用于更细粒度的业务逻辑控制,例如权限校验、参数转换或数据封装等。它的执行发生在HandlerMapping定位到目标处理器之后,但在实际控制器方法执行前/后。 #### 三、适用场景分析 以下是两种技术各自的典型应用场景: ##### (1)过滤器适合的情况: - 需要对所有进入应用程序的请求做全局性的处理时; - 实现跨域资源共享(CORS),设置响应头信息; - 压缩解压缩请求体应答流的内容; - 统计网站访问量或其他形式的日志收集工作; 示例代码展示如何注册自定义过滤器: ```java @Configuration public class FilterConfig { @Bean public FilterRegistrationBean<TsanFilter> loggingFilter(){ FilterRegistrationBean<TsanFilter> registrationBean = new FilterRegistrationBean<>(); TsanFilter tsanFilter = new TsanFilter(); registrationBean.setFilter(tsanFilter); registrationBean.addUrlPatterns("/api/*"); return registrationBean; } } ``` ##### (2)拦截器更适合的情形: - 当仅需关注特定路径下的资源访问行为而非全部URL模式的时候; - 对用户登录状态检查以及角色授权判断; - 动态修改模型属性值以便传递给视图渲染引擎; 配置拦截器的方式如下所示: ```java @Bean public WebMvcConfigurer webMvcConfigurer() { return new WebMvcConfigurer() { @Override public void addInterceptors(InterceptorRegistry registry) { registry.addInterceptor(new MyCustomInterceptor()).addPathPatterns("/secure/**"); } }; } ``` #### 四、总结比较表 | 特性 | 过滤器 (Filter) | 拦截器 (Interceptor) | |---------------------|------------------------------------|----------------------------------| | 执行位置 | DispatcherServlet前后 | Controller 方法前后 | | 生命周期管理者 | Servlet 容器 | Spring IoC 容器 | | 是否支持XML方式声明| 支持 | 不支持 | | 主要用途举例 | 日志记录, 编码转换, 性能测试 | 权限认证, 数据绑定, 参数加密 | --- ###
评论 3
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值