引用 Servlet中使用HttpServletResponseWrapper截获返回的页面内容

 

引用

【轰隆隆】 的 Servlet中使用HttpServletResponseWrapper截获返回的页面内容

来源：铁木箱子的博客

     像标题所说的，虽然在在JEE开发中并不常见，但也不是没有需要。比如知名的页面装饰框架sitemesh，就是利用filter过滤器先截获返回给客户端的页面，然后分析html代码并最终装饰页面效果后返回给客户端。我这里也先简单的说下如何来自己编程实现，然后说一个我遇到的问题，应该也是大家会遇到但很难找到原因的问题。

      要截获页面返回的内容，整体的思路是先把原始返回的页面内容写入到一个字符Writer，然后再组装成字符串并进行分析，最后再返回给客户端。代码如下：

1. package cc.mzone.test ;
2.  
3. import java.io.CharArrayWriter ;
4. import java.io.PrintWriter ;
5.  
6. import javax.servlet.http.HttpServletResponse ;
7. import javax.servlet.http.HttpServletResponseWrapper ;
8.  
9. /**
10.  * 自定义一个响应结果包装器，将在这里提供一个基于内存的输出器来存储所有
11.  * 返回给客户端的原始HTML代码。
12.  *
13.  * @author 铁木箱子
14.  *
15.  */
16. public class ResponseWrapper extends HttpServletResponseWrapper {
17. private PrintWriter cachedWriter ;
18. private CharArrayWriter bufferedWriter ;
19.  
20. public ResponseWrapper (HttpServletResponse response ) {
21. super (response ) ;
22. // 这个是我们保存返回结果的地方
23. bufferedWriter = new CharArrayWriter ( ) ;
24. // 这个是包装PrintWriter的，让所有结果通过这个PrintWriter写入到bufferedWriter中
25. cachedWriter = new PrintWriter (bufferedWriter ) ;
26. }
27.  
28. @Override
29. public PrintWriter getWriter ( ) {
30. return cachedWriter ;
31. }
32.  
33. /**
34. * 获取原始的HTML页面内容。
35. * @return
36. */
37. public String getResult ( ) {
38. return bufferedWriter. toString ( ) ;
39. }
40. }

      然后再写一个过滤器来截获内容并处理：

1. package cc.mzone.test ;
2.  
3. import java.io.IOException ;
4. import java.io.PrintWriter ;
5.  
6. import javax.servlet.Filter ;
7. import javax.servlet.FilterChain ;
8. import javax.servlet.FilterConfig ;
9. import javax.servlet.ServletException ;
10. import javax.servlet.ServletRequest ;
11. import javax.servlet.ServletResponse ;
12. import javax.servlet.http.HttpServletResponse ;
13.  
14. public class MyServletFilter implements Filter {
15.  
16. @Override
17. public void destroy ( ) {
18. // TODO Auto-generated method stub
19.  
20. }
21.  
22. @Override
23. public void doFilter (ServletRequest request, ServletResponse response,
24. FilterChain chain ) throws IOException, ServletException {
25. // 使用我们自定义的响应包装器来包装原始的ServletResponse
26. ResponseWrapper wrapper = new ResponseWrapper ( (HttpServletResponse )response ) ;
27. // 这句话非常重要，注意看到第二个参数是我们的包装器而不是response
28. chain. doFilter (request, wrapper ) ;
29. // 处理截获的结果并进行处理，比如替换所有的“名称”为“铁木箱子”
30. String result = wrapper. getResult ( ) ;
31. result = result. replace ( "名称", "铁木箱子" ) ;
32. // 输出最终的结果
33. PrintWriter out = response. getWriter ( ) ;
34. out. write (result ) ;
35. out. flush ( ) ;
36. out. close ( ) ;
37. }
38.  
39. @Override
40. public void init (FilterConfig filterConfig ) throws ServletException {
41. // TODO Auto-generated method stub
42.  
43. }
44.  
45. }

      然后将该servlet配置在web.xml文件中，如下：

1. >
2. >myFilter >
3. >cc.mzone.test.MyServletFilter >
4. >
5. >
6. >myFilter >
7. >*.jsp >
8. >

      我们上面配置的是只过滤访问后缀为.jsp的url地址，当然你可以根据自己的需要修改成其他的过滤模式。然后我们在web应用根目录下建立一个jsp文件test.jsp，内容如下：

1. <%@ page language="java" pageEncoding="UTF-8" contentType="text/html; charset=UTF-8" %>
2. >
3. >
4. <span style="color: rgb(0, 0, 0); font-weight: bold;">></span></span></span>页面返回结果过滤测试<span style="color: rgb(0, 153, 0);"><span style="color: rgb(0, 0, 0); font-weight: bold;">> >
5. >
6. >
7. 你好，我叫“名称”。
8. >
9. >

      配置完后，部署到tomcat，然后访问应用下的test.jsp文件，就可以发现返回的内容变成了：

1. 你好，我叫“铁木箱子”

      而不是页面中原始的内容：

1. 你好，我叫“名称”

      从而也就达到了我们想要的效果了。在文章开头我也提到了说有一个问题，那就是有可能在运行的过程中页面只输出一部分，尤其是在使用多个框架后(比如sitemesh)出现的可能性非常大，在探究了好久之后终于发现原来是响应的ContentLength惹的祸。因为在经过多个过滤器或是框架处理后，很有可能在其他框架中设置了响应的输出内容的长度，导致浏览器只根据得到的长度头来显示部分内容。知道了原因，处理起来就比较方便了，我们在处理结果输出前重置一下ContentLength即可，如下：

1. // 重置响应输出的内容长度
2. response. setContentLength ( - 1 ) ;
3. // 输出最终的结果
4. PrintWriter out = response. getWriter ( ) ;
5. out. write (result ) ;
6. out. flush ( ) ;
7. out. close ( ) ;

      这样处理后就不会再出现只出现部分页面的问题了！

 

【轰隆隆】推荐:

http://www.honglonglong.com

http://blog.163.com/fulong258