Log4j & Log4j2

前言

       今天抽时间来把这个日志框架学学，毕竟经常用，虽然不用自己写，但是书到用时方恨少，技多不压身。而且最近我的 GUI 软件中有一个关于日志问题的希望学完能够感觉解决掉。

Log4j & Log4j2

       Log4j2 是 Log4j 的升级版，2015年5月，Apache 宣布停止 log4j 的更新，最终的版本定格在了 1.2.17。

1、Log4j

       Log4j 有三大组件：Loggers（记录器）、Appenders（输出源）和 Layouts（布局）。可以简单理解为

• Loggers：日志的类型，比如 DEBUG（调试信息）、INFO、WARN、ERROR、FATAL
• Appenders：日志输出到哪里，比如控制台，甚至可以是 GUI 组件，比如 JavaFX、Swing 的 TextArea ，这也是我重点希望了解的
• 和 Layouts：日志以怎样的形式输出，比如 ${yyyy-MM-dd HH:mm:ss}

1.1、Loggers

       在设置日志输出的时候，会设置一个日志的输出级别，只有大于等于这个级别的日志才会输出。

       DEBUG < INFO < WARN < ERROR < FATAL

1.2、Appenders

       日志的输出源，可以是控制台（Console），可以是文件（File），或者是我们 Java Swing 和 JavaFX 的 TextArea 这种 GUI 控件中。        

       可以根据文件的大小产生新的文件，可以以流的形式发送到其它地方等。

常用的类：

• org.apache.log4j.ConsoleAppender（控制台）
• org.apache.log4j.FileAppender（文件）
• org.apache.log4j.DailyRollingFileAppender（每天产生一个新的文件，比如 hive.log）
• org.apache.log4j.RollingFileAppender（文件大小达到指定大小就产生一个新的文件）
• org.apache.log4j.WriterAppender（将日志信息以流格式发送到任意指定的地方）

       基本上可以满足我们日常的需求，如果我们的需求比较特殊，比如把日志输出到 JavaFX 的 TextArea 中，输出到 org.fxmisc.richtext 的 CodeArea 中，那么我们就可以自定义一个 Appender 类实现 AppenderSkeleton 接口。AppenderSkeleton 接口定义了一系列记录日志的方法，我们按照自己的需求实现这些方法即可。

1.3、Layouts

       用户可以根据自己的喜好格式化自己的日志输出，Layouts 提供了四种日志的输出样式，比如根据 HTML 样式、自由指定样式、包含日志级别与信息的样式和包含日志时间、线程、类别等信息的样式。

常用的类如下：

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

1.4、Log4j 的使用

       log4j 的使用依赖配置文件。log4j 支持两种配置文件的形式，一种是 XML 格式、一种是 .properties 文件。

1.4.1、导包

<dependency>
    <groupId>log4j</groupId>
    <artifactId>log4j</artifactId>
    <version>1.2.17</version>
</dependency>

1.4.2、创建配置文件

日志配置文件：log4j.properties 或者 logback.xml。

普通 Java 项目放到 src 同级目录下，maven 项目下放到 src/main/resources/ 目录下

# 指定日志输出级别，输出源
log4j.rootLogger=INFO,textArea,FILE
 
# 输出到 GUI 组件
log4j.appender.textArea=org.apache.log4j.ConsoleAppender
log4j.appender.textArea.layout=org.apache.log4j.PatternLayout
log4j.appender.textArea.layout.ConversionPattern=%-d{yyyy-MM-dd HH:mm:ss}  [ %p ]  %m%n
 
# 输出到文件
log4j.appender.FILE=org.apache.log4j.RollingFileAppender
log4j.appender.FILE.File=./logs/app.log
log4j.appender.FILE.Append=true
log4j.appender.FILE.layout=org.apache.log4j.PatternLayout
log4j.appender.FILE.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss} %-5p %c{1}:%L - %m%n

1.4.3、使用

class Test{
    
    // 一般都是定义为静态全局变量
    private final static Logger logger = Logger.getLogger(Test.class);
 
    public static void main(String[] args){
        // 需要输出日志的时候直接调用
        logger.info("这是一段 info 级别的日志");
        logger.error("这里一段 error 级别的日志");
    }
}

1.4.4、配置文件详解

示例

log4j.rootLogger=INFO,A1
log4j.appender.A1=org.apache.log4j.ConsoleAppender
log4j.appender.A1.layout=org.apache.log4j.PatternLayout
log4j.appender.A1.layout.ConversionParttern=%-4r %-5p [%t] %37c %3x - %m%n

