log4j详解及log4j.properties配置

目录

log4j

1.log4j是什么?

Log4j是Apache的一个开源项目。通过使用Log4j,我们可以

控制日志信息输送的目的地控制台、文件、GUI组件,甚至是套接口服务器、NT的事件记录器、UNIX Syslog守护进程

控制每一条日志的输出格式

③通过定义每一条日志信息的级别,更加细致地控制日志的生成过程

最令人感兴趣的就是,这些可以通过一个配置文件来灵活地进行配置,而不需要修改应用的代码。

2.log4j 安装配置

最新log4j的版本,包括完整的源代码,类文件和文档都可以在这里找到https://logging.apache.org/log4j/2.x/

在Windows上开发使用eclipse时,可以在eclipse创建用户库,并加入到构建路径中

①加入log4j-1.2.17.jar(可以选择log4j的更高版本)

如果使用maven项目,也可以选择在pom.xml中新增依赖:

<!-- https://mvnrepository.com/artifact/log4j/log4j -->
<dependency>
    <groupId>log4j</groupId>
    <artifactId>log4j</artifactId>
    <version>1.2.17</version>
</dependency>

②在CLASSPATH下建立log4j.properties。内容如下(数字为行号):

#将等级为DEBUG的日志信息输出到console和file这两个目的地,console和file的定义在下面的代码
log4j.rootLogger=DEBUG,console,file

#控制台输出的相关设置
log4j.appender.console = org.apache.log4j.ConsoleAppender
log4j.appender.console.Target = System.out
log4j.appender.console.Threshold=DEBUG
log4j.appender.console.layout = org.apache.log4j.PatternLayout
log4j.appender.console.layout.ConversionPattern=[%c]-%m%n

#文件输出的相关设置
log4j.appender.file = org.apache.log4j.RollingFileAppender
log4j.appender.file.File=./log/kuang.log
log4j.appender.file.MaxFileSize=10mb
log4j.appender.file.Threshold=DEBUG
log4j.appender.file.layout=org.apache.log4j.PatternLayout
log4j.appender.file.layout.ConversionPattern=[%p][%d{yy-MM-dd}][%c]%m%n

#日志输出级别
log4j.logger.org.mybatis=DEBUG
log4j.logger.java.sql=DEBUG
log4j.logger.java.sql.Statement=DEBUG
log4j.logger.java.sql.ResultSet=DEBUG
log4j.logger.java.sql.PreparedStatement=DEBUG

③相应的修改其中属性,修改之前就必须知道这些都是干什么的。见第二部分。

④在要输出日志的类中加入相关语句:

定义属性:static Logger logger = Logger.getLogger(LogDemo.class); //LogDemo为相关的类

在相应的方法中:

if (logger.isDebugEnabled()){

logger.debug(“System …..”);

}

3.log4j架构

log4j api 设计为分层结构,其中每一层提供了不同的对象,对象执行不同的任务。易于扩展。

核心对象:

  • Logger对象:捕获日志信息

  • Layout对象:格式化日志信息

  • Appender对象:发布日志信息

支持对象:

  • Leverl对象:记录级别
  • Filter对象:分析日志信息
  • Object Renderer 对象渲染器:提供传递到日志框架的不同对象的字符串表示
  • LogManager 日志管理

4.对log4j.properties配置文件中的各个属性的讲解

1.log4j.rootLogger=DEBUG,console,file

此句将等级为 DEBUG 的日志信息输出到 console 和 file 这两个目的地,console 和 file 定义在下面的代码,可以任意起名。

等级可分为:ALL < DEBUG < INFO < WARN < ERROR < FATAL < OFF ;

如果配置OFF则不打出任何信息,如果配置为INFO这样只显示INFO、WARN、ERROR的log信息,而DEBUG信息不会被显示。

具体见 logger

2.log4j.appender.console = org.apache.log4j.ConsoleAppender

此句为定义名为 console 的输出端是哪种类型,可以是:

org.apache.log4j.ConsoleAppender(控制台)

org.apache.log4j.FileAppender(文件)

org.apache.log4j.DailyRollingFileAppender(每天产生一个日志文件)

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

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

具体见 Appender

3.log4j.appender.console.layout = org.apache.log4j.PatternLayout

此句为定义名为 console 的输出端的 layout 是哪种类型,可以是:

