log4j之NDC、MDC

 NDC 介绍

NDC（Nested Diagnostic Context）是 Neil Harrison 在名为《Patterns for Logging Diagnostic Messages》的书中提出的嵌套诊断环境的机制。这种机制的提出，主要为了减少多线程的系统为每个客户单独记录日志的系统开销。在过去，区分两个客户的日志输出的常用方法是单独为每个客户机实例化新类别，但该方法会增加类别数量，并增加日志记录的管理开销。Neil Harrison 提出的方法就是把用户的上下文信息放到嵌套式诊断环境 (NDC) 中。

NDC 为每一个线程管理一个堆栈。开发人员可以在代码中合适的位置嵌入简单的 push 和 pop 方法，用来维护堆栈。通常 push 进堆栈的是可以唯一标示客户的上下文信息，如 SessionID 或者客户名称，IP 地址等。因为每个客户请求都会有单独的 NDC 堆栈，因此日志系统在输出的时候会根据每个线程找到对应的堆栈，并在输出日志的时候附加上堆栈内的信息。开发人员就可以很容易的在日志中区分出各个不同客户所产生的日志条目。

Log4J 从 1.2 起开始支持 NDC，org.apache.log4j.NDC 声明如下：

代码 5. NDC 声明代码

1. public class NDC {
2. // 返回诊断堆栈的内容
3. public static String get();
4. // 从堆栈的顶端删除一个元素
5. public static String pop();
6. //在堆栈顶端加入一个元素
7. public static void push(String message);
8. //察看这个堆栈最顶层的元素，但不删除它
9. public static String peek()
10. // 删除这个线程的堆栈内容
11. public static void remove();
12. }

要注意的是，org.apache.log4j.NDC 类中所有的方法都是静态的。假设 NDC 日志输出功能被打开，每一次的日志请求，Log4J 组件都会把当前线程的整个 NDC 堆栈内容输出在日志条目中。这样的过程不需要开发人员写过多的代码，程序员只需要在代码中合适的地方通过 push 和 pop 方法将正确的信息放到 NDC 的堆栈中，然后通过修改 Log4J 的配置文件，指定用户标志信息输出的位置和格式，而原来 Java 代码中输出日志的代码不需要任何修改，就能够输出带有用户标志信息的日志。

NDC和MDC是log4j用于存储应用程序的上下文信息（context infomation），从而便于在log中使用这些上下文信息。

NDC采用了一个类似栈的机制来push存储上下文信息，每一个线程都独立地储存上下文信息。比如说一个servlet就可以针对每一个request创建对应的NDC，储存客户端地址等等信息。相关的信息使用NDC.push(message);

在log的时候将信息输出。在相应的PatternLayout中使用”%x”来输出存储的上下文信息

例如：String remoteAddr = request.getRemoteAddr();

NDC.push(remoteAddr);

在log4j.properties文件中作如下的配置即可

log4j.appender.console.layout.ConversionPattern=%-d{yyyy/MM/dd HH:mm:ss,SSS} [%X] -[%c]-[%p] %m%n

Log4J 配置文件中相应的配置信息，其中 PatternLayout 的 ConversionPattern 用于程序员指定日志输出的格式。要使用 NDC 的方式输出用户标志信息，只需要在 PatternLayout 的格式定义 ConversionPattern 中使用 %x，就能在相应的位置上输出 NDC 存储的上下文信息。

MDC介绍

MDC 和 NDC 相似，也可以减少多线程的系统为每个客户单独记录日志的系统开销。它同样是为每个线程建立一个独立的存储空间，开发人员可以根据需要把信息存入其中。不同的是 MDC 使用 Map 的机制来存储信息，信息以 key/value 对的形式存储在 Map 中。

Log4J 从 1.3 alpha 版本开始提供对 MDC 的支持，org.apache.log4j.MDC 声明如下：

代码 6. MDC 声明代码

1. public class MDC {
2. // 清空map所有的条目。
3. public static void clear();
4. // 根据key值返回相应的对象
5. public static object get(String key);
6. //返回所有的key值.
7. public static Enumeration getKeys();
8. //把key值和关联的对象，插入map中
9. public static void put(String key, Object val),
10. //删除key对应的对象
11. public static  remove(String key)
12. }

MDC 和 NDC 的使用方法也类似，区别只是在

Log4J配置文件中，在通过 PatternLayout 的 ConversionPattern 来配置日志的格式的时候，需要使用 %x{key} 来输出相应的用户标志信息对象。

下面，我们通过具体的例子来说明如何在使用 Log4J 的 Web 应用中增加用户标志信息，达到进行用户跟踪的目的。在开发中，对于使用 NDC 还是 MDC 的机制，要看具体的应用在处理上下文信息的时候，是采用堆栈式的还是 Map 式的方便。下面我们以 MDC 为例进行说明。

MDC内部使用了类似map的机制来存储信息，相对应的方法，MDC.put(key, value);在配置PatternLayout的时候使用：%x{key}来输出对应的value

例如：String remoteAddr = request.getRemoteAddr();

MDC.put("ip", remoteAddr);

在log4j.properties文件中作如下的配置即可

log4j.appender.console.layout.ConversionPattern=%-d{yyyy/MM/dd HH:mm:ss,SSS} [%X{ip}] -[%c]-[%p] %m%n

如果在项目中有过滤器，你可以把获取ip 的方法直接定义在过滤器中，然后在配置文件中配置获取ip的显示就可以了

相关配置例子如下：

web.xml中：

<filter>
  　　<filter-name>logFilter</filter-name>
  　　<filter-class>com.speed.base.filter.Log4jUserFilter</filter-class>
  </filter>
  <filter-mapping>
  　　<filter-name>logFilter</filter-name>
  　　<url-pattern>/*</url-pattern>
  </filter-mapping>

public class Log4jUserFilter implements Filter{

    @Override
    public void destroy() {

    }

    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
        try {
            HttpServletRequest httpReq = (HttpServletRequest)request;
                        MDC.put("sessionId", httpReq.getSession().getId());
            chain.doFilter(request, response);
        } finally{
            if(MDC.getContext() != null)
                MDC.getContext().clear();
        }

    }

    @Override
    public void init(FilterConfig arg0) throws ServletException {

    }

}