Spring MVC + Slf4j + Log4j2 日志文件系统配置和log4j2配置文件log4j2.xml详解(转载)

转载自 

吴赵笔记的“Spring MVC + Slf4j + Log4j2 日志文件系统配置” 

博文地址:https://www.jianshu.com/p/191273d04d2d

阿豪聊干货的“聊一聊log4j2配置文件log4j2.xml

博文地址:https://www.cnblogs.com/hafiz/p/6170702.html

一、各种日志系统介绍:

Commons Logging

Commons Logging 也就是JCL,提供的是一个日志接口(Interface),自身提供一个简单的日志文件系统,但一般和其他日志系统组合使用。如:Commons-Logging + Log4j组合使用。
它会通过动态查找机制,在程序运行时自动找出真正使用的日志库。

Slf4j

Slf4j 即Simple Logging Facade for Java,和Commons-Logging类似,也是对不同日志框架提供的一个门面封装,可以在部署的时候可以通过桥接包接入其他日志方案来组合使用。
它支持多个参数并通过"{ }"占位符来进行替换。

Log4j

Log4j 即Log for Java ,经典的一种日志解决方案。内部把日志系统抽象封装成Logger 、appender 、pattern 等实现。我们可以通过配置文件轻松的实现日志系统的管理和多样化配置。
Log4j 系统的三大板块:日志写入器Logger、日志输出终端Appender、日志布局模式Layout。其中Appender常用的有ConsoleAppender(输出到控制台)、FileAppender(输出文件)和RollingFileAppender(输出滚动文件)三种。
在classpath下编写配置文件log4j.properties,配置相关日志属性和格式。

Log4j2

Log4j2 是在Log4j 1.x版本基础上的一个升级版本。性能得到提升的同时,还能够自动装载配置文件,支持参数变量的占位符功能,可以专门指定事件进行过滤,并且支持插件式架构。

Logback

Logback是由log4j创始人涉及的又一个开源的日志组件,logback当前分成三个模块:logback-core,logback- classic和logback-access。logback-core是其它两个模块的基础模块。logback-classic是log4j的一个 改良版本。此外logback-classic完整实现Slf4j API,使我们可以很方便地更换成其它日志系统,如:log4j或JDK。logback-access访问模块与Servlet容器集成提供通过Http来访问日志的功能。

二、Spring MVC + Slf4j + Log4j2 配置步骤:

Maven配置

