Java 中Log4j的使用详情

时间:2023-03-09 08:45:22
Java 中Log4j的使用详情

Log4j 真的很简单,简单到令人发指的地步。不是要记录日志吗?那就给你一个Log ,然后你用Log 来写东西就行了,先来一个完整类示例:

package test;

import org.apache.commons.logging.Log;

import org.apache.commons.logging.LogFactory;

public class Test {

    static Log log = LogFactory.getLog (Test. class );

    public void log(){

       log .debug( "Debug info." );

       log .info( "Info info" );

       log .warn( "Warn info" );

       log .error( "Error info" );

       log .fatal( "Fatal info" );

    }

    public static void main(String[] args) {

       Test test = new Test();

       test.log();

    }

}

日志等级

Log4j 默认把日志信息分为五个等级

   debug < info < warn < error < fatal

虽然可以自己添加等级,但是我觉得没有必要,五个够用了吧!你要写入信息的时候就把信息归为五个等级中的一个,然后调用相应的函数即可。

   分五个等级到底有什么用呢?日志信息到底写到哪里去了?

   “ LogFactory.getLog (Test. class ) ”又是什么意思捏?接着往下看吧!

继承思想

Log4j 的关键之处在于它的继承思想。也就是一个Log 可以继承另外一个Log 的属性(输出到哪里,日志等级,日志格式等等)。怎么继承?

Log4j 是根据Log 的名字来判断继承关系的,比如:

名字为“com.zhlmmc.lib ”的Log 就是“com.zhlmmc.lib.log ”的parent !Log4j 还有一个rootLogger ,相当于Java 的Object 。

三、回过头来看“ LogFactory.getLog (Test. class ) ”这里的“ Test. class ”事实上传进去的是Test 这个类的完整路径(包名+ 类名),“test.Test ”。这样如果存在“test ”这个Log 那么Test 这个Log 就继承它,否则就继承rootLogger 。

定义属性文件

log4j.rootLogger= info, stdout

log4j.appender.stdout= org.apache.log4j.ConsoleAppender

log4j.appender.stdout.layout= org.apache.log4j.PatternLayout

Pattern to output the caller’s file name and line number.

log4j.appender.stdout.layout.ConversionPattern= %5p [%t] (%F : %L) - %m%n

分析一下:

第一行,配置log4j.rootLogger 你明白吧。应为它是根,总得配置一下,否则别的Log 继承什么啊。其他的Log 可以配置也可以不配置。等号后面的第一个参数表示日志级别,可以填五个级别中的一种,后面的参数都是让Log 知道输出到哪里,如果你想让日志输出到两个地方就加两个输出参数,比如:

log4j.rootLogger= info, stdout, file

这里的info 表示,该Log 的日志级别为info ,所有级别小于info 的日志都不会被记录。比如使用这个配置文件的话,我刚开始举的那个类中

log .debug( “Debug info.” );

这句话是不起作用的,因为debug 的级别小于info 。这样就很容易控制什么信息在调试的时候要显示,什么信息在发布的时候要去掉。这些都不用改代码,很方便吧。

但,stdout 和file 又是什么呢?

接着往下看,就是配置stdout 了,这个名字是随便取的,你可以叫它A :

log4j.appender.A= org.apache.log4j.ConsoleAppender

那么上面的rootLogger 的参数stdout 也要改成A ,其他用到的地方当然也要改。这里的关键不是名字,而是appender 类型,比如这里的“ ConsoleAppender ”,看明白了吧,输出到Console 。后面两行都是设置日志格式的,一般情况下你就照抄吧。

在实际的项目开发中,很可能遇到所引用的包用Log4j 来记录日志,比如Hibernate 。那么在这里你可以很容易的控制这个包如何记录日志。比如在上面的配置文件中加一行:

log4j.logger.org.hibernate=fatal

那么所有org.hibernate 包下面的类就只会显示很少的信息,因为fatal 的级别最高啊。

部署

