Log4j 日志总结

Log4j 日志总结

1.日志组件

Loggers「记录器」：Logger 负责捕捉事件并将其发送给合适的 Appender。

Appenders「输出源」：也被称为 Handlers，负责将日志事件记录到目标位置。在将日志事件输出之前， Appenders 使用 Layouts 来对事件进行格式化处理。

Layouts「布局」：也被称为 Formatters，它负责对日志事件中的数据进行转换和格式化。Layouts 决定了数据在一条日志记录中的最终形式。

当 Logger 记录一个事件时，它将事件转发给适当的 Appender。然后 Appender 使用 Layout 来对日志记录进行格式化，并将其发送给控制台、文件或者其它目标位置。另外，Filters 可以让你进一步指定一个 Appender 是否可以应用在一条特定的日志记录上。在日志配置中，Filters 并不是必需的，但可以让你更灵活地控制日志消息的流动。

2.日志系统

日志系统：日志的具体实现。Java 的常见的日志系统有 Log4j、jdk-jul「即：java.util.logging」、logback 等，这些日志系统各自独立，编程方式也不一致。如果你一个系统要用到多个「框架库」，而这些框架库又可能要用不同的「日志系统」，那么你一个系统中就得使用多套日志系统，那多套日志系统如何融合在一起是个很大的问题。

3.日志框架

那么如何解决呢？进行抽象，抽象出一个接口层，对每个日志实现都适配或者转接，这样这些提供给别人的库都直接使用抽象层即可，不需要关注具体的日志实现。常见的日志抽象出来的框架有 Apache commons-logging 和 slf4j。抽象层可以让我们更加容易地改变项目现有的日志框架，或者集成那些使用了不同日志框架的项目。

4.日志故事

这里有个故事：最新是开源社区提供了 commons-logging 抽象，被称为 JCL 日志框架「JCL，全称为”Jakarta Commons Logging”，也可称为”Apache Commons Logging”」，出色地完成了兼容主流的日志实现「log4j、JUL、simplelog」，基本一统江湖，就连顶顶大名的 spring 也是依赖了 JCL。

看起来事物确实是美好，但是美好的日子不长，接下来另一个优秀的日志框架 slf4j 的加入导致了更加混乱的场面。比较巧的是 slf4j 的作者(Ceki Gülcü)就是 log4j 的作者，他觉得 JCL 不够优秀，所以他要自己搞一套更优雅的出来，于是 slf4j 日志体系诞生了，并为 slf4j 实现了一个亲子 —— logback，确实更加优雅。

但是由于之前很多代码库已经使用 JCL，虽然出现 slf4j 和 JCL 之间的桥接转换，但是集成的时候问题依然多多，对很多新手来说确实会很懊恼，因为比单独的 log4j 时代“复杂”多了，可以关注下这个，抱怨声确实很多。到此本来应该完了，但是 Ceki Gülcü 觉得还是得回头拯救下自己的 “大阿哥” —— log4j，于是 log4j2 诞生了，同样 log4j2 也参与到了 slf4j 日志体系中。日志体系的江湖又将面临血雨腥风的混乱了。

5.Loggers 组件

Loggers 组件在此系统中被分为五个级别：DEBUG、INFO、WARN、ERROR 和 FATAL。这五个级别是有顺序的，DEBUG < INFO < WARN < ERROR < FATAL，分别用来指定这条日志信息的重要程度。

FATAL      0  
ERROR      3  
WARN       4  
INFO       6  
DEBUG      7

Log4j 有一个规则：只输出级别不低于设定级别的日志信息，假设 Loggers 级别设定为INFO，则 INFO、WARN、ERROR 和 FATAL 级别的日志信息都会输出，而级别比 INFO 低的 DEBUG 则不会输出。

// 获取 Logger 对象
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
private static final Logger logger = LoggerFactory.getLogger(Test.class);

6.Appenders 组件

Appenders 为日志输出目的地，如控制台「Console」、文件「Files」等，还可以根据天数或者文件大小产生新的文件，可以以流的形式发送到其它地方等等。Log4j 提供的 appenders 有以下几种：

org.apache.log4j.ConsoleAppender「控制台」
org.apache.log4j.FileAppender「文件」
org.apache.log4j.DailyRollingFileAppender「每天产生一个日志文件」
org.apache.log4j.RollingFileAppender「文件大小到达指定尺寸的时候产生一个新的文件」
org.apache.log4j.WriterAppender「将日志信息以流格式发送到任意指定的地方」

配置模式：

log4j.appender.appenderName = className
log4j.appender.appenderName.Option1 = value1
......
log4j.appender.appenderName.OptionN = valueN

7.Layouts 指定日志输出格式

Layouts 指定日志输出格式。Layouts 提供四种日志输出样式：HTML样式、自由指定样式、包含日志级别与信息的样式、包含日志时间、线程、类别等信息的样式。

