SpringBoot 拦截器

本文详细介绍如何在SpringBoot中自定义Filter,包括实现Filter接口、配置Filter注册Bean及设置过滤路径、初始化参数和优先级。通过实战示例,展示自定义Filter在请求处理过程中的作用。

1. 自定义Filter

 

pring Boot自动添加了OrderedCharacterEncodingFilter和HiddenHttpMethodFilter,并且我们可以自定义Filter。

从输出日志可以看到默认添加的Filter

两个步骤:

  1. 实现Filter接口,实现Filter方法
  2. 添加@Configuration 注解,将自定义Filter加入过滤链

代码 :

@Configuration
public class WebConfiguration {
    @Bean
    public RemoteIpFilter remoteIpFilter() {
        return new RemoteIpFilter();
    }
    
    @Bean
    public FilterRegistrationBean testFilterRegistration() {

        FilterRegistrationBean registration = new FilterRegistrationBean();
        registration.setFilter(new MyFilter());//添加过滤器
        registration.addUrlPatterns("/*");//设置过滤路径,/*所有路径
        registration.addInitParameter("name", "wcb");registration.setinitParameter("age",26);//添加默认参数
       registration.setOrder(1);//设置优先级
        return registration;
    }
    
    public class MyFilter implements Filter {
		@Override
		public void destroy() {
			// TODO Auto-generated method stub
		}

		@Override
		public void doFilter(ServletRequest srequest, ServletResponse sresponse, FilterChain filterChain)
				throws IOException, ServletException {
			HttpServletRequest request = (HttpServletRequest) srequest;
			System.out.println("this is MyFilter,url :"+request.getRequestURI());
			filterChain.doFilter(srequest, sresponse);
		}

		@Override
		public void init(FilterConfig arg0) throws ServletException {
			// TODO Auto-generated method stub
		}
    }
}//添加过滤器
        registration.addUrlPatterns("/*");//设置过滤路径,/*所有路径
        registration.addInitParameter("name", "wcb");registration.setinitParameter("age",26);//添加默认参数
       registration.setOrder(1);//设置优先级
        return registration;
    }
    
    public class MyFilter implements Filter {
		@Override
		public void destroy() {
			// TODO Auto-generated method stub
		}

		@Override
		public void doFilter(ServletRequest srequest, ServletResponse sresponse, FilterChain filterChain)
				throws IOException, ServletException {
			HttpServletRequest request = (HttpServletRequest) srequest;
			System.out.println("this is MyFilter,url :"+request.getRequestURI());
			filterChain.doFilter(srequest, sresponse);
		}

		@Override
		public void init(FilterConfig arg0) throws ServletException {
			// TODO Auto-generated method stub
		}
    }
}
@RestController
public class TestController {
	@Autowired
	private FilterRegistrationBean filterRegistrationBean;
	@RequestMapping("/test")
	public Map<String, String> test() {
		return filterRegistrationBean.getInitParameters();
	}
}

访问http://localhost:8080/test 可以看到,页面结果如下

再看控制台输出日志,可见自定义的拦截器也有拦截并输出内容

在 Spring Boot 中创建和配置拦截器是一个相对简单的过程,可以通过以下步骤实现: ### 创建自定义拦截器 1. **创建拦截器类** 自定义拦截器可以通过实现 `HandlerInterceptor` 接口或继承 `HandlerInterceptorAdapter` 类来完成。拦截器的主要方法包括: - `preHandle()`:在 Controller 方法执行之前调用,返回值为 `true` 表示继续执行后续流程,`false` 表示中断请求。 - `postHandle()`:在 Controller 方法执行之后、视图渲染之前调用。 - `afterCompletion()`:在整个请求完成之后(视图渲染结束)调用,可用于资源清理等操作。 示例代码如下: ```java import org.springframework.web.servlet.HandlerInterceptor; import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletResponse; public class MyInterceptor implements HandlerInterceptor { @Override public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception { // 在 Controller 方法执行前执行 System.out.println("preHandle 方法执行"); return true; // 返回 true 表示继续后续流程 } @Override public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception { // 在 Controller 方法执行后、视图渲染前执行 System.out.println("postHandle 方法执行"); } @Override public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception { // 在整个请求完成之后执行 System.out.println("afterCompletion 方法执行"); } } ``` 2. **配置拦截器** 需要创建一个 Java 配置类,实现 `WebMvcConfigurer` 接口,并重写 `addInterceptors` 方法,将自定义拦截器注册到 Spring Boot 的拦截器链中。 示例代码如下: ```java import org.springframework.context.annotation.Configuration; import org.springframework.web.servlet.config.annotation.InterceptorRegistry; import org.springframework.web.servlet.config.annotation.WebMvcConfigurer; @Configuration public class WebConfig implements WebMvcConfigurer { @Override public void addInterceptors(InterceptorRegistry registry) { // 添加自定义拦截器,并指定拦截路径 registry.addInterceptor(new MyInterceptor()) .addPathPatterns("/**") // 拦截所有请求 .excludePathPatterns("/", "/login", "/index.html", "/user/login", "/css/**", "/images/**", "/js/**", "/fonts/**"); // 排除特定路径 } } ``` 3. **拦截器的作用范围** - `addPathPatterns("/**")` 表示拦截所有请求路径。 - `excludePathPatterns(...)` 可以指定一些不需要拦截的路径,例如登录页面、静态资源等。 - 通过这种方式,可以灵活地控制拦截器的作用范围,避免对某些特定请求造成干扰。 4. **注意事项** - 在较新的 Spring Boot 版本中,建议直接实现 `WebMvcConfigurer` 接口,而不是继承 `WebMvcConfigurerAdapter` 类,因为后者在 Spring Boot 5 中已被标记为过时。 - 拦截器类可以放在 `config` 包下,或者与主应用类在同一目录下,以确保 Spring Boot 能够正确扫描到该类。 ### 拦截器的工作流程 拦截器的执行顺序如下: 1. `preHandle()`:在 Controller 方法执行之前执行。 2. Controller 方法执行。 3. `postHandle()`:在 Controller 方法执行之后、视图渲染之前执行。 4. `afterCompletion()`:在整个请求完成之后执行,通常用于清理资源。 通过拦截器,可以实现对请求的统一处理,例如权限校验、日志记录、请求时间统计等功能。 --- ###
评论 1
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值