log4j
日志:系统的运行信息,功能主要用于系统调试和后期维护
运行的日志记录占代码总量的4%
Apache开源项目Log4j
可以控制日志的输出设置(控制台、文件等)
可以控制日志的输出格式
通过日志级别、控制日志的生成过程
特点:通过配置文件灵活配置
对比System.out不利于维护
开发步骤
导入jar包
1.创建记录器Logger
private static Logger LOG = Logger.getLogger(TestLog4j.class.getName())
2.设置默认配置(输出到控制台)
BasicConfigurator.configure();
3.设置输出级别(可选)
LOG.setLevel(Level.ERROR)
4.输入内容
LOG.trace("这个trace输出"); //堆栈
LOG.debug("这个debug输出"); //调试
LOG.info("这个info输出"); //信息
LOG.warn("这个warn输出"); //警告
LOG.error("这个error输出"); //严重
LOG.fatal("这个fatal输出"); //致命
日记级别:由高到低,六个级别
fatal(致命)、error(错误)、warn(警告)、info(信息)、debug(调试)、trace(栈)
设置级别:fatal、error、warn、info、debug、trace、off关闭、all所有
Logger对象,提供方法确定使用哪个级别提示。
public void debug(Object message)
public void info(Object message)
public void warn(Object message)
public void error(Object message)
方法的执行顺序 : 当前级别,以及更高级别都将执行
trace级别:所有的方法都执行
info级别:info/warn/error/fatal
配置文件
文件名称:log4j.properties
文件位置:src
文件内容:
记录器(Loggers),设置级别与输出源
log4j.rootLogger=输出级别,输出源1,输出源2...
例如:log4j.rootLogger=info.stdout
输出源(Appenders),确定输出位置
语法 log4j.appender.名称 = 实现类
属性语法 log4j.appender.名称.属性 = 值 --执行实现类的setter方法,将值进行赋值。
实现类:log4j 已经提供好的
org.apache.log4j.ConsoleAppender 输出到控制台
target 确定使用什么语句进行输出 取值:System.out、System.err
org.apache.log4j.FileAppender 输出到文本
布局(Layouts),确定输出格式
语法:log4j.appender.名称.layout = 实现类
布局参数语法:lo4j.appender.名称.ConversionPattern = 参数
Lo4j汇总
1.配置根Logger:
1 | |
2 |
log4j.rootLogger = [ level ] , appenderName1, appenderName2, … |
3 |
log4j.additivity.org.apache=false:表示Logger不会在父Logger的appender里输出,默认为true。 |
4 |
level :设定日志记录的最低级别,可设的值有OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL或者自定义的级别,Log4j建议只使用中间四个级别。通过在这里设定级别,您可以控制应用程序中相应级别的日志信息的开关,比如在这里设定了INFO级别,则应用程序中所有DEBUG级别的日志信息将不会被打印出来。 |
5 |
appenderName:就是指定日志信息要输出到哪里。可以同时指定多个输出目的地,用逗号隔开。 |
6 |
例如:log4j.rootLogger=INFO,A1,B2,C3 |
7 |
2.配置日志信息输出目的地(appender)
01 | |
02 |
log4j.appender.appenderName = className |
03 |
appenderName:自定义appderName,在log4j.rootLogger设置中使用; |
04 |
className:可设值如下: |
05 |
(1)org.apache.log4j.ConsoleAppender(控制台) |
06 |
(2)org.apache.log4j.FileAppender(文件) |
07 |
(3)org.apache.log4j.DailyRollingFileAppender(每天产生一个日志文件) |
08 |
(4)org.apache.log4j.RollingFileAppender(文件大小到达指定尺寸的时候产生一个新的文件) |
09 |
(5)org.apache.log4j.WriterAppender(将日志信息以流格式发送到任意指定的地方) |
10 |
(1)ConsoleAppender选项: |
11 |
Threshold=WARN:指定日志信息的最低输出级别,默认为DEBUG。 |
12 |
ImmediateFlush=true:表示所有消息都会被立即输出,设为false则不输出,默认值是true。 |
13 |
Target=System.err:默认值是System.out。 |
14 |
(2)FileAppender选项: |
15 |
Threshold=WARN:指定日志信息的最低输出级别,默认为DEBUG。 |
16 |
ImmediateFlush=true:表示所有消息都会被立即输出,设为false则不输出,默认值是true。 |
17 |
Append=false:true表示消息增加到指定文件中,false则将消息覆盖指定的文件内容,默认值是true。 |
18 |
File=D:/logs/logging.log4j:指定消息输出到logging.log4j文件中。 |
19 |
(3)DailyRollingFileAppender选项: |
20 |
Threshold=WARN:指定日志信息的最低输出级别,默认为DEBUG。 |
21 |
ImmediateFlush=true:表示所有消息都会被立即输出,设为false则不输出,默认值是true。 |
22 |
Append=false:true表示消息增加到指定文件中,false则将消息覆盖指定的文件内容,默认值是true。 |
23 |
File=D:/logs/logging.log4j:指定当前消息输出到logging.log4j文件中。 |
24 |
DatePattern=‘.‘yyyy-MM:每月滚动一次日志文件,即每月产生一个新的日志文件。当前月的日志文件名为logging.log4j,前一个月的日志文件名为logging.log4j.yyyy-MM。 |
25 |
另外,也可以指定按周、天、时、分等来滚动日志文件,对应的格式如下: |
26 |
1)‘.‘yyyy-MM:每月 |
27 |
2)‘.‘yyyy-ww:每周 |
28 |
3)‘.‘yyyy-MM-dd:每天 |
29 |
4)‘.‘yyyy-MM-dd-a:每天两次 |
30 |
5)‘.‘yyyy-MM-dd-HH:每小时 |
31 |
6)‘.‘yyyy-MM-dd-HH-mm:每分钟 |
32 |
(4)RollingFileAppender选项: |
33 |
Threshold=WARN:指定日志信息的最低输出级别,默认为DEBUG。 |
34 |
ImmediateFlush=true:表示所有消息都会被立即输出,设为false则不输出,默认值是true。 |
35 |
Append=false:true表示消息增加到指定文件中,false则将消息覆盖指定的文件内容,默认值是true。 |
36 |
File=D:/logs/logging.log4j:指定消息输出到logging.log4j文件中。 |
37 |
MaxFileSize=100KB:后缀可以是KB, MB 或者GB。在日志文件到达该大小时,将会自动滚动,即将原来的内容移到logging.log4j.1文件中。 |
38 |
MaxBackupIndex=2:指定可以产生的滚动文件的最大数,例如,设为2则可以产生logging.log4j.1,logging.log4j.2两个滚动文件和一个logging.log4j文件。 |
39 |
3.配置日志信息的输出格式(Layout)
01 | |
02 |
log4j.appender.appenderName.layout=className |
03 |
className:可设值如下: |
04 |
(1)org.apache.log4j.HTMLLayout(以HTML表格形式布局) |
05 |
(2)org.apache.log4j.PatternLayout(可以灵活地指定布局模式) |
06 |
(3)org.apache.log4j.SimpleLayout(包含日志信息的级别和信息字符串) |
07 |
(4)org.apache.log4j.TTCCLayout(包含日志产生的时间、线程、类别等等信息) |
08 |
(1)HTMLLayout选项: |
09 |
LocationInfo=true:输出java文件名称和行号,默认值是false。 |
10 |
Title=My Logging: 默认值是Log4J Log Messages。 |
11 |
(2)PatternLayout选项: |
12 |
ConversionPattern=%m%n:设定以怎样的格式显示消息。 |
13 |
格式化符号说明: |
14 |
%p:输出日志信息的优先级,即DEBUG,INFO,WARN,ERROR,FATAL。 |
15 |
%d:输出日志时间点的日期或时间,默认格式为ISO8601,也可以在其后指定格式,如:%d{yyyy/MM/dd HH:mm:ss,SSS}。 |
16 |
%r:输出自应用程序启动到输出该log信息耗费的毫秒数。 |
17 |
%t:输出产生该日志事件的线程名。 |
18 |
%l:输出日志事件的发生位置,相当于%c.%M(%F:%L)的组合,包括类全名、方法、文件名以及在代码中的行数。例如:test.TestLog4j.main(TestLog4j.java:10)。 |
19 |
%c:输出日志信息所属的类目,通常就是所在类的全名。 |
20 |
%M:输出产生日志信息的方法名。 |
21 |
%F:输出日志消息产生时所在的文件名称。 |
22 |
%L::输出代码中的行号。 |
23 |
%m::输出代码中指定的具体日志信息。 |
24 |
%n:输出一个回车换行符,Windows平台为"rn",Unix平台为"n"。 |
25 |
%x:输出和当前线程相关联的NDC(嵌套诊断环境),尤其用到像java servlets这样的多客户多线程的应用中。 |
26 |
%%:输出一个"%"字符。 |
27 |
另外,还可以在%与格式字符之间加上修饰符来控制其最小长度、最大长度、和文本的对齐方式。如: |
28 |
1) c:指定输出category的名称,最小的长度是20,如果category的名称长度小于20的话,默认的情况下右对齐。 |
29 |
2)%-20c:"-"号表示左对齐。 |
30 |
3)%.30c:指定输出category的名称,最大的长度是30,如果category的名称长度大于30的话,就会将左边多出的字符截掉,但小于30的话也不会补空格。 |
31 |
附:Log4j比较全面的配置
01 | |
02 |
Log4j配置文件实现了输出到控制台、文件、回滚文件、发送日志邮件、输出到数据库日志表、自定义标签等全套功能。 |
03 |
log4j.rootLogger=DEBUG,console,dailyFile,im |
04 |
log4j.additivity.org.apache=true |
05 |
# 控制台(console) |
06 |
log4j.appender.console=org.apache.log4j.ConsoleAppender |
07 |
log4j.appender.console.Threshold=DEBUG |
08 |
log4j.appender.console.ImmediateFlush=true |
09 |
log4j.appender.console.Target=System.err |
10 |
log4j.appender.console.layout=org.apache.log4j.PatternLayout |
11 |
log4j.appender.console.layout.ConversionPattern=[%-5p] %d(%r) --> [%t] %l: %m %x %n |
12 |
|
13 |
# 日志文件(logFile) |
14 |
log4j.appender.logFile=org.apache.log4j.FileAppender |
15 |
log4j.appender.logFile.Threshold=DEBUG |
16 |
log4j.appender.logFile.ImmediateFlush=true |
17 |
log4j.appender.logFile.Append=true |
18 |
log4j.appender.logFile.File=D:/logs/log.log4j |
19 |
log4j.appender.logFile.layout=org.apache.log4j.PatternLayout |
20 |
log4j.appender.logFile.layout.ConversionPattern=[%-5p] %d(%r) --> [%t] %l: %m %x %n |
21 |
# 回滚文件(rollingFile) |
22 |
log4j.appender.rollingFile=org.apache.log4j.RollingFileAppender |
23 |
log4j.appender.rollingFile.Threshold=DEBUG |
24 |
log4j.appender.rollingFile.ImmediateFlush=true |
25 |
log4j.appender.rollingFile.Append=true |
26 |
log4j.appender.rollingFile.File=D:/logs/log.log4j |
27 |
log4j.appender.rollingFile.MaxFileSize=200KB |
28 |
log4j.appender.rollingFile.MaxBackupIndex=50 |
29 |
log4j.appender.rollingFile.layout=org.apache.log4j.PatternLayout |
30 |
log4j.appender.rollingFile.layout.ConversionPattern=[%-5p] %d(%r) --> [%t] %l: %m %x %n |
31 |
# 定期回滚日志文件(dailyFile) |
32 |
log4j.appender.dailyFile=org.apache.log4j.DailyRollingFileAppender |
33 |
log4j.appender.dailyFile.Threshold=DEBUG |
34 |
log4j.appender.dailyFile.ImmediateFlush=true |
35 |
log4j.appender.dailyFile.Append=true |
36 |
log4j.appender.dailyFile.File=D:/logs/log.log4j |
37 |
log4j.appender.dailyFile.DatePattern=‘.‘yyyy-MM-dd |
38 |
log4j.appender.dailyFile.layout=org.apache.log4j.PatternLayout |
39 |
log4j.appender.dailyFile.layout.ConversionPattern=[%-5p] %d(%r) --> [%t] %l: %m %x %n |
40 |
# 应用于socket |
41 |
log4j.appender.socket=org.apache.log4j.RollingFileAppender |
42 |
log4j.appender.socket.RemoteHost=localhost |
43 |
log4j.appender.socket.Port=5001 |
44 |
log4j.appender.socket.LocationInfo=true |
45 |
# Set up for Log Factor 5 |
46 |
log4j.appender.socket.layout=org.apache.log4j.PatternLayout |
47 |
log4j.appender.socket.layout.ConversionPattern=[%-5p] %d(%r) --> [%t] %l: %m %x %n |
48 |
# Log Factor 5 Appender |
49 |
log4j.appender.LF5_APPENDER=org.apache.log4j.lf5.LF5Appender |
50 |
log4j.appender.LF5_APPENDER.MaxNumberOfRecords=2000 |
51 |
# 发送日志到指定邮件 |
52 |
log4j.appender.mail=org.apache.log4j.net.SMTPAppender |
53 |
log4j.appender.mail.Threshold=FATAL |
54 |
log4j.appender.mail.BufferSize=10 |
55 |
log4j.appender.mail.From = [email protected] |
56 |
log4j.appender.mail.SMTPHost=mail.com |
57 |
log4j.appender.mail.Subject=Log4J Message |
58 |
log4j.appender.mail.To= [email protected] |
59 |
log4j.appender.mail.layout=org.apache.log4j.PatternLayout |
60 |
log4j.appender.mail.layout.ConversionPattern=[%-5p] %d(%r) --> [%t] %l: %m %x %n |
61 |
# 应用于数据库 |
62 |
log4j.appender.database=org.apache.log4j.jdbc.JDBCAppender |
63 |
log4j.appender.database.URL=jdbc:mysql://localhost:3306/test |
64 |
log4j.appender.database.driver=com.mysql.jdbc.Driver |
65 |
log4j.appender.database.user=root |
66 |
log4j.appender.database.password= |
67 |
log4j.appender.database.sql=INSERT INTO LOG4J (Message) VALUES(‘=[%-5p] %d(%r) --> [%t] %l: %m %x %n‘) |
68 |
log4j.appender.database.layout=org.apache.log4j.PatternLayout |
69 |
log4j.appender.database.layout.ConversionPattern=[%-5p] %d(%r) --> [%t] %l: %m %x %n |
70 |
|
71 |
# 自定义Appender |
72 |
log4j.appender.im = net.cybercorlin.util.logger.appender.IMAppender |
73 |
log4j.appender.im.host = mail.cybercorlin.net |
74 |
log4j.appender.im.username = username |
75 |
log4j.appender.im.password = password |
76 |
log4j.appender.im.recipient = [email protected] |
77 |
log4j.appender.im.layout=org.apache.log4j.PatternLayout |
78 |
log4j.appender.im.layout.ConversionPattern=[%-5p] %d(%r) --> [%t] %l: %m %x %n |