org.apache.log4j.HTMLLayout(以[HTML](https://baike.baidu.com/item/HTML)表格形式布局),

org.apache.log4j.PatternLayout(可以灵活地指定布局模式),

org.apache.log4j.SimpleLayout(包含日志信息的级别和信息[字符串](https://baike.baidu.com/item/字符串)),

org.apache.log4j.TTCCLayout(包含日志产生的时间、[线程](https://baike.baidu.com/item/线程)、类别等等信息)

具体见 Layout

4.log4j.appender.file.layout.ConversionPattern=[%p][%d{yy-MM-dd}][%c]%m%n

如果使用 pattern 布局,就要指定打印信息的具体格式 ConversionPattern,打印参数如下:

%m 输出代码中指定的消息

%M 输出打印该条日志的方法名

%p 输出优先级,即DEBUG,INFO,WARN,ERROR,FATAL;

%r 输出自应用启动到输出该log信息耗费的毫秒数

%c 输出所属的类目,通常就是所在类的全名

%t 输出产生该日志事件的线程名

%n 输出一个回车换行符,Windows平台为"rn”,Unix平台为"n”;

%d 输出日志时间点的日期或时间,默认格式为ISO8601,也可以在其后指定格式,比如:%d{yyyy-MM-dd HH:mm:ss,SSS},输出类似:2002-10-18 22:10:28,921;

%l 输出日志事件的发生位置,及在代码中的行数

[QC]是log信息的开头,可以为任意字符,一般为项目简称

输出的信息。

具体定义配置文件中的格式化日志信息

5.log4j.appender.file = org.apache.log4j.RollingFileAppender

定义名为 file 的输出端的类型为 文件大小到达指定尺寸的时候产生一个新的文件。

6.log4j.appender.file.File=./log/kuang.log

定义名为 file 的输出端的文件名为 ./log/kuang.log ,可以自行修改。

7.log4j.logger.org.mybatis=DEBUG

此句为 mybatis 的包下所有类的等级为 DEBUG。包的设置可根据项目的实际情况而自行定制。

5.log4j的详细讲解

Log4j支持两种配置文件格式,一种是XML标准通用标记语言下的一个应用)格式的文件,一种是Java特性文件log4j.properties(键=值)。下面将介绍使用log4j.properties文件作为配置文件的方法:

①、配置根Logger

Logger 负责处理日志记录的大部分操作。

其语法为:

log4j.rootLogger = [ level ] , appenderName, appenderName, …

其中,

1)level 是日志记录的优先级,分为OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL或者自定义的级别。Log4j 建议只使用四个级别,优先级从高到低分别是ERROR、WARN、INFO、DEBUG

2)通过在这里定义的级别,您可以控制到应用程序中相应级别的日志信息的开关。比如在这里定义了INFO级别,只有等于及高于这个级别的才进行处理,则应用程序中所有DEBUG级别的日志信息将不被打印出来。

3)ALL:打印所有的日志,OFF:关闭所有的日志输出。

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

②、配置日志信息输出目的地 Appender

Appender 负责控制日志记录操作的输出。

其语法为:

log4j.appender.appenderName = fully.qualified.name.of.appender.class

log4j.appender.appenderName.option1 = value1

log4j.appender.appenderName.optionN = valueN

这里的appenderName为在①里定义的,可任意起名。

其中,Log4j提供的appender有以下几种:

org.apache.log4j.ConsoleAppender(控制台),

org.apache.log4j.FileAppender(文件),

org.apache.log4j.DailyRollingFileAppender(每天产生一个日志文件),

org.apache.log4j.RollingFileAppender(文件大小到达指定尺寸的时候产生一个新的文件),可通过log4j.appender.R.MaxFileSize=100KB设置文件大小,还可通过log4j.appender.R.MaxBackupIndex=1设置为保存一个备份文件

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

例如:log4j.appender.stdout=org.apache.log4j.ConsoleAppender

定义一个名为stdout的输出目的地,ConsoleAppender为控制台。

③、配置日志信息的格式(布局)Layout

Layout 负责格式化Appender的输出。

其语法为:

log4j.appender.appenderName.layout = fully.qualified.name.of.layout.class

log4j.appender.appenderName.layout.option1 = value1

log4j.appender.appenderName.layout.optionN = valueN

其中,Log4j提供的layout有以下几种:

org.apache.log4j.HTMLLayout(以HTML表格形式布局),

org.apache.log4j.PatternLayout(可以灵活地指定布局模式),

org.apache.log4j.SimpleLayout(包含日志信息的级别和信息字符串),

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

6.格式化日志

Log4J采用类似C语言中的printf函数的打印格式格式化日志信息,打印参数如下:

%m 输出代码中指定的消息;

%M 输出打印该条日志的方法名;

%p 输出优先级,即DEBUG,INFO,WARN,ERROR,FATAL;

%r 输出自应用启动到输出该log信息耗费的毫秒数;

%c 输出所属的类目,通常就是所在类的全名;

%t 输出产生该日志事件的线程名;

%n 输出一个回车换行符,Windows平台为"rn”,Unix平台为"n”;

%d 输出日志时间点的日期或时间,默认格式为ISO8601,也可以在其后指定格式,比如:%d{yyyy-MM-dd HH:mm:ss,SSS},输出类似:2002-10-18 22:10:28,921;

%l 输出日志事件的发生位置,及在代码中的行数。

7.运用在代码中

我们在需要输出日志信息的类中做如下的三个工作:

1、导入所有需的commons-logging类:

import org.apache.commons.logging.Log;

import org.apache.commons.logging.LogFactory;

2、在自己的类中定义一个org.apache.commons.logging.Log类的私有静态类成员:

private final Log log = LogFactory.getLog(getClass());

LogFactory.getLog()方法的参数使用的是当前类的class。

3、使用org.apache.commons.logging.Log类的成员方法输出日志信息:

if (log.isDebugEnabled()){

	log.debug("111");

}

if (log.isInfoEnabled()){

	log.info("222");

}

if (log.isWarnEnabled()){

	log.warn("333");

}

if (log.isErrorEnabled()){

	log.error("444");

}

if (log.isFatalEnabled()){

	log.fatal("555");

}

示例:

public class Test {
	private static Logger logger = Logger.getLogger(Test.class);  
 
    /** 
     * @param args 
     */  
    public static void main(String[] args) {  
        // System.out.println("This is println message.");  
 
        // 记录debug级别的信息  
        logger.debug("This is debug message.");  
        // 记录info级别的信息  
        logger.info("This is info message.");  
        // 记录error级别的信息  
        logger.error("This is error message.");  
    }  
 

8.如何应用记录器的层次

如何定义及获取不同层次的记录器?

任何一个记录器的使用都有两个步骤:

1) 在配置文件中定义相应的记录器。

记录器的格式有两种: 根记录器、非根记录器。

log4j.rootLogger = [ level ], appendName1, appendName2, …appendNameN

log4j.logger.loggerName1 = [ level ], appendName1,…appendNameN

……

log4j.logger.loggerNameM = [ level ], appendName1, …appendNameN

可以定义任意个非根记录器。

2) 在代码中调用Logger类的取得记录器方法取得相应的记录器对象。

要取得根记录器对象可通过Logger.getRootLogger()函数,要取得非根记录器可通过Logger.getLogger()函数。

在Web application中应用log4j也很简单,与在application中应用log4j不同之处就是要在所有应用log4j的代码之前对log4j进行初始化。

因为log4j的初始化要在所有的log4j调用之前完成,所以在web.xml文件中,我们一定要把对应的Servlet定义的load-on-startup应设为1,以便在Web容器启动时即装入该Servlet。

9.附一个完整的log4j.properties

Threshold 为 appender 阈值级别。

MaxFileSize 为 文件的回滚临界尺寸。

ConversionPattern 为模式布局的转换模式。

#将等级为DEBUG的日志信息输出到console和file这两个目的地,console和file的定义在下面的代码
log4j.rootLogger=DEBUG,console,file

#控制台输出的相关设置
log4j.appender.console = org.apache.log4j.ConsoleAppender
log4j.appender.console.Target = System.out
log4j.appender.console.Threshold=DEBUG
log4j.appender.console.layout = org.apache.log4j.PatternLayout
log4j.appender.console.layout.ConversionPattern=[%c]-%m%n

#文件输出的相关设置
log4j.appender.file = org.apache.log4j.RollingFileAppender
log4j.appender.file.File=./log/kuang.log
log4j.appender.file.MaxFileSize=10mb
log4j.appender.file.Threshold=DEBUG
log4j.appender.file.layout=org.apache.log4j.PatternLayout
log4j.appender.file.layout.ConversionPattern=[%p][%d{yy-MM-dd}][%c]%m%n

#日志输出级别
log4j.logger.org.mybatis=DEBUG
log4j.logger.java.sql=DEBUG
log4j.logger.java.sql.Statement=DEBUG
log4j.logger.java.sql.ResultSet=DEBUG
log4j.logger.java.sql.PreparedStatement=DEBUG
上一篇:Spring Boot 各种日志框架记录方式


下一篇:SSM框架的几个重要配置文件