Servlet Filter 过滤器

Posted 2020-08-15

Filter也称之为过滤器，它是Servlet技术中最激动人心的技术，WEB开发人员通过Filter技术，对web服务器管理的所有web资源：

例如Jsp, Servlet, 静态图片文件或静态 html 文件等进行拦截，从而实现一些特殊的功能。

例如实现URL级别的权限访问控制、过滤敏感词汇、压缩响应信息等一些高级功能。

 

Servlet API中提供了一个Filter接口，开发web应用时，如果编写的Java类实现了这个接口，则把这个java类称之为过滤器Filter。

通过Filter技术，开发人员可以实现用户在访问某个目标资源之前，对访问的请求和响应进行拦截

 

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.　编写java类实现Filter接口，并实现其doFilter方法。

　　2.   在 web.xml 文件中使用<filter>和<filter-mapping>元素对编写的filter类进行注册，并设置它所能拦截的资源。

Filter链
在一个web应用中，可以开发编写多个Filter，这些Filter组合起来称之为一个Filter链。

web服务器根据Filter在web.xml文件中的注册顺序，决定先调用哪个Filter，当第一个Filter的doFilter方法被调用时，web服务器会创建一个代表Filter链的FilterChain对象传

递给该方法。在doFilter方法中，开发人员如果调用了FilterChain对象的doFilter方法，则web服务器会检查FilterChain对象中是否还有filter，如果有，则调用第2个filter，如

果没有，则调用目标资源。

 

public class FilterDemo1 implements Filter {
    /*
     * filter在开发中的常见应用：
     * 1.filter可以在目标资源执行之前，进行权限检查，检查用户有无权限，如有权限则放行，如没有，则拒绝访问
     * 2.filter可以放行之前，对request和response进行预处理，从而实现一些全局性的设置。
     * 3.filter在放行之后，可以捕获到目标资源的输出，从而对输出作出类似于压缩这样的设置
     */
    private FilterConfig config;
    public void doFilter(ServletRequest request, ServletResponse response,
            FilterChain chain) throws IOException, ServletException {
        String value = this.config.getInitParameter("xxx");
        //解决全站乱码问题
        request.setCharacterEncoding("UTF-8");
        response.setCharacterEncoding("UTF-8");
        response.setContentType("text/html;charset=UTF-8");
        System.out.println("servletDemo1之前");
        chain.doFilter(request, response);  //放行
        System.out.println("servletDemo1之后!!");
    }
    public void init(FilterConfig filterConfig) throws ServletException {
        System.out.println("filter被创建了！！");
        this.config = filterConfig;
    }
    public void destroy() {
        System.out.println("filter被销毁了！！");
    }
}

 

 

 

init(FilterConfig filterConfig)throws ServletException：

和我们编写的Servlet程序一样，Filter的创建和销毁由WEB服务器负责。 web 应用程序启动时，web 服务器将创建Filter 的实例对象，并调用其init方法，完成对象的初始化

功能，从而为后续的用户请求作好拦截的准备工作（注：filter对象只会创建一次，init方法也只会执行一次。 ）

开发人员通过init方法的参数，可获得代表当前filter配置信息的FilterConfig对象。

destroy()：

在Web容器卸载 Filter 对象之前被调用。该方法在Filter的生命周期中仅执行一次。在这个方法中，可以释放过滤器使用的资源。

 

 

 Filter应用：

<filter>
      <filter-name>CharacterEncodingFilter</filter-name>
      <filter-class>cn.itcast.web.filter.example.CharacterEncodingFilter</filter-class>
      <init-param>
          <param-name>charset</param-name>
          <param-value>UTF-8</param-value>
      </init-param>
  </filter>
  
  
  <filter-mapping>
      <filter-name>CharacterEncodingFilter</filter-name>
      <url-pattern>/index.jsp</url-pattern>
      <dispatcher>REQUEST</dispatcher>
  </filter-mapping>

 

