文档章节

【杂谈】FilterChain相关知识整理

o
 osc_a22drz29
发布于 2019/03/21 21:22
字数 1422
阅读 10
收藏 0

钉钉、微博极速扩容黑科技,点击观看阿里云弹性计算年度发布会!>>>

前言

  做后台的,Filter肯定没少配置,但是知晓其原理的可能不多。在这之前我也不懂,但这并不影响业务开发,同时也有其他的知识要学,所以一直就没看。这阵子有点闲,刚好在看《How Tomcat Works》的PipeLine相关内容。索性好好梳理一下FilterChain相关的知识。

类图

FilterChain的作用

顾名思义,FilterChain就是一条过滤链。其中每个过滤器(Filter)都可以决定是否执行下一步。

过滤分两个方向,进和出:

进:在把ServletRequest和ServletResponse交给Servlet的service方法之前,需要进行过滤

出:在service方法完成后,往客户端发送之前,需要进行过滤

Filter的定义与配置

定义

一般,我们定义Filter类一般通过实现Filter接口来完成,然后在doFilter方法中编写自己的过滤逻辑。由于方法参数中有Filter对象所在FilterChain的引用,故可以控制过滤链的进行。但控制内容,只能是

1.向下执行

2.不向下执行。

配置

在老项目中,一般直接在web.xml文件中配置。利用<filter></filter>配置过滤器名称,类以及过滤器在链中的位置。

而在Spring Boot项目中,则可以通过FilterRegisterBean来配置过滤器。

FilterChain的执行原理

FilterChain的实现类是上图中的ApplicationFilterChain。一个ApplicationFilterChain对象包含几个主要参数

  • n  => filter个数
  • pos => 下一个要执行的filter的位置
  • Servlet  => 当pos >= n,即过滤完成时,调用Servlet的service方法,把请求交给Servlet
  • filters => Filter的相关配置信息

很多人,可能会疑惑,FilterChain是如何实现向下执行的。其实看到上面那些参数,你估计就已经明白了。即FilterChain持有所有Filter的配置信息,它们保存在一个数组中,然后通过移动pos,来获取后续的Filter并执行的。

触发方式:由上一个执行的Filter调用FilterChain的doFilter方法。

以下是ApplicationFilterChain的doFilter和internalDoFilter的源码