org.apache.log4j.HTMLLayout「以HTML表格形式布局」
org.apache.log4j.PatternLayout「可以灵活地指定布局模式」
org.apache.log4j.SimpleLayout「包含日志信息的级别和信息字符串」
org.apache.log4j.TTCCLayout「包含日志产生的时间、线程、类别等等信息」

配置模式：

log4j.appender.appenderName.layout = className
log4j.appender.appenderName.layout.Option1 = value1
......
log4j.appender.appenderName.layout.OptionN = valueN

8.配置详解

在实际应用中，要使 Log4j 在系统中运行须事先设定配置文件。配置文件事实上也就是对 Logger、Appender 及 Layout 进行相应设定。Log4j 支持两种配置文件格式:

一种是 XML 格式的文件。
一种是 properties 属性文件。

下面以 properties 属性文件为例介绍 log4j.properties 的配置。

8.1 配置根记录器 Logger

1
2
3

log4j.rootLogger = [level], appenderName1, appenderName2, ......  
# false：表示 Logger 不会在父 Logger 的 appender 里输出，默认为 true。
log4j.additivity.org.apache = false;

level：设定日志记录的最低级别，可设的值有 OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL 或者自定义的级别，Log4j 建议只使用中间四个级别。通过在这里设定级别，您可以控制应用程序中相应级别的日志信息的开关，比如在这里设定了INFO 级别，则应用程序中所有 DEBUG 级别的日志信息将不会被打印出来。
appendName：指定日志信息要输出到哪里。可以同时指定多个输出目的地，用逗号隔开。
1
log4j.rootLogger＝INFO, A1, B2, C3

8.2 配置输出目的地 appender

1 2	# appenderName：自定义 appderName，在 log4j.rootLogger 设置中使用。 log4j.appender.appenderName = className

className 可以设如下值：

# ConsoleAppender 选项
# Threshold = WARN：指定日志信息的最低输出级别，默认为 DEBUG。
# ImmediateFlush = true：表示所有消息都会被立即输出，设为 false 则不输出，默认值是 true。
# Target = System.err：默认值是 System.out。
org.apache.log4j.ConsoleAppender「控制台」

# FileAppender 选项
# Threshold = WARN「同上」
# ImmediateFlush = true「同上」
# Append = false：true 表示消息增加到指定文件中，false 则将消息覆盖指定的文件内容，默认值是 true。
# File = D:/logs/logging.log4j：指定消息输出到 D:/logs/logging.log4j 文件中。也可以使用相对路径。
org.apache.log4j.FileAppender「文件」

# DailyRollingFileAppender 选项
# Threshold = WARN「同上」
# ImmediateFlush = true「同上」
# Append = false「同上」
# File = D:/logs/logging.log4j「同上」
# encoding = UTF-8 指定输出内容所采用的字符集
# DatePattern = '.'yyyy-MM：每月滚动一次日志文件，即每月产生一个新的日志文件。当前月的日志文件名为logging.log4j，前一个月的日志文件名为logging.log4j.yyyy-MM。
org.apache.log4j.DailyRollingFileAppender「每天产生一个日志文件」

# RollingFileAppender 选项
# Threshold = WARN「同上」
# ImmediateFlush = true「同上」
# Append = false「同上」
# File = D:/logs/logging.log4j「同上」
# MaxFileSize = 100KB：后缀可以是 KB, MB 或者 GB。在日志文件到达该大小时，将会自动滚动，即将原来的内容移到 logging.log4j.1 文件中。
org.apache.log4j.RollingFileAppender「文件大小到达指定尺寸的时候产生一个新的文件」

org.apache.log4j.WriterAppender「将日志信息以流格式发送到任意指定的地方」

注意：配置消息输出路径的时候，可以使用相对路径，这里的相对路径的参照点为服务器的目录。如：log4j.appender.file.File = ../logs/info.log 该日志系统运行在 Tomcat 服务器上，所以其对应的绝对地址为：服务器 Tomcat 的绝对路径 + ../logs/info.log。

8.3 配置输出格式 Layout

1	log4j.appender.appenderName.layout = className

className 可以设如下值：

# LocationInfo = true：输出 java 文件名称和行号，默认值是 false。
# Title = My Logging： 默认值是 Log4J Log Messages。
org.apache.log4j.HTMLLayout「以HTML表格形式布局」

# ConversionPattern = %m%n：设定以怎样的格式显示消息。
org.apache.log4j.PatternLayout「可以灵活地指定布局模式」

org.apache.log4j.SimpleLayout「包含日志信息的级别和信息字符串」

org.apache.log4j.TTCCLayout「包含日志产生的时间、线程、类别等等信息」

参考博客

Java Log 日志
 log4j 详细介绍
 日志系统和日志框架
 Log4j.properties 配置详解-简书
 log4j.properties 配置详解-CSDN
为什么 logger 要声明为 static final