Log4j 入门（一）

目录

一、引言

二、简介

1、控制台输出 

2、参数说明

（1）log4j.rootLogger = level, appenderName1, appenderName2, … 

（2） 配置日志信息输出目的地 Appender

（3）配置日志信息的格式（布局）

（4） log4j.appender.appenderName.option

（5）ConversionPattern日志信息

---

一、引言

市场上存在非常多的日志框架。JUL（java.util.logging），JCL（Apache Commons Logging），Log4j，Log4j2，Logback、SLF4j、jboss-logging等。Spring Boot在框架内容部使用JCL，spring-boot-starter-logging采用了 slf4j+logback的形式，Spring Boot也能自动适配（jul、log4j2、logback） 并简化配置。

日志门面	日志实现
JCL（Jakarta Commons Logging）	Log4j、Log4j2
SLF4j（Simple Logging Facade for Java）	Logback
jboss-logging	JUL（java.util.logging）

二、简介

Log4j是Apache的一个开源项目，通过使用Log4j，我们可以控制日志信息输送的目的地是控制台、文件、GUI组件，甚至是套接口服务器、NT的事件记录器、UNIX Syslog守护进程等；我们也可以控制每一条日志的输出格式；通过定义每一条日志信息的级别。（引用百度百科）

Log4j有7种不同的log级别，按照等级从低到高依次为：trace、debug、info、warn、error、fatal、off。如果配置为off级别，表示关闭log。 Log4j官方建议实际实用的话，Log4j建议只使用四个级别，优先级从高到低分别是 debug、info、warn、error。

Log4j支持两种格式的配置文件：properties和xml。包含三个主要的组件：Logger、appender、Layout。

1、控制台输出 

通过如下配置，设定root日志的输出级别为INFO，appender为控制台输出stdout

#配置级别。默认输出debug
log4j.rootLogger = info,console,fileAppender,dailyRollingFile,ROLLING_FILE,MAIL,DATABASE

#设置输出sql的级别，其中logger后面的内容全部为jar包中所包含的包名
log4j.logger.org.apache=dubug
log4j.logger.java.sql.Connection=dubug
log4j.logger.java.sql.Statement=dubug
log4j.logger.java.sql.PreparedStatement=dubug
log4j.logger.java.sql.ResultSet=dubug

#配置输出到控制台
log4j.appender.console = org.apache.log4j.ConsoleAppender
log4j.appender.console.Target = System.out       #默认情况下是：System.out,指定输出控制台
log4j.appender.console.layout = org.apache.log4j.PatternLayout  #以灵活地指定布局模式
log4j.appender.console.layout.ConversionPattern =  %d{ABSOLUTE} %5p %c{1}:%L - %m%n

#配置输出到文件
log4j.appender.fileAppender = org.apache.log4j.FileAppender
log4j.appender.fileAppender.File = logs/log.log
log4j.appender.fileAppender.Append = true
log4j.appender.fileAppender.Threshold = DEBUG   #指定日志消息的输出最低层次。
log4j.appender.fileAppender.layout = org.apache.log4j.PatternLayout
log4j.appender.fileAppender.layout.ConversionPattern = %-d{yyyy-MM-dd HH:mm:ss}  [ %t:%r ] - [ %p ]  %m%n

#配置输出到文件，并且每天都创建一个文件
log4j.appender.dailyRollingFile = org.apache.log4j.DailyRollingFileAppender
log4j.appender.dailyRollingFile.File = logs/log.log
log4j.appender.dailyRollingFile.Append = true
log4j.appender.dailyRollingFile.Threshold = DEBUG
log4j.appender.dailyRollingFile.layout = org.apache.log4j.PatternLayout
log4j.appender.dailyRollingFile.layout.ConversionPattern = %-d{yyyy-MM-dd HH:mm:ss}  [ %t:%r ] - [ %p ]  %m%n

