log4j的常用用法
最近一段时间一直在用别人封装好,配置好的日志类记录日志,感觉挺好奇的。下面就记录一下用log4j处理日志的常用用法。
至于log4j是什么,我不清楚,暂时也觉得没必要太深入,只知道是处理日志比较好的选择。
Game Starts
参考文档
1)官方pdf文档
依赖jar包
1)log4j-api-2.0.2.jar
2)log4j-core-2.0.2.jar [D]
主要的类
1)Logger
看名字也就知道是干什么的了,就是靠他来记录日志,但是具体的实现类已经封装在log4j-core-2.0.2.jar 里,我们只需配置他处理方式
常用的有info(Message);warn(Message);Error(Message);
2)LogManager
通过静态方法LogManager.getLogger(Name);来获取我们定义的Logger。这里传递的Name和配置文件有关
3)Config
配置文件主要常用两种log4j2.xml,log4j.properties;
配置文件要放在classPath下,一般就是放在src下就行。
(log4j2只能以xml,json格式配置)
4)Appender
配置文件中配置,指明日志的展现介质
1 org.apache.log4j.ConsoleAppender(控制台), 2 org.apache.log4j.FileAppender(文件), 3 org.apache.log4j.DailyRollingFileAppender(每天产生一个日志文件), 4 org.apache.log4j.RollingFileAppender(文件大小到达指定尺寸的时候产生一个新的文件), 5 org.apache.log4j.WriterAppender(将日志信息以流格式发送到任意指定的地方)
展现格式(目前只会PatternLayout,觉得这个用的也最多)
1 org.apache.log4j.HTMLLayout(以HTML表格形式布局), 2 org.apache.log4j.PatternLayout(可以灵活地指定布局模式), 3 org.apache.log4j.SimpleLayout(包含日志信息的级别和信息字符串), 4 org.apache.log4j.TTCCLayout(包含日志产生的时间、线程、类别等等信息)
属性配置
控制台选项 Threshold=DEBUG:指定日志消息的输出最低层次。 ImmediateFlush=true:默认值是true,意谓着所有的消息都会被立即输出。 Target=System.err:默认情况下是:System.out,指定输出控制台 FileAppender 选项 Threshold=DEBUF:指定日志消息的输出最低层次。 ImmediateFlush=true:默认值是true,意谓着所有的消息都会被立即输出。 File=mylog.txt:指定消息输出到mylog.txt文件。 Append=false:默认值是true,即将消息增加到指定文件中,false指将消息覆盖指定的文件内容。 RollingFileAppender 选项 Threshold=DEBUG:指定日志消息的输出最低层次。 ImmediateFlush=true:默认值是true,意谓着所有的消息都会被立即输出。 File=mylog.txt:指定消息输出到mylog.txt文件。 Append=false:默认值是true,即将消息增加到指定文件中,false指将消息覆盖指定的文件内容。 MaxFileSize=100KB: 后缀可以是KB, MB 或者是 GB. 在日志文件到达该大小时,将会自动滚动,即将原来的内容移到mylog.log.1文件。 MaxBackupIndex=2:指定可以产生的滚动文件的最大数。
5)Level
日志记录器(Logger)的行为是分等级的。 具体分为:OFF、 FATAL、ERROR、WARN、INFO、DEBUG、TRACE、ALL或者您定义的级别。 Log4j建议只使用四个级别,优先级从高到低分别是 ERROR、WARN、INFO、DEBUG。 通过在这里定义的级别,您可以控制到应用程序中相应级别的日志信息的开关。 比如在这里定义了INFO级别, 则应用程序中所有DEBUG级别的日志信息将不被打印出来。 程序会打印高于或等于所设置级别的日志,设置的日志等级越高,打印出来的日志就越少。 如果设置级别为INFO,则优先级高于等于INFO级别(如:INFO、 WARN、ERROR)的日志信息将可以被输出,小于该级别的如DEBUG将不会被输出。 本篇文章来源于 Linux公社网站(www.linuxidc.com) 原文链接:http://www.linuxidc.com/Linux/2012-09/70120.htm
6)Pattern
日志信息格式中几个符号所代表的含义: -X号: X信息输出时左对齐; %p: 输出日志信息优先级,即DEBUG,INFO,WARN,ERROR,FATAL, %d: 输出日志时间点的日期或时间,默认格式为ISO8601,也可以在其后指定格式,比如:%d{yyy MMM dd HH:mm:ss,SSS},输出类似:2002年10月18日 22:10:28,921 %r: 输出自应用启动到输出该log信息耗费的毫秒数 %c: 输出日志信息所属的类目,通常就是所在类的全名 %t: 输出产生该日志事件的线程名 %l: 输出日志事件的发生位置,相当于%C.%M(%F:%L)的组合,包括类目名、发生的线程,以及在代码中的行数。举例:Testlog4.main (TestLog4.java:10) %x: 输出和当前线程相关联的NDC(嵌套诊断环境),尤其用到像java servlets这样的多客户多线程的应用中。 %%: 输出一个"%"字符 %F: 输出日志消息产生时所在的文件名称 %L: 输出代码中的行号 %m: 输出代码中指定的消息,产生的日志具体信息 %n: 输出一个回车换行符,Windows平台为"/r/n",Unix平台为"/n"输出日志信息换行 可以在%与模式字符之间加上修饰符来控制其最小宽度、最大宽度、和文本的对齐方式。如: 1)%20c:指定输出category的名称,最小的宽度是20,如果category的名称小于20的话,默认的情况下右对齐。 2)%-20c:指定输出category的名称,最小的宽度是20,如果category的名称小于20的话,"-"号指定左对齐。 3)%.30c:指定输出category的名称,最大的宽度是30,如果category的名称大于30的话,就会将左边多出的字符截掉,但小于30的话也不会有空格。 4)%20.30c:如果category的名称小于20就补空格,并且右对齐,如果其名称长于30字符,就从左边较远输出的字符截掉。
Always Be Coding
1)log4j2.xml
1 <?xml version="1.0" encoding="UTF-8"?> 2 <Configuration status="WARN"> 3 <Appenders> 4 <Console name="Console" target="SYSTEM_OUT"> <!--控制台输出 --> 5 <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n"/> 6 </Console> 7 <File name="File"> <!--文件输出 --> 8 <PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss} - %msg%n"/> 9 </File> 10 </Appenders> 11 <Loggers> 12 <Root level="error"> <!-- 根级日志,level为error --> 13 <AppenderRef ref="Console"/> 14 </Root> 15 <Logger name = "mylogger" level="info"> <!-- 自定义日志,level为info,代码中通过LogManager.getLogger("mylogger")获取 --> 16 <AppenderRef ref="File" /> <!--指定为文件展示方式--> 17 </Logger> 18 </Loggers> 19 </Configuration>
2)log4j.properties
1 #根级logger 2 log4j.rootLogger = info 3 #配置控制台appender 4 log4j.appender.stdout = org.apache.log4j.ConsoleAppender 5 log4j.appender.stdout.Target = System.out 6 log4j.appender.stdout.layout = org.apache.log4j.PatternLayout 7 log4j.appender.stdout.layout.ConversionPattern = %d{ABSOLUTE} %5p %c{ 1 }:%L - %m%n 8 #配置文件appender 9 log4j.appender.D = org.apache.log4j.FileAppender 10 log4j.appender.D.File = /logs/log.log 11 log4j.appender.D.Append = true 12 log4j.appender.D.layout = org.apache.log4j.PatternLayout 13 log4j.appender.D.layout.ConversionPattern = %-d{yyyy-MM-dd HH:mm:ss} [ %t:%r ] - [ %p ] %m%n 14 #自定义logger,logger配置规则:log4j.logger.${loggerName}=level,appender1,appender2.... 15 log4j.logger.mylogger=level,D
3)日志层级关系
总是说到根级日志,什么意思呢?
日志像类一样是有父子关系的,rootLogger是所有logger的父级
若有log4j.logger.A.B和log4j.logger.A两个logger那么A就是A.B的父级
有什么用呢?就像构造方法一样,在执行子级logger的方法时,同时也会调用父级的方法。
4)代码调用
1 package com.apache.log4j; 2 3 import org.apache.logging.log4j.LogManager; 4 import org.apache.logging.log4j.Logger; 5 6 public class LogWriter { 7 public static void main(String[] args) { 8 //Logger logger = LogManager.getLog(LogWriter.class);//二者一样 9 Logger logger = LogManager.getRootLogger(); 10 logger.error("hello"); 11 } 12 }