方立勋_30天掌握JavaWeb_Servlet Filter（过滤器）未完

傷城~ 2022-06-17 01:46 95阅读 0赞

# Filter简介 #

Filter也称之为过滤器，它是Servlet技术中最激动人心的技术，WEB开发人员通过Filter技术，对web服务器管理的所有web资源：例如Jsp, Servlet, 静态图片文件或静态 html 文件等进行拦截，从而实现一些特殊的功能。例如实现URL级别的权限访问控制、过滤敏感词汇、压缩响应信息等一些高级功能。

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

![这里写图片描述][SouthEast]

# Filter是如何实现拦截的？ #

Filter接口中有一个doFilter方法，当开发人员编写好Filter，并配置对哪个web资源进行拦截后，WEB服务器每次在调用web资源的service方法之前，都会先调用一下filter的doFilter方法，因此，在该方法内编写代码可达到如下目的：  
1. 调用目标资源之前，让一段代码执行  
2. 是否调用目标资源（即是否让用户访问web资源）  
web服务器在调用doFilter方法时，会传递一个filterChain对象进来，filterChain对象是filter接口中最重要的一个对象，它也提供了一个doFilter方法，开发人员可以根据需求决定是否调用此方法，调用该方法，则web服务器就会调用web资源的service方法，即web资源就会被访问，否则web资源不会被访问。  
3. 调用目标资源之后，让一段代码执行

**filter在开发中的常见应用：**  
1. filter可以目标资源执行之前，进行权限检查，检查用户有无权限，如有权限则放行，如没有，则拒绝访问  
2. filter可以放行之前，对request和response进行预处理，从而实现一些全局性的设置  
3. filter在放行之后，可以捕获目标资源的输出，从而对输出做出类似于压缩这样的设置

**笔记重点：**  
点击页面超链接 和 刷新的区别？  
A：点击链接，先看本地是否有缓存，有的话，则取出；刷新是每次刷新都是向服务器发送请求。

# Filter开发入门 #

Filter开发分为二个步骤：  
1. 编写java类实现Filter接口，并实现其doFilter方法。  
2. 在 web.xml 文件中使用和元素对编写的filter类进行注册，并设置它所能拦截的资源。

**Filter链**  
在一个web应用中，可以开发编写多个Filter，这些Filter组合起来称之为一个Filter链。  
web服务器根据Filter在web.xml文件中的注册顺序，决定先调用哪个Filter，当第一个Filter的doFilter方法被调用时，web服务器会创建一个代表Filter链的FilterChain对象传递给该方法。在doFilter方法中，开发人员如果调用了FilterChain对象的doFilter方法，则web服务器会检查FilterChain对象中是否还有filter，如果有，则调用第2个filter，如果没有，则调用目标资源。

# Filter的生命周期 #

*  init(FilterConfig filterConfig)throws ServletException：
    
    1.  和我们编写的Servlet程序一样，Filter的创建和销毁由WEB服务器负责。 web 应用程序启动时，web 服务器将创建Filter 的实例对象，并调用其init方法，完成对象的初始化功能，从而为后续的用户请求作好拦截的准备工作（注：filter对象只会创建一次，init方法也只会执行一次。示例 ）
    2.  开发人员通过init方法的参数，可获得代表当前filter配置信息的FilterConfig对象。(filterConfig对象见下页PPT)
 *  destroy()：  
    在Web容器卸载 Filter 对象之前被调用。该方法在Filter的生命周期中仅执行一次。在这个方法中，可以释放过滤器使用的资源。

# FilterConfig接口 #

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

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

# Filter常见应用 #

1.  统一全站字符编码的过滤器：  
    通过配置参数encoding指明使用何种字符编码,以处理Html Form请求参数的中文问题
2.  禁止浏览器缓存所有动态页面的过滤器：
    
     *  有 3 个 HTTP 响应头字段都可以禁止浏览器缓存当前页面，它们在 Servlet 中的示例代码如下：  
        response.setDateHeader(“Expires”,-1);  
        response.setHeader(“Cache-Control”,”no-cache”);  
        response.setHeader(“Pragma”,”no-cache”);
     *  并不是所有的浏览器都能完全支持上面的三个响应头，因此最好是同时
     *  使用上面的三个响应头。  
        Expires数据头：值为GMT时间值，为-1指浏览器不要缓存页面  
        Cache-Control响应头有两个常用值：  
        no-cache指浏览器不要缓存当前页面。  
        max-age:xxx指浏览器缓存页面xxx秒。
3.  控制浏览器缓存页面中的静态资源的过滤器：
    
     *  场景：有些动态页面中引用了一些图片或css文件以修饰页面效果，这些图片和css文件经常是不变化的，所以为减轻服务器的压力，可以使用filter控制浏览器缓存这些文件，以提升服务器的性能。
