log4j2 使用(一)

日志是一个系统经常用到的功能,我们可以在调试的时候依靠日志查看输出,在程序运行的时候通过查看日志判断程序运行状态。
在Java世界中,有一个非常著名的日志类库——Log4j。现在Log4j也有了新版本,就是Log4j2。

引入Log4j2

要使用Log4j2,第一步就是先导入它的jar包。如果是普通项目的话,到log4j2官网下载jar包。

  • log4j-api-2.7.jar
  • log4j-core-2.7.jar

添加到你项目的类路径下。

slf4j+log4j2 maven

<dependency>
    <groupId>org.apache.logging.log4j</groupId>
    <artifactId>log4j-api</artifactId>
    <version>2.0.1</version>
</dependency>
<dependency>
    <groupId>org.apache.logging.log4j</groupId>
    <artifactId>log4j-core</artifactId>
    <version>2.0.1</version>
</dependency>
<dependency>
    <groupId>org.apache.logging.log4j</groupId>
    <artifactId>log4j-slf4j-impl</artifactId>
    <version>2.0.1</version>
</dependency>

然后打开项目,添加以下两句,创建一个Logger并调试一些信息。注意这里的Logger和LogManager两个类的全名分别是org.apache.logging.log4j.LogManager和org.apache.logging.log4j.Logger。不要和Java自带的java.util.logging下的日志类搞混了。

Logger logger = LogManager.getLogger();
logger.debug("5555555");

然后运行一下项目,就可以看到对应的输出了。

日志级别

这时发现前面其实什么输出都没有。

日志分为几个级别,按照从轻往重如此排列:

TRACE < DEBUG < INFO < WARN < ERROR < FATAL

相应的Logger类也有这么几个对应方法,用于输出相应的日志信息。

如果我们定义了一个级别,那么低于这个级别的日志不会输出。由于没有配置文件,所以默认情况下的日志级别是error。这样一来,低于error的日志就不会输出。

回到刚才,将debug方法改为error方法,再次运行项目。这次出现了日志输出。

16:37:10.704 [main] ERROR com.meng.controller.UserController - 5555555

配置文件

Log4j2既可以使用配置文件配置,也可以使用编程方式用代码来配置。这里简单说说配置文件方式。

Log4j2支持多种配置文件,XML、JSON、YAML和perperties文件都支持,当然最常用的还是XML文件。将配置文件放在类路径下即可,如果使用Maven或者Gradle的话,就是在resources文件夹下。

前面如果没有配置文件的话,Log4j2就会使用一个默认配置,等效于下面的配置文件。

<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="WARN">
  <Appenders>
    <Console name="Console" target="SYSTEM_OUT">
      <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n"/>
    </Console>
  </Appenders>
  <Loggers>
    <Root level="error">
      <AppenderRef ref="Console"/>
    </Root>
  </Loggers>
</Configuration>

配置文件有两个主要的地方:

  • 第一个是Appender节点,这个节点下会有很多Appender,也就是我们日志输出的目的地,可以是控制台也可以是某个文件,甚至是专用的远程日志服务器。默认情况下只有一个控制台。
  • 第二种重要的节点是Loggers节点,这个节点下可以有很多个Logger,每个Logger可以记录不同的信息,Logger之间也可以共享某些配置。
    上面定义了一个Root Logger,如果没有指定Logger 的名称或者指定的Logger不存在,就会使用Root,而且Root Logger下的配置默认会被其他Logger继承,除非它们定义了自己的配置。

然后我们再回头看看Appenders节点,其中有这么一段:

<PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n"/>

这里定义的就是日志的输出格式。

下面来简单说说常用的输出格式

  • %d{HH:mm:ss.SSS} 输出时间,精确度为毫秒。
  • %t 输出当前线程的名称。
  • %-5level 输出日志级别,-5表示左对齐并且固定占5个字符宽度,如果不足用空格补齐。
  • %logger 输出Logger名称,如果是Root的话就没有名称。
  • %msg 日志信息,也就是我们传入的信息。
  • %n 换行。
  • %F 输出所在的文件名。
  • %L 输出行号。
  • %M 输出所在方法名。
  • %l 输出语句所在的位置信息,包括文件名、类名、方法名、行号。

如果没有配置文件,则按默认输出ERROR级别以上的日志:

Logger logger = LogManager.getLogger();
logger.trace("trace level");
logger.debug("debug level");
logger.info("info level");
logger.warn("warn level");
logger.error("error level");
logger.fatal("fatal level");
16:52:51.124 [main] ERROR com.meng.controller.UserController - error level
16:52:51.125 [main] FATAL com.meng.controller.UserController - fatal level

