在 Web 应用中增加用户跟踪功能（3）

look_w

在 Web 应用中添加用户跟踪通常，开发人员会在系统的很多地方设置输出点，输出日志。如果要全面的修改这些输出点使日志条目附加上所需的信息，是一件繁重的工作。我们可以利用 Servlet 的 filter 来简化这项工作。Servlets Filter 是 Servlet 2.3 规范中出现的，它能截取用户从客户端提交的请求，并在请求没有到达真正需要访问的资源前运行一个指定的类。如果我们在这个类中实现 NDC 或 MDC 的功能，就可以大量简化日志修改的工作。下面的清单显示了实现这种修改所需的三个步骤。在这里，我们使用的是 NDC，您也可以使用 MDC 实现相同的功能。
在下面的例子中，介绍如何在前面已有的 的 Web 应用代码的基础上，通过为 Web 应用的 Servlet 增加一个 filter 的方法，将用户标志信息在 filter 中压入 / 弹出 NDC 堆栈，而不需要修改任何原来的 Java 程序中的输出日志的代码，使用起来非常简便。
第 1 步：增加一个处理 NDC 堆栈信息的 filter 类
本例通过在 filter 中取得访问该 Web 应用的客户机的 IP 地址，用以唯一地标识客户。您也可以和实际的应用程序代码相配合，使用更加人性化的方式来唯一标识客户，如取得 Session 中存储的客户名称等。
代码 7. 在 filter 中增加将用户标志信息放入 NDC 堆栈

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19

package is.dsw.base.filter; import javax.servlet.Filter; import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpSession; import org.apache.log4j.NDC; public class Log4jNdcFilter implements Filter { public void doFilter(ServletRequest request, ServletResponse response,    FilterChain chain) throws IOException, ServletException {    // 获得客户的网络地址    String address = request.getRemoteAddr();     // 把网络地址放入 NDC 中 . 那么在在 layout pattern 中通过使用 %x，就可在每条日之中增加网络地址的信息 .     NDC.push(address);     // 继续处理其他的 filter 链 .     chain.doFilter(req, res);     // 从 NDC 的堆栈中删除网络地址 .    NDC.pop();    } }

第 2 步：修改 Web 应用的 web.xml 文件
我们需要修改 Web 应用的 web.xml 文件，对 filter 进行设置。在 <web-app< 元素下面增加下列的代码行：
代码 8. 修改 web.xml 文件，增加 filter 配置

1 2 3 4 5 6 7 8 9 10

…… <filter>   <filter-name>NdcFilter</filter-name>   <filter-class> is.dsw.base.filter.Log4jNdcFilter</filter-class> </filter> <filter-mapping>   <filter-name>NdcFilter</filter-name>   <url-pattern>/*</url-pattern> </filter-mapping> ……

上述 XML 中的 url-pattern 元素与这个 Web 应用中的所有 URL 匹配。如果只想应用于部分 URL，可以相应地调整模式。
第 3 步：修改 Log4J 的配置文件
需要对 Log4J.properties 文件的配置做一些改变，以便看到 NDC 上下文。在 NDC 简介部分，我们曾经说过，%x 表示会在每个日志行上打印当前 NDC 上下文。我们对 中的 进行如下修改，在 PatternLayout 的格式定义 ConversionPattern 中增加 %x， 将 NDC 堆栈中的信息在 %x 指定的位置上进行输出。如下：
代码 9. Log4J 配置文件中修改 PatternLayout 的输出格式

1	log4j.appender.A1.layout.ConversionPattern=%d %p %c %x - %m%n

完成以上修改之后，每一条记录都会把我们在 Filter 中 push 进 NDC 堆栈的内容打印出来。仍然以 中的三个并发用户访问为例，我们可以得到如下的日志信息，和前面不使用 NDC 的方式下 相比较，可以看到在原来日志的基础上增加了客户机 IP 地址，这样可以很容易地区分不同的用户的信息，为我们进行日志分析和用户跟踪打下了很好的基础。
图 2.  应用 NDC 之后，运行 Web 应用后输出的日志或许以上的描述已经让你了解到如何利用 NDC 和 MDC 的机制来记录某个用户的唯一标示，或者跟踪其他特定于应用的数据。一旦这些用户标示的数据记入日志，则能很容易地利用其他工具将他们抽取出来，如 grep。如果我们自定义一个数据库的 Appenders，把日志信息插入数据库的话，还能很容易的对这些数据进行统计和分析。