Log4j

48 阅读 0 评论 32 点赞

我是靠谱客的博主腼腆茉莉，最近开发中收集的这篇文章主要介绍Log4j，觉得挺不错的，现在分享给大家，希望可以做个参考。

概述

Log4j

- - 一、Log4j简介
  - 二、Log4j 案例
  - 三、配置详解

一、Log4j简介

Log4j log for java(java的日志) 是java主流的日志框架，提供各种类型，各种存储，各种格式，多样化的日志服务在爬虫领域，主要用于记录爬虫的执行过程，方便排查爬虫执行错误问题；

详细介绍参考百度百科

二、Log4j 案例

三、配置详解

rootLogger根配置

rootLogger :指代把指定级别的日志信息输出到指定的一个或者多个位置

log4j.rootLogger = [ level ] , appenderName, appenderName, … //level 表示日志等级
例如：
log4j.rootLogger=DEBUG, Console ,File  //将日志等级为debug的日志输出到Console或者File中。

log4j日志等级
Log4j 根据日志信息的重要程度，分为OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL。当然再细分的话还有FATAl（严重错误)，但是Log4j官方建议实际使用的话，Log4j建议只使用四个级别，优先级从高到底分别是ERROR、WARN、INFO、DEBUG。当日志级别设置为低等级则其他日志等级可以显示，当设置为高等级则其他低等级不可显示

当日志等级设置为ERROR时

log4j.rootLogger=ERROR, Console ,File

在这里插入图片描述

当日志等级设置为DEBUG时

log4j.rootLogger=DEBUG, Console ,File

在这里插入图片描述

Log4j appender输出类型配置
Log4j官方的appender给出了一下几种实现

org.apache.log4j.ConsoleAppender（控制台），  

org.apache.log4j.FileAppender（文件），  

org.apache.log4j.DailyRollingFileAppender（每天产生一个日志文件），  

org.apache.log4j.RollingFileAppender（文件大小到达指定尺寸的时候产生一个新的文件），  

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

实际开发我们使用第1，第3和第4种实现；
假如日志数据量不是很大，我们可以用DailyRollingFileAppender 每天产生一个日志，方便查看；
假如日志数据量很大，我们一般用RollingFileAppender，固定尺寸的日志，假如超过了就产生一个新的文件；

具体的类，可以去log4j jar包下查看，重点是PropertyConfigurator

在这里插入图片描述
PropertyConfigurator.class

实例

log4j.rootLogger=DEBUG, Console ,File ,DailyRollingFile ,RollingFile
    
#Console  控制台
log4j.appender.Console=org.apache.log4j.ConsoleAppender  
log4j.appender.Console.layout=org.apache.log4j.PatternLayout  
log4j.appender.Console.layout.ConversionPattern=%d [%t] %-5p [%c] - %m%n
    
#File   文件
log4j.appender.File = org.apache.log4j.FileAppender
log4j.appender.File.File = C://log2.log
log4j.appender.File.layout = org.apache.log4j.PatternLayout
log4j.appender.File.layout.ConversionPattern =%d [%t] %-5p [%c] - %m%n
 
#DailyRollingFile  每天产生一个新的文件
log4j.appender.DailyRollingFile = org.apache.log4j.DailyRollingFileAppender
log4j.appender.DailyRollingFile.File = C://log3.log
log4j.appender.DailyRollingFile.layout = org.apache.log4j.PatternLayout
log4j.appender.DailyRollingFile.layout.ConversionPattern =%d [%t] %-5p [%c] - %m%n
 
#RollingFile 文件到达指定尺寸，产生一个新的文件
log4j.appender.RollingFile = org.apache.log4j.RollingFileAppender
log4j.appender.RollingFile.File = C://log4.log
log4j.appender.RollingFile.MaxFileSize=1KB
log4j.appender.RollingFile.MaxBackupIndex=3
log4j.appender.RollingFile.layout = org.apache.log4j.PatternLayout
log4j.appender.RollingFile.layout.ConversionPattern =%d [%t] %-5p [%c] - %m%n

这里有两个新的配置项解释下：

MaxFileSize 是日志文件的最大尺寸；根据实际需求来定 10KB 100KB也行
MaxBackupIndex是日志文件的个数，假如超过了，则覆盖，主要考虑到的是硬盘的容量问题；根据实际需求来定比如 100 500；

log4j layout日志信息格式
Log4j提供的layout有以下几种