log4j2默认会在classpath目录下寻找log4j.json、log4j.jsn、log4j2.xml等名称的文件,如果都没有找到,则会按默认配置输出,也就是输出到控制台。

自定义配置

自定义Logger

现在我们就可以开始自定义配置文件了。

首先我们来添加一个新的Logger,来记录所有信息,这个Logger的名称就叫做TRACE_ALL吧。这个Logger有两个属性,level指定记录级别,additivity指定传递性。假如传递性指定为true,如果我们现在使用TRACE_ALL记录一个debug级别的日志,由于debug级别的也符合Root的记录范围,这样这个日志就会记录两遍。最后,我们用<AppenderRef ref="Console"/>指定使用上面的控制台Appender。

<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="WARN" monitorInterval="300">
    <Appenders>
        <Console name="Console" target="SYSTEM_OUT">
            <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n"/>
        </Console>
    </Appenders>
    <Loggers>
        <Root level="error">
            <AppenderRef ref="Console"/>
        </Root>
        <Logger name="TRACE_ALL" level="debug" additivity="true">
            <AppenderRef ref="Console"/>
        </Logger>
    </Loggers>
</Configuration>

注意根节点增加了一个monitorInterval属性,含义是每隔300秒重新读取配置文件,可以不重启应用的情况下修改配置,还是很好用的功能。

在调用getLogger的时候指定要使用哪一个Logger。

Logger logger = LogManager.getLogger("TRACE_ALL");
logger.trace("trace level");
logger.debug("debug level");
logger.info("info level");
logger.warn("warn level");
logger.error("error level");
logger.fatal("fatal level");

控制台输出:

17:15:04.025 [main] DEBUG TRACE_ALL - debug level
17:15:04.025 [main] DEBUG TRACE_ALL - debug level
17:15:04.027 [main] INFO  TRACE_ALL - info level
17:15:04.027 [main] INFO  TRACE_ALL - info level
17:15:04.027 [main] WARN  TRACE_ALL - warn level
17:15:04.027 [main] WARN  TRACE_ALL - warn level
17:15:04.028 [main] ERROR TRACE_ALL - error level
17:15:04.028 [main] ERROR TRACE_ALL - error level
17:15:04.028 [main] FATAL TRACE_ALL - fatal level
17:15:04.028 [main] FATAL TRACE_ALL - fatal level
自定义Appender

除了使用Console作为日志输出目的地之外,我们还可以定义其他的输出,比如文件。下面我们来新建一个文件Appender。

在Appenders节点下新建一个File节点,name和fileName属性分别指定Appender名称和目的文件名。然后我们指定TRACE_ALL Logger同时将日志输出到控制台和文件。

<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="WARN" monitorInterval="300">
    <Appenders>
        <Console name="Console" target="SYSTEM_OUT">
            <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n"/>
        </Console>
        <File name="File" fileName="D:\Desktop\mylog.txt">
            <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n"/>
        </File>
    </Appenders>
    <Loggers>
        <Root level="error">
            <AppenderRef ref="Console"/>
        </Root>
        <Logger name="TRACE_ALL" level="debug" additivity="false">
            <AppenderRef ref="File"/>
            <AppenderRef ref="Console"/>
        </Logger>
    </Loggers>
</Configuration>

再次运行程序,我们就会发现这次在对应的路径下多出一个文件,这个文件的内容就是我们的输出。

实用型配置

配置一个按时间和文件大小滚动的RollingRandomAccessFileAppender,名字真是够长,但不光只是名字长,相比RollingFileAppender有很大的性能提升,官网宣称是20-200%。

Rolling的意思是当满足一定条件后,就重命名原日志文件用于备份,并从新生成一个新的日志文件。例如需求是每天生成一个日志文件,但是如果一天内的日志文件体积已经超过1G,就从新生成,两个条件满足一个即可。这在log4j 1.x原生功能中无法实现,在log4j2中就很简单了。

