使用Log4j

前面介绍了Commons Logging，可以作为“日志接口”来使用。而真正的“日志实现”可以使用Log4j。

Log4j是一种非常流行的日志框架，最新版本是2.x。

Log4j是一个组件化设计的日志系统，它的架构大致如下：

  1. log.info("User signed in.");
  2.  │
  3.  │   ┌──────────┐    ┌──────────┐    ┌──────────┐    ┌──────────┐
  4.  ├──>│ Appender │───>│  Filter  │───>│  Layout  │───>│ Console  │
  5.  │   └──────────┘    └──────────┘    └──────────┘    └──────────┘
  6.  │
  7.  │   ┌──────────┐    ┌──────────┐    ┌──────────┐    ┌──────────┐
  8.  ├──>│ Appender │───>│  Filter  │───>│  Layout  │───>│   File   │
  9.  │   └──────────┘    └──────────┘    └──────────┘    └──────────┘
  10.  │
  11.  │   ┌──────────┐    ┌──────────┐    ┌──────────┐    ┌──────────┐
  12.  └──>│ Appender │───>│  Filter  │───>│  Layout  │───>│  Socket  │
  13.      └──────────┘    └──────────┘    └──────────┘    └──────────┘

当我们使用Log4j输出一条日志时，Log4j自动通过不同的Appender把同一条日志输出到不同的目的地。例如：

  • console：输出到屏幕；
  • file：输出到文件；
  • socket：通过网络输出到远程计算机；
  • jdbc：输出到数据库

在输出日志的过程中，通过Filter来过滤哪些log需要被输出，哪些log不需要被输出。例如，仅输出ERROR级别的日志。

最后，通过Layout来格式化日志信息，例如，自动添加日期、时间、方法名称等信息。

上述结构虽然复杂，但我们在实际使用的时候，并不需要关心Log4j的API，而是通过配置文件来配置它。

以XML配置为例，使用Log4j的时候，我们把一个log4j2.xml的文件放到classpath下就可以让Log4j读取配置文件并按照我们的配置来输出日志。下面是一个配置文件的例子：

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <Configuration>
  3.     <Properties>
  4.         <!-- 定义日志格式 -->
  5.         <Property name="log.pattern">%d{MM-dd HH:mm:ss.SSS} [%t] %-5level %logger{36}%n%msg%n%n</Property>
  6.         <!-- 定义文件名变量 -->
  7.         <Property name="file.err.filename">log/err.log</Property>
  8.         <Property name="file.err.pattern">log/err.%i.log.gz</Property>
  9.     </Properties>
  10.     <!-- 定义Appender，即目的地 -->
  11.     <Appenders>
  12.         <!-- 定义输出到屏幕 -->
  13.         <Console name="console" target="SYSTEM_OUT">
  14.             <!-- 日志格式引用上面定义的log.pattern -->
  15.             <PatternLayout pattern="${log.pattern}" />
  16.         </Console>
  17.         <!-- 定义输出到文件,文件名引用上面定义的file.err.filename -->
  18.         <RollingFile name="err" bufferedIO="true" fileName="${file.err.filename}" filePattern="${file.err.pattern}">
  19.             <PatternLayout pattern="${log.pattern}" />
  20.             <Policies>
  21.                 <!-- 根据文件大小自动切割日志 -->
  22.                 <SizeBasedTriggeringPolicy size="1 MB" />
  23.             </Policies>
  24.             <!-- 保留最近10份 -->
  25.             <DefaultRolloverStrategy max="10" />
  26.         </RollingFile>
  27.     </Appenders>
  28.     <Loggers>
  29.         <Root level="info">
  30.             <!-- 对info级别的日志，输出到console -->
  31.             <AppenderRef ref="console" level="info" />
  32.             <!-- 对error级别的日志，输出到err，即上面定义的RollingFile -->
  33.             <AppenderRef ref="err" level="error" />
  34.         </Root>
  35.     </Loggers>
  36. </Configuration>

虽然配置Log4j比较繁琐，但一旦配置完成，使用起来就非常方便。对上面的配置文件，凡是INFO级别的日志，会自动输出到屏幕，而ERROR级别的日志，不但会输出到屏幕，还会同时输出到文件。并且，一旦日志文件达到指定大小（1MB），Log4j就会自动切割新的日志文件，并最多保留10份。

有了配置文件还不够，因为Log4j也是一个第三方库，我们需要从这里下载Log4j，解压后，把以下3个jar包放到classpath中：

  • log4j-api-2.x.jar
  • log4j-core-2.x.jar
  • log4j-jcl-2.x.jar

因为Commons Logging会自动发现并使用Log4j，所以，把上一节下载的commons-logging-1.2.jar也放到classpath中。

要打印日志，只需要按Commons Logging的写法写，不需要改动任何代码，就可以得到Log4j的日志输出，类似：

  1. 03-03 12:09:45.880 [main] INFO  com.itranswarp.learnjava.Main
  2. Start process...

最佳实践

在开发阶段，始终使用Commons Logging接口来写入日志，并且开发阶段无需引入Log4j。如果需要把日志写入文件， 只需要把正确的配置文件和Log4j相关的jar包放入classpath，就可以自动把日志切换成使用Log4j写入，无需修改任何代码。

练习

根据配置文件，观察Log4j写入的日志文件。

从使用Log4j - 图1下载练习：commons logging + log4j （推荐使用IDE练习插件快速下载）

小结

通过Commons Logging实现日志，不需要修改代码即可使用Log4j；

使用Log4j只需要把log4j2.xml和相关jar放入classpath；

如果要更换Log4j，只需要移除log4j2.xml和相关jar；

只有扩展Log4j时，才需要引用Log4j的接口（例如，将日志加密写入数据库的功能，需要自己开发）。

读后有收获可以支付宝请作者喝咖啡：

使用Log4j - 图2