log4j学习总结
log4j是一个优秀的日志组件,基本上所有的java开发项目都会用到它。下面将自己学习的一些心得总结一下,方便以后学习。
log4j在项目中都不会单独使用,至少是我写过的java项目中没有。一般来说log4j是和commons-loggings组件一同使用,在maven中的依赖项是:
commons-logging和log4j的关系就像是jdbc和mysql数据库一样,一个是工厂方法,一个是具体的实现,好处:1,逻辑代码是实现分离 2.维护变少。其中第二点是很重要的。配置比单独使用log4j组件还要简单。
先说一下原理。
项目在classpath中引用完commons-logging的jar包之后。按照commons-loggings的官方说法:
翻译成中文,我也是在别的地方找的,是这样的:
1) 首先在classpath下寻找自己的配置文件commons-logging.properties,如果找到,则使用其中定义的Log实现类;
2) 如果找不到commons-logging.properties文件,则在查找是否已定义系统环境变量org.apache.commons.logging.Log,找到则使用其定义的Log实现类;
3) 否则,查看classpath中是否有Log4j的包,如果发现,则自动使用Log4j作为日志实现类;
4) 否则,使用JDK自身的日志实现类(JDK1.4以后才有日志实现类);
5) 否则,使用commons-logging自己提供的一个简单的日志实现类SimpleLog
所以按照上面的说法,我们在classpath中引用万log4j的jar包就可以自动的使用log4j组件来给我们输入日志了。这样就完成了log4j和commons-logging的耦合了。不需要任何的配置文件,只需要引入两个jar包就可以了。
然后在程序中填上下面一句话后:
private static Log log = LogFactory.getLog(YouClassName.class);
就可以使用commons-logging来输入日志文件了。可以使用下面五种级别在程序中进行输出:
log.debug() 输出“调试”级别的日志信息;
log.info() 输出“信息”级别的日志信息;
log.warn() 输出“警告”级别的日志信息;
log.error() 输出“错误”级别的日志信息;
log.fatal() 输出“致命错误”级别的日志信息;
需要注意的是:
log4j组件必须使用log4j.properties配置文件。
log4j组件有三个组成部分:日志记录器(Loggers),输出端(Appenders)和日志格式化器(Layout)。可以通过配置文件来统一配置。
比如下面的配置文件,从网上摘抄的:
log4j.rootLogger=DEBUG, CONSOLE,A1
#它定义日志信息的“输出级别”和“输出目的地”。“DEBUG, CONSOLE,A1”这里我们要把它分成两部分:第一个逗号之前的是第一部分,指定“输出级别”;后面的是第二部分,指定“输出目的#地”。可以同时指定多个“输出目的地”,以逗号隔开。具体到上面这一行:它指定的“输出级别”是“DEBUG”;它指定的“输出目的地”是“CONSOLE”和“A1”。
#“输出级别”有可选的五个值,分别是DEBUG、INFO、WARN、ERROR、FATAL,它们是由Log4j系统定义的。
# “输出目的地”就是我们自己定义的了,就在log4j.properties的后面部分,此文件定义的“输出目的地”有CONSOLE、FILE、ROLLING_FILE、SOCKET、LF5_APPENDER、MAIL、DATABA#SE、A1、im。该文件之所以可作主模板,就是因为它比较全面地定义了各种常见的输出目的地(控制台、文件、电子邮件、数据库等)。
#当在程序中使用DEBUG的时候,意思是调试级别以上的日志信息都要输出,包括 log.debug,log.info,log.warn,log.warn,log.error,log.fatal的日志。
#同理,当使用INFO的时候,意思是级别以上的日志信息都要输出,包括 log.info,log.warn,log.warn,log.error,log.fatal的日志。
log4j.addivity.org.apache=true
# 应用于控制台
log4j.appender.CONSOLE=org.apache.log4j.ConsoleAppender
log4j.appender.CONSOLE.Threshold=DEBUG
log4j.appender.CONSOLE.Target=System.out
log4j.appender.CONSOLE.layout=org.apache.log4j.PatternLayout
log4j.appender.CONSOLE.layout.ConversionPattern=[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n
#log4j.appender.CONSOLE.layout.ConversionPattern=[start]%d{DATE}[DATE]%n%p[PRIORITY]%n%x[NDC]%n%t[THREAD] n%c[CATEGORY]%n%m[MESSAGE]%n%n
#应用于文件
log4j.appender.FILE=org.apache.log4j.FileAppender
log4j.appender.FILE.File=file.log
log4j.appender.FILE.Append=false
log4j.appender.FILE.layout=org.apache.log4j.PatternLayout
log4j.appender.FILE.layout.ConversionPattern=[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n
# Use this layout for LogFactor 5 analysis
# 应用于文件回滚
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
#应用于socket
log4j.appender.SOCKET=org.apache.log4j.RollingFileAppender
log4j.appender.SOCKET.RemoteHost=localhost
log4j.appender.SOCKET.Port=5001
log4j.appender.SOCKET.LocationInfo=true
# Set up for Log Facter 5
log4j.appender.SOCKET.layout=org.apache.log4j.PatternLayout
log4j.appender.SOCET.layout.ConversionPattern=[start]%d{DATE}[DATE]%n%p[PRIORITY]%n%x[NDC]%n%t[THREAD]%n%c[CATEGORY]%n%m[MESSAGE]%n%n
# Log Factor 5 Appender
log4j.appender.LF5_APPENDER=org.apache.log4j.lf5.LF5Appender
log4j.appender.LF5_APPENDER.MaxNumberOfRecords=2000
# 发送日志给邮件
log4j.appender.MAIL=org.apache.log4j.net.SMTPAppender
log4j.appender.MAIL.Threshold=FATAL
log4j.appender.MAIL.BufferSize=10
log4j.appender.MAIL.From=web@www.wuset.com
log4j.appender.MAIL.SMTPHost=www.wusetu.com
log4j.appender.MAIL.Subject=Log4J Message
log4j.appender.MAIL.To=web@www.wusetu.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
#自定义Appender
log4j.appender.im = net.cybercorlin.util.logger.appender.IMAppende
log4j.appender.im.host = mail.cybercorlin.net
log4j.appender.im.username = username
log4j.appender.im.password = password
log4j.appender.im.recipient = corlin@cybercorlin.net
log4j.appender.im.layout=org.apache.log4j.PatternLayout
log4j.appender.im.layout.ConversionPattern =[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n
# 结束
还有一个经常使用到的地方就是:
使用log4j控制程序中的包的输出级别,一开始看这句话可能不太理解,下面我举例来说明。
比如下面的一句话:
log4j.rootLogger=DEBUG,console
log4j.logger.org.springframework=ERROR
log4j.logger.com=INFO
log4j.logger.net=INFO
所有以org.springframework打头的包都是ERROR级别和ERROR级别以上的,也就是FATAL才会输出;所有以com或者net打头的包都是INFO级别和INFO级别以上的输出,而其他的则为DEBUG级别及DEBUG级别以上的输出。
上面是设置包的级别,还可以设置输出地的级别:比如下面
log4j.rootLogger=INFO, stdout, logfile
log4j.appender.stdout=org.apache.log4j.ConsoleAppender
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
log4j.appender.stdout.layout.ConversionPattern=%d %p [%t] [%c] - %m%n
log4j.appender.stdout.Threshold=DEBUG
设置向控制台输出的级别必须是DEBUG以上的,因为rootLogger中设置的输出级别是INFO级别,所以这个设置其实是没有用的。
下面举一个例子来说明上面的配置。
比如程序需要部署到客户到服务器上进行试运行,
log4j.rootLogger=DEBUG, stdout, logfile
在根目录下,我们选择让所有的log都输出,但是很多东西不想让用户在控制台看到。
就可以设置log4j.appender.stdout.Threshold=INFO
这样在文件信息中就有我们想要看到的所有信息,而用户看到的就没有那么多。
等到过一段时间程序比较稳定了。日志文件中也不需要那么多信息了。就可以增加log4j.appender.logfile.Threshold=INFO
这样日志中的信息就会变少,或者使用提高某个包中信息的输出级别来实现:
log4j.logger.com.lxzh=INFO