/**
     * Invoke the next filter in this chain, passing the specified request
     * and response.  If there are no more filters in this chain, invoke
     * the <code>service()</code> method of the servlet itself.
     *
     * @param request The servlet request we are processing
     * @param response The servlet response we are creating
     *
     * @exception IOException if an input/output error occurs
     * @exception ServletException if a servlet exception occurs
     */
    @Override
    public void doFilter(ServletRequest request, ServletResponse response)
        throws IOException, ServletException {

        if( Globals.IS_SECURITY_ENABLED ) {
            final ServletRequest req = request;
            final ServletResponse res = response;
            try {
                java.security.AccessController.doPrivileged(
                    new java.security.PrivilegedExceptionAction<Void>() {
                        @Override
                        public Void run()
                            throws ServletException, IOException {
                            internalDoFilter(req,res);
                            return null;
                        }
                    }
                );
            } catch( PrivilegedActionException pe) {
                Exception e = pe.getException();
                if (e instanceof ServletException)
                    throw (ServletException) e;
                else if (e instanceof IOException)
                    throw (IOException) e;
                else if (e instanceof RuntimeException)
                    throw (RuntimeException) e;
                else
                    throw new ServletException(e.getMessage(), e);
            }
        } else {
            internalDoFilter(request,response);
        }
    }

    private void internalDoFilter(ServletRequest request,
                                  ServletResponse response)
        throws IOException, ServletException {

        // Call the next filter if there is one
        if (pos < n) {
            ApplicationFilterConfig filterConfig = filters[pos++];
            try {
                Filter filter = filterConfig.getFilter();

                if (request.isAsyncSupported() && "false".equalsIgnoreCase(
                        filterConfig.getFilterDef().getAsyncSupported())) {
                    request.setAttribute(Globals.ASYNC_SUPPORTED_ATTR, Boolean.FALSE);
                }
                if( Globals.IS_SECURITY_ENABLED ) {
                    final ServletRequest req = request;
                    final ServletResponse res = response;
                    Principal principal =
                        ((HttpServletRequest) req).getUserPrincipal();

                    Object[] args = new Object[]{req, res, this};
                    SecurityUtil.doAsPrivilege ("doFilter", filter, classType, args, principal);
                } else {
                    filter.doFilter(request, response, this);
                }
            } catch (IOException | ServletException | RuntimeException e) {
                throw e;
            } catch (Throwable e) {
                e = ExceptionUtils.unwrapInvocationTargetException(e);
                ExceptionUtils.handleThrowable(e);
                throw new ServletException(sm.getString("filterChain.filter"), e);
            }
            return;
        }

        // We fell off the end of the chain -- call the servlet instance
        try {
            if (ApplicationDispatcher.WRAP_SAME_OBJECT) {
                lastServicedRequest.set(request);
                lastServicedResponse.set(response);
            }

            if (request.isAsyncSupported() && !servletSupportsAsync) {
                request.setAttribute(Globals.ASYNC_SUPPORTED_ATTR,
                        Boolean.FALSE);
            }
            // Use potentially wrapped request from this point
            if ((request instanceof HttpServletRequest) &&
                    (response instanceof HttpServletResponse) &&
                    Globals.IS_SECURITY_ENABLED ) {
                final ServletRequest req = request;
                final ServletResponse res = response;
                Principal principal =
                    ((HttpServletRequest) req).getUserPrincipal();
                Object[] args = new Object[]{req, res};
                SecurityUtil.doAsPrivilege("service",
                                           servlet,
                                           classTypeUsedInService,
                                           args,
                                           principal);
            } else {
                servlet.service(request, response);
            }
        } catch (IOException | ServletException | RuntimeException e) {
            throw e;
        } catch (Throwable e) {
            e = ExceptionUtils.unwrapInvocationTargetException(e);
            ExceptionUtils.handleThrowable(e);
            throw new ServletException(sm.getString("filterChain.servlet"), e);
        } finally {
            if (ApplicationDispatcher.WRAP_SAME_OBJECT) {
                lastServicedRequest.set(null);
                lastServicedResponse.set(null);
            }
        }
    }

FilterChain的执行结构

doFilter1 { //Filter1的doFilter方法
    ...
    doFilter2 { //Filter2的doFilter方法
        ...
        doFilter3 {
            ...
            doFilterN {
                ...
                service(request, response);
            }
        }
    }
    operation1();
}

对于CoyoteAdapter来说,它只调用了一次FilterChain的doFilter方法。这个方法内部到底执行了什么,它不知道,它只知道当这个方法返回的时候,它就把响应内容返回给客户端。

在这个doFilter内部嵌套执行多个Filter的doFilter方法,结构有点类似递归。如上,当所有Filter都完成的时候,会调用Servlet的service方法。最后逐层返回,执行完operaion1()。FilterChain的调用就算完成了。

不调用service的情况

可能出现在chain中的某个环节检测到,请求不合规。则可以直接返回,而不用执行doFilter方法。也就不会交给servlet执行。

那必要的提示信息怎么办?

在实际应用中可能要告知用户的违规情况,这其实挺简单的。因为在doFilter方法中,request和response的引用已经有了,直接操作response就可以了。比如你要返回一个JSON格式的错误信息。你就可以在Repsonse的OutputStream中写入相应的JSON字符串。然后设置Content-Type为application/json,设置Content-Length为字符串的长度。直接返回就可以了。

FilterChain对象与请求的关系

看到上面移动pos(本质上就是++操作),估计有人会跟我一样想到线程安全问题,即FilterChain是否会存在多线程访问的情况。如果存在多线程访问,由于每个线程的过滤进度可能都不一样,必然会互相干扰。