4.  使用Filter实现URL级别的权限认证
    
     *  情景：在实际开发中我们经常把一些执行敏感操作的servlet映射到一些特殊目录中，并用filter把这些特殊目录保护起来，限制只能拥有相应访问权限的用户才能访问这些目录下的资源。从而在我们系统中实现一种URL级别的权限功能。
     *  要求：为使Filter具有通用性，Filter保护的资源和相应的访问权限通过filter参数的形式予以配置。
5.  实现用户自动登陆的过滤器
    
     *  在用户登陆成功后，发送一个名称为user的cookie给客户端，cookie的值为用户名和md5加密后的密码。
     *  编写一个AutoLoginFilter，这个filter检查用户是否带有名称为user的cookie来，如果有，则调用dao查询cookie的用户名和密码是否和数据库匹配，匹配则向session中存入user对象（即用户登陆标记），以实现程序完成自动登陆。

# Filter的部署—注册Filter #

<filter>
             <filter-name>testFitler</filter-name>
             <filter-class>org.test.TestFiter</filter-class>
             <init-param>
             <param-name>word_file</param-name> 
             <param-value>/WEB-INF/word.txt</param-value>
             </init-param>
    </filter>

<filter-name>用于为过滤器指定一个名字，该元素的内容不能为空。
    <filter-class>元素用于指定过滤器的完整的限定类名。
    <init-param>元素用于为过滤器指定初始化参数，它的子元素<param-name>指定参数的名字，<param-value>指定参数的值。在过滤器中，可以使用FilterConfig接口对象来访问初始化参数。
    
    <filter-mapping>元素用于设置一个 Filter 所负责拦截的资源。一个Filter拦截的资源可通过两种方式来指定：Servlet 名称和资源访问的请求路径
    1. <filter-name>子元素用于设置filter的注册名称。该值必须是在<filter>元素中声明过的过滤器的名字
    2. <url-pattern>设置 filter 所拦截的请求路径(过滤器关联的URL样式)
    3. <servlet-name>指定过滤器所拦截的Servlet名称。
    4. <dispatcher>指定过滤器所拦截的资源被 Servlet 容器调用的方式，可以是REQUEST,INCLUDE,FORWARD和ERROR之一，默认REQUEST。用户可以设置多个<dispatcher> 子元素用来指定 Filter 对资源的多种调用方式进行拦截。
    
    <dispatcher> 子元素可以设置的值及其意义：
    REQUEST：当用户直接访问页面时，Web容器将会调用过滤器。如果目标资源是通过RequestDispatcher的include()或forward()方法访问时，那么该过滤器就不会被调用。
    
    INCLUDE：如果目标资源是通过RequestDispatcher的include()方法访问时，那么该过滤器将被调用。除此之外，该过滤器不会被调用。
    
    FORWARD：如果目标资源是通过RequestDispatcher的forward()方法访问时，那么该过滤器将被调用，除此之外，该过滤器不会被调用。
    
    ERROR：如果目标资源是通过声明式异常处理机制调用时，那么该过滤器将被调用。除此之外，过滤器不会被调用。

**Filter的部署—映射Filter示例**

<filter-mapping>
         <filter-name>testFilter</filter-name>
        <url-pattern>/test.jsp</url-pattern>
    </filter-mapping>

<filter-mapping>
        <filter-name>testFilter</filter-name>
       <url-pattern>/index.jsp</url-pattern>
       <dispatcher>REQUEST</dispatcher>
       <dispatcher>FORWARD</dispatcher>
    </filter-mapping>

# Filter高级开发 #

由于开发人员在filter中可以得到代表用户请求和响应的request、response对象，因此在编程中可以使用Decorator(装饰器)模式对request、response对象进行包装，再把包装对象传给目标资源，从而实现一些特殊需求。

# Decorator设计模式 #

*  当某个对象的方法不适应业务需求时，通常有2种方式可以对方法进行增强：  
    编写子类，覆盖需增强的方法  
    使用Decorator设计模式对方法进行增强
 *  疑问：在实际应用中遇到需增强对象的方法时，到底选用哪种方式呢？
    
     *  没有具体的定式，不过有一种情况下，必须使用Decorator设计模式：即被增强的对象，开发人员只能得到它的对象，无法得到它的class文件。
     *  比如request、response对象，开发人员之所以在servlet中能通过sun公司定义的HttpServletRequest\\response接口去操作这些对象，是因为Tomcat服务器厂商编写了request、response接口的实现类。web服务器在调用servlet时，会用这些接口的实现类创建出对象，然后传递给servlet程序。
     *  此种情况下，由于开发人员根本不知道服务器厂商编写的request、response接口的实现类是哪个？在程序中只能拿到服务器厂商提供的对象，因此就只能采用Decorator设计模式对这些对象进行增强。

