Spring学习手册(14)—— Spring整合Log4j2

我们首先学习了Spring的两个核心技术:IOC和AOP,然后为满足真实的项目需求我们又学习了Spring的基础JDBC操作以及如何再Spring框架下整合mybatis数据持久化框架。到目前为止我们已经可以完成简单的Spring后台项目开发工作。但是在实际的项目中,为了方便调试和追踪问题,我们往往需要打印日志信息来帮助我们发现和追踪问题。因此,为完善项目实际开发能力,本文我们主要学习在Spring框架中如何引入目前流行的日志框架Log4J2。

一、Log4j2简介

Log4J2是Log4j 1.x的升级版版,在Log4j 1.x的基础上有显著的改进,并且提供了Logback中许多i可用的功能,同时也修复了一些Logback上的一些固有的问题。

二、引入Log4j2的jar包依赖

官网文档指出,如果需要依赖Log4j2需要依赖log4j-apilog4j-core两个jar包,因此我们在gradle.build文件中添加如下依赖:

dependencies {
    testCompile group: 'junit', name: 'junit', version: '4.11'
    compile 'org.apache.logging.log4j:log4j-api:2.8.1'
    compile 'org.apache.logging.log4j:log4j-core:2.8.1'
}

log4j-apilog4j-core的依赖版本我们都选择2.8.1,在命令行下运行如下命令,gradle会自动完成依赖解析。

gradle build

三、Hello-log4j2

在将log4j2整合到Spring之前我们先完成一个使用log4j2最简单的例子:hello-log4j2。
首先创建主java运行程序:

public class Application {

    private static final Logger logger = LogManager.getLogger(Application.class);

    public static void main(String[] args){
        logger.info("Hello, Log4j2!");
    }
}

这个例子很简单,我们定义了类Application并为其定义静态常量logger,其使用LogManager进行实例化,并获取一个命名的logger对象。在main方法中,我们直接使用logger.info输出“Hello,Log4j2”信息。

Tip : Log4j2 将日志级别分为8个级别:All < Trace < Debug < Info < Warn < Error < Fatal < OFF,级别越高打印的日志越少,Logger也提供了相应的方法对应相应的日志级别。

Log4j2提供XML、JSON、YAML和properties格式进行配置,我们这里主要以XML配置方式进行学习,如果想了解更多的配置方式,读者可自动查看官网文档

log4j2.xml配置,该文件需在classpath路径下,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="debug">
            <AppenderRef ref="Console"/>
        </Root>
    </Loggers>
</Configuration>

如上我们定义了最简单的log4j2配置文件,我们对该文件中的元素标签进行简单介绍:

Configuration 标签

log4j的所有配置信息需要包含在该标签下,这里我们用到了status属性,它用于指定log4j内部日志信息打印级别,这里我们设置为WARN,它同时可被设置为如下数值:tracedebuginfoerror,共5种不同级别。同时该标签下可包含<Appenders><Loggers>标签,<Appenders>用于定义日志信息所传输(写入)的目标地,当然它还会定义输出格式等信息;<Loggers>关联一个具体的Appender,上面的配置文件关联的名为“Console”的AppenderLoggers内部可定义<Root><Logger>,统称为Logger,其中Root为所有Logger的父亲,当代码中定义的Logger没有对应匹配的<Logger>时则会直接使用Root的配置信息。

Appenders 标签

该标签下定义所有的Appender,其中常见的为ConsoleFileRollingFile......,这里我们使用Console标签定义一个中断输出,其中target可设置为"SYSTEM_OUT"或者“SYSTEM_ERR”,一般设置为“SYSTEM_OUT”且默认为该值。这里我们使用<PatternLayout>来设置了日志输出格式。每个Appender提供了丰富的属性或标签进行设置相应的输出结果,使得我们可以在不改变源代码的情况下,对日志输出进行灵活改动。详细学习该标签下属性的设置超出了本文的范围,我们会放在后面进行学习。

Loggers 标签

该标签下定义所有的Logger,用来关联代码中定义的Logger和Appender。该标签下包含两种标签:<Root><Logger>。Root为所有Logger的根(父亲),所有的Logger自动继承Root的配置信息。我们使用level来设置该Logger输出的日志级别。并且使用�<AppenderRef>来关联一个前面定义好的Appender。

完成以上配置后运行代码我们会在控制台看到如信息:

