您的位置: 首页  >  文章  >  log4j的运用

log4j的运用

分类: 文章 • 2023-09-13 23:45:37

一、为什么使用log4j？

        通常，我们习惯使用System.out.println("日志信息");这种方式的优点是使用起来方便快捷，不需要导入其余的jar包，但是不利于更精准的控制，功能不够强大。

        Log4j就是帮助开发人员进行日志输出管理的API类库。它可以通过配置文件灵活的设置日志信息的优先级、日志信息的输出目的地以及日志信息的输出格式。它的应用场景有：

a、调试代码的时候；

b、应用出现了问题，我们分析、定位、解决问题的时候；

c、将某些日志信息作为离线的业务数据分析的时候等；

二、使用步骤。

    a、引入下载好的 commons-logging-1.0.4.jar 和 log4j-1.2.15.jar；若是采用maven搭建的工程，在pom.xml中添加：

<!--日志log4j-->
<dependency>
  <groupId>log4j</groupId>
  <artifactId>log4j</artifactId>
  <version>1.2.17</version>
</dependency>

    b、创建一个log4j.properties配置文件，放在src文件夹下，该配置文件的内容：

### set log levels 设置日志的最低级别;从低到高：trace->debug->info->warn->error->fatal
###    输出位置：Console(控制台)、File(文件)

log4j.rootLogger = debug,Console,File
        
###  输出到控制台  ###
log4j.appender.Console=org.apache.log4j.ConsoleAppender
log4j.appender.Console.Target=System.out
log4j.appender.Console.layout=org.apache.log4j.PatternLayout
log4j.appender.Console.layout.ConversionPattern= %d{ABSOLUTE} %5p %c{1}:%L - %m%n


### 输出到日志文件 ###
log4j.appender.File=org.apache.log4j.RollingFileAppender
log4j.appender.File.File=${project}/WEB-INF/logs/app.log
#log4j.appender.File.DatePattern=_yyyyMMdd'.log'
log4j.appender.File.MaxFileSize=10MB
log4j.appender.File.Threshold=ALL
log4j.appender.File.layout=org.apache.log4j.PatternLayout
log4j.appender.File.layout.ConversionPattern=[%p][%d{yyyy-MM-dd HH\:mm\:ss,SSS}][%c]%m%n

    c、初始化类，创建main函数

import org.apache.log4j.Logger;
import org.junit.Test;

public class Log4jTest {
    //实例化Log4jTest类，才能创建对应的class的日志对象。
    private static Logger log = Logger.getLogger(Log4jTest.class);
    @Test
    public void testLog(){
        System.out.println("testLogger");
        log.trace(">>>>>>>>>>>this is a trace");
        log.debug(">>>>>>>>>>>this is a debug");
        log.info(">>>>>>>>>>>this is a info");
        log.warn(">>>>>>>>>>>this is a warn");
        log.error(">>>>>>>>>>>this is a error");
        log.fatal(">>>>>>>>>>>this is a fatal");

    }
}

输出：

testLogger
17:04:17,627 DEBUG Log4jTest:16 - >>>>>>>>>>>this is a debug
17:04:17,633  INFO Log4jTest:17 - >>>>>>>>>>>this is a info
17:04:17,634  WARN Log4jTest:18 - >>>>>>>>>>>this is a warn
17:04:17,634 ERROR Log4jTest:19 - >>>>>>>>>>>this is a error

17:04:17,634 FATAL Log4jTest:20 - >>>>>>>>>>>this is a fatal

log4j的日志级别从低到高依次为：trace->debug->info->warn->error->fatal。

由于在log4j.properties中做了限制，log4j.rootLogger = debug,Console,File. 这里输出日志的最低级别为debug，所以控制台中没有输出trace。

三.配置项说明（来自：http://www.cnblogs.com/crazyacking/p/5456347.html#_label010）

Log4j支持两种配置文件格式，一种是XML格式的文件，一种是properties格式的文件。一般我常用的是properties文件

1、log4j.rootLogger = [ level ] , appenderName, appenderName, …
level：是log4j的日志级别，优先级从高到低分别是ERROR、WARN、INFO、DEBUG。

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


2、 配置日志信息输出目的地Appender，其语法为：
log4j.appender.appenderName = fully.qualified.name.of.appender.class
log4j.appender.appenderName.option1 = value1
…
log4j.appender.appenderName.option = valueN
其中，Log4j提供的appender有以下几种：
org.apache.log4j.ConsoleAppender（控制台），
org.apache.log4j.FileAppender（文件），
org.apache.log4j.DailyRollingFileAppender（每天产生一个日志文件），
org.apache.log4j.RollingFileAppender（文件大小到达指定尺寸的时候产生一个新的文件），

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


