美文网首页Java web
logging日志-log4j、log4j 2、logback、

logging日志-log4j、log4j 2、logback、

作者: dancer4code | 来源:发表于2019-09-28 21:53 被阅读0次

    1.简介

    • commons-logging: Apache基金会所属最早提供的日志的门面接口。之前叫Jakarta Commons Logging,后更名为Commons Logging.避免和具体的日志方案直接耦合。类似于JDBC 的api 接口,具体的的JDBC driver 实现由各数据库提供商实现。通过统一接口解耦,不过其内部也实现了一些简单日志方案。

    • Slf4j: 全称为Simple Logging Facade for JAVA:java简单日志门面。 是对不同日志框架提供的一个门面封装。可以在部署的时候不修改任何配置即可接入一种日志实现方案。和commons-loging 应该有一样的初衷。设计上更好一些,没有commons 那么多潜规则。

    • Jul: (Java Util Logging)自Java1.4以来的官方日志实现。可参考这里使用步骤

    • Log4j: Apache Log4j是一个基于Java的日志记录工具。它是由Ceki Gülcü首创的,现在则是Apache软件基金会的一个项目。 Log4j是几种Java日志框架之一。

    • Logback:一套日志组件的实现(Slf4j阵营)。

    • Log4j 2: Apache Log4j 2是apache开发的一款Log4j的升级产品。log4j属于1.x.x, log4j 2属于2.x.x. Apache官网地址 | github地址

      • log4j优点
      • 能支持多个参数,并通过{} 占位符进行替换,避免老写logger.isXXXEnabled 这种无奈的判断,带来性能提升
      • OSGI 机制更好兼容支持

    \color{red}{总结粗略可以看成:}
    日志接口: commons-logging、Slf4j
    日志实现: log4j、logback、log4j2

    推荐使用slf4j+X(log4j/logback/log4j 2)这种方式,而不是直接使用log4j/logback/log4j 2。具体原因可参考:为什么要用 SLF4J

    slf4j日志相关.png

    2. 简单用法(测试环境针对java,web环境没测)

    2.1 slf4j+log4j

    maven依赖

      <dependency>
           <groupId>org.slf4j</groupId>
           <artifactId>slf4j-log4j12</artifactId>
           <version>1.7.26</version>
      </dependency>
    

    配置文件位置classpath下名称 log4j.properties

    log4j.rootLogger=ALL, Console ,File 
    
    #Console
    log4j.appender.Console=org.apache.log4j.ConsoleAppender 
    log4j.appender.Console.layout=org.apache.log4j.PatternLayout 
    log4j.appender.Console.layout.ConversionPattern=%d [%t] %-5p [%c] - %m%n
    
    #File
    log4j.appender.File = org.apache.log4j.FileAppender
    log4j.appender.File.File = D://log4j2.log
    log4j.appender.File.layout = org.apache.log4j.PatternLayout
    log4j.appender.File.layout.ConversionPattern =%d [%t] %-5p [%c] - %m%n
    

    代码测试

    package com.dancer4code.slf4j;
    
    
    import org.slf4j.Logger;
    import org.slf4j.LoggerFactory;
    
    /**
     * Created with IntelliJ IDEA.
     * User: liangqing.zhao(zlq)
     * Date: 2019/9/21 13:24
     * Description:
     */
    
    public class Slf4jTest {
        static Logger log = LoggerFactory.getLogger(Slf4jTest.class);
        public static void main(String[] args) {
            log.trace("hello trace");
            log.debug("hello debug");
            log.info("hello info");
            log.warn("hello warn");
            log.error("hello error");
        }
    }
    

    输出结果

    2019-09-21 22:03:14,581 [main] TRACE [com.dancer4code.slf4j.Slf4jTest] - hello trace
    2019-09-21 22:03:14,582 [main] DEBUG [com.dancer4code.slf4j.Slf4jTest] - hello debug
    2019-09-21 22:03:14,582 [main] INFO  [com.dancer4code.slf4j.Slf4jTest] - hello info
    2019-09-21 22:03:14,582 [main] WARN  [com.dancer4code.slf4j.Slf4jTest] - hello warn
    2019-09-21 22:03:14,582 [main] ERROR [com.dancer4code.slf4j.Slf4jTest] - hello error
    

    2.2 slf4j+logback

    maven依赖

     <dependency>
           <groupId>ch.qos.logback</groupId>
           <artifactId>logback-classic</artifactId>
           <version>1.2.3</version>
    </dependency>
    

    配置文件classpath下 logback.xml
    完全来自slf4j+logback的配置及使用

    <?xml version="1.0" encoding="UTF-8"?>
    <!--scan:
                当此属性设置为true时,配置文件如果发生改变,将会被重新加载,默认值为true。
    scanPeriod:
                设置监测配置文件是否有修改的时间间隔,如果没有给出时间单位,默认单位是毫秒。当scan为true时,此属性生效。默认的时间间隔为1分钟。
    debug:
                当此属性设置为true时,将打印出logback内部日志信息,实时查看logback运行状态。默认值为false。
    
    configuration 子节点为 appender、logger、root
    
                -->
    <configuration scan="true" scanPeriod="60 seconds" debug="false">
        <!--用于区分不同应用程序的记录-->
        <contextName>edu-cloud</contextName>
        <!--日志文件所在目录,如果是tomcat,如下写法日志文件会在则为${TOMCAT_HOME}/bin/logs/目录下-->
        <property name="LOG_HOME" value="logs"/>
    
        <!--控制台-->
        <appender name="stdout" class="ch.qos.logback.core.ConsoleAppender">
            <encoder>
                <!--格式化输出:%d表示日期,%thread表示线程名,%-5level:级别从左显示5个字符宽度 %logger输出日志的logger名 %msg:日志消息,%n是换行符 -->
                <pattern>[%d{yyyy-MM-dd HH:mm:ss.SSS}] [%thread] %-5level %logger{36} : %msg%n</pattern>
                <!--解决乱码问题-->
                <charset>UTF-8</charset>
            </encoder>
        </appender>
    
        <!--滚动文件-->
        <appender name="infoFile" class="ch.qos.logback.core.rolling.RollingFileAppender">
            <!-- ThresholdFilter:临界值过滤器,过滤掉 TRACE 和 DEBUG 级别的日志 -->
            <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
                <level>INFO</level>
            </filter>
            <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
                <fileNamePattern>${LOG_HOME}/log.%d{yyyy-MM-dd}.log</fileNamePattern>
                <maxHistory>30</maxHistory><!--保存最近30天的日志-->
            </rollingPolicy>
            <encoder>
                <charset>UTF-8</charset>
                <pattern>[%d{yyyy-MM-dd HH:mm:ss.SSS}] [%thread] %-5level %logger{36} : %msg%n</pattern>
            </encoder>
        </appender>
    
        <!--滚动文件-->
        <appender name="errorFile" class="ch.qos.logback.core.rolling.RollingFileAppender">
            <!-- ThresholdFilter:临界值过滤器,过滤掉 TRACE 和 DEBUG 级别的日志 -->
            <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
                <level>error</level>
            </filter>
            <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
                <fileNamePattern>${LOG_HOME}/error.%d{yyyy-MM-dd}.log</fileNamePattern>
                <maxHistory>30</maxHistory><!--保存最近30天的日志-->
            </rollingPolicy>
            <encoder>
                <charset>UTF-8</charset>
                <pattern>[%d{yyyy-MM-dd HH:mm:ss.SSS}] [%thread] %-5level %logger{36} : %msg%n</pattern>
            </encoder>
        </appender>
    
        <!--将日志输出到logstack-->
        <!--<appender name="logstash" class="net.logstash.logback.appender.LogstashTcpSocketAppender">
            <destination>47.93.173.81:7002</destination>
            <encoder class="net.logstash.logback.encoder.LogstashEncoder">
                <charset>UTF-8</charset>
            </encoder>
            <keepAliveDuration>5 minutes</keepAliveDuration>
        </appender>-->
    
        <!--这里如果是info,spring、mybatis等框架则不会输出:TRACE < DEBUG < INFO <  WARN < ERROR-->
        <!--root是所有logger的祖先,均继承root,如果某一个自定义的logger没有指定level,就会寻找
        父logger看有没有指定级别,直到找到root。-->
        <root level="debug">
            <appender-ref ref="stdout"/>
            <appender-ref ref="infoFile"/>
            <appender-ref ref="errorFile"/>
            <appender-ref ref="logstash"/>
        </root>
    
        <!--为某个包单独配置logger
    
        比如定时任务,写代码的包名为:com.seentao.task
        步骤如下:
        1、定义一个appender,取名为task(随意,只要下面logger引用就行了)
        appender的配置按照需要即可
    
    
        2、定义一个logger:
        <logger name="com.seentao.task" level="DEBUG" additivity="false">
          <appender-ref ref="task" />
        </logger>
        注意:additivity必须设置为false,这样只会交给task这个appender,否则其他appender也会打印com.seentao.task里的log信息。
    
        3、这样,在com.seentao.task的logger就会是上面定义的logger了。
        private static Logger logger = LoggerFactory.getLogger(Class1.class);
        -->
    </configuration>
    

    测试代码与上同

    打印信息省略许多logback内部信息

    [2019-09-21 22:29:34.941] [main] DEBUG com.dancer4code.slf4j.Slf4jTest : hello debug
    [2019-09-21 22:29:34.943] [main] INFO  com.dancer4code.slf4j.Slf4jTest : hello info
    [2019-09-21 22:29:34.944] [main] WARN  com.dancer4code.slf4j.Slf4jTest : hello warn
    [2019-09-21 22:29:34.945] [main] ERROR com.dancer4code.slf4j.Slf4jTest : hello error
    

    参考了
    IDEA项目搭建十——使用slf4j和logback进行日志记录
    slf4j+logback的配置及使用
    Slf4j日志配置文件 logback.xml
    日志:slf4j+logback 的配置与使用
    谢谢你们(*V*)

    2.3 slf4j+log4j 2

    (性能优越,不过集成一些流行框架后需要更改有点多。用不用结合自己的项目考虑)
    请参考Apache Log4j 2.0 值得升级吗

    maven依赖

    <dependency>
         <groupId>org.apache.logging.log4j</groupId>
         <artifactId>log4j-slf4j-impl</artifactId>
         <version>2.9.1</version>
    </dependency>
    

    配置文件classpath下log4j2.xml

    <?xml version="1.0" encoding="UTF-8"?>
    <!--日志级别以及优先级排序: OFF > FATAL > ERROR > WARN > INFO > DEBUG > TRACE > ALL -->
    <!--Configuration后面的status,这个用于设置log4j2自身内部的信息输出,可以不设置,当设置成trace时,你会看到log4j2内部各种详细输出-->
    <!--monitorInterval:Log4j能够自动检测修改配置 文件和重新配置本身,设置间隔秒数-->
    <configuration status="ERROR" monitorInterval="30">
        <!--先定义所有的appender-->
        <appenders>
            <!--这个输出控制台的配置-->
            <console name="Console" target="SYSTEM_OUT">
                <!--输出日志的格式-->
                <PatternLayout pattern="[%d{HH:mm:ss:SSS}] [%5p] - %l - %m%n"/>
            </console>
            <!--文件会打印出所有信息,这个log每次运行程序会自动清空,由append属性决定,这个也挺有用的,适合临时测试用-->
            <File name="log" fileName="log/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="${sys:user.home}/logs/info.log"
                         filePattern="${sys:user.home}/logs/$${date:yyyy-MM}/info-%d{yyyy-MM-dd}-%i.log">
                <!--控制台只输出level及以上级别的信息(onMatch),其他的直接拒绝(onMismatch)-->
                <ThresholdFilter level="info" onMatch="ACCEPT" onMismatch="DENY"/>
                <PatternLayout pattern="[%d{HH:mm:ss:SSS}] [%p] - %l - %m%n"/>
                <Policies>
                    <TimeBasedTriggeringPolicy/>
                    <SizeBasedTriggeringPolicy size="100 MB"/>
                </Policies>
            </RollingFile>
            <RollingFile name="RollingFileWarn" fileName="${sys:user.home}/logs/warn.log"
                         filePattern="${sys:user.home}/logs/$${date:yyyy-MM}/warn-%d{yyyy-MM-dd}-%i.log">
                <ThresholdFilter level="warn" onMatch="ACCEPT" onMismatch="DENY"/>
                <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="${sys:user.home}/logs/error.log"
                         filePattern="${sys:user.home}/logs/$${date:yyyy-MM}/error-%d{yyyy-MM-dd}-%i.log">
                <ThresholdFilter level="error" onMatch="ACCEPT" onMismatch="DENY"/>
                <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和mybatis的一些无用的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>
    

    打印信息

    [23:04:14:602] [TRACE] - com.dancer4code.slf4j.Slf4jTest.main(Slf4jTest.java:17) - hello trace
    [23:04:14:605] [DEBUG] - com.dancer4code.slf4j.Slf4jTest.main(Slf4jTest.java:18) - hello debug
    [23:04:14:605] [ INFO] - com.dancer4code.slf4j.Slf4jTest.main(Slf4jTest.java:19) - hello info
    [23:04:14:606] [ WARN] - com.dancer4code.slf4j.Slf4jTest.main(Slf4jTest.java:20) - hello warn
    [23:04:14:607] [ERROR] - com.dancer4code.slf4j.Slf4jTest.main(Slf4jTest.java:21) - hello error
    

    参考了
    Log4j2与Slf4j的最佳实践
    浅谈Log4j2日志框架及使用
    Log4j2
    SLF4J 使用手册
    **谢谢上面的博客参考**

    3.补充

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

    slf4j日志级别代码中只支持
    Trace < Debug < Info < Warn < Error

    源码gitee地址----slf4jtest

    log4j pattern请参考
    Apache官方pattern
    Log4j输出格式控制--log4j的PatternLayout参数含义
    log4j日志pattern配置

    相关文章

      网友评论

        本文标题:logging日志-log4j、log4j 2、logback、

        本文链接:https://www.haomeiwen.com/subject/noqeuctx.html