JavaWeb 过滤器(Filter)

什么是过滤器Filter

Servlet API中提供了一个Filter接口,开发web应用时,如果编写的Java类实现了这个接口,则把这个java类称之为过滤器Filter。通过Filter技术,开发人员可以实现用户在访问某个目标资源之前,对访问的请求和响应进行拦截。

简单说,过滤器实际上就是对web资源进行拦截,做一些处理后再交给下一个过滤器或servlet处理。通常都是用来拦截request进行处理的,也可以对返回的response进行拦截处理。

过滤器Filter的具体流程图

具体流程图如下:

java 过滤器 设置不过滤 java中过滤器_java

过滤器的应用场景

  • 自动登录
  • 统一设置编码格式
  • 访问权限控制
  • 敏感字符过滤等

如何创建过滤器Filter

两种方法:

第一种:IDEA自动创建

java 过滤器 设置不过滤 java中过滤器_java_02

java 过滤器 设置不过滤 java中过滤器_javaweb_03

在web.xml里面配置:

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_4_0.xsd"
         version="4.0">
    <filter>
        <filter-name>CharsetFilter</filter-name>
        <filter-class>com.hang.filter.CharsetFilter</filter-class>
    </filter>
    <filter-mapping>
        <filter-name>CharsetFilter</filter-name>
        <url-pattern>/*</url-pattern>
    </filter-mapping>
</web-app>

第二种方法:

创建一个普通类实现Filter接口,注意是 javax.servlet包下的

java 过滤器 设置不过滤 java中过滤器_java_04

@WebFilter(filterName = "CharsetFilter")
public class CharsetFilter implements Filter {

    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        /*初始化方法  接收一个FilterConfig类型的参数 该参数是对Filter的一些配置*/
    }

    @Override
    public void doFilter(ServletRequest req, ServletResponse resp, FilterChain chain) throws IOException, ServletException {
        /*过滤方法 主要是对request和response进行一些处理,然后交给下一个过滤器或Servlet处理*/

        chain.doFilter(req, resp);//交给下一个过滤器或servlet处理
    }

    @Override
    public void destroy() {
        /*销毁时调用*/
    }
}

关于注解@WebFilter

@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface WebFilter {
    String description() default ""; //添加描述信息
    String displayName() default "";
    WebInitParam[] initParams() default {}; // 配置初始化参数,跟Servlet配置一样
    String filterName() default ""; // 定义Filter名字
    String smallIcon() default "";
    String largeIcon() default "";
    String[] servletNames() default {};
    String[] value() default {};
    String[] urlPatterns() default {}; // 配置要拦截的资源
    DispatcherType[] dispatcherTypes() default {DispatcherType.REQUEST}; // 配置拦截的类型,可配置多个。默认为DispatcherType.REQUEST
    boolean asyncSupported() default false;
}

// DispatcherType是个枚举类型,有下面几个值
FORWARD,// 转发
INCLUDE,// 包含在页面
REQUEST,// 请求
ASYNC,  // 异步
ERROR;  // 出错

对过滤器进行补充

@WebFilter(filterName = "CharsetFilter",
        urlPatterns = "/*",/*通配符(*)表示对所有的web资源进行拦截*/
        initParams = {
                @WebInitParam(name = "charset", value = "utf-8")/*这里可以放一些初始化的参数*/
        })
public class CharsetFilter implements Filter {

    private String charset;

    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        /*初始化方法  接收一个FilterConfig类型的参数 该参数是对Filter的一些配置*/
        charset = filterConfig.getInitParameter("charset");
        String filterName = filterConfig.getFilterName();
        System.out.println("我被初始化了!");
        System.out.println("初始化过滤器名称:" + filterName);
        System.out.println("初始化Param:" + charset);
    }

    @Override
    public void doFilter(ServletRequest req, ServletResponse resp, FilterChain chain) throws IOException, ServletException {
        /*过滤方法 主要是对request和response进行一些处理,然后交给下一个过滤器或Servlet处理*/
        System.out.println("我在工作ing");
        req.setCharacterEncoding(charset);
        resp.setCharacterEncoding(charset);
        chain.doFilter(req, resp);//交给下一个过滤器或servlet处理
    }

    @Override
    public void destroy() {
        /*销毁时调用*/
        System.out.println("我被销毁了!");
    }
}

查看运行结果

java 过滤器 设置不过滤 java中过滤器_xml_05

过滤器是在服务器启动时就会创建的,只会创建一个实例,常驻内存,也就是说服务器一启动就会执行Filter的init(FilterConfig config)方法。当Filter被移除或服务器正常关闭时,会执行destroy方法

Filter执行顺序问题

在我们的请求到达Servle之间是可以经过多个Filter的,一般来说,建议Filter之间不要有关联,各自处理各自的逻辑即可。这样,我们也无需关心执行顺序问题。

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

  1. 在web.xml中,filter执行顺序跟<filter-mapping>的顺序有关,先声明的先执行
  2. 使用注解配置的话,filter的执行顺序跟名称的字母顺序有关,例如AFilter会比BFilter先执行
  3. 如果既有在web.xml中声明的Filter,也有通过注解配置的Filter,那么会优先执行web.xml中配置的Filter