Filter的使用技巧

Filter

　　Filter 技术是servlet 2.3 新增加的功能.servlet2.3是sun公司与2000年10月发布的,它的开发者包括许多个人和公司团体,充分体现了sun公司所倡导的代码开放性原则.由于众多的参与者的共同努力,servlet2.3比以往功能都强大了许多,而且性能也有了大幅提高.
　　它新增加的功能包括:
　　1. 应用程序生命周期事件控制;
　　2. 新的国际化;
　　3. 澄清了类的装载规则;
　　4. 新的错误及安全属性;
　　5. 不赞成使用HttpUtils 类;
　　6. 各种有用的方法;
　　7. 阐明并扩展了几个servlet DTD;
　　8. filter功能.
　　其中最重要的就是filter功能.它使用户可以改变一个request和修改一个response. Filter 不是一个servlet,它不能产生一个response,它能够在一个request到达servlet之前预处理request,也可以在离开servlet时处理response.换种说法,filter其实是一个”servlet chaining”(servlet 链).一个filter 包括:
　　1. 在servlet被调用之前截获;
　　2. 在servlet被调用之前检查servlet request;
　　3. 根据需要修改request头和request数据;
　　4. 根据需要修改response头和response数据;
　　5. 在servlet被调用之后截获.
　　你能够配置一个filter 到一个或多个servlet;单个servlet或servlet组能够被多个filter 使用.几个实用的filter 包括:用户辨认filter,日志filter,审核filter,加密filter,符号filter,能改变xml内容的XSLT filter等.
　　一个filter必须实现javax.servlet.Filter接口并定义三个方法:
　　1.void setFilterConfig(FilterConfig config) //设置filter 的配置对象;
　　2. FilterConfig getFilterConfig() //返回filter的配置对象;
　　3. void doFilter(ServletRequest req, ServletResponse res, FilterChain chain) //执行filter 的工作.
　　服务器每次只调用setFilterConfig方法一次准备filter 的处理;调用doFilter方法多次以处理不同的请求.FilterConfig接口有方法可以找到filter名字及初始化参数信息.服务器可以设置FilterConfig为空来指明filter已经终结.
　　每一个filter从doFilter()方法中得到当前的request及response.在这个方法里,可以进行任何的针对request及response的操作.(包括收集数据,包装数据等).filter调用chain.doFilter()方法把控制权交给下一个filter.一个filter在doFilter()方法中结束.如果一个filter想停止request处理而获得对response的完全的控制,那它可以不调用下一个filter.
　　一个filter可以包装request 或response以改变几个方法和提供用户定制的属性.Api2.3提供了HttpServletRequestWrapper 和HttpServletResponseWrapper来实现.它们能分派最初的request和response.如果要改变一个方法的特性,必须继承wapper和重写方法.下面是一段简单的日志filter用来记录所有request的持续时间.
　　public class LogFilter implements Filter {
　　FilterConfig config;
　　public void setFilterConfig(FilterConfig config) {
　　this.config = config;
　　}
　　public FilterConfig getFilterConfig() {
　　return config;
　　}
　　public void doFilter(ServletRequest req,
　　ServletResponse res,
　　FilterChain chain) {
　　ServletContext context = getFilterConfig().getServletContext();
　　long bef = System.currentTimeMillis();
　　chain.doFilter(req, res); // no chain parameter needed here
　　long aft = System.currentTimeMillis();
　　context.log("Request to " + req.getRequestURI()
　　+ ": " + (aft-bef));
　　}
　　}
　　当server调用setFilterConfig(),filter保存config信息.在doFilter()方法中通过config信息得到servletContext.如果要运行这个filter,必须去配置到web.xml中.以tomcat4.01为例:
　　<filter>
　　<filter-name>
　　log //filter 名字
　　</filter-name>
　　<filter-class>
　　LogFilter //filter class(上例的servlet)
　　</filter-class>
　　</filter>
　　<filter-mapping>
　　<filter-name>log</filter-name>
　　<servletname>servletname</servlet-name>
　　</filter-mapping>
　　<servlet>
　　<servlet-name>servletname</servletname>
　　<servletclass>servletclass</servlet-class>
　　</servlet>
　　<servlet-mapping>
　　<servlet-name>servletname</servlet-name>
　　<url-pattern>*</url-pattern>
　　</servlet-mapping>
　　把这个web.xml放到web-inf中(详请参考tomcat帮助文档).
　　当每次请求一个request时(如index.jsp),先到LogFilter中去并调用doFilter()方法,然后才到各自的servlet中去.如果是一个简单的servlet(只是一个页面,无任何输出语句),那么可能的输出是:
　　Request to /index.jsp: 10
　　Filter是一个COM组件，由一个或多个Pin组成。Pin也是一个COM组件。Filter文件的扩展名为.ax，但也可以是.dll。Filter根据其包含Input pin或Output pin的情况（或在Filter Graph的位置），大致可分为三类：Source Filter(仅有Output pin)、Transform Filter(同时具有Input pin和Output pin)和Renderer Filter(仅有Input pin)。
　　一般情况下，创建Filter使用一个普通的Win32 DLL项目。而且，一般Filter项目不使用MFC。这时，应用程序通过CoCreateInstance函数Filter实例；Filter与应用程序在二进制级别的协作。另外一种方法，也可以在MFC的应用程序项目中创建Filter。这种情况下，Filter不需注册为COM组件，Filter与应用程序之间的协作是源代码级别的；创建Filter实例，不再使用CoCreateInstance函数，而是直接new出一个Filter对象，如下：
　　m_pFilterObject = new CFilterClass();
　　// make the initial refcount 1 to match COM creation
　　m_pFilterObject ->AddRef();
　　因为Filter的基类实现了对象的引用计数，所以即使在第二种情况下，对创建后的Filter对象的操作也完全可以遵循COM标准。
　　Filter是一个独立功能模块，最好不要将Filter依赖于其他第三方的DLL。因为Filter具有COM的位置透明性特点，Filter文件可以放在硬盘的任何位置，只要位置移动后重新注册。但此时，如果Filter依赖其他DLL，则Filter对该DLL的定位就会出现问题。
　　Filter不能脱离Filter Graph单独使用。所以，如果你想绕过Filter Graph直接使用Filter实现的模块功能，请将你的Filter移植成DMO（DirectX Media Object）。对于DirectShow应用程序开发者来说，还有一点，请不要忘记使用OleInitialize进行初始化。
　　2. Filter的注册
　　Filter是COM组件，所以在使用前一定要注册。Filter的注册程序为regsvr32.exe。如果带上命令行参数/u，表示注销；如果带上是/s，表示不弹出任何注册/注销成功与否的提示对话框。如果你想在Build Filter项目的时候进行自动注册，请在VC的Project settings的Custom Build页如下设置：
　　Description: Register filter
　　Commands: regsvr32 /s /c $(TargetPath)
　　echo regsvr32 exe.time > $(TargetDir)/$(TargetName).trg
　　Outputs: $(TargetDir)/$(TargetName).trg
　　Filter的注册信息包括两部分：基本的COM信息和Filter信息。注册信息都存放在注册表中。前者的位置为：HKEY_CLASSES_ROOT/CLSID/Filter Clsid/，后者的位置为：HKEY_CLASSES_ROOT/CLSID/Category/Instance/ Filter Clsid/。COM信息标示了Filter是一个标准的可以通过CoCreateInstance函数创建的COM组件，Filter信息标示了我们通过Graphedit看到的描述这个Filter的信息。如果你不想让Graphedit看到（或者让Filter枚举器找到）你写的Filter，你完全可以不注册Filter信息。而且不用担心，你这么做也完全不会影响Filter的功能。
　　屏蔽注册Filter信息的方法也很简单。因为CBaseFilter实现了IAMovieSetup接口的两个函数：Register和Unregister。我们只需重载这两个函数，直接return S_OK就行了。
　　Filter的Merit值。这个值是微软的“智能连接”函数使用的。在Graphedit中，当我们加入一个Source Filter后，在它的pin上执行“Render”，会自动连上一些Filter。Merit的值参考如下：
　　MERIT_PREFERRED = 0x800000,
　　MERIT_NORMAL = 0x600000,
　　MERIT_UNLIKELY = 0x400000,
　　MERIT_DO_NOT_USE = 0x200000,
　　MERIT_SW_COMPRESSOR = 0x100000,
　　MERIT_HW_COMPRESSOR = 0x100050
　　Merit值只有大于MERIT_DO_NOT_USE的时候才有可能被“智能连接”使用；Merit的值越大，这个Filter的机会就越大。
　　3. Filter之间Pin的连接过程
　　Filter只有加入到Filter Graph中并且和其它Filter连接成完整的链路后，才会发挥作用。Filter之间的连接（也就是Pin之间的连接），实际上是连接双方的一个Media type的协商过程。连接的方向总是从Output pin指向Input pin。连接的大致过程为：如果调用连接函数时已经指定了完整的Media type，则用这个Media type进行连接，成功与否都结束连接过程；如果没有指定或不完全指定了Media type，则进入下面的枚举过程。枚举欲连接的Input pin上所有的Media type，逐一用这些Media type与Output pin进行连接（如果连接函数提供了不完全Media type，则要先将每个枚举出来的Media type与它进行匹配检查），如果Output pin也接受这种Media type，则Pin之间的连接宣告成功；如果所有Input pin上枚举的Media type，Output pin都不支持，则枚举Output pin上的所有Media type，并逐一用这些Media type与Input pin进行连接。如果Input pin接受其中的一种Media type，则Pin之间的连接到此也宣告成功；如果Output pin上的所有Media type，Input pin都不支持，则这两个Pin之间的连接过程宣告失败。
　　每个Pin都可以实现GetMediaType函数来提供该Pin上支持的所有Preferred Media type（但一般只在Output pin上实现，Input pin主要实现CheckMediaType看是否支持当前提供的Media type就行了）。连接过程中，Pin上枚举得到的所有Media type就是这里提供的。
　　在CBasePin类中有一个protected的成员变量m_bTryMyTypesFirst，默认值为false。在我们定制Filter的Output pin中改变这个变量的值为true，可以定制我们自己的连接过程（先枚举Output pin上的Media type）。
　　当Pin之间的连接成功后，各自的pin上都会调用CompleteConnect函数。我们可以在这里取得一些连接上的Media type的信息，以及进行一些计算等。在Output pin的CompleteConnect实现中，还有一个重要的任务，就是协商Filter Graph运行起来后Sample传输使用的内存配置情况。这同样是一个交互过程：首先要询问一下Input pin上的配置要求，如果Input pin提供内存管理器（Allocator），则优先使用Input pin上的内存管理器；否则，使用Output pin自己生成的内存管理器。我们一般都要实现DecideBufferSize来决定存放Sample的内存大小。注意：这个过程协商完成之后，实际的内存并没有分配，而要等到Output pin上的Active函数调用。
　　4. Filter Media type概述
　　Media type一般可以有两种表示：AM_MEDIA_TYPE和CMediaType。前者是一个Struct，后者是从这个Struct继承过来的类。
　　每个Media type有三部分组成：Major type、Subtype和Format type。这三个部分都使用GUID来唯一标示。Major type主要定性描述一种Media type，比如指定这是一个Video，或Audio或Stream等；Subtype进一步细化Media type，如果Video的话可以进一步指定是UYVY或YUY2或RGB24或RGB32等；Format type用一个Struct更进一步细化Media type。
　　如果Media type的三个部分都是指定了某个具体的GUID值，则称这个Media type是完全指定的；如果Media type的三个部分中有任何一个值是GUID_NULL，则称这个Media type 是不完全指定的。GUID_NULL具有通配符的作用。
　　常用的Major type:
　　MEDIATYPE_Video;
　　MEDIATYPE_Audio;
　　MEDIATYPE_AnalogVideo; // Analog capture
　　MEDIATYPE_AnalogAudio;
　　MEDIATYPE_Text;
　　MEDIATYPE_Midi;
　　MEDIATYPE_Stream;
　　MEDIATYPE_Interleaved; // DV camcorder
　　MEDIATYPE_MPEG1SystemStream;
　　MEDIATYPE_MPEG2_PACK;
　　MEDIATYPE_MPEG2_PES;
　　MEDIATYPE_DVD_ENCRYPTED_PACK;
　　MEDIATYPE_DVD_NAVIGATION;
　　常用的Subtype:
　　MEDIASUBTYPE_YUY2;
　　MEDIASUBTYPE_YVYU;
　　MEDIASUBTYPE_YUYV;
　　MEDIASUBTYPE_UYVY;
　　MEDIASUBTYPE_YVU9;
　　MEDIASUBTYPE_Y411;
　　MEDIASUBTYPE_RGB4;
　　MEDIASUBTYPE_RGB8;
　　MEDIASUBTYPE_RGB565;
　　MEDIASUBTYPE_RGB555;
　　MEDIASUBTYPE_RGB24;
　　MEDIASUBTYPE_RGB32;
　　MEDIASUBTYPE_ARGB32; // Contains alpha value
　　MEDIASUBTYPE_Overlay;
　　MEDIASUBTYPE_MPEG1Packet;
　　MEDIASUBTYPE_MPEG1Payload; // Video payload
　　MEDIASUBTYPE_MPEG1AudioPayload; // Audio payload
　　MEDIASUBTYPE_MPEG1System; // A/V payload
　　MEDIASUBTYPE_MPEG1VideoCD;
　　MEDIASUBTYPE_MPEG1Video;
　　MEDIASUBTYPE_MPEG1Audio;
　　MEDIASUBTYPE_Avi;
　　MEDIASUBTYPE_Asf;
　　MEDIASUBTYPE_QTMovie;
　　MEDIASUBTYPE_PCM;
　　MEDIASUBTYPE_WAVE;
　　MEDIASUBTYPE_dvsd; // DV
　　MEDIASUBTYPE_dvhd;
　　MEDIASUBTYPE_dvsl;
　　MEDIASUBTYPE_MPEG2_VIDEO;
　　MEDIASUBTYPE_MPEG2_PROGRAM;
　　MEDIASUBTYPE_MPEG2_TRANSPORT;
　　MEDIASUBTYPE_MPEG2_AUDIO;
　　MEDIASUBTYPE_DOLBY_AC3;
　　MEDIASUBTYPE_DVD_SUBPICTURE;
　　MEDIASUBTYPE_DVD_LPCM_AUDIO;
　　MEDIASUBTYPE_DVD_NAVIGATION_PCI;
　　MEDIASUBTYPE_DVD_NAVIGATION_DSI;
　　MEDIASUBTYPE_DVD_NAVIGATION_PROVIDER;
　　常用的Format type：
　　FORMAT_None
　　FORMAT_DvInfo DVINFO
　　FORMAT_MPEGVideo MPEG1VIDEOINFO
　　FORMAT_MPEG2Video MPEG2VIDEOINFO
　　FORMAT_VideoInfo VIDEOINFOHEADER
　　FORMAT_VideoInfo2 VIDEOINFOHEADER2
　　FORMAT_WaveFormatEx WAVEFORMATEX
　　5. Filter之间的数据传送
　　Filter之间的数据是通过Sample来传送的。Sample是一个COM组件，拥有自己的一段数据缓冲。Sample由Allocator统一管理。如下图所示：
　　Filter之间数据传送的方式有两种：Push模式和Pull模式。