//解决全站乱码
public class CharacterEncodingFilter implements Filter {
    private FilterConfig config;
    private String defaultCharset = "UTF-8";
    public void doFilter(ServletRequest req, ServletResponse resp,
            FilterChain chain) throws IOException, ServletException {
        //获取要设置的字符集
        String charset = this.config.getInitParameter("charset");
        if(charset==null){
            charset = defaultCharset;
        }
        HttpServletRequest request = (HttpServletRequest) req;
        HttpServletResponse response = (HttpServletResponse) resp;
        
        request.setCharacterEncoding(charset);  //post  get
        response.setCharacterEncoding(charset);
        response.setContentType("text/html;charset=" + charset);
        
        chain.doFilter(request, response);
    }
    public void destroy() {
        // TODO Auto-generated method stub

    }
    public void init(FilterConfig filterConfig) throws ServletException {
        this.config = filterConfig;
    }
}

 

控制访问jsp时不缓存

<filter>
      <filter-name>NoCacheFilter</filter-name>
      <filter-class>cn.itcast.web.filter.example.NoCacheFilter</filter-class>
  </filter>
  
  
  <filter-mapping>
      <filter-name>NoCacheFilter</filter-name>
      <url-pattern>*.jsp</url-pattern>
      <dispatcher>FORWARD</dispatcher>
      <dispatcher>REQUEST</dispatcher>
  </filter-mapping>

 

public class NoCacheFilter implements Filter {
    public void doFilter(ServletRequest req, ServletResponse resp,
            FilterChain chain) throws IOException, ServletException {
        HttpServletRequest request = (HttpServletRequest) req;
        HttpServletResponse response = (HttpServletResponse) resp;
        
        response.setDateHeader("Expires",-1);
        response.setHeader("Cache-Control","no-cache");
        response.setHeader("Pragma","no-cache");
        chain.doFilter(request, response);
    }
    public void destroy() {
        // TODO Auto-generated method stub
    }
    public void init(FilterConfig filterConfig) throws ServletException {
        // TODO Auto-generated method stub

    }
}

 

控制浏览器缓存

<filter>
      <filter-name>CacheFilter</filter-name>
      <filter-class>cn.itcast.web.filter.example.CacheFilter</filter-class>
      <init-param>
          <param-name>css</param-name>
          <param-value>10</param-value>
      </init-param>
      <init-param>
          <param-name>jpg</param-name>
          <param-value>1</param-value>
      </init-param>
      <init-param>
          <param-name>js</param-name>
          <param-value>20</param-value>
      </init-param>
  </filter>
  
  
  <filter-mapping>
      <filter-name>CacheFilter</filter-name>
      <url-pattern>*.jpg</url-pattern>
  </filter-mapping>
  
    <filter-mapping>
      <filter-name>CacheFilter</filter-name>
      <url-pattern>*.css</url-pattern>
  </filter-mapping>
  
   <filter-mapping>
      <filter-name>CacheFilter</filter-name>
      <url-pattern>*.js</url-pattern>
  </filter-mapping>
  
  

 

 

//控制浏览器缓存的过滤器
public class CacheFilter implements Filter {

    private FilterConfig config;
    
    public void doFilter(ServletRequest req, ServletResponse resp,
            FilterChain chain) throws IOException, ServletException {
        
        HttpServletRequest request = (HttpServletRequest) req;
        HttpServletResponse response = (HttpServletResponse) resp;
        
        //1.获取到用户想访问的资源
        String uri = request.getRequestURI();
        
        //2.获取该资源的缓存时间
        int expires = 0;
        if(uri.endsWith(".jpg")){
            expires = Integer.parseInt(this.config.getInitParameter("jpg"));
        }else if(uri.endsWith(".css")){
            expires = Integer.parseInt(this.config.getInitParameter("css"));
        }else{
            expires = Integer.parseInt(this.config.getInitParameter("js"));
        }
        
        response.setDateHeader("expires", System.currentTimeMillis()+expires*60*1000);
        chain.doFilter(request, response);
    }
    
    


    public void init(FilterConfig filterConfig) throws ServletException {
        this.config = filterConfig;
    }

    
    public void destroy() {
            
    
        }
    }