前言:本博文主要是对filter学习的总结,一则巩固所学知识,二则方便本人和大家查看相关知识。

一、Filter的作用

Filter 过滤器,在我们的日常生活中并不陌生,常见的有空气净化器,水过滤器等等。如下图所示,就是一个水过滤器,可以看到它分为了很多层,每一层都发挥不同的作用,有的过滤水中比较大的,可见的颗粒杂质;有的吸附比较小的看不见的微粒;有的层杀死病菌等等。

Java EE 中的Filter过滤器,也发挥着类似的作用,它可以拦截请求和响应,进行一些业务逻辑需要的处理。

java sso 过滤器 javaee过滤器_java sso 过滤器

参考官方文档:Java EE 7

public interface Filter

A filter is an object that performs filtering tasks on either the request to a resource (a servlet or static content), or on the response from a resource, or both.

Filters perform filtering in the doFilter method. Every Filter has access to a FilterConfig object from which it can obtain its initialization parameters, and a reference to the ServletContext which it can use, for example, to load resources needed for filtering tasks.

Filters are configured in the deployment descriptor of a web application.

Examples that have been identified for this design are:

  1. Authentication Filters
  2. Logging and Auditing Filters
  3. Image conversion Filters
  4. Data compression Filters
  5. Encryption Filters
  6. Tokenizing Filters
  7. Filters that trigger resource access events
  8. XSL/T filters
  9. Mime-type chain Filter

主要内容:

Filter对象可以对请求和响应执行过滤任务。请求的资源可能是servlet或者静态资源,例如html文档、图片、音频、视频等等。

需要在部署描述符web.xml中配置该组件,才可以生效。这一点和servlet组件相同。

(了解即可)使用案例包含:身份验证过滤器、日志记录和审计过滤器、图像转换过滤器 、数据压缩过滤器 、加密的过滤器 、分过滤器 、触发资源访问事件的过滤器 、XSL / T过滤器 、mime类型过滤器链

其执行流程如下图所示:

每个请求,先经过若干过滤器的拦截处理,最后到达资源。资源将处理结果放入响应,然后,按照和请求相反的顺序经过若干过滤器拦截处理,最后返回给客户端。

java sso 过滤器 javaee过滤器_优先级_02

如果我注释掉response.setCharacterEncoding("UTF-8"); 这句,会如何呢?参考官方文档:If no character encoding has been specified, ISO-8859-1 is returned.如果没有指定字符编码,会使用默认的ISO-8859-1。我们知道Java的字符串基于Unicode字符集 (字符集和编码是有区别的,参见区别) 而ISO-8859-1编码的字符集中不存在中文,因此Unicode字符集表示的中文在ISO-8859-1编码的字符集中找不到对应的字符,一般字符集转换找不到对应字符,会使用 “?"代替该字符。我代码中的字符串是”你好,世界",这5个Unicode字符,最终转换为ISO-8859-1的"?????”这里我把页面的编码设置为ISO-8859-1,显示5个问号,这是容易理解的,因为这5个问号的编码本来就是ISO-8859-1。如果我改为GBK呢?同样也是显示5个问号,因为ISO-8859-1编码的字符集中的英文问号在GBK编码的字符集里可以找到,假设找不到,会显示GBK找不到对应字符时的特殊符号。所以,乱码和显示?的原因是不同的! 扯得有点远了,但是可以理解本部分内容对解决乱码问题大有裨益。回归正题。

(3) 通过注解配置组件

这种配置方式,虽然使用起来特别方便,但是不利于维护。如果向更改某些配置,必须重新编译,发布项目,耦合性高。只适合小型项目,或者用于学习、测试Servlet、Filter等组件的功能。

大型项目建议使用web.xml文件配置组件,耦合性低。修改配置,只需修改配置文件,再重启服务器即可。

配置Servlet注解

@WebServlet(urlPatterns = "/helloServlet")
public class HelloServlet extends HttpServlet {
	...
}

配置Filter注解

@WebFilter(urlPatterns = "/*")
public class MimeTypeFilter implements Filter {
	...
}

3、初始化函数的参数

和Servlet一样,我们可以配置Filter的初始化参数。假设一个使用场景,我们的网站支持不同的语言,因此响应对象的字符编码类型不能“写死”,必须是可以动态修改的。

以下示例仅仅用于参数的使用方法,实际可能并不实用。

web.xml文件中的配置

<filter>
  <filter-name>mimeTypeFilter</filter-name>
  <filter-class>com.company.filter.MimeTypeFilter</filter-class>
  <init-param>
    <param-name>language-en</param-name>
    <param-value>ISO-8859-1</param-value>
  </init-param>
  <init-param>
    <param-name>language-cn</param-name>
    <param-value>GBK</param-value>
  </init-param>
</filter>

java 代码

private FilterConfig filterConfig;
    
    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        this.filterConfig = filterConfig;
    }

	// doFilter方法,根据请求的信息,灵活选择使用的编码

4. urlPattern 的设置 (重点)

urlPattern表示Filter可以拦截处理的请求,主要有三种形式:

  1. /index.jsp 精准匹配
  2. /servlet/* 前缀模糊匹配
  3. *.jsp 后缀模糊匹配

2和3可以组合使用。

我们上文中设置HelloServlet的urlPattern为/helloSerlet,其实也可以设置为 / ,则表示我们的servlet为默认资源。同时Filter的urlPattern设置为/ 相当于精准匹配默认资源Servlet。如果我们的项目中存在index.jsp文件,默认资源冲突,index.jsp优先级高,会优先访问index.jsp。默认资源Servlet失效了或者说访问不到了。

那么Filter的urlPattern设置为/,会拦截默认资源index.jsp?答案是否定的,它只会拦截默认资源Servlet,要想拦截index.jsp,可以设置urlPattern为/index.jsp 等等。

5. 过滤链

(1)执行过程

其执行过程如下图所示,如果Filter中没有调用

java sso 过滤器 javaee过滤器_Filter_03


FilterChain.doFilter(ServletRequest,ServletResponse)方法,则会直接返回,不会向下传递了。

java sso 过滤器 javaee过滤器_过滤器_04

(2) Filter优先级

web.xml配置方式的优先级,由filter-mapping在web.xml文件中定义的先后顺序决定。

<filter-mapping>
    <filter-name>mimeTypeFilter</filter-name>
    <url-pattern>/*</url-pattern>
  </filter-mapping>

注解方式的优先级,是根据类名在字母表中的先后顺序决定的。例如
FilterA > FilterB>FilterC,不可能为了优先级而给类名起这种奇怪的名字,仅仅了解就可以了。实际还是使用web.xml配置。