SpringBoot下，利用@WebFilter配置使用与注意Filter

最新推荐文章于 2024-07-25 19:52:57 发布

With_Her

最新推荐文章于 2024-07-25 19:52:57 发布

阅读量5.4w

点赞数 25

分类专栏： JAVA 文章标签： @WebFilter SpringBoot Filter

本文链接：https://blog.csdn.net/With_Her/article/details/82627620

版权

JAVA 专栏收录该内容

49 篇文章 0 订阅

订阅专栏

Filter简介

Filter也称之为过滤器，它是Servlet技术中最实用的技术，WEB开发人员通过Filter技术，对web服务器管理的所有web资源：例如JSP，Servlet，静态图片文件或静态HTML文件进行拦截，从而实现一些特殊功能。例如实现URL级别的权限控制、过滤敏感词汇、压缩响应信息等一些高级功能。

Filter工作原理

当客户端发出Web资源的请求时，Web服务器根据应用程序配置文件设置的过滤规则进行检查，若客户请求满足过滤规则，则对客户请求／响应进行拦截，对请求头和请求数据进行检查或改动，并依次通过过滤器链，最后把请求／响应交给请求的Web资源处理。请求信息在过滤器链中可以被修改，也可以根据条件让请求不发往资源处理器，并直接向客户机发回一个响应。当资源处理器完成了对资源的处理后，响应信息将逐级逆向返回。同样在这个过程中，用户可以修改响应信息，从而完成一定的任务。

服务器会按照过滤器定义的先后循序组装成一条链，然后一次执行其中的doFilter()方法。（注：这一点Filter和Servlet是不一样的）执行的顺序就如下图所示，执行第一个过滤器的chain.doFilter()之前的代码，第二个过滤器的chain.doFilter()之前的代码，请求的资源，第二个过滤器的chain.doFilter()之后的代码，第一个过滤器的chain.doFilter()之后的代码，最后返回响应。

SpringBoot利用@WebFilter配置Filter

第一步：利用@WebFilter创建Filter过滤器类
//@Component//无需添加此注解，在启动类添加@ServletComponentScan注解后，会自动将带有@WebFilter的注解进行注入！
@WebFilter(urlPatterns = "/lvjia/carbodyad/api/*", filterName = "rest0PubFilter")
@Order(1)//指定过滤器的执行顺序,值越大越靠后执行
public class Rest0PubFilter implements Filter {


    @Override
    public void init(FilterConfig filterConfig) {//初始化过滤器
         System.out.println("getFilterName:"+filterConfig.getFilterName());//返回<filter-name>元素的设置值。
         System.out.println("getServletContext:"+filterConfig.getServletContext());//返回FilterConfig对象中所包装的ServletContext对象的引用。
         System.out.println("getInitParameter:"+filterConfig.getInitParameter("cacheTimeout"));//用于返回在web.xml文件中为Filter所设置的某个名称的初始化的参数值
         System.out.println("getInitParameterNames:"+filterConfig.getInitParameterNames());//返回一个Enumeration集合对象。
    }

    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse,             
         FilterChain filterChain) throws IOException, ServletException {
         if(false){
             response.sendRedirect("http://localhost:8081/demo/test/login");//重定向
         }
         filterChain.doFilter(servletRequest, servletResponse);//doFilter将请求转发给过滤器链下一个filter , 如果没有filter那就是你请求的资源

 }

    @Override
    public void destroy() {
    }

}
@WebFilter常用属性

属性类型是否必需说明
asyncSupported boolean 否指定Filter是否支持异步模式
dispatcherTypes DispatcherType[] 否指定Filter对哪种方式的请求进行过滤。
支持的属性：ASYNC、ERROR、FORWARD、INCLUDE、REQUEST；
默认过滤所有方式的请求
filterName String 否 Filter名称
initParams WebInitParam[] 否配置参数
displayName String 否 Filter显示名
servletNames String[] 否指定对哪些Servlet进行过滤
urlPatterns/value String[] 否两个属性作用相同，指定拦截的路径

过滤器的urlPatterns的过滤路径规则：

1.全路径匹配： /abc/myServlet1.do

2.部分路径匹配： /abc/*

3.通配符匹配：/*

4.后缀名匹配：*.do (注意:前面不加/)

注意：
@WebFilter(urlPatterns = "/lvjia/carbodyad/api/*", filterName = "rest0PubFilter")
filterName的首字母一定要小写！！！小写！！！小写！！！
我因为这个，导致配置的多个过滤器拦截url都失效了！不管啥路径，全给我拦截到Filter里去了

属性	类型	是否必需	说明
asyncSupported	boolean	否	指定Filter是否支持异步模式
dispatcherTypes	DispatcherType[]	否	指定Filter对哪种方式的请求进行过滤。支持的属性：ASYNC、ERROR、FORWARD、INCLUDE、REQUEST；默认过滤所有方式的请求
filterName	String	否	Filter名称
initParams	WebInitParam[]	否	配置参数
displayName	String	否	Filter显示名
servletNames	String[]	否	指定对哪些Servlet进行过滤
urlPatterns/value	String[]	否	两个属性作用相同，指定拦截的路径

第二步;Application启动类添加@ServletComponentScan注解

@SpringBootApplication
@ServletComponentScan   //Servlet、Filter、Listener 可以直接通过 @WebServlet、@WebFilter、@WebListener 注解自动注册，无需其他代码。
public class Application {
	public static void main(String[] args) {
		SpringApplication.run(Application.class, args);
	}
}

至此，在SpringBoot内利用@WebFilter注解配置过滤器就ok了，确实比较快捷方便，除了@WebFilter方式，还有利用spring 的@Bean配置过滤器的方式，下次再补充进来、。

本文章主要以理解与使用为主，至于Filter的原理问题未进行深入探索，如有问题请及时留言交流。

参考文档：

https://blog.csdn.net/ethanq/article/details/7336938

https://blog.csdn.net/u013087513/article/details/56835894

https://blog.csdn.net/mytt_10566/article/details/70214640