把log4j 的包和commons-logging 的包(加在一起才两个)放到classpath 下面。然后把配置文件保存为log4j.properties ,也放在classpath 下面(如果用Eclipse 的话,放在src 目录下即可)。然后你就可以跑了。

在加载的过程中,程序会读取/WEB-INF/log4j.properties 这个文件。

配置文件讲解如下 :

#log4j 中有五级logger FATAL ERROR WARN INFODEBUG
# 配置根Logger ,其语法为:
#log4j.rootLogger = [ level ] , appenderName, appenderName, …
log4j.rootLogger=INFO, A1 ,R
# 这一句设置会把所有级别的log 都输出
# 如果为log4j.rootLogger=WARN, 则意味着只有WARN,ERROR,FATAL 被输出,DEBUG,INFO 将被屏蔽掉.
# A1 is set to be a ConsoleAppender.
#log4j 中Appender 有几层如控制台、文件、GUI 组件、甚至是套接口服务器、NT 的事件记录器、UNIX Syslog 守护进程等
#ConsoleAppender 输出到控制台
log4j.appender.A1=org.apache.log4j.ConsoleAppender
# A1 使用的输出布局,其中log4j 提供4 种布局. org.apache.log4j.HTMLLayout (以HTML 表格形式布局)
#org.apache.log4j.PatternLayout (可以灵活地指定布局模式),
#org.apache.log4j.SimpleLayout (包含日志信息的级别和信息字符串),
#org.apache.log4j.TTCCLayout (包含日志产生的时间、线程、类别等等信息)

log4j.appender.A1.layout=org.apache.log4j.PatternLayout
# 灵活定义输出格式 具体查看log4j javadoc org.apache.log4j.PatternLayout
#d 时间 ....
log4j.appender.A1.layout.ConversionPattern=%-d{yyyy-MM-dd HH:mm:ss} [%c]-[%p] %m%n
#R 输出到文件 RollingFileAppender 的扩展,可以提供一种日志的备份功能。
log4j.appender.R=org.apache.log4j.RollingFileAppender
# 日志文件的名称
log4j.appender.R.File=log4j.log
# 日志文件的大小
log4j.appender.R.MaxFileSize=100KB

保存一个备份文件

log4j.appender.R.MaxBackupIndex=1

log4j.appender.R.layout=org.apache.log4j.TTCCLayout


log4j.appender.R.layout.ConversionPattern=%-d{yyyy-MM-dd HH:mm:ss} [%c]-[%p] %m%n


level : 是日志记录的优先级,分为OFF 、FATAL 、ERROR 、WARN 、INFO 、DEBUG 、ALL 或者您定义的级别。


Log4j 建议只使用四个级别,优先级从高到低分别是ERROR 、WARN 、INFO 、DEBUG 。


Log4jTest.java 中的Logger logger = Logger.getLogger(this.getClass().getName()); 可能对应了log4j.rootLogger=DEBUG,CONSOLE,A1 的配置

log4j.rootLogger = DEBUG,CONSOLE,A1

log4j.addivity.org.apache = true


将DAO 层log 记录到DAOLog,allLog 中;代码中使用Logger logger = Logger.getLogger(“DAO”) 来获得此配置;

log4j.logger.DAO = DEBUG,A2

应用于控制台

log4j.appender.CONSOLE = org.apache.log4j.ConsoleAppender


本处设置为”WARN” 以上级别在控制台输出( 默认情况使用rootLogger 中的设置)


log4j.appender.CONSOLE.Threshold = WARN

log4j.appender.CONSOLE.Target = System.out

log4j.appender.CONSOLE.Encoding = GBK

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.A1 = org.apache.log4j.DailyRollingFileAppender

log4j.appender.A1.File = C:/log4j/website.log

log4j.appender.A1.Encoding = GBK

log4j.appender.A1.Threshold = DEBUG

log4j.appender.A1.DatePattern = ‘.’yyyy-MM-dd

