【Java】异常处理之使用Log4j

朱雀 2024-03-23 20:27 51阅读 0赞

## 使用 Log4j ##

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

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

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

log.info("User signed in.");
     │
     │   ┌──────────┐    ┌──────────┐    ┌──────────┐    ┌──────────┐
     ├──>│ Appender │───>│  Filter  │───>│  Layout  │───>│ Console  │
     │   └──────────┘    └──────────┘    └──────────┘    └──────────┘
     │
     │   ┌──────────┐    ┌──────────┐    ┌──────────┐    ┌──────────┐
     ├──>│ Appender │───>│  Filter  │───>│  Layout  │───>│   File   │
     │   └──────────┘    └──────────┘    └──────────┘    └──────────┘
     │
     │   ┌──────────┐    ┌──────────┐    ┌──────────┐    ┌──────────┐
     └──>│ Appender │───>│  Filter  │───>│  Layout  │───>│  Socket  │
         └──────────┘    └──────────┘    └──────────┘    └──────────┘

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

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

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

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

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

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

<?xml version="1.0" encoding="UTF-8"?>
    <Configuration>
    	<Properties>
            
    		<Property name="log.pattern">%d{MM-dd HH:mm:ss.SSS} [%t] %-5level %logger{36}%n%msg%n%n</Property>
            
    		<Property name="file.err.filename">log/err.log</Property>
    		<Property name="file.err.pattern">log/err.%i.log.gz</Property>
    	</Properties>
        
    	<Appenders>
            
    		<Console name="console" target="SYSTEM_OUT">
                
    			<PatternLayout pattern="${log.pattern}" />
    		</Console>
            
    		<RollingFile name="err" bufferedIO="true" fileName="${file.err.filename}" filePattern="${file.err.pattern}">
    			<PatternLayout pattern="${log.pattern}" />
    			<Policies>
                    
    				<SizeBasedTriggeringPolicy size="1 MB" />
    			</Policies>
                
    			<DefaultRolloverStrategy max="10" />
    		</RollingFile>
    	</Appenders>
    	<Loggers>
    		<Root level="info">
                
    			<AppenderRef ref="console" level="info" />
                
    			<AppenderRef ref="err" level="error" />
    		</Root>
    	</Loggers>
    </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的日志输出，类似：

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

## 最佳实践 ##

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

## 小结 ##

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

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

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