org.apache.log4j.HTMLLayout（以HTML表格形式布局），  

org.apache.log4j.PatternLayout（可以灵活地指定布局模式），  

org.apache.log4j.SimpleLayout（包含日志信息的级别和信息字符串），  

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

布局为HTMLLayout

log4j.appender.Console.layout=org.apache.log4j.HTMLLayout

结果为：

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>Log4J Log Messages</title>
<style type="text/css">
<!--
body, table {font-family: arial,sans-serif; font-size: x-small;}
th {background: #336699; color: #FFFFFF; text-align: left;}
-->
</style>
</head>
<body bgcolor="#FFFFFF" topmargin="6" leftmargin="6">
<hr size="1" noshade>
Log session start time Fri Jun 03 15:07:03 CST 2022<br>
<br>
<table cellspacing="0" cellpadding="4" border="1" bordercolor="#224466" width="100%">
<tr>
<th>Time</th>
<th>Thread</th>
<th>Level</th>
<th>Category</th>
<th>Message</th>
</tr>

<tr>
<td>0</td>
<td title="main thread">main</td>
<td title="Level"><font color="#339933">DEBUG</font></td>
<td title="com.cjw.log4j.TestLog4j category">com.cjw.log4j.TestLog4j</td>
<td title="Message">调试debug信息</td>
</tr>

<tr>
<td>21</td>
<td title="main thread">main</td>
<td title="Level"><font color="#993300"><strong>ERROR</strong></font></td>
<td title="com.cjw.log4j.TestLog4j category">com.cjw.log4j.TestLog4j</td>
<td title="Message">报错error信息</td>
</tr>

<tr>
<td>22</td>
<td title="main thread">main</td>
<td title="Level"><font color="#993300"><strong>WARN</strong></font></td>
<td title="com.cjw.log4j.TestLog4j category">com.cjw.log4j.TestLog4j</td>
<td title="Message">警告warn信息</td>
</tr>

<tr>
<td>22</td>
<td title="main thread">main</td>
<td title="Level"><font color="#993300"><strong>FATAL</strong></font></td>
<td title="com.cjw.log4j.TestLog4j category">com.cjw.log4j.TestLog4j</td>
<td title="Message">毁灭性的信息</td>
</tr>

<tr>
<td>22</td>
<td title="main thread">main</td>
<td title="Level">INFO</td>
<td title="com.cjw.log4j.TestLog4j category">com.cjw.log4j.TestLog4j</td>
<td title="Message">普通Info信息</td>
</tr>

<tr>
<td>23</td>
<td title="main thread">main</td>
<td title="Level">INFO</td>
<td title="com.cjw.log4j.TestLog4j category">com.cjw.log4j.TestLog4j</td>
<td title="Message">普通info信息</td>
</tr>
<tr><td bgcolor="#993300" style="color:White; font-size : xx-small;" colspan="6">java.lang.Exception: 普通info
<br>&nbsp;&nbsp;&nbsp;&nbsp;	at com.cjw.log4j.TestLog4j.main(TestLog4j.java:21)
</td></tr>

<tr>
<td>25</td>
<td title="main thread">main</td>
<td title="Level">INFO</td>
<td title="com.cjw.log4j.TestLog4j category">com.cjw.log4j.TestLog4j</td>
<td title="Message">erro信息</td>
</tr>
<tr><td bgcolor="#993300" style="color:White; font-size : xx-small;" colspan="6">java.lang.IllegalArgumentException: 非法参数
<br>&nbsp;&nbsp;&nbsp;&nbsp;	at com.cjw.log4j.TestLog4j.main(TestLog4j.java:22)
</td></tr>

布局为PatternLayout

PatternLayout是我们以后推荐使用的，很灵活；

有个ConversionPattern属性，灵活配置输出属性：

%m 输出代码中指定的消息；

%M 输出打印该条日志的方法名；

%p 输出优先级，即DEBUG，INFO，WARN，ERROR，FATAL；

%r 输出自应用启动到输出该log信息耗费的毫秒数；

%c 输出所属的类目，通常就是所在类的全名；

%t 输出产生该日志事件的线程名；

%n 输出一个回车换行符，Windows平台为"rn”，Unix平台为"n”；

%d 输出日志时间点的日期或时间，默认格式为ISO8601，也可以在其后指定格式，比如：%d{yyyy-MM-dd HH:mm:ss,SSS}，输出类似：2002-10-18 22:10:28,921；

%l 输出日志事件的发生位置，及在代码中的行数；

布局为SimpleLayout

log4j.appender.Console.layout=org.apache.log4j.SimpleLayout

在这里插入图片描述

布局为TTCCLayout

log4j.appender.Console.layout=org.apache.log4j.TTCCLayout

在这里插入图片描述

Log4j Threshold属性指定输出等级

作用：有时候我们需要把一些报错ERROR日志单独存到指定文件，这时候，Threshold属性就派上用场了;
Threshold属性可以指定日志level ,Log4j根据日志信息的重要程度，分OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL 。比如我们指定某个appender的Threshold为WARN，那这个appender输出的日志信息就是WARN级别以及WARN以上的级别；假如我们指定的是ERROR，那这个就输出ERROR或者FATAL日志信息;
rootLogger里配置的level小于Threshold层级 否则无效还是按照总的rootLogger里的level来输出;
一般我们实际实用的话 rootLogger里配置DEBUG，然后某个文件专门存储ERRO日志，就配置下Threshold为ERROR，这个就是我们的最佳实践；

例如：

Threshold 分别设置为ERROR、DEBUG

在这里插入图片描述

设置DEBUG得到的信息
设置ERROR得到的信息

在这里插入图片描述

Log4j Append属性指定是否追加内容

Log4j默认是不断的把日志内容追加到日志文件；
这里就有个属性 Append 默认就是true；
假如我们设置成false 就不追加了直接覆盖前面的内容；

例如：

log4j.appender.File.Append=false  //将rootLogger为File设置不自动追加

执行程序多次后依旧是如下内容：
在这里插入图片描述

log4j.logger 针对不同包或类的个性化配置
当我们需要针对不同的类或者包设置日志级别，其他的类保持不变时，那么我们就采用log4j.logger。

增加TestLog4jLogger作为测试

import org.apache.log4j.Logger;
public class TestLog4jLogger {

    public static void main(String[] args) {
        Logger logger = Logger.getLogger(TestLog4jLogger.class);
        logger.debug("TestLog4jLogger_______调试debug信息");
        logger.error("TestLog4jLogger_______报错error信息");
        logger.warn("TestLog4jLogger_______警告warn信息");
        logger.fatal("TestLog4jLogger_______毁灭性的信息");//一般用不到
        logger.info("TestLog4jLogger_______普通Info信息");
        logger.info("普通info信息", new Exception("普通info"));
        logger.info("erro信息", new IllegalArgumentException("非法参数")) ;
    }
}

配置log4j.properties

log4j.rootLogger=DEBUG, Console, File
log4j.logger.com.cjw.log4j.TestLog4jLogger=error, DFILE

#Console
log4j.appender.Console=org.apache.log4j.ConsoleAppender  
log4j.appender.Console.layout=org.apache.log4j.PatternLayout  
log4j.appender.Console.layout.ConversionPattern=%d [%t] %-5p [%c] - %m%n
#File
log4j.appender.File = org.apache.log4j.FileAppender
log4j.appender.File.File = C://Users//tiaoxiaozi//Desktop//log.log
log4j.appender.File.layout = org.apache.log4j.PatternLayout
log4j.appender.File.layout.ConversionPattern =%d [%t] %-5p [%c] - %m%n
log4j.appender.File.Append=false

#DFILE
log4j.appender.DFILE=org.apache.log4j.FileAppender
log4j.appender.DFILE.File=C://Users//tiaoxiaozi//Desktop//log_error.log
log4j.appender.DFILE.layout=org.apache.log4j.PatternLayout
log4j.appender.DFILE.layout.ConversionPattern =%d [%t] %-5p [%c] - %m%n
log4j.appender.DFILE.Append=false

其中log4j.logger.com.cjw.log4j.TestLog4jLogger=error, DFILE单独为TestLog4jLogger配置的，注意不要在log4j.rootLogger再配置DFILE, 否则就相当于全局设置。log4j.logger后面配置也是log4j.logger.类名或者包名=[level], appenderName,.....。

测试单独设置类时，查看TestLog4jLogger和TestLog4j 是否在log_error中生成日志：
TestLog4jLogger结果：
TestLog4j 结果：
测试单独设置包时，查看TestLog4jLogger和testpackage 是否在log_error中生成日志：
在com.cjw包下增加testpackage, 该类中的方法和其他一致的类一致。

TestLog4jLogger结果：
TestLog4j 结果：