17:54:29.921 [main] INFO  com.liangwei.learnspring.Application - Hello, Log4j2!

如上,我们记录了时间、方法名、日志级别、类名、输出信息。

三、Spring整合Log4j2

Spring强制依赖commons-loggingjar包,该jar包由spring-core间接引入。commons-logging是JCL(Jakarta Commons Logging API)的一种典型实现,Spring的框架日志信息都是使用JCL标准接口来进行输出的,如果我们想将Spring的框架日志输出按照log4j的配置方式进行输出,我们需要完成JCL-log4j之间的映射,而log4j为我们提供了相关依赖jar包。为完成Spring框架整合Log4j日志框架,我们只需要增加如下依赖信息:

dependencies {
    testCompile group: 'junit', name: 'junit', version: '4.11'
    compile 'org.apache.logging.log4j:log4j-api:2.8.1'
    compile 'org.apache.logging.log4j:log4j-core:2.8.1'
    compile 'org.apache.logging.log4j:log4j-jcl:2.8.1'
    compile 'org.springframework:spring-context:4.3.6.RELEASE'
}

如上,我们增加了compile 'org.apache.logging.log4j:log4j-jcl:2.8.1'配置信息,增加了log4j-jcl的jar包。接下来我们需要修改log4j2.xml文件,来完成Spring框架日志文件的输出:

<?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>
        <Logger name="org.springframework.beans.factory" level="DEBUG"/>
        <Root level="debug">
            <AppenderRef ref="Console"/>
        </Root>
    </Loggers>
</Configuration>

如上,我们定义了一个名为org.springframework.beans.factory的Logger,该Logger的日志级别为DEBUG,这样Spring 框架内的DEBUG以上级别的日志信息会被输出,由于该Logger并没有定义AppenderRef信息,因此它自动集成Root设置的Console,该信息会被输出到控制台。

我们在源代码Application.java中增加Spring加载启动代码:

public class Application {

    private static final Logger logger = LogManager.getLogger(Application.class);

    public static void main(String[] args){

        ApplicationContext applicationContext = new ClassPathXmlApplicationContext("dao.xml");
        logger.info("Hello, Log4j2!");
    }
}

重新运行程序,我们将在控制台看到如下信息:

19:06:24.314 [main] DEBUG org.springframework.core.env.StandardEnvironment - Adding [systemProperties] PropertySource with lowest search precedence
19:06:24.318 [main] DEBUG org.springframework.core.env.StandardEnvironment - Adding [systemEnvironment] PropertySource with lowest search precedence
19:06:24.319 [main] DEBUG org.springframework.core.env.StandardEnvironment - Initialized StandardEnvironment with PropertySources [systemProperties,systemEnvironment]
...... ......

19:06:25.073 [main] INFO  com.liangwei.learnspring.Application - Hello, Log4j2!

为保持简洁,省略了大部分Spring框架启动时的信息,读者可自行下载代码进行运行查看。

四、总结

本文我们将log4j2引入Spring框架,我们通过最简单的Hello-log4j程序学习了Log4j2日志框架配置方式:1. 使用LogManager定义Logger;2,配置log4j2.xml文件。最后我们通过增加jar包依赖和配置关于Spring框架日志的Logger将Spring框架日志信息通过Log4j日志框架进行输出,至此,我们已完成将log4j2引入Spring的工作。
当然,本文并没有详细学习log4j2.xml文件的配置以及配置文件中各标签的用法,这超出简单将log4j2引入Spring框架的目的以及本系列文章学习Spring知识的初衷,关于log4j的学习,后面有机会会专门开辟系列文章进行共同学习。
本文实例代码地址

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

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,637评论 18 139
  • Spring Boot 参考指南 介绍 转载自:https://www.gitbook.com/book/qbgb...
    毛宇鹏阅读 46,778评论 6 342
  • 在应用程序中添加日志记录总的来说基于三个目的:监视代码中变量的变化情况,周期性的记录到文件中供其他应用进行统计分析...
    时待吾阅读 5,008评论 1 13
  • 在应用程序中添加日志记录总的来说基于三个目的:监视代码中变量的变化情况,周期性的记录到文件中供其他应用进行统计分析...
    时待吾阅读 4,975评论 0 6
  • 摘要: 基本概念 1.1、Spring spring是一个开源框架,Spring是于2003 年兴起的一个轻量级的...
    ITsupuerlady阅读 1,405评论 0 8