log4j.appender.A1.layout = org.apache.log4j.PatternLayout

log4j.appender.A1.layout.ConversionPattern = %d{ABSOLUTE} %5p %c{1}: %L: %m%n

A2– 打印到文件DAOLog 中– 专门为DAO 层服务


log4j.appender.A2 = org.apache.log4j.DailyRollingFileAppender

log4j.appender.A2.file = C:/log4j/DAOLog.log

log4j.appender.A2.DatePattern = ‘.’yyyy-MM-dd

log4j.appender.A2.layout = org.apache.log4j.PatternLayout

log4j.appender.A2.layout.ConversionPattern = [%-5p] %d{yyyy-MM-dd HH:mm:ss,SSS} method: %l : %m%n

#  %n 代表换行

#  %d 代表日期

#  %c 代表路径名 (Logger.getLogger("DAO") 时为 DAO: ,Logger.getLogger(this.getClass().getName()) 时为绝对类名 )

#  %c{1} 为类名,如Log4jTest

#  %l 代表类路径及代码所在行数,%L 仅代表代码所在行数

#  [%-5p] 代表该日志对应的日志级别(%5p ),如DEBUG,ERROR ,中间的- 起到在[] 中左对齐的作用

#  %m 代表“类名: ”(Logger.getLogger("DAO") 时为DAO: ,Logger.getLogger(this.getClass().getName()) 时为类名)及日志信息
#----------------------------------------------------------------------------------

# 分别说明如下:

#1 、使用Logger logger = Logger.getLogger("DAO") 获得配置时,属性文件中必须要有对应设置:log4j.logger.DAO=DEBUG,A2

#2 、%c 为DAO

#3 、%l 为logger.debug("DAO: Debug info."); 的类绝对路径以及代码所在行,

#   log.DAOlogTest.doGet(DAOlogTest.java:23)

#4 、%L 为logger.debug("DAO: Debug info."); 代码所在行 23

#5 、%m 为类名和日志信息     DAO: Debug info.

#1 、使用Logger logger = Logger.getLogger(this.getClass().getName()) 获得配置时

#2 、%c 为log.Log4jTest    %c{1} 为Log4jTest

#3 、%l 为 log.Log4jTest.doGet(Log4jTest.java:23)

#4 、%L 同上

#5 、%m 为 Debug info.

#

#

# -X 号: X 信息输出时左对齐;

#%p: 日志信息级别

#%d{}: 日志信息产生时间

#%c: 日志信息所在地(类名)

#%m: 产生的日志具体信息

#%n: 输出日志信息换行

日志目录默认情况为 tomcat_home ,

可以通过 log4j.appender.A1.File = webapps//Hibernate_Web//logs//website.log 设置相对路径的日志目录

--------------------------------------------------

为了能够清楚的看到系统启动的情况,以及一些信息,在项目中使用Log4j功能

log4j.properties文件为:(为了使tomcat能够看着干净点,我ConsoleAppender的等级设置为FATAL,具体的详细日志可以在%TOMCAT_HOME%下的log4j.log中)

log4j.rootLogger=INFO, A1, R

log4j.appender.A1=org.apache.log4j.ConsoleAppender

log4j.appender.A1.layout=org.apache.log4j.PatternLayout

log4j.appender.A1.Threshold=FATAL

log4j.appender.A1.layout.ConversionPattern=%-d{yyyy-MM-dd HH:mm:ss} [%c]-[%p] %m%n


R 输出到文件 RollingFileAppender的扩展,可以提供一种日志的备份功能。


log4j.appender.R=org.apache.log4j.DailyRollingFileAppender

log4j.appender.R.File=log4j.log

log4j.appender.R.Encoding=GBK

log4j.appender.R.Threshold=INFO

log4j.appender.R.DatePattern=’.’yyyy-MM-dd

log4j.appender.R.layout=org.apache.log4j.PatternLayout

log4j.appender.R.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm} %5p %c{1}: %L: %m%n