springboot 通过@WebFilter(urlPatterns )配置Filter过滤路径

springboot 通过@WebFilter(urlPatterns )配置Filter过滤路径，没有配置/*，输入任何路径都能进过滤器
2019年04月25日 12:51:33 peigui.huang 阅读数 1005
版权声明：本文为博主原创文章，遵循 CC 4.0 by-sa 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/huangpeigui/article/details/89513769
 @Slf4j
@Component
@ServletComponentScan
@WebFilter(urlPatterns = {"/config/*","/driver/*","/order/*","/im/*","/privacy/*","/config/*"}, filterName = "apiFilter")
public class SecurityRequestFilter implements Filter {
}
以上代码，urlPatterns 没有指名要过滤“/”根路径，但是在输入http://localhost:8080/之后，却能进入filter。

启动打印日志如下：

 观察日志可以看出，注册的过滤器除了使用filterName = "apiFilter"显示注册的外，还隐试注册了一个以类名首字母为小写的过滤器（securityRequestFilter ）

解决方法：将 filterName = "apiFilter" 修改为 filterName = "securityRequestFilter"，覆盖掉隐试注册的过滤器，这样就可以避免注册多个过滤器。从而解决输入任何路径都能进过滤器的问题。

__________________________________________________________________________

https://www.jianshu.com/p/05c8be17c80a

前言

以往的javaEE增加Filter是在web.xml中配置，然而spring-boot中很明显不能这样实现，那怎么办呢？看完下面的教程，答案自然知道了。

前言

传统的javaEE增加Filter是在web.xml中配置，如以下代码：

<filter>
     <filter-name>TestFilter</filter-name>
        <filter-class>com.cppba.filter.TestFilter</filter-class>
</filter>
<filter-mapping>
    <filter-name>TestFilter</filter-name>
    <url-pattern>/*</url-pattern>
    <init-param>
       <param-name>paramName</param-name>
       <param-value>paramValue</param-value>
    </init-param>
</filter-mapping>

然而spring-boot中很明显不能这样实现，那怎么办呢？看完下面的教程，答案自然知道了。

---

老方法（新方法请直接下拉）

1.创建自定义Filter

package com.cppba.filter;

import javax.servlet.*;
import java.io.IOException;

public class TestFilter implements Filter {
    @Override
    public void init(FilterConfig filterConfig) throws ServletException {

    }

    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain)
            throws IOException, ServletException {
        System.out.println("TestFilter");
    }

    @Override
    public void destroy() {

    }
}

2.在ApplicationConfiguration.java中增加一个@bean

 @Bean
    public FilterRegistrationBean testFilterRegistration() {

        FilterRegistrationBean registration = new FilterRegistrationBean();
        registration.setFilter(new TestFilter());
        registration.addUrlPatterns("/*");
        registration.addInitParameter("paramName", "paramValue");
        registration.setName("testFilter");
        registration.setOrder(1);
        return registration;
    }

3.启动项目

你会看到控制台打印如下代码：

 

https://github.com/bigbeef/cppba-spring-boot

4.访问项目

最后我们访问以下http://127.0.0.1:8080/test
如果你看到控制台打印出:TestFilter

 

https://github.com/bigbeef/cppba-spring-boot

恭喜你，配置成功！

---

2017-04-20 最新spring-boot增加Filter方法

首先定义一个Filter

@Order(1)
//重点
@WebFilter(filterName = "testFilter1", urlPatterns = "/*")
public class TestFilterFirst implements Filter {
    @Override
    public void init(FilterConfig filterConfig) throws ServletException {

    }

    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain)
            throws IOException, ServletException {
        System.out.println("TestFilter1");
        filterChain.doFilter(servletRequest,servletResponse);
    }

    @Override
    public void destroy() {

    }
}

比较核心的代码是自定义类上面加上@WebFilter，其中@Order注解表示执行过滤顺序，值越小，越先执行

我们在spring-boot的入口处加上如下注解@ServletComponentScan：

@SpringBootApplication(scanBasePackages = "com.cppba")
//重点
@ServletComponentScan
public class Application {
    public static void main(String[] args) throws UnknownHostException {
        SpringApplication app = new SpringApplication(Application.class);
        Environment environment = app.run(args).getEnvironment();
    }
}

这种方法效果和上面版本一样，但是用起来更加方便！

____________________________________________________________________________________

Web 过滤器参数设置问题

Posted on 2017-09-06 22:00 耍流氓的兔兔 阅读(197) 评论(0) 编辑 收藏

问题描述：

在代码定义了3个过滤器，分别为filter1，filter2，filter3，过滤的Servlet范围分别是"/*"，"/Servlet1"，"/Servlet1"，只在filter3种配置了初始化参数

预设结果为：

　　　　filter1...进...
　　　　filter2...进...
　　　　filter3...进...
　　　　com.roxy_filter.Filter3
　　　　hello
　　　　filter3...出...
　　　　filter2...出...
　　　　filter1...出...

　

　运行结果却是：

　　　　filter1...进...
　　　　filter2...进...
　　　　filter2...出...
　　　　filter1...出...

问题代码：

@WebFilter(filterName="filter3", servletNames="/Servlet1",
        initParams={
                @WebInitParam(name="ok", value="hello")
    }
) 

public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {

　　System.out.println("filter3...进...");

　　System.out.println(Thread.currentThread().getStackTrace()[1].getClassName());
　　String v = fConfig.getInitParameter("ok");
　　System.out.println(v);

　　chain.doFilter(request, response);

　　System.out.println("filter3...出...");
}

问题分析：

首先将filter3的@WebFilter声明改为和filter2一致，输出正常，说明doFilter()方法没有问题

仔细查看文档，发现有两个参数：
　　servletNames String[]：指定过滤器将应用于哪些 Servlet。取值是 @WebServlet 中的 name 属性的取值，或者是 web.xml 中 <servlet-name> 的取值

　　urlPatterns ：指定要过滤的URL模式,也可使用属性value来声明.(指定要过滤的URL模式是必选属性)

所以将servletNames="/Servlet1"改为urlPatterns ="/Servlet1"，表明只对Servlet1进行过滤，运行，结果正确

问题解决：

@WebFilter(filterName="filter3", urlPattens="/Servlet1",
        initParams={
                @WebInitParam(name="ok", value="hello")
    }
) 

问题总结：

web3.0 之后，对于servlet，filter，listener有两种配置方式，一种是在web.xml种进行传统的配置，另一种是直接在类种进行注解式声明

@WebFilter 用于将一个类声明为过滤器，该注解将会在部署时被容器处理，容器将根据具体的属性配置将相应的类部署为过滤器。该注解具有下表给出的一些常用属性 ( 以下所有属性均为可选属性，但是 value、urlPatterns、servletNames 三者必需至少包含一个，且 value 和 urlPatterns 不能共存，如果同时指定，通常忽略 value 的取值 )

属性名	类型	描述
filterName	String	指定过滤器的 name 属性，等价于 <filter-name>
value	String[]	该属性等价于 urlPatterns 属性。但是两者不应该同时使用
urlPatterns	String[]	指定一组过滤器的 URL 匹配模式。等价于 <url-pattern> 标签
servletNames	String[]	指定过滤器将应用于哪些 Servlet。取值是 @WebServlet 中的 name 属性的取值，或者是 web.xml 中 <servlet-name> 的取值
dispatcherTypes	DispatcherType	指定过滤器的转发模式。具体取值包括： ASYNC、ERROR、FORWARD、INCLUDE、REQUEST
initParams	WebInitParam[]	指定一组过滤器初始化参数，等价于 <init-param> 标签
asyncSupported	boolean	声明过滤器是否支持异步操作模式，等价于 <async-supported> 标签
description	String	该过滤器的描述信息，等价于 <description> 标签
displayName	String	过滤器的显示名，通常配合工具使用，等价于 <display-name> 标签