Log4j详细介绍

ゝ一纸荒年。 2022-05-31 04:57 298阅读 0赞

## 1 log4j介绍 ##

Log4j log for java(java的日志) 是java主流的日志框架，提供各种类型，各种存储，各种格式，多样化的日志服务；

--------------------

## 2 入门案例 ##

步骤一：  
建一个Maven简单项目 ，并pom.xml引入log4j

步骤二：  
配置log4j.properties

#日志的等级和要输出的形式,这里是要输出到控制台和文档里
    log4j.rootLogger=DEBUG, Console ,File 
    
    #控制台中具体要输出的样式 
    #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://log.log
    log4j.appender.File.layout = org.apache.log4j.PatternLayout
    log4j.appender.File.layout.ConversionPattern =%d [%t] %-5p [%c] - %m%n

步骤三：  
测试类

package com.java1234.log4j;
    
    import org.apache.log4j.Logger;
    
    public class Log4jTest { 
    
        private static Logger logger=Logger.getLogger(Log4jTest.class);
        public static void main(String[] args) {
    
            logger.info("普通信息");
            logger.debug("调试信息");
            //也可以输出异常
            logger.error("参数错误",new IllegalArgumentException());
        }
    }

这时候控制台就会输出日志和C盘就会出现一个日志文档log.log。

--------------------

## 3 Log4j日志等级 ##

Log4j根据日志信息的重要程度，分OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL。当然再细分的话 还有 FATAL（严重错误），但是Log4j官方建议实际实用的话，Log4j建议只使用四个级别，优先级从高到低分别是 ERROR、WARN、INFO、DEBUG。

--------------------

## 4 Log4j rootLogger配置 ##

Log4j 根配置语法：

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

level 表示日志等级  
appenderName表示输出类型（控制台 文档 ……）

--------------------

## 5 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.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。**

这里给下日志文件的效果：  
DailyRollingFileAppender 效果：  
![这里写图片描述][SouthEast]

RollingFileAppender 效果：  
![这里写图片描述][1490686652333016707.jpg]

--------------------

## 6 log4j layout日志信息格式 ##

Log4j提供的layout有以下几种  
org.apache.log4j.HTMLLayout（以HTML表格形式布局），  
org.apache.log4j.PatternLayout（可以灵活地指定布局模式），  
org.apache.log4j.SimpleLayout（包含日志信息的级别和信息字符串），  
org.apache.log4j.TTCCLayout（包含日志产生的时间、线程、类别等等信息）

HTMLLayout实例，我们把前面的实例的配置文件改下：

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

输出结果为html格式，标准的table表格格式，显示信息包括 线程 等级 类 报错信息；

**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 输出日志事件的发生位置，及在代码中的行数；  
注意：上面的5为了对齐级别字样。

SimpleLayout简单布局：

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

TTCCLayout我们测试下：

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

--------------------

## 7 Log4j Threshold属性指定输出等级 ##

有时候**我们需要把一些报错ERROR日志单独存到指定文件** ，这时候，Threshold属性就派上用场了；

Threshold属性可以指定日志level ，比如我们指定某个appender的Threshold为WARN，那这个appender输出的日志信息就是WARN级别以及WARN以上的级别； 假如我们指定的是ERROR，那这个就输出ERROR或者FATAL日志信息；  
当然这里有个提前 rootLogger里配置的level比如小于Threshold层级 否则无效 还是按照总的rootLogger里的level来输出，**一般我们实际实用的话 rootLogger里配置DEBUG，然后某个文件专门存储ERRO日志，就配置下Threshold为ERROR，**这个就是我们的最佳实践，不要乱七八糟瞎配置。

我们给下参考配置：

log4j.rootLogger=DEBUG, Console ,DFile ,EFILE
    
    #Console 
    log4j.appender.Console=org.apache.log4j.ConsoleAppender  
    log4j.appender.Console.layout=org.apache.log4j.TTCCLayout  
    
    #DEBUGFile
    log4j.appender.DFile = org.apache.log4j.FileAppender
    log4j.appender.DFile.File = C://DEBUG.log
    log4j.appender.DFile.layout = org.apache.log4j.PatternLayout
    log4j.appender.DFile.layout.ConversionPattern =%d [%t] %-5p [%c] - %m%n
    log4j.appender.DFile.Threshold = DEBUG
    
    #ERRORFile
    log4j.appender.EFILE = org.apache.log4j.FileAppender
    log4j.appender.EFILE.File = C://ERROR.log
    log4j.appender.EFILE.layout = org.apache.log4j.PatternLayout
    log4j.appender.EFILE.layout.ConversionPattern =%d [%t] %-5p [%c] - %m%n
    log4j.appender.EFILE.Threshold = ERROR

rootLogger里配置DEBUG，  
DFile的Threshold 配置为DEBUG  
EFILE的Threshold 配置为ERROR 只输入ERROR信息；

![这里写图片描述][1490779256583017738.jpg]

ERROR.LOG只输出error信息；  
![这里写图片描述][1490779268208098150.jpg]

--------------------

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

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

我们来测试下：

log4j.rootLogger=DEBUG, Console ,FIEL
    
    #Console 
    log4j.appender.Console=org.apache.log4j.ConsoleAppender  
    log4j.appender.Console.layout=org.apache.log4j.TTCCLayout  
    
    #FIEL
    log4j.appender.FIEL = org.apache.log4j.FileAppender
    log4j.appender.FIEL.File = C://log.log
    log4j.appender.FIEL.layout = org.apache.log4j.PatternLayout
    log4j.appender.FIEL.layout.ConversionPattern =%d [%t] %-5p [%c] - %m%n
    #改成了 Append false
    log4j.appender.FIEL.Append = false

注意：log4j.rootLogger=DEBUG, Console ,FIEL中的FIEL和log4j.appender.FIEL保持一致即可。  
了解一下就可以了 一般是不进行配置该属性 默认为true

[SouthEast]: /images/20220531/7dc8a6256910444798e206d3274283d5.png
[1490686652333016707.jpg]: /images/20220531/d8f4024a84cd45069c61cf935eac8d3f.png
[1490779256583017738.jpg]: /images/20220531/daec34944436459f9691c403cdd2c157.png
[1490779268208098150.jpg]: /images/20220531/c6dd4402f4424007b7e64e2288cebdbe.png