3、设置好appender后，针对appender的配置
也就是设置好要输出到什么地方后，其它配置选项
(1).ConsoleAppender选项
Threshold=WARN:指定日志消息的输出最低层次。
ImmediateFlush=true:默认值是true,意谓着所有的消息都会被立即输出。
Target=System.err：默认情况下是：System.out,指定输出控制台
(2).FileAppender 选项
Threshold=WARN:指定日志消息的输出最低层次。
ImmediateFlush=true:默认值是true,意谓着所有的消息都会被立即输出。
File=mylog.txt:指定消息输出到mylog.txt文件。
Append=false:默认值是true,即将消息增加到指定文件中，false指将消息覆盖指定的文件内容。
(3).DailyRollingFileAppender 选项
Threshold=WARN:指定日志消息的输出最低层次。
ImmediateFlush=true:默认值是true,意谓着所有的消息都会被立即输出。
File=mylog.txt:指定消息输出到mylog.txt文件。
Append=false:默认值是true,即将消息增加到指定文件中，false指将消息覆盖指定的文件内容。
DatePattern=’.’yyyy-ww:每周滚动一次文件，即每周产生一个新的文件。当然也可以指定按月、周、天、时和分。即对应的格式如下：
’.’yyyy-MM: 每月
’.’yyyy-ww: 每周
’.’yyyy-MM-dd: 每天
’.’yyyy-MM-dd-a: 每天两次
’.’yyyy-MM-dd-HH: 每小时
’.’yyyy-MM-dd-HH-mm: 每分钟
(4).RollingFileAppender 选项
Threshold=WARN:指定日志消息的输出最低层次。
ImmediateFlush=true:默认值是true,意谓着所有的消息都会被立即输出。
File=mylog.txt:指定消息输出到mylog.txt文件。
Append=false:默认值是true,即将消息增加到指定文件中，false指将消息覆盖指定的文件内容。
MaxFileSize=100KB: 后缀可以是KB, MB 或者是 GB. 在日志文件到达该大小时，将会自动滚动，即将原来的内容移到mylog.log.1文件

MaxBackupIndex=2:指定可以产生的滚动文件的最大数。


4. 配置日志信息的布局，其语法为：
log4j.appender.appenderName.layout = fully.qualified.name.of.layout.class
log4j.appender.appenderName.layout.option1 = value1
…
log4j.appender.appenderName.layout.option = valueN
其中，Log4j提供的layout有以下几种：
org.apache.log4j.HTMLLayout（以HTML表格形式布局），
org.apache.log4j.PatternLayout（可以灵活地指定布局模式），
org.apache.log4j.SimpleLayout（包含日志信息的级别和信息字符串），
org.apache.log4j.TTCCLayout（包含日志产生的时间、线程、类别等等信息） 
关于additivity
log4j.additivity.zhangsanLog = false
这个additivity也是很有意思的选项。
它是 子Logger 是否继承 父Logger 的 输出源（appender） 的标志位。具体说，默认情况下子Logger会继承父Logger的appender，也就是说子Logger会在父Logger的appender里输出。若是additivity设为false，则子Logger只会在自己的appender里输出，而不会在父Logger的appender里输出。
效果如下：
log4j.rootLogger=WARN,A2,A3
log4j.logger.test=DEBUG 
log4j.appender.A2=org.apache.log4j.RollingFileAppender
log4j.appender.A2.File=../logs/test.log
log4j.appender.A2.Encoding=UTF-8
log4j.appender.A2.Append=true
log4j.appender.A2.MaxFileSize=2MB
log4j.appender.A2.MaxBackupIndex=5
log4j.appender.A2.layout=org.apache.log4j.PatternLayout
log4j.appender.A2.layout.ConversionPattern=%-5p %d [%t] %c{3}.%M - %m%n 
log4j.additivity.test.xml=false
log4j.logger.test.xml=DEBUG,A3 
log4j.appender.A3=org.apache.log4j.RollingFileAppender
log4j.appender.A3.File=../logs/test-xml.log
log4j.appender.A3.Encoding=UTF-8
log4j.appender.A3.Append=true
log4j.appender.A3.MaxFileSize=2MB
log4j.appender.A3.MaxBackupIndex=5
log4j.appender.A3.layout=org.apache.log4j.PatternLayout
log4j.appender.A3.layout.ConversionPattern=%-5p %d [%t] %c{3}.%M - %m%n
配置文件中有
log4j.logger.test=DEBUG
log4j.additivity.test.xml=false
log4j.logger.test.xml=DEBUG,A3

这个实例中，通过log4j.additivity.test.xml=false这一句取消了继承关系，这样XML的log就只会在A3中输出.

另：不考虑日志级别，a.java, b.java, c.java 分别调用自己的logger，将日志分别写入到不同的文件中。
这个需求主要是在配置文件中，给appender取个名字

然后在调用时，使用名称的方式调用

public static Logger loggerA = Logger.getLogger(“Alog”);
public static Logger loggerB = Logger.getLogger(“Blog”);
public static Logger loggerC = Logger.getLogger(“Clog”);

四、注意事项

在引入log4j的相关jar包后，在main函数中执行该demo时，控制台可能会报如下错误：

log4j:WARN No appenders could be found for logger (org.apache.solr.client.solrj.impl.HttpClientUtil).

log4j:WARN Please initialize the log4j system properly.

log4j:WARN See http://logging.apache.org/log4j/1.2/faq.html#noconfig for more info.


其中的原因可能是：未将src标记为Sources文件

log4j的运用


五.打日志时为什么要使  isTraceEnabled()、isDebugEnabled()、 isInfoEnabled() 进行判断？

        其作用是因为Debug,Info和Trace一般会打印比较详细的信息，而且打印的次数较多，如果我们不加log.isDebugEnabled()等
进行预先判断，当系统loglevel设置高于Debug或Info或Trace时，虽然系统不会答应出这些级别的日志，但是每次还是会拼接
参数字符串，影响系统的性能。

      



相关推荐