javaweb-filter

1 过滤器简介

filter也称之为过滤器，它是javaWeb三大组件之一（Servlet程序、Listener监听器、Filter过滤器）
Filter过滤器它是JavaEE的规范，也就是接口。
Servlet API中提供了一个Filter接口，开发web应用时，如果编写的Java类实现了这个接口，则把这个java类称之为过滤器Filter。
**作用：**既可以对请求进行拦截，也可以对响应进行处理。

常见场景：权限检查，日记操作、拦截请求、过滤操作、对请求字符设置编码。

2 Filter详细介绍

要想介绍filter，就必须介绍Filter中的三个方法。

    /**
     * web应用启动时，web服务器将创建Filter的实例对象，并调用init方法，读取web.xml的配置，完成对象的初始化功能，
     * 从而为后续的用户请求做好拦截的准备工作（filter对象只会创建一次，init方法也只会执行一次，开发人员通过init的参数，
     * 可或得代表当前filter配置信息的FilterConfig对象）
     * @param filterConfig
     * @throws ServletException
     */
    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
 
    }
 
    /**
     * 这个方法完成实际的过滤操作，当客户请求访问与过滤器相关联的URL的时候，Servlet过滤器将先执行doFilter方法，FilterChain参数用于访问后续过滤器
     * @param servletRequest
     * @param servletResponse
     * @param filterChain
     * @throws IOException
     * @throws ServletException
     */
    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
 
    }
 
    /**
     * filter创建后会保存在内存中，当web应用移除或者服务器停止时才销毁，该方法在Filter的生命周期中仅执行一次，在这个方法中，可以释放过滤器使用的资源
     */
    @Override
    public void destroy() {
 
    }

3.Filter的配置

1.注解式配置

在自定义的Filter类上使用注解@WebFilter(“/*”)

2.xml配置

• 在web.xml中进行过滤器的配置：

<!--过滤器的xml配置 -->
<filter> 
    <!--名称-->
    <filter-name>fi</filter-name>
     <!--过滤器类全称--> 
    <filter-class>com.it.web.filter.SecondFilter</filter-class> 
</filter> 
    <!--映射路径配-->
<filter-mapping>
   <!--名称--> 
   <filter-name>fi</filter-name> 
   <!--过滤的url匹配规则和Servlet的一模一样--> 
   <url-pattern>/</url-pattern>
</filter-mapping>

在配置中需要注意的有两处：一是指明过滤器类所在的包路径。二是处定义过滤器作用的对象。一般有以下规则：

在这里插入代码片

1：作用与所有web资源：<url—pattern>/。则客户端请求访问任意资源文件时都要经过过滤器过滤，通过则访问文件，否则拦截。
2：作用于某一文件夹下所有文件：<url—pattern>/dir/
3：作用于某一种类型的文件：<url—pattern>.扩展名。比如<url—pattern>.jsp过滤所有对jsp文件的访问请求。
4：作用于某一文件夹下某一类型文件：<url—pattern>/dir/*.扩展名
如果一个过滤器需要过滤多种文件，则可以配置多个，一个mapping定义一个url-pattern来定义过滤规则。

4 Filter的用法

1）自定义一个过滤器实现Filter接口、配置@WebFilter注解，配置拦截路径（也可通过web.xml配置）

@WebFilter(urlPatterns = "/*")
public class MyFilterOne implements Filter {
 
    /**
     * web应用启动时，web服务器将创建Filter的实例对象，并调用init方法，读取web.xml的配置，完成对象的初始化功能，
     * 从而为后续的用户请求做好拦截的准备工作（filter对象只会创建一次，init方法也只会执行一次，开发人员通过init的参数，
     * 可或得代表当前filter配置信息的FilterConfig对象）
     * @param filterConfig
     * @throws ServletException
     */
    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
 
    }
 
    /**
     * 这个方法完成实际的过滤操作，当客户请求访问与过滤器相关联的URL的时候，Servlet过滤器将先执行doFilter方法，FilterChain参数用于访问后续过滤器
     * @param servletRequest
     * @param servletResponse
     * @param filterChain
     * @throws IOException
     * @throws ServletException
     */
    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        System.out.println("我是过滤器，我进来了");
    }
 
    /**
     * filter创建后会保存在内存中，当web应用移除或者服务器停止时才销毁，该方法在Filter的生命周期中仅执行一次，在这个方法中，可以释放过滤器使用的资源
     */
    @Override
    public void destroy() {
 
    }
}

2）在启动类上加上@ServletComponentScan注解

@SpringBootApplication
@ServletComponentScan
public class SpringbootInterceptorApplication {
 
    public static void main(String[] args) {
        SpringApplication.run(SpringbootInterceptorApplication.class, args);
    }
 
}

3）controller：

@RestController
public class LoginController {
 
    @GetMapping("/test/filter")
    public String testFilter(){
        return "该请求被拦截了，但是在过滤器中已经放行了";
    }
}

直接浏览器访问：

控制台输出：发现该请求已经被过滤去拦截

5.多个Filter的执行顺序

如果一定要确保执行顺序，就要对配置进行修改了，执行顺序如下：

• 在web.xml中，filter执行顺序跟的顺序有关，先声明的先执行。
  使用注解配置的话，filter的执行顺序跟名称的字母顺序有关，例如AFilter会比BFilter先执行。
• 如果既有在web.xml中声明的Filter，也有通过注解配置的Filter，那么会优先执行web.xml中配置的Filter。

先执行带有url-pattern标签的filter，再执行带有servlet-name标签的filter
如果同为url-pattern或servlet-name，则会按照在web.xml中的声明顺序执行

6.Filter的生命周期

1、Filter的创建
Filter的创建和销毁由web服务器负责。 web应用程序启动时，web服务器将创建Filter的实例对象，并调用其init方法，完成对象的初始化功能，从而为后续的用户请求作好拦截的准备工作，filter对象只会创建一次，init方法也只会执行一次。通过init方法的参数，可获得代表当前filter配置信息的FilterConfig对象。

2、Filter的销毁
　web容器调用destroy方法销毁Filter。destroy方法在Filter的生命周期中仅执行一次。在destroy方法中，可以释放过滤器使用的资源。

3、FilterConfig接口
用户在配置filter时，可以使用为filter配置一些初始化参数，当web容器实例化Filter对象，调用其init方法时，会把封装了filter初始化参数的filterConfig对象传递进来。因此开发人员在编写filter时，通过filterConfig对象的方法，就可获得：

　　String getFilterName()：得到filter的名称。
　　String getInitParameter(String name)： 返回在部署描述中指定名称的初始化参数的值。如果不存在返回null.
　　Enumeration getInitParameterNames()：返回过滤器的所有初始化参数的名字的枚举集合。
　　public ServletContext getServletContext()：返回Servlet上下文对象的引用。

总结：

要想调用配置一个过滤器：

1）启动类上增加注解@ServletComponentScan

2）新建一个类使其实现Filter接口，并实现里面的三个方法

3）在新建类上加上@WebFilter()注解，配置需要拦截的规则

4）在doFilter方法中控制filterChain.doFilter(servletRequest, servletResponse)调用

原文链接：https://blog.csdn.net/qq_50652600/article/details/127308348