Log4j2使用详解

日志框架简单比较(slf4j、j.u.l、log4j、logback、log4j2 )

slf4j:slf4j是对所有日志框架制定的一种规范、标准、接口,并不是一个框架的具体的实现,因为接口并不能独立使用,需要和具体的日志框架实现配合使用(如log4j、logback、log4j2)。

j.u.l:j.u.l是java.util.logging包的简称,是JDK在1.4版本中引入的Java原生日志框架。

log4j:log4j是apache实现的一个开源日志组件。

logback:logback同样是由log4j的作者设计完成的,拥有更好的特性,用来取代log4j的一个日志框架,是slf4j的原生实现。

log4j2:Log4j2是log4j 1.x和logback的改进版,据说采用了一些新技术(无锁异步等),使得日志的吞吐量、性能比log4j 1.x提高了10倍,并解决了一些死锁的bug,而且配置更加简单灵活。

为什么需要日志接口,直接使用具体的实现不就行了吗?

接口用于定制规范,可以有多个实现,使用时是面向接口的(导入的包都是slf4j的包而不是具体某个日志框架中的包),即直接和接口交互,不直接使用实现,所以可以任意的更换实现而不用更改代码中的日志相关代码。

对于Java工程师来说,关于日志工具的使用,最佳实践就是在应用中使用如log4j2 + slf4j这样的组合来进行日志输出。这样做的最大好处,就是业务层的开发不需要关心底层日志框架的实现及细节,在编码的时候也不需要考虑日后更换框架所带来的成本。这也是日志接口(门面模式)所带来的好处。

日志级别

Log4j2中日志有六个级别(level):

trace:追踪,是最低的日志级别,相当于追踪程序的执行,一般不怎么使用

debug:调试,一般在开发中,都将其设置为最低的日志级别

info:信息,输出重要的信息,使用较多

warn:警告,有些时候,虽然程序不会报错,但是还是需要告诉程序员的

error:错误,这个在开发中也挺常用的

fatal:严重错误,这个一旦发生,程序基本上也要停止了

当日志级别设置为某个值的时候,低于它的日志信息将不会被记录,只有高于设置的级别的信息会被记录。

Spring Boot集成log4j2

1. pom.xml

Spring Boot默认使用LogBack,但是我们没有看到显示依赖的jar包,其实是因为所在的jar包spring-boot-starter-logging都是作为spring-boot-starter-web或者spring-boot-starter依赖的一部分。

如果这里要使用Log4j2,需要从spring-boot-starter-web中去掉spring-boot-starter-logging依赖,同时显示声明使用Log4j2的依赖jar包,具体如下:

<dependency>

  <groupId>org.springframework.boot</groupId>

  <artifactId>spring-boot-starter-web</artifactId>

  <exclusions>

  <!-- 去掉默认配置 -->

  <exclusion>

  <groupId>org.springframework.boot</groupId>

  <artifactId>spring-boot-starter-logging</artifactId>

  </exclusion>

  </exclusions>

</dependency>

<!-- 引入log4j2依赖 -->

<dependency>

  <groupId>org.springframework.boot</groupId>

  <artifactId>spring-boot-starter-log4j2</artifactId>

</dependency>

2. log4j2.xml

在application.properties中指定log4j2.xml的位置

logging.config=classpath:log4j2.xml

如果不想在application.properties中指定log4j2.xml的位置,可以把log4j2.xml重命名为log4j2-spring.xml,这样也是可以按照配置打印日志信息的。

log4j2.xml简单示例

<?xml version="1.0" encoding="UTF-8"?>

<configuration>

    <Appenders>

        <Console name="CONSOLE" target="SYSTEM_OUT">

            <PatternLayout charset="UTF-8" pattern="[%-5p] %d %c - %m%n" />

        </Console>

        <File name="File" fileName="logs/file.log">

            <PatternLayout pattern="%m%n" />

        </File>

    </Appenders>

    <Loggers>

        <root level="info">

            <AppenderRef ref="CONSOLE" />

            <AppenderRef ref="File" />

        </root>

    </Loggers>

</configuration>

3. 打印日志

只使用log4j2的话,获取Logger对象一般是使用LogManager去获取的,但是如果使用slf4j的话,使用LoggerFactory去获取

private final static org.slf4j.Logger logger = LoggerFactory.getLogger(Log4j2Controller.class);

logger.trace("trace level");

logger.debug("debug level");

logger.info("info level");

logger.warn("warn level");