#配置输出到文件，且大小到达指定尺寸的时候产生一个新的文件
log4j.appender.ROLLING_FILE=org.apache.log4j.RollingFileAppender 
log4j.appender.ROLLING_FILE.Threshold=ERROR 
log4j.appender.ROLLING_FILE.File=rolling.log 
log4j.appender.ROLLING_FILE.Append=true 
log4j.appender.ROLLING_FILE.MaxFileSize=10KB 
log4j.appender.ROLLING_FILE.MaxBackupIndex=1 
log4j.appender.ROLLING_FILE.layout=org.apache.log4j.PatternLayout 
log4j.appender.ROLLING_FILE.layout.ConversionPattern=[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n

#配置输出到邮件
log4j.appender.MAIL=org.apache.log4j.net.SMTPAppender
log4j.appender.MAIL.Threshold=FATAL
log4j.appender.MAIL.BufferSize=10
log4j.appender.MAIL.From=example@xxx.com
log4j.appender.MAIL.SMTPHost=mail.xxxxxx.com
log4j.appender.MAIL.Subject=Log4J Message
log4j.appender.MAIL.To=example@xxx.com
log4j.appender.MAIL.layout=org.apache.log4j.PatternLayout
log4j.appender.MAIL.layout.ConversionPattern=[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n

#配置输出到数据库
log4j.appender.DATABASE=org.apache.log4j.jdbc.JDBCAppender
log4j.appender.DATABASE.URL=jdbc:mysql://localhost:3306/test
log4j.appender.DATABASE.driver=com.mysql.jdbc.Driver
log4j.appender.DATABASE.user=root
log4j.appender.DATABASE.password=
log4j.appender.DATABASE.sql=INSERT INTO LOG4J (Message) VALUES ('[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n')
log4j.appender.DATABASE.layout=org.apache.log4j.PatternLayout
log4j.appender.DATABASE.layout.ConversionPattern=[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n
log4j.appender.A1=org.apache.log4j.DailyRollingFileAppender
log4j.appender.A1.File=SampleMessages.log4j
log4j.appender.A1.DatePattern=yyyyMMdd-HH'.log4j'
log4j.appender.A1.layout=org.apache.log4j.xml.XMLLayout

2、参数说明

（1）log4j.rootLogger = level, appenderName1, appenderName2, … 

level : 是日志记录的优先级。Log4j有7种不同的log级别，按照等级从低到高依次为：trace、debug、info、warn、error、fatal、off。如果配置为off级别，表示关闭log。 Log4j官方建议实际实用的话，Log4j建议只使用四个级别，优先级从高到低分别是 debug、info、warn、error。比如在这里定义了info级别，则应用程序中所有debug级别的日志信息将不被打印出来。

appenderName：就是指定日志信息输出到哪个地方。可以同时指定多个输出目的地。

（2） 配置日志信息输出目的地 Appender

其语法为： 

log4j.appender.appenderName = fully.qualified.name.of.appender.class。其中fully.qualified.name.of.appender.class有以下几种选择： 

        1）org.apache.lcog4j.ConsoleAppender （控制台） 

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

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

    #log4j.appender.appenderName = org.apache.log4j.DailyRollingFileAppender。今天是2019-12-13，到明天这个文件将更名为debug.log.2019-12-14。

log4j.appender.File.DatePattern='.'yyyy-MM-dd
每天	’.’YYYY-MM-dd（默认）
每星期	’.’YYYY-ww
每月	’.’YYYY-MM
每隔半天	’.’YYYY-MM-dd-a
每小时	’.’YYYY-MM-dd-HH
每分钟	’.’YYYY-MM-dd-HH-mm

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

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

（3）配置日志信息的格式（布局）

其语法为： 

        log4j.appender.appenderName.layout = fully.qualified.name.of.layout.class。其中，fully.qualified.name.of.layout.class有以几种选择： 

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

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

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

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

（4） log4j.appender.appenderName.option

option 可替换的属性：

1）ConsoleAppender控制台选项

      ① Threshold=DEBUG：指定日志消息的输出最低层次。

      ② ImmediateFlush=true：默认值是true，表示所有的消息都会被立即输出。

      ③ Target=System.err：默认情况下是：System.out，指定输出控制台

2）FileAppender 文件选项

　　　  ① Threshold=DEBUF：指定日志消息的输出最低层次。

　　　  ② ImmediateFlush=true：默认值是true，表示所有的消息都会被立即输出。

　　　  ③ File=log.txt：指定消息输出到log.txt文件。

　　　  ④ Append=false：默认值是true，即将消息增加到指定文件中，false指将消息覆盖指定的文件内容。

　　3）RollingFileAppender 每天生成一个文件选项

　　　  ① Threshold=DEBUG：指定日志消息的输出最低层次。

　　　  ② ImmediateFlush=true：默认值是true,意谓着所有的消息都会被立即输出。

　　　  ③ File=log.txt：指定消息输出到log.txt文件。

　　　  ④ Append=false：默认值是true，即将消息增加到指定文件中，false指将消息覆盖指定的文件内容。

　　　  ⑤ MaxFileSize=100KB：后缀可以是KB，MB 或是 GB。在日志文件到达该大小时，将会自动滚动，即将原来的内容移到mylog.log.1文件。

　　　  ⑥ MaxBackupIndex=2：指定可以产生的滚动文件的最大数。

（5）ConversionPattern日志信息

log4j.appender.console.layout.ConversionPattern，符号所代表的含义： 

-X	X信息输出时左对齐
%p	输出日志信息优先级。即DEBUG，INFO，WARN，ERROR，FATAL
%d	输出日志时间点的日期或时间。默认格式为ISO8601，也可以在其后指定格式，比如：%d{yyy MMM dd HH:mm:ss,SSS}
%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字符，就从左边较远输出的字符截掉。