log4j日志配置文件详解

时间:2022-08-09 04:36:40


   博客来由,前一段时间,架构组统一修改了log4j的文件,修改之后,单元测试日志就打印不出来了。所以就学习了一下log4j.properties文件的配置。


1.log4j是什么?


    Log4j是Apache的一个开放源代码项目,通过使用Log4j,

(1)我们可以控制日志信息输送的目的地是控制台、文件、GUI组件、甚至是套接口服务器、NT的事件记录器、UNIX Syslog守护进程等;我们也可以控制每一条日志的输出格式;
(2)通过定义每一条日志信息的级别,我们能够更加细致地控制日志的生成过程。优点是,这些可以通过一个配置文件来灵活地进行配置,而不需要修改应用的代码。
(3)可以在多种语言中使用log4j,其语法和用法与在Java程序中一样,使得多语言分布式系统得到一个统一一致的日志组件模块


2.组成部分


由三个重要的组件构成,日志信息的优先级,日志信息的输出目的地,日志信息的输出格式。级别建议只使用四个级别,优先级从高到低分别为ERROR,Warn,Info,Debug.
。分别执行这条信息的重要程度。

(1)日志级别


log4j日志配置文件详解


(2)日志信息的输出目的


指定了日志将打印到控制台还是文件中。

其中,Log4j提供的layout有以下几种:

org.apache.log4j.ConsoleAppender(控制台),  
org.apache.log4j.FileAppender(文件), 
org.apache.log4j.DailyRollingFileAppender(每天产生一个日志文件), 
org.apache.log4j.RollingFileAppender(文件大小到达指定尺寸的时候产生一个新的文件), 
org.apache.log4j.WriterAppender(将日志信息以流格式发送到任意指定的地方)


(3)输出格式


控制了日志信息的显示内容。其中,Log4j提供的layout有以下几种:


org.apache.log4j.HTMLLayout(以HTML表格形式布局), 
org.apache.log4j.PatternLayout(可以灵活地指定布局模式), 
org.apache.log4j.SimpleLayout(包含日志信息的级别和信息字符串), 
org.apache.log4j.TTCCLayout(包含日志产生的时间、线程、类别等等信息)
Log4J采用类似C语言中的printf函数的打印格式格式化日志信息,打印参数如下: %m 输出代码中指定的消息
%p 输出优先级,即DEBUG,INFO,WARN,ERROR,FATAL 
%r 输出自应用启动到输出该log信息耗费的毫秒数 
%c 输出所属的类目,通常就是所在类的全名 
%t 输出产生该日志事件的线程名 
%n 输出一个回车换行符,Windows平台为“rn”,Unix平台为“n” 
%d 输出日志时间点的日期或时间,默认格式为ISO8601,也可以在其后指定格式,比如:%d{yyy MMM dd HH:mm:ss,SSS},输出类似:2002年10月18日 22:10:28,921 
%l 输出日志事件的发生位置,包括类目名、发生的线程,以及在代码中的行数


(4)三种方式总结


• Logger类:完成日志记录,设置日志信息级别
• Appender类:决定日志去向,终端、DB、硬盘
• Layout类:决定日志输出的样式,例如包含当前线程、行号、时间


3.重点配置解析


(1)  log4j.rootLogger=info, stdout,file


等号后面的第一个参数表示日志级别,可以填五个级别中的一种,后面的参数都是让Log知道输出到哪里,如果你想让日志输出到两个地方就加两个输出参数,比如:
log4j.rootLogger=info, stdout, file
这里的info表示,该Log的日志级别为info,所有级别小于info的日志都不会被记录
staout和file的作用。名字是随便起的,你可以叫它A。比如:
Log4j.appender.A=org.apache.log4j.ConsoleAppender.
那么上面的rootLogger的参数也要改为A,其他用到的地方当然也要改。这里关键不是名字,而是appender类型。比如这里的consoleAppender.


(2)log4j thread 属性指定输出等级


log4j.appender.A.Threshold=DEBUG
log4j.appender.B.Threshold=WARN

表示A的接收级别为debug,而B的接收级别为warn。这样,A就可以看到debug以上的所有日志,而写入B的只有warn级别以上的日志。
og4j.logger.XX cover ==> log4j.rootLogger
log4j.appender.XX.Threshold决定了最低接收级别
也就是说rootLogger首先决定所有log的输出级别,而log4j.logger.XX是对XX路径下的jar包的输出级别的修改,直接覆盖rootLogger

比如我设置如下:
log4j.rootLogger=debug,CONSOLE,file
log4j.appender.CONSOLE.Threshold=info
这个info级别会覆盖dubug的信息。最后控制台上输出的是info级别的信息。


4.项目中的应用


(1)dubbo支持


在dubbo框架内所有的日志输出都是通过
LoggerFactory这个静态工厂类来获得Logger的对象实体,并且抽离了一个LoggerAdapter用于对接第三方日志框架,所以就有了JDKLoggerAdapter,Log4jLoggerAdapter,SLF4JLogg erAdapter等一些实现子类,分别对接了不同Log第三方实现。这些子类的优先级如下,这里的优先级是只未配置指定的logger提供方的情况下,由dubbo框架自己选择。
第三方日志框架 优先级

Log4j             最高(默认就用这个)
SLF4J             次高
Common Logging(jcl就是common logging)  次低(Log4j和SLF4J在项目中均没有就用这个)
JDK log         最低   (最后的选择)


(2)项目中配置如下


# ##设置日志级别
# log4j.rootLogger=info,debug,CONSOLE,file
log4j.rootLogger=debug,CONSOLE,file
# ## 指定输出信息到控制台
log4j.addivity.org.apache=true
log4j.appender.CONSOLE=org.apache.log4j.ConsoleAppender
# thread属性,指定日志level.根据日志的重要程度,可以分为off,fatal,error,warn,info,debug。
log4j.appender.CONSOLE.Threshold=info
log4j.appender.CONSOLE.Target=System.out
log4j.appender.CONSOLE.Encoding= UTF-8
log4j.appender.CONSOLE.layout=org.apache.log4j.PatternLayout
log4j.appender.appender1.MaxFileSize=100KB

# ##输出Debug级别以上的日志到log文件夹下。
log4j.appender.file=org.apache.log4j.DailyRollingFileAppender
log4j.appender.file.DatePattern=yyyyMMdd
log4j.appender.file.File=../logs/teachingManagementService.log
# 每天的日志打印就不需要设置大小属性
# log4j.appender.file.MaxFileSize=20MB
# log4j.appender.file.MaxBackupIndex=10
log4j.appender.file.layout=org.apache.log4j.PatternLayout
log4j.appender.file.layout.ConversionPattern=%d [%X{uuid}] [%X{ip}] [%X{userId}] %-5p %l - %m%n

log4j.logger.com.alibaba.dubbo=error

(3)日志打印不出来原因?


项目中设置打印级别,设置为了error。如下

log4j.rootLogger=ERROR,CONSOLE,file
log4j.appender.CONSOLE.Threshold=ERROR

设置为error之后,在生产环境中,只打印错误信息是可以的。但是如果是本地单元测试时,如果打印级别设置为error,就打印不出来日志信息。所以走单元测试,好多日志信息就打印不出来。将日志级别修改成为info或者debug之后,就可以成功,打印日志信息了。


小结


遇到问题,解决问题,学习了一下日志配置的相关信息。