logger.error("error level");

使用lombok插件(详细安装方法请上网查询),可以简化Logger对象的获取,首先在相关的类上面添加@Slf4j注解(该注解由lombok提供),然后通过下面的方式打印日志:

log.trace("trace level");

log.debug("debug level");

log.info("info level");

log.warn("warn level");

log.error("error level");

log4j2配置文件详解

log4j2.xml文件的配置大致如下:

1. Configuration

Configuration为根节点,有status和monitorInterval等多个属性。

status的值有trace、debug、info、warn、error和 fatal,用于控制log4j2日志框架本身的日志级别,如果将status设置为较低的级别(如trace)就会看到很多关于log4j2本身的日志,如加载log4j2配置文件的路径等信息,一般不用设置。

monitorInterval,含义是每隔多少秒重新读取配置文件,可以不重启应用的情况下修改配置。

name:配置名称

strict: 是否使用严格的XML格式,推荐使用,规范开发者的配置编写。

2. properties

properties:配置文件全局的参数变量,用于减少自定义配置信息的重复编码,该配置是可选的,例如定义日志的存放位置D:/logs

3. Appenders

Appenders是输出源,用于定义日志输出的地方,log4j2支持的输出源有很多,有控制台Console、文件File、RollingRandomAccessFile、MongoDB、Flume等。

Console:控制台输出源是将日志打印到控制台上,开发的时候一般都会配置,以便调试

File:文件输出源,用于将日志写入到指定的文件,需要配置输入到哪个位置(例如:D:/logs/mylog.log)

RollingRandomAccessFile: 该输出源也是写入到文件,不同的是比File更加强大,可以指定当文件达到一定大小(如20MB)时,另起一个文件继续写入日志,另起一个文件就涉及到新文件的名字命名规则,因此需要配置文件命名规则 这种方式更加实用,因为你不可能一直往一个文件中写,如果一直写,文件过大,打开就会卡死,也不便于查找日志。

fileName:指定当前日志文件的位置和文件名称

filePattern:指定当发生Rolling时,文件的转移和重命名规则

SizeBasedTriggeringPolicy:指定当文件体积大于size指定的值时,触发Rolling

DefaultRolloverStrategy:指定最多保存的文件个数

TimeBasedTriggeringPolicy:这个配置需要和filePattern结合使用。

假如filePattern中配置的文件重命名规则是${FILE_NAME}-%d{yyyy-MM-dd HH-mm}-%i,最小的时间粒度是mm,即分钟,若TimeBasedTriggeringPolicy指定的interval是1,结合起来就是每1分钟生成一个新文件。如果改成%d{yyyy-MM-dd HH},最小粒度为小时,则每一个小时生成一个文件。

RollingFile:同上,与RollingRandomAccessFile不同的是,RollingRandomAccessFile默认日志文件写入策略为异步刷盘,RollingRandomAccessFile会将日志信息先写入到缓冲区,然后缓冲区满后刷到磁盘,并清空缓冲区,默认缓冲区的大小在8-256kb,具体大小需要自己设置。

NoSql:MongoDb, 输出到MongDb数据库中

Flume:输出到Apache Flume(Flume是Cloudera提供的一个高可用的,高可靠的,分布式的海量日志采集、聚合和传输的系统,Flume支持在日志系统中定制各类数据发送方,用于收集数据;同时,Flume提供对数据进行简单处理,并写到各种数据接受方(可定制)的能力。)

Async:异步,需要通过AppenderRef来指定要对哪种输出源进行异步(一般用于配置RollingRandomAccessFile)

PatternLayout:控制台或文件输出源(Console、File、RollingRandomAccessFile)都必须包含一个PatternLayout节点,用于指定输出文件的格式(如日志输出的时间、文件、方法、行数等格式),例如pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n",各标记符详细含义如下:

%d 输出时间

    %d{HH:mm:ss.SSS} 表示输出到毫秒的时间

%t 输出当前线程名称

%p 输出日志级别

    %-5p -5表示左对齐并且固定输出5个字符,如果不足在右边补0

%c 日志消息所在类名

%m 消息内容

%n 换行

%F 输出所在的类文件名,如Log4j2Test.java

%L 输出行号

%M 输出所在方法名

%l 输出语句所在的行数, 包括类名、方法名、文件名、行数

%logger 输出logger名称,如果没有名称,就不输出

4. Loggers