**Decorator设计模式的实现**

1.  首先看需要被增强对象继承了什么接口或父类，编写一个类也去继承这些接口或父类。
2.  在类中定义一个变量，变量类型即需增强对象的类型。
3.  在类中定义一个构造函数，接收需增强的对象。
4.  覆盖需增强的方法，编写增强的代码。

举例：使用Decorator设计模式为BufferedReader类的readLine方法添加行号的功能。

# request对象的增强 #

Servlet API 中提供了一个request对象的Decorator设计模式的默认实现类HttpServletRequestWrapper ， （HttpServletRequestWrapper 类实现了request 接口中的所有方法，但这些方法的内部实现都是仅仅调用了一下所包装的的 request 对象的对应方法）以避免用户在对request对象进行增强时需要实现request接口中的所有方法。

案例：  
1. 使用Decorator模式包装request对象，完全解决get、post请求方式下的乱码问题。  
2. 使用Decorator模式包装request对象，实现html标签转义功能（Tomcat服务器中提供了转义html标签的工具类）。

Servlet API 中提供了response对象的Decorator设计模式的默认实现类HttpServletResponseWrapper ， （HttpServletResponseWrapper类实现了response接口中的所有方法，但这些方法的内部实现都是仅仅调用了一下所包装的的 response对象的对应方法）以避免用户在对response对象进行增强时需要实现response接口中的所有方法。

**response增强案例—压缩响应**  
应用HttpServletResponseWrapper对象，压缩响应正文内容。思路:

*  通过filter向目标页面传递一个自定义的response对象。  
    
    
     *  在自定义的response对象中，重写getOutputStream方法和getWriter方法，使目标资源调用此方法输出页面内容时，获得的是我们自定义的ServletOutputStream对象。
     *  在我们自定义的ServletOuputStream对象中，重写write方法，使写出的数据写出到一个buffer中。
 *  当页面完成输出后，在filter中就可得到页面写出的数据，从而我们可以调用GzipOuputStream对数据进行压缩后再写出给浏览器，以此完成响应正文件压缩功能。

**实用案例－缓存数据到内存**  
对于页面中很少更新的数据，例如商品分类，为避免每次都要从数据库查询分类数据，因此可把分类数据缓存在内存或文件中，以此来减轻数据库压力，提高系统响应速度。

# 动态代理 #

1.  在java里，每个对象都有一个类与之对应。  
    现在要生成某一个对象的代理对象，这个代理对象也要通过一个类来生成，所以首先要编写用于生成代理对象的类。
2.  如何编写生成代理对象的类，两个要素：  
    代理谁  
    如何生成代理对象
3.  代理谁？  
    设计一个类变量，以及一个构造函数，记住代理类 代理哪个对象。
4.  如何生成代理对象？  
    设计一个方法生成代理对象（在方法内编写代码生成代理对象是此处编程的难点）

Java提供了一个Proxy类，调用它的newInstance方法可以生成某个对象的代理对象，使用该方法生成代理对象时，需要三个参数：  
1.生成代理对象使用哪个类装载器  
2.生成哪个对象的代理对象，通过接口指定  
3.生成的代理对象的方法里干什么事，由开发人员编写handler接口的实现来指定。

初学者必须理解，或不理解必须记住的2件事情：

*  Proxy类负责创建代理对象时，如果指定了handler（处理器），那么不管用户调用代理对象的什么方法，该方法都是调用处理器的invoke方法。
 *  由于invoke方法被调用需要三个参数：代理对象、方法、方法的参数，因此不管代理对象哪个方法调用处理器的invoke方法，都必须把自己所在的对象、自己（调用invoke方法的方法）、方法的参数传递进来。

![这里写图片描述][SouthEast 1]

**动态代理应用**

*  在动态代理技术里，由于不管用户调用代理对象的什么方法，都是调用开发人员编写的处理器的invoke方法（这相当于invoke方法拦截到了代理对象的方法调用）。
 *  并且，开发人员通过invoke方法的参数，才可以在拦截的同时，知道用户调用的是什么方法，因此利用这两个特性，就可以实现一些特殊需求，例如：拦截用户的访问请求，以检查用户是否有访问权限、动态为某个对象添加额外的功能。

[SouthEast]: /images/20220617/56015c8ea4f14bdcb2c81fa79e055441.png
[SouthEast 1]: /images/20220617/dd42d59d4f2247e8be1d3da9083ec983.png