首先,应在Maven中加载所需依赖包,并通过桥接器将Slf4j和Log4j2组合起来使用。
第一步:将Spring中的Commons-Logging取消依赖( Spring自身的日志系统是基于Commons-Logging接口的,而我们所采用的是Slf4j接口 + Log4j2组合模式,为了避免冲突,故需在配置依赖中将Spring中的Commons-Logging取消依赖

        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-core</artifactId>
            <version>${springframework}</version>
            <exclusions>
                <exclusion>
                    <groupId>commons-logging</groupId>
                    <artifactId>commons-logging</artifactId>
                </exclusion>
            </exclusions>
        </dependency>

第二步:配置 Slf4j 需要的依赖:(选用“1.7.25”版本)

        <!-- slf4j config start -->
        <dependency>
            <groupId>org.slf4j</groupId>
            <artifactId>slf4j-api</artifactId>
            <version>${slf4j}</version>
        </dependency>
        <dependency>
            <groupId>org.slf4j</groupId>
            <artifactId>jcl-over-slf4j</artifactId>
            <version>${slf4j}</version>
            <scope>runtime</scope>
        </dependency>
        <!-- slf4j config end -->

slf4j-api : Slf4j的核心包,只有日志的接口,并没有实现。
jcl-over-slf4j : 桥接器,将JCL的日志输出重定向到Slf4j中。

第三步:配置 log4j2 需要的依赖:(选用“2.8.2”版本)

        <!-- log4j2 config start -->
        <dependency>
            <groupId>org.apache.logging.log4j</groupId>
            <artifactId>log4j-core</artifactId>
            <version>${log4j2}</version>
            <scope>runtime</scope>
        </dependency>
        <dependency>
            <groupId>org.apache.logging.log4j</groupId>
            <artifactId>log4j-web</artifactId>
            <version>${log4j2}</version>
            <scope>runtime</scope>
        </dependency>
        <dependency>
            <groupId>org.apache.logging.log4j</groupId>
            <artifactId>log4j-api</artifactId>
            <version>${log4j2}</version>
            <scope>runtime</scope>
        </dependency>
        <dependency>
            <groupId>org.apache.logging.log4j</groupId>
            <artifactId>log4j-slf4j-impl</artifactId>
            <version>${log4j2}</version>
            <scope>runtime</scope>
        </dependency>
        <!-- log4j2 config end -->

log4j-slf4j-impl : 将log4j2 和 slf4j进行绑定。

编写Log4j2 日志配置文件

  1. 配置文件格式及读取优先级:
    Log4j2 配置文件后缀要求为".xml"、".json"或者".jsn"。
    系统选择配置文件的优先级为(从先到后):
    (1).classpath下的名为log4j2-test.json 或者log4j2-test.jsn的文件.
    (2).classpath下的名为log4j2-test.xml的文件.
    (3).classpath下名为log4j2.json 或者log4j2.jsn的文件.
    (4).classpath下名为log4j2.xml的文件.
    (5).如果classpath下没有相关配置文件,则使用默认日志系统.

  2. 详细配置文件解析:
    要点介绍 :
    日志的级别: ALL< Trace < DEBUG < INFO < WARN < ERROR < FATAL < OFF。
    Properties 模块 : 配置一些全局的属性值。
    Appenders 模块 :日志输出相关配置。
    Loggers 模块 : 只有定义了Logger并根据Appender的name属性引入其中,Appender才会生效。

  3. 配置文件节点解析    

    (1).根节点Configuration有两个属性:status和monitorinterval,有两个子节点:Appenders和Loggers(表明可以定义多个Appender和Logger).

      status用来指定log4j本身的打印日志的级别.

      monitorinterval用于指定log4j自动重新配置的监测间隔时间,单位是s,最小是5s.

    (2).Appenders节点,常见的有三种子节点:Console、RollingFile、File.

      Console节点用来定义输出到控制台的Appender.

       name:指定Appender的名字.

       target:SYSTEM_OUT 或 SYSTEM_ERR,一般只设置默认:SYSTEM_OUT.

       PatternLayout:输出格式,不设置默认为:%m%n.

      File节点用来定义输出到指定位置的文件的Appender.

       name:指定Appender的名字.

       fileName:指定输出日志的目的文件带全路径的文件名.

       PatternLayout:输出格式,不设置默认为:%m%n.

      RollingFile节点用来定义超过指定大小自动删除旧的创建新的的Appender.

       name:指定Appender的名字.

       fileName:指定输出日志的目的文件带全路径的文件名.

       PatternLayout:输出格式,不设置默认为:%m%n.

       filePattern:指定新建日志文件的名称格式.

       Policies:指定滚动日志的策略,就是什么时候进行新建日志文件输出日志.

       TimeBasedTriggeringPolicy:Policies子节点,基于时间的滚动策略,interval属性用来指定多久滚动一次,默认是1 hour。modulate=true用来调整时间:比如现在是早上3am,interval是4,那么第一次滚动是在4am,接着是8am,12am...而不是7am.

       SizeBasedTriggeringPolicy:Policies子节点,基于指定文件大小的滚动策略,size属性用来定义每个日志文件的大小.

       DefaultRolloverStrategy:用来指定同一个文件夹下最多有几个日志文件时开始删除最旧的,创建新的(通过max属性)。

    (3).Loggers节点,常见的有两种:Root和Logger.

      Root节点用来指定项目的根日志,如果没有单独指定Logger,那么就会默认使用该Root日志输出

       level:日志输出级别,共有8个级别,按照从低到高为:All < Trace < Debug < Info < Warn < Error < Fatal < OFF.

       AppenderRef:Root的子节点,用来指定该日志输出到哪个Appender.

      Logger节点用来单独指定日志的形式,比如要为指定包下的class指定不同的日志级别等。

       level:日志输出级别,共有8个级别,按照从低到高为:All < Trace < Debug < Info < Warn < Error < Fatal < OFF.

       name:用来指定该Logger所适用的类或者类所在的包全路径,继承自Root节点.

       AppenderRef:Logger的子节点,用来指定该日志输出到哪个Appender,如果没有指定,就会默认继承自Root.如果指定了,那么会在指定的这个Appender和Root的Appender中都会输出,此时我们可以设置Logger的additivity="false"只在自定义的Appender中进行输出。

     (4).关于日志level.

      共有8个级别,按照从低到高为:All < Trace < Debug < Info < Warn < Error < Fatal < OFF.

      All:最低等级的,用于打开所有日志记录.

      Trace:是追踪,就是程序推进以下,你就可以写个trace输出,所以trace应该会特别多,不过没关系,我们可以设置最低日志级别不让他输出.

      Debug:指出细粒度信息事件对调试应用程序是非常有帮助的.

      Info:消息在粗粒度级别上突出强调应用程序的运行过程.

      Warn:输出警告及warn以下级别的日志.

      Error:输出错误信息日志.

      Fatal:输出每个严重的错误事件将会导致应用程序的退出的日志.

      OFF:最高等级的,用于关闭所有日志记录.

      程序会打印高于或等于所设置级别的日志,设置的日志等级越高,打印出来的日志就越少

  4. 比较完整的log4j2.xml配置模板

    <?xml version="1.0" encoding="UTF-8"?>
    <!-- 
        status:这个用于设置log4j2自身内部的信息输出,可以不设置,当设置成trace时,你会看到log4j2内部各种详细输出。
        monitorInterval : Log4j2能够自动检测修改配置文件和重新配置本身,设置间隔秒数,单位是s,最小是5s. 
    -->
    <Configuration status="ERROR" monitorInterval="30">
        <Properties>
            <!-- 配置日志文件输出目录 -->
            <Property name="LOG_HOME">/root/bubble/logs</Property>
            <property name="ERROR_LOG_FILE_NAME">/root/bubble/logs</property>
        </Properties>
        <Appenders>
            <!-- Console节点 配置控制台日志输出: 
                name:指定Appender的名字.
                target: SYSTEM_OUT 或 SYSTEM_ERR,一般只设置默认:SYSTEM_OUT.
                PatternLayout: 输出格式,不设置默认为:%m%n.
            -->
            <Console name="Console" target="SYSTEM_OUT">
                <!-- ThresholdFilter 过滤器: 
                    控制台只输出level及以上级别的信息(onMatch),其他的直接拒绝(onMismatch)
                    日志的级别: ALL< Trace < DEBUG < INFO < WARN < ERROR < FATAL < OFF。
                -->
                <ThresholdFilter level="TRACE" onMatch="ACCEPT"
                    onMismatch="DENY" />
                <!-- PatternLayout 日志输出格式模板:
                    %d{yyyy-MM-dd HH:mm:ss.SSS} 日志生成时间。
                    %-5level 日志级别(级别从左显示5个字符宽度)。
                    %logger{36} 表示logger名字最长36个字符,否则按照句点分割。
                    %L 日志输出所在行数 日志输出所在行数 
                    [%t] 输出产生该日志事件的线程名
                    %msg 日志消息
                    %n 是换行符
                    eg:"2017-04-17 16:04:02.312 INFO  com.zte.lucene.tools.DateUtils2Joda:424 [main] - Info Message!"
                -->
                <PatternLayout
                    pattern="%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level %logger{36}:%L [%t] - %msg%n" />
            </Console>
            <!-- RollingFileAppender 定义输出滚动文件格式。(FileAppender 定义输出到文件)
                name : RollingFileAppender的名字,用于与Loggers模块的绑定
                fileName : 日志输出保存的文件路径
                filePattern:满足条件后,日志输出保存的文件路径和名称。
                (eg: 2017-04/search-2017-04-17-1.log)
            -->
            <RollingFile name="RollingFileInfo" fileName="${LOG_HOME}/search.log"
                filePattern="${LOG_HOME}/$${date:yyyy-MM}/search-%d{yyyy-MM-dd}-%i.log">
                <ThresholdFilter level="INFO" onMatch="ACCEPT"
                    onMismatch="DENY" />
                <PatternLayout
                    pattern="%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level %logger{36}:%L [%t] - %msg%n" />
                <!-- Policies定义相关策略:-->
                <Policies>
                    <!--TimeBasedTriggeringPolicy 基于时间的滚动策略:该策略主要是完成周期性的log文件封存工作。
                        interval: integer型,指定两次封存动作之间的时间间隔,默认是1 hour。
                            单位:以日志的命名精度来确定单位,比如yyyy-MM-dd-HH 单位为小时,yyyy-MM-dd-HH-mm 单位为分钟。
                            关键点在于 filePattern后的日期格式.
                        modulate: boolean型,说明是否对封存时间进行调制。
                            若modulate=true,则封存时间将以0点为边界进行偏移计算。
                            比如:modulate=true,interval=4hours,那么假设上次封存日志的时间为01:00,
                            则下次封存日志的时间为04:00,之后的封存时间依次为08:00,12:00.             
                    -->
                    <!-- log4j2的按天分日志文件 : search-%d{yyyy-MM-dd}.log -->
                    <TimeBasedTriggeringPolicy interval="1"
                        modulate="true" />
                    <!--SizeBasedTriggeringPolicy 基于对log文件大小的判断策略:
                        当log文件大于设定的阈值时,将触发封存动作。
                        可设定的log文件大小的单位有bytes、KB、MB或GB。
                    -->
                    <SizeBasedTriggeringPolicy size="100 MB" />
                </Policies>
                <!--DefaultRolloverStrategy(属性如不设置,则默认为最多同一文件夹下7个文件):
                    fileIndex: String类型,有两个选择“max”或“min”。
                        设置为“max”意味着将最新的日志信息封存在序号较大的封存文件中。“min”则相反。
                    max: integer类型,封存文件的序号的最大值。(超过最大值时,将有文件被删除)
                    min: integer类型,封存文件的序号的起始值。
                相当于min和max两个参数设置了一个保存窗口,超出这个窗口的日志文件将会被删除。
                -->
                <DefaultRolloverStrategy max="100" />
            </RollingFile>
            <RollingFile name="RollingFileError"
                fileName="${ERROR_LOG_FILE_NAME}/search-error.log"
                filePattern="${ERROR_LOG_FILE_NAME}/$${date:yyyy-MM}/search-error-%d{yyyy-MM-dd}.log">
                <ThresholdFilter level="ERROR" onMatch="ACCEPT"
                    onMismatch="DENY" />
                <PatternLayout
                    pattern="%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level %logger{36}:%L [%t] - %msg%n" />
                <Policies>
                    <TimeBasedTriggeringPolicy interval="1"
                        modulate="true" />
                </Policies>
                <DefaultRolloverStrategy max="100" />
            </RollingFile>
        </Appenders>
        <!--然后定义logger,只有定义了logger并引入的appender,appender才会生效-->
        <Loggers>
            <!--过滤掉spring的一些无用的DEBUG信息-->
            <logger name="org.springframework" level="INFO"></logger>
            <!-- 配置日志的根节点 -->
            <!-- level="all" 只能够输出level级别是all及all以上的-->
            <root level="all">
                <appender-ref ref="Console" />
                <appender-ref ref="RollingFileInfo" />
                <appender-ref ref="RollingFileError" />
            </root>
        </Loggers>
    </Configuration>
    

     

评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值