日志器分根日志器Root和自定义日志器,当根据日志名字获取不到指定的日志器时就使用Root作为默认的日志器,自定义时需要指定每个Logger的名称name(对于命名可以以包名作为日志的名字,不同的包配置不同的级别等),日志级别level,相加性additivity(是否继承下面配置的日志器), 对于一般的日志器(如Console、File、RollingRandomAccessFile)一般需要配置一个或多个输出源AppenderRef。

每个logger可以指定一个level(TRACE, DEBUG, INFO, WARN, ERROR, ALL or OFF),不指定时level默认为ERROR。

additivity指定是否同时输出log到父类的appender,缺省为true。

详细配置示例

<?xml version="1.0" encoding="UTF-8"?>

<configuration monitorInterval="30">

    <appenders>

        <console name="Console" target="SYSTEM_OUT">

            <PatternLayout pattern="[%d{HH:mm:ss:SSS}] [%p] - %l - %m%n"/>

        </console>

        <!--文件会打印出所有信息,这个log每次运行程序会自动清空,由append属性决定,这个也挺有用的,适合临时测试用-->

        <File name="log" fileName="logs/test.log" append="false">

            <PatternLayout pattern="%d{HH:mm:ss.SSS} %-5level %class{36} %L %M - %msg%xEx%n"/>

        </File>

        <!-- 这个会打印出所有的info及以下级别的信息,每次大小超过size,

        则这size大小的日志会自动存入按年份-月份建立的文件夹下面并进行压缩,作为存档-->

        <RollingFile name="RollingFileInfo" fileName="logs/info.log"

                    filePattern="logs/$${date:yyyy-MM}/info-%d{yyyy-MM-dd}-%i.log">

            <Filters>

                <!--控制台只输出level及以上级别的信息(onMatch),其他的直接拒绝(onMismatch)-->

                <ThresholdFilter level="INFO" onMatch="ACCEPT" onMismatch="DENY"/>

                <ThresholdFilter level="WARN" onMatch="DENY" onMismatch="NEUTRAL"/>

            </Filters>

            <PatternLayout pattern="[%d{HH:mm:ss:SSS}] [%p] - %l - %m%n"/>

            <Policies>

                <TimeBasedTriggeringPolicy/>

                <SizeBasedTriggeringPolicy size="100 MB"/>

            </Policies>

        </RollingFile>

        <RollingFile name="RollingFileWarn" fileName="logs/warn.log"

                    filePattern="logs/$${date:yyyy-MM}/warn-%d{yyyy-MM-dd}-%i.log">

            <Filters>

                <ThresholdFilter level="WARN" onMatch="ACCEPT" onMismatch="DENY"/>

                <ThresholdFilter level="ERROR" onMatch="DENY" onMismatch="NEUTRAL"/>

            </Filters>

            <PatternLayout pattern="[%d{HH:mm:ss:SSS}] [%p] - %l - %m%n"/>

            <Policies>

                <TimeBasedTriggeringPolicy/>

                <SizeBasedTriggeringPolicy size="100 MB"/>

            </Policies>

            <!-- DefaultRolloverStrategy属性如不设置,则默认为最多同一文件夹下7个文件,这里设置了20 -->

            <DefaultRolloverStrategy max="20"/>

        </RollingFile>

        <RollingFile name="RollingFileError" fileName="logs/error.log"

                    filePattern="logs/$${date:yyyy-MM}/error-%d{yyyy-MM-dd}-%i.log">

            <ThresholdFilter level="ERROR"/>

            <PatternLayout pattern="[%d{HH:mm:ss:SSS}] [%p] - %l - %m%n"/>

            <Policies>

                <TimeBasedTriggeringPolicy/>

                <SizeBasedTriggeringPolicy size="100 MB"/>

            </Policies>

        </RollingFile>

    </appenders>

    <!--然后定义logger,只有定义了logger并引入的appender,appender才会生效-->

    <loggers>

        <!--过滤掉spring和hibernate的一些无用的debug信息-->

        <logger name="org.springframework" level="INFO">

        </logger>

        <logger name="org.mybatis" level="INFO">

        </logger>

        <root level="all">

            <appender-ref ref="Console"/>

            <appender-ref ref="RollingFileInfo"/>

            <appender-ref ref="RollingFileWarn"/>

            <appender-ref ref="RollingFileError"/>

        </root>

    </loggers>

</configuration>

若您觉得还可以,请帮忙点个赞,谢谢,您的支持是我最大的动力

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

推荐阅读更多精彩内容