8 Log4j 日志格式 Layout类

Log4j 日志格式 Layout类

Apache Log4j提供了多个Layout对象,每个根据布局的不同都可格式化日志数据。还可以创建一个Layout对象,以应用特有的方式格式化日志。

所有Layout对象从Appender对象那里接收一个LoggingEvent对象,然后从LoggingEvent对象那里获取信息,并使用恰当的ObjectRenderer对象获取该信息的字符串形式。

Layout类型

位于继承关系顶层的是抽象类org.apache.log4j.Layout,这是所有Log4j APILayout类的基类。
Layout类是个抽象类,在应用中我们从不直接使用该类,而是使用它的子类,如下所示:

  • DateLayout
  • HTMLLayout
  • PatternLayout
  • SimpleLayout
  • XMLLayout

Layout方法

该类对于所有其他Layout对象的通用操作提供了框架性的实现,声明了两个抽象方法:

Layout抽象类的抽象方法 描述
public abstract boolean ignoresThrowable() 该方法指明日志信息是否处理由日志事件传来的java.lang.Throwable对象,如果Layout对象能处理Throwable对象,则Layout对象不会忽略它,并且返回false
public abstract String format(LoggingEvent event) Layout子类实现该方法,以定义各自的格式。

除了这些抽象方法,Layout 类还提供了如下的具体方法:

Layout抽象类具体方法 描述
public String getContentType() 返回布局对象使用的内容类型。
public String getFooter() 记录消息的页脚信息。
public String getHeader() 日志消息的头信息。

每个子类均可覆盖这些方法的实现,返回各自特有的信息。