答案是这样,每个请求都会创建一个新的FilterChain对象。

注意:Filter配置是针对整个Web项目的,而每个FilterChain对象是针对每个请求的。

我是怎么知道的?

猜测加验证。即定位ApplicationFilterChain的创建操作即可。ApplicationFilterChain对象由ApplicationFilterFactory工厂的createFilterChain方法生成。而这个方法在ApplicationDispatcher的invoke方法内被调用。这个invoke方法是Connector把新请求传递给Container的方式。

责任链模式

FilterChain就是典型的责任链模式的实现案例。类似的还有,Tomcat的Pipeline Task,Netty的ChannelPipeline.

 

o
粉丝 0
博文 500
码字总数 0
作品 0
私信 提问
加载中
请先登录后再评论。
【杂谈】当前知识蒸馏与迁移学习有哪些可用的开源工具?

本文分享自微信公众号 - 有三AI(yanyousanai)。 如有侵权,请联系 support@oschina.cn 删除。 本文参与“OSC源创计划”,欢迎正在阅读的你也加入,一起分享。...

言有三
2019/12/24
0
0
【年终总结】2019年有三AI做了什么,2020年我们要做什么?

本文分享自微信公众号 - 有三AI(yanyousanai)。 如有侵权,请联系 support@oschina.cn 删除。 本文参与“OSC源创计划”,欢迎正在阅读的你也加入,一起分享。...

言有三
2019/12/31
0
0
【杂谈】除了生成图像(造假),GAN如何给目标检测,图像分割,图像增强等问题打辅助?

本文分享自微信公众号 - 有三AI(yanyousanai)。 如有侵权,请联系 support@oschina.cn 删除。 本文参与“OSC源创计划”,欢迎正在阅读的你也加入,一起分享。...

言有三
03/07
0
0
【杂谈】为了让大家学好深度学习模型设计和优化,有三AI都做了什么

本文分享自微信公众号 - 有三AI(yanyousanai)。 如有侵权,请联系 support@oschina.cn 删除。 本文参与“OSC源创计划”,欢迎正在阅读的你也加入,一起分享。...

言有三
02/04
0
0
【知识星球】这几年人脸都有哪些有意思的数据集?

本文分享自微信公众号 - 有三AI(yanyousanai)。 如有侵权,请联系 support@oschina.cn 删除。 本文参与“OSC源创计划”,欢迎正在阅读的你也加入,一起分享。...

言有三
03/08
0
0

没有更多内容

加载失败,请刷新页面

加载更多

react+antd form 警告Warning: [antd: Form.Item] `children` is array of render props cannot have `name`.

如题所示,该警告出现在react与antd使用中,我们页面表单form中使用了Form.Item包含输入框,在username输入框的下面,加入了一行提示文字,代码如下: import React from 'react'import {Ca...

osc_ct0tt1cu
26分钟前
8
0
电子垃圾:物联网的另一面

云栖号资讯:【点击查看更多行业资讯】 在这里您可以找到不同行业的第一手的上云资讯,还在等什么,快来! 我们所知道的世界与过去相比已经发生了巨大的变化,并通过技术继续发展。然而,这种...

osc_zls6dx9i
27分钟前
16
0
「数据库」sql刷题(No.1)

喜欢就 关注 我们吧! 简介: Hello 各位 ,我是公号「八点半技术站」的创作者 - Bruce.D (姓氏:豆)。 感谢微信给予的个人认证,专注于PHP、数据库技术领域知识经验分享。 技术的交流、不...

八点半的Bruce丶D
前天
10
0
UiPath获2.25亿美元E轮融资

在24个月的时间里,该RPA与AI领导企业的年度经常性收入从1亿美元增长到超过4亿美元;计划推进市场领先的超自动化平台,扩展云产品线 纽约--(美国商业资讯)--机器人流程自动化(RPA)软件领导...

osc_icwhzig7
29分钟前
16
0
Linux 选择内存分配机制

osc_gh0ost1g
29分钟前
22
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部