作者: 桌前明月
0、序言
0.0、demo版本说明
软件版本开发工具Spring Tool Suite (STS)jdk版本1.8.0_144springboot版本2.0.5.RELEASE
0.1、场景介绍
springboot 中没有 web.xml ;我们无法按照原来定义filter 方式使用,我们的自定义 filter;我们需要编写声明 @Configuration 注解的类,并将我们自定义的filter 通过 FilterRegistrationBean 实例添加到springboot 的过滤链中。
1、自定义filter
这里的 filter 除了无需在web.xml中配置其他的和javaWeb中的Filter 没有什么区别。在这里我们定义一个拦截访问url的filter 来拦截访问项目的URI 和URL
package cn.lijunkui.filters;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.http.HttpServletRequest;import org.slf4j.Logger;import org.slf4j.LoggerFactory;public class UrlFilter implements Filter { private Logger log = LoggerFactory.getLogger(UrlFilter.class); @Override public void init(FilterConfig filterConfig) throws ServletException { } @Override public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException { HttpServletRequest httpServletRequest = (HttpServletRequest) request; String requestURI = httpServletRequest.getRequestURI(); StringBuffer requestURL = httpServletRequest.getRequestURL(); log.info("requestURI:" +requestURI+" "+"requestURL:"+requestURL); chain.doFilter(httpServletRequest, response); } @Override public void destroy() { }}
2、定义springboot 过滤链配置类
定义@Configuration 注解的类 并将自定义的filter 通过 FilterRegistrationBean 实例对象加入到过滤链中。
FilterRegistrationBean 中方法介绍:设置我们自定义拦截器示例对象:registration.setFilter(new UrlFilter())
设置拦截的:registration.setUrlPatterns(urlList)
设置拦截器的名称:registration.setName("UrlFilter")
设置拦截器拦截顺序:registration.setOrder(1)
具体代码如下:
package cn.lijunkui.config;import java.util.ArrayList;import java.util.List;import org.springframework.boot.web.servlet.FilterRegistrationBean;import org.springframework.context.annotation.Bean;import org.springframework.context.annotation.Configuration;import cn.lijunkui.filters.UrlFilter;@Configurationpublic class FilterConfig { @Bean public FilterRegistrationBean filterRegistration() { FilterRegistrationBean registration = new FilterRegistrationBean(); registration.setFilter(new UrlFilter()); List urlList = new ArrayList(); urlList.add("/*"); registration.setUrlPatterns(urlList); registration.setName("UrlFilter"); registration.setOrder(1); return registration; }}
3、进行测试
启动spirngboot 项目 通过游览器访问我们的服务:
demo总结:springboot中自定义filter
1、我们需要编写Filter类实现Filter接口;同时定义 Filter的配置类。
2、配置类需要声明 @Configuration 注解,同时定义声明@Bean的方法。
3、然后将自定义filter添加到FilterRegistrationBean 中即可。
项目源码地址:
https://github.com/zhuoqianmingyue/springbootexamples