背景
程序开发调试中,不可缺少的便是日志管理,常用的日志管理框架有如下几种:
- Log4j:Apache Log4j是一个基于Java的日志记录工具。它是由Ceki Gülcü首创的,现在则是Apache软件基金会的一个项目。 Log4j是几种Java日志框架之一。
- Log4j 2: Apache Log4j 2是Apache开发的一款Log4j的升级产品。
- Commons Logging: Apache基金会所属的项目,是一套Java日志接口,之前叫Jakarta Commons Logging,后更名为Commons Logging。
- Slf4j: 类似于Commons Logging,是一套简易Java日志门面,本身并无日志的实现。(Simple Logging Facade for Java,缩写Slf4j)。
- Logback: 一套日志组件的实现(Slf4j阵营)。
- Jul (Java Util Logging),自Java1.4以来的官方日志实现。
因框架众多,本章重点介绍Log4j使用方法,在文中若有误解的地方烦请各位读者提出,在这里小编先感谢百忙之中的您提出宝贵的意见。
Log4j入门介绍
- Log4j是什么?
一个开源的、轻量级的、用于日志管理的框架。
- Log4j用途?
- 日志监控打印,在项目运行期需要记录用户所有的操作;
- 程序调试期间,记录运行的步骤和运行;
- 多个日志的输出源,比如到数据库、eclipse控制台,或者日志文件到linux服务器下等。
- Log4j常用配置文件有以下两种方式:
- log4j.properties
- log4j.xml
Log4j日志级别
Log4j日志级别有以下几种:
- OFF 最高等级,用于关闭所有日志记录;
- FATAL 指出每个严重的错误事件将会导致应用程序的退出;
- ERROR 指出虽然发生错误事件,但仍然不影响系统的继续运行;
- WARN 表明会出现潜在的错误情形;
- INFO 一般和在粗粒度级别上,强调应用程序的运行全程;
- DEBUG 一般用于细粒度级别上,对调试应用程序非常有帮助。
- ALL 最低等级,用于打开所有日志记录。
常用日志级别:
- 常用日志级别有:ERROR、WARN、INFO、DEBUG;
- 排列顺序(从高到低):DEBUG < INFO < WARN < ERROR;
- 日志打印规则: 打印自身往后靠。
获取方式
private static final Logger logger = Logger.getLogger(ClassName.class);
输出源Appender、布局LayOut
- 输出源Appender
- 布局LayOut
- Appender、Layout、Logger三者之间的关系:
- 每个appender后面必然需要跟随layout,指定自己的风格样式 ;
- 每个Logger都可以指定一个级别,同时引用多个Appender;
- 每个Appender也同时可以被多个Logger引用。
配置文件设置
rootLogger(配置根logger)
rootLogger语法:
log4j.rootLogger = [ level], appenderName1, appenderName2, appenderNameN
说明:
1. level为日志记录的优先级;
2. appenderName为日志的输出地方;
例如:
log4j.appender.appenderName1 = org.apache.log4j.ConsoleAppender
appender(配置日志输出目的地)
appender语法:
# 控制台
log4j.appender.appenderName = org.apache.log4j.ConsoleAppender
# 文件
log4j.appender.appenderName = org.apache.log4j.FileAppender
# 每天产生一个日志文件
log4j.appender.appenderName = org.apache.log4j.DailyRollingFileAppender
# 文件大小到达指定尺寸的时候产生一个新的文件
log4j.appender.appenderName = org.apache.log4j.RollingFileAppender
# 将日志信息以流格式发送到任意指定的地方
log4j.appender.appenderName = org.apache.log4j.WriterAppender
# 把日志用JDBC记录到数据库中
log4j.appender.appenderName = org.apache.log4j.jdbc.JDBCAppender
layout(配置日志信息的格式/布局)
layout语法:
# 以HTML表格形式布局
log4j.appender.appenderName.layout = org.apache.log4j.HTMLLayout
# 可以灵活的指定布局模式(常用)
log4j.appender.appenderName.layout = org.apache.log4j.PatternLayout
# 包含日志信息的级别和信息字符串
log4j.appender.appenderName.layout = org.apache.log4j.SimpleLayout
# 包含日志产生的时间、线程、类别等等信息
log4j.appender.appenderName.layout = org.apache.log4j.TTCCLayout
说明:
log4j.appender.appenderName.layout = org.apache.log4j.PatternLayout 和
log4j.appender.FileLog.layout.ConversionPattern = %d{yyyy-MM-dd HH:mm:ss,SSS}
都是成对出现的;
配置文件常用选项属性
- ConsoleAppender选项属性
Threshold=DEBUG: 指定日志消息的输出最低层次;
ImmediateFlush=true: 默认值是true,意谓着所有的消息都会被立即输出;
Target=System.err:默认值System.out,输出到控制台(err为红色,out为黑色)。
- FileAppender选项属性
Threshold=DEBUF:指定日志消息的输出最低层次;
ImmediateFlush=true:默认值是true,意谓着所有的消息都会被立即输出;
File=mylog.txt:指定消息输出到mylog.txt文件;
Append=false:默认值是true,将消息追加到指定文件中,false指将消息覆盖指定的文件内容;
Encoding = UTF-8:可以指定文件编码格式。
- DailyRollingFileAppender选项属性
Threshold = WARN: 指定日志消息的输出最低层次;
ImmediateFlush = TRUE: 默认值是true,所有的消息都会被立即输出;
File = C:log4j.log:指定消息输出到C:log4j.log文件;
Append = FALSE:默认值true,将消息追加到指定文件中,false指将消息覆盖指定的文件内容;
Encoding = UTF-8:可以指定文件编码格式;
DatePattern='.'yyyy-ww:每周滚动一次文件,即每周产生一个新的文件。
其中DatePattern还可以是以下参数文件:
'.'yyyy-MM:每月
'.'yyyy-ww:每周
'.'yyyy-MM-dd:每天
'.'yyyy-MM-dd-a:每天半天
'.'yyyy-MM-dd-HH:每小时
'.'yyyy-MM-dd-HH-mm:每分钟
- RollingFileAppender选项属性
Threshold = ERROR:指定日志消息的输出最低层次;
ImmediateFlush = TRUE:默认值是true,所有的消息都会被立即输出;
File = C:/log4j.log:指定消息输出到C:/log4j.log文件;
Append = FALSE:默认值true,将消息追加到指定文件中,false指将消息覆盖指定的文件内容;
MaxFileSize = 100KB:后缀可以是KB,MB,GB.在日志文件到达该大小时,将会自动滚动;例如:log4j.log.1
MaxBackupIndex = 2:指定可以产生的滚动文件的最大数;
Encoding = UTF-8:可以指定文件编码格式。
- HTMLLayout选项属性
LocationInfo = TRUE:默认值false,输出java文件名称和行号
Title=Struts Log Message:默认值 Log4J Log Messages
- PatternLayout选项属性
ConversionPattern = %m%n:格式化指定的消息
- XMLLayout选项属性
LocationInfo = TRUE:默认值false,输出java文件名称和行号
配置文件Log4j.properties和Log4j.xml优先级
- log4j.xml优先于log4j.properties;
- log4j.xml的优势:
1. filter精确匹配,避免往后靠的大于等于,可以OnlyOne过滤出我需要的;
2. additivity="false"精确匹配,停止传播。
附注
因时间有限,文章中Log4j和Log4j.xml具体代码未进行展示,若有需要可随时@我。小编在这里致敬每一位技术人,另外祝大家国庆快乐!!!!