1）配置根目录的语法

log4j.rootLogger=[ level ] , appenderName , appenderName ...

       其中，level 是优先级，分为 OFF、FATTAL、ERROR、WARN、INFO 、DEBUG、ALL 或者自定义方级别。Log4j 建议只使用四个级别，优先级从高到低地刺是 ERROR、WARN、INFO 、DEBUG。如果在配置文件指定了 INFO 级别，那么所有 DEBUG 的信息将不被打印出来。

       appenderName 就是指定日志信息输出到哪个地方，这个名字是我们自己起的。

2）配置日志信息输出源 Appender

log4j.appender.appenderName = fully.qualified.name.of.appender.class
log4j.appender.appenderName.optionl = value1
...
log4j.appender.appenderName.option = valueN

其中，Log4j 提供方 appender 有以下几种：

• org.apache.log4j.ConsoleAppender（控制台）
• org.apache.log4j.FileAppender（文件）
• org.apache.log4j.DailyRollingFileAppender（每天产生一个新的文件，比如 hive.log）
• org.apache.log4j.RollingFileAppender（文件大小达到指定大小就产生一个新的文件）
• org.apache.log4j.WriterAppender（将日志信息以流格式发送到任意指定的地方）

当然也可以是我们自定义的 appender ，比如我的下一篇文章中使用的 com.lyh.util.MyAppender。

不同的 appender 有不同的配置选项：

（1）ConsoleAppender 选项

• Threshold=WARN （指定日志消息的输出最低层次）
• ImmediateFlush=true （默认为true，意味着所有的消息被立即输出）
• Target=System.err （默认下为 System.out,指定输出控制台）

（2）FileAppender 选项

• Threshold=WARN （指定日志消息的输出最低层次）
• ImmediateFlush=true （默认为true，意味着所有的消息被立即输出）
• File=mylog.txt （指定消息输出到 mylog.txt）
• Append=false （默认是true，即将消息追加到指定文件，false指将消息覆盖指定的文件内容）
• DataPattern='.'yyyy-ww （每周滚动一次文件，即每周产生一个新的文件）

也可以设置为每月、周、天、时和分：

1. '.'yyyy-MM （每月）
2. '.'yyyy-ww （每周）
3. '.'yyyy-MM-dd （每天）
4. '.'yyyy-MM-dd-a （每天两次）
5. '.'yyyy-MM-dd-HH （每小时）
6. '.'yyyy-MM-dd-HH-mm （每分钟）

（4）RollingFileAppender 选项

• Threshold=WARN （指定日志消息的输出最低层次）
• ImmediateFlush=true （默认为true，意味着所有的消息被立即输出）
• File=mylog.txt （指定消息输出到 mylog.txt）
• Append=false （默认是true，即将消息追加到指定文件，false指将消息覆盖指定的文件内容）
• MaxFileSize=100KB（后缀可以是 KB,MB 或者 GB，当日志大小达到该大小时，会自动滚动，将原来的内容移动到 mylog.1 文件）
• MaxBackupIndex=2 （指定可以产生的滚动文件的最大数）

3）配置日志信息的布局

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

了解即可

4）输出格式设置

在配置文件中通过 log4j.appender.A1.layout.ConversionPattern 设置日志输出格式。

参数：

• %p：输出日志信心优先级，也就是 DEBUG，IOFO，WARN，ERROR，FATAL
• %d：输出日志的时间或日期，默认格式为 ISO8601 ，也可以指定格式，比如 %d{yyyy MM dd HH:mm:ss,SSS} ，输出 2024年01月29日19:20:15,200
• %r：输出自应用启动到输出该 log 信息消耗的毫秒数
• %c：输出日志信息所属类目，通常就是所在类的全名
• %t：输出产生该日志事件的线程名
• %l：输出日志事件的发生位置，相当于 %C.%M(%F:%L) 的组合，包括类目名、发生的线程，已经在代码中的行数。比如 Test.main(Test.java:10)
• %x：输出和当前线程相关联的 NDC（嵌套诊断环境），尤其用到像 Java servlets 这样的多客户线程的应用中。
• %%：输出 %
• %F：输出日志消息产生时所在的文件名称
• %L：输出代码中的行符
• %m：输出代码中指定的消息，产生的日志具体信息
• %n：输出一个回车换行符，windows平台为 "\r\n"，unix平台为 "\n"

2、Log4j2

总结