<Configuration status="WARN" monitorInterval="300">  
    <properties>  
        <property name="LOG_HOME">D:/logs</property>  
        <property name="FILE_NAME">mylog</property>  
    </properties>  
    <Appenders>  
        <Console name="Console" target="SYSTEM_OUT">  
            <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n" />  
        </Console>  
        <RollingRandomAccessFile name="MyFile"  
            fileName="${LOG_HOME}/${FILE_NAME}.log"  
            filePattern="${LOG_HOME}/$${date:yyyy-MM}/${FILE_NAME}-%d{yyyy-MM-dd HH-mm}-%i.log">  
            <PatternLayout  
                pattern="%d{yyyy-MM-dd HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n" />  
            <Policies>  
                <TimeBasedTriggeringPolicy interval="1" />  
                <SizeBasedTriggeringPolicy size="10 MB" />  
            </Policies>  
            <DefaultRolloverStrategy max="20" />  
        </RollingRandomAccessFile>  
    </Appenders>  
  
    <Loggers>  
        <Logger name="mylog" level="trace" additivity="false">  
            <AppenderRef ref="MyFile" />  
        </Logger>  
        <Root level="error">  
            <AppenderRef ref="Console" />  
        </Root>  
    </Loggers>  
</Configuration>  

<properties>定义了两个常量方便后面复用。

RollingRandomAccessFile的属性:

  • fileName 指定当前日志文件的位置和文件名称。
  • filePattern 指定打包的日志文件的格式(指定当发生Rolling时,文件的转移和重命名规则)。

Policies节点,指定什么之后执行rollover,常用的有这么三个策略:

  • OnStartupTriggeringPolicy 程序启动时候执行一次rollover。
  • SizeBasedTriggeringPolicy 指定当文件体积大于size指定的值时,触发Rolling。单位可以使KB、MB、GB。
  • TimeBasedTriggeringPolicy 这个配置需要和filePattern结合使用,注意filePattern中配置的文件重命名规则是${FILE_NAME}-%d{yyyy-MM-dd HH-mm}-%i,最小的时间粒度是mm,即分钟,TimeBasedTriggeringPolicy指定的size是1,结合起来就是每1分钟生成一个新文件。如果改成%d{yyyy-MM-dd HH},最小粒度为小时,则每一个小时生成一个文件。
    它有两个可定义的属性:
  • interval,表示rollover的间隔,单位是日期的最小单位。比如如果日期是%d{yyyy-MM-dd-HH},那么interval="6"意思就是每隔六个小时。
  • modulate,指定是否调整rollover的间隔。假如现在是上午3点,间隔是4个小时,当modulate为false的时候下次rollover就是上午七点,以此类推。如果modulate是true,下次rollover就是上午4点,然后以此类推。
  • DefaultRolloverStrategy 指定最多保存的文件个数。

自定义配置文件位置

log4j2默认在classpath下查找配置文件,可以修改配置文件的位置。在非web项目中:

File file = new File("D:/log4j2.xml");  
    BufferedInputStream in = new BufferedInputStream(new FileInputStream(file));  
    final ConfigurationSource source = new ConfigurationSource(in);  
    Configurator.initialize(null, source);  
      
    Logger logger = LogManager.getLogger("mylog");  

如果是web项目,在web.xml中添加

<context-param>  
    <param-name>log4jConfiguration</param-name>  
    <param-value>/WEB-INF/conf/log4j2.xml</param-value>  
</context-param>  
  
<listener>  
    <listener-class>org.apache.logging.log4j.web.Log4jServletContextListener</listener-class>  
</listener> 

转自 http://blog.csdn.net/autfish/article/details/51203709 感谢作者。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 215,076评论 6 497
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,658评论 3 389
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 160,732评论 0 350
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,493评论 1 288
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,591评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,598评论 1 293
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,601评论 3 415
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,348评论 0 270
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,797评论 1 307
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,114评论 2 330
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,278评论 1 344
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,953评论 5 339
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,585评论 3 322
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,202评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,442评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,180评论 2 367
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,139评论 2 352

推荐阅读更多精彩内容

  • 在应用程序中添加日志记录总的来说基于三个目的:监视代码中变量的变化情况,周期性的记录到文件中供其他应用进行统计分析...
    时待吾阅读 5,023评论 1 13
  • 在应用程序中添加日志记录总的来说基于三个目的:监视代码中变量的变化情况,周期性的记录到文件中供其他应用进行统计分析...
    时待吾阅读 4,982评论 0 6
  • 一、Log4j简介 Log4j有三个主要的组件:Loggers(记录器),Appenders (输出源)和Layo...
    默默守护阅读 1,907评论 2 8
  • from:https://www.cnblogs.com/ITtangtang/p/3926665.html一、L...
    enshunyan阅读 3,289评论 0 0
  • log4j是一个被广泛使用的Java日志记录框架,通过使用该框架,我们可以在自己的项目中根据自身需求灵活配置日志输...
    LilacZiyun阅读 5,920评论 0 7