记性不如烂笔头33-利用java过滤器实现压缩响应正文内容

在前面的Response的相关内容中，就提到了把数据压缩然后传到浏览器上，通过压缩，能够提升网络文件的传输效率，在很多的场所都需要实用。

如果我们需要在所有的页面都实现压缩，那么是不是把这个加在某一个地方就一起解决了呢？貌似我们能够在过滤器中加载很多的内容，那么是不是也可以把这个也加在过滤器中呢？答案是可以的。

我们可以通过增强HttpServletResponseWrapper对象，压缩响应正文内容。

1、 原理

通过过滤器filter向目标页面传递一个自定义的response对象。在自定义的response对象中，重写getOutputStream方法和getWriter方法，使目标资源调用此方法输出页面内容时，获得的是我们自定义的ServletOutputStream对象。在我们自定义的ServletOuputStream对象中，重写write方法，使写出的数据写出到一个buffer中。当页面完成输出后，在filter中就可得到页面写出的数据，从而我们可以调用GzipOuputStream对数据进行压缩后再写出给浏览器，以此完成响应正文件压缩功能。可以设置Location响应头，实现请求重定向（可以查看HttpServletRequest相关内容）；也可以设置Content-Encoding响应头，告诉浏览器数据的压缩格式；还可以设置content-type响应头，指定回送数据类型；也可以设置content-disposition响应头，让浏览器下载文件（（可以查看HttpServletReonse相关内容））

还可以利用它，做很多很多的事情。

2、 用JAVA过滤器实现压缩响应正文的源代码

在带宽不够的时候，压缩是一种解决事情的好方法；现在的带宽是越来越大了，不过文件也越来越大，压缩还是有英雄用武之地的。其中百度等网站也是使用压缩的数据传递方式。

package com.filter;
import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.io.OutputStreamWriter;
import java.io.PrintWriter;
import java.util.zip.GZIPOutputStream;

import javax.servlet.Filter;
import javax.servlet.FilterChain;
import javax.servlet.FilterConfig;
import javax.servlet.ServletException;
import javax.servlet.ServletOutputStream;
import javax.servlet.ServletRequest;
import javax.servlet.ServletResponse;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.http.HttpServletResponseWrapper;
/**
 * 一个简单的响应正文压缩，过滤器实现
 * @author 范芳铭
 */
public class EasyResponseGzipFilter implements Filter{
    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        System.out.println("----过滤器初始化----");
    }

    @Override
    public void doFilter(ServletRequest req, ServletResponse resp,
            FilterChain chain) throws IOException, ServletException {

        HttpServletRequest request = (HttpServletRequest) req;
        HttpServletResponse response = (HttpServletResponse) resp;

        BufferResponse myresponse = new BufferResponse(response);
        chain.doFilter(request, myresponse);
        //拿出缓存中的数据，压缩后再打给浏览器
        byte out[] = myresponse.getBuffer();
        System.out.println("原始大小:" + out.length);

        ByteArrayOutputStream bout = new ByteArrayOutputStream();
        //压缩输出流中的数据
        GZIPOutputStream gout = new GZIPOutputStream(bout);
        gout.write(out);
        gout.close();

        byte gzip[] = bout.toByteArray();
        System.out.println("压缩后的大小:" + gzip.length);

        response.setHeader("content-encoding", "gzip");
        response.setContentLength(gzip.length);
        response.getOutputStream().write(gzip);
    }

    @Override
    public void destroy() {
        System.out.println("----过滤器销毁----");
    }
}

class BufferResponse extends HttpServletResponseWrapper{
    private ByteArrayOutputStream bout = new ByteArrayOutputStream();
    private PrintWriter pw;
    private HttpServletResponse response;
    public BufferResponse(HttpServletResponse response) {
        super(response);
        this.response = response;
    }
    @Override
    public ServletOutputStream getOutputStream() throws IOException {
        return new MyServletOutputStream(bout);
    }
    @Override
    public PrintWriter getWriter() throws IOException {
        pw = new PrintWriter(new OutputStreamWriter(bout,this.response.getCharacterEncoding()));
        return pw;
    }

    public byte[] getBuffer(){
        try{
            if(pw!=null){
                pw.close();
            }
            if(bout!=null){
                bout.flush();
                return bout.toByteArray();
            }

            return null;
        }catch (Exception e) {
            throw new RuntimeException(e);
        }
    }
}

class MyServletOutputStream extends ServletOutputStream{

    private ByteArrayOutputStream bout;
    public MyServletOutputStream(ByteArrayOutputStream bout){
        this.bout = bout;
    }

    @Override
    public void write(int b) throws IOException {
        this.bout.write(b);
    }
}

3、 修改web.xml

<filter>
      <description>配置压缩过滤器</description>
      <filter-name>GzipFilter</filter-name>
      <filter-class>com.filter.EasyResponseGzipFilter</filter-class>
  </filter>

  <!--jsp文件的输出的内容都经过压缩过滤器压缩后才输出 -->
  <filter-mapping>
      <filter-name>GzipFilter</filter-name>
      <url-pattern>*.jsp</url-pattern>
      <!-- 对重定向或者转向的jsp页面拦截，在Servlet中通过       request.getRequestDispatcher().forward()   -->
      <dispatcher>FORWARD</dispatcher>
      <!--对于直接以URL方式访问的jsp页面进行拦截，过滤器的拦截方式默认就是 REQUEST-->
      <dispatcher>REQUEST</dispatcher>
  </filter-mapping>
  <!--js文件的输出的内容都经过压缩过滤器压缩后才输出 -->
  <filter-mapping>
      <filter-name>GzipFilter</filter-name>
      <url-pattern>*.js</url-pattern>
  </filter-mapping>
  <!--css文件的输出的内容都经过压缩过滤器压缩后才输出 -->
  <filter-mapping>
      <filter-name>GzipFilter</filter-name>
      <url-pattern>*.css</url-pattern>
  </filter-mapping>
  <!--html文件的输出的内容都经过压缩过滤器压缩后才输出 -->
  <filter-mapping>
      <filter-name>GzipFilter</filter-name>
      <url-pattern>*.html</url-pattern>
  </filter-mapping> 

4、 最终运行结果

输入url测试地址：http://localhost:8080/webStudy/index.jsp

Index.jsp是我通过myeclipse创建WEB应用自己创建的文件，没有做任何修改。

运行结果如下：

原始大小:625

压缩后的大小:354