java日志框架

摘要：一日志概述领域存在多种日志框架，目前常用的日志框架包括，，，，，。开销更高三与其他日志组件调用关系包名说明版本的桥接器，你需要将加入。的桥接器，原生日志框架。

java领域存在多种日志框架，目前常用的日志框架包括Log4j 1，Log4j 2，Commons Logging，Slf4j，Logback，Jul。

Commons Logging和Slf4j是日志门面(门面模式是软件工程中常用的一种软件设计模式，也被称为正面模式、外观模式。它为子系统中的一组接口提供一个统一的高层接口，使得子系统更容易使用)。Log4j和Logback则是具体的日志实现方案。可以简单的理解为接口与接口的实现，调用者只需要关注接口而无需关注具体的实现，做到解耦。

Commons Logging Apache基金会所属的项目，是一套Java日志接口，之前叫Jakarta Commons Logging，后更名为Commons Logging。

Slf4j 类似于Commons Logging，是一套简易Java日志门面，本身并无日志的实现。（Simple Logging Facade for Java，缩写Slf4j）。

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

Logback必须配合Slf4j使用。由于Logback和Slf4j是同一个作者，其兼容性不言而喻。

比较常用的组合使用方式是Slf4j与Logback组合使用，Commons Logging与Log4j组合使用。

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

Log4j 2 Apache Log4j 2是apache开发的一款Log4j的升级产品。

Log4j 2与Log4j 1发生了很大的变化，Log4j 2不兼容Log4j 1。

Jul (Java Util Logging),自Java1.4以来的官方日志实现。

Commons Logging是通过动态查找机制，在程序运行时，使用自己的ClassLoader寻找和载入本地具体的实现。详细策略可以查看commons-logging-*.jar包中的org.apache.commons.logging.impl.LogFactoryImpl.java文件。由于Osgi不同的插件使用独立的ClassLoader，Osgi的这种机制保证了插件互相独立, 其机制限制了Commons Logging在Osgi中的正常使用。Slf4j在编译期间，静态绑定本地的Log库，因此可以在Osgi中正常使用。它是通过查找类路径下org.slf4j.impl.StaticLoggerBinder，然后在StaticLoggerBinder中进行绑定。

如果是在一个新的项目中建议使用Slf4j与Logback组合，这样有如下的几个优点：

Slf4j实现机制决定Slf4j限制较少，使用范围更广。由于Slf4j在编译期间，静态绑定本地的LOG库使得通用性要比Commons Logging要好。

Logback拥有更好的性能。

Commons Logging开销更高

当我们在同一项目中使用不同的组件时应该如果解决不同组件依赖的日志组件不一致的情况呢？现在我们需要统一日志方案，统一使用Slf4j，把他们的日志输出重定向到Slf4j，然后Slf4j又会根据绑定器把日志交给具体的日志实现工具。Slf4j带有几个桥接模块，可以重定向Log4j，JCL和java.util.logging中的Api到Slf4j。

在使用Slf4j桥接时要注意避免形成死循环，在项目依赖的jar包中不要存在以下情况：

logback主要包含三个组成部分：Loggers（日志记录器）、Appenders（输出目的在）、Layouts（日志输出格式）
logback 主要分为三个模块，分别是：

　　logback-core：提供基础功能，是其他两个模块的基础
　　logback-classic ： log4j的升级，实现了self4j api
　　logback-access：用于与sevlet容器进行集成、提供网络访问日志的功能

logback初始化时，默认会去classpath下依次加载如下配置文件(logback.groovy、logback-test.xml、logback.xml)，当找不到配置文件时logback将为rootLogger 添加一个 ConsoleAppender ，用于将日志输出到控制台。

编程时可是要如下代码查看logback内部运行情况：

LoggerContext lc = (LoggerContext) LoggerFactory.getILoggerFactory();
StatusPrinter.print(lc);

对于web项目，可配置sevlet，然后通过网页查看logback内部运行状态，如下：

    
        ViewStatusMessages
        ch.qos.logback.classic.ViewStatusMessagesServlet
    

    
        ViewStatusMessages
        /lbClassicStatus
    

首先，在pom文件引入相关依赖，如下：

    org.slf4j
    slf4j-api
    1.7.7


    ch.qos.logback
    logback-core
    1.1.7


    ch.qos.logback
    logback-access
    1.1.7


    ch.qos.logback
    logback-classic
    1.1.7

接着，编写logback.xml(位于classpath目录下，此处为src/main/resources目录)

    
    myAppName
    
    
        
        
            %d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n
        
    
    
      
        
        ./my_log.log
        
        
            
            ./my_log%d{yyyyMMdd}.log.zip
            30
        
       
        
        
        
        

        
          %d{HH:mm:ss.SSS}[%-5level][%thread]%logger{36} - %msg%n
          
        
    
    
    
    
    
        
    

    
    
        
        
    

最后，就可以在程序中使用logback了，例如：

package com.yinz.aaa;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class Test {

    public static void main(String[] args) {
        Logger logger = LoggerFactory.getLogger(Test.class);
        logger.debug("test........");
    }
}

有几点需要注意：

logger 的日志级别若没显示定义，则继承最近的祖先logger（该logger需显示定义level,直到rootLogger）的日志级别。

　　logger的父子关系，由logger的名称决定，例如有三个logger，分别为：java.lang.util 、 java.lang 、java

　　则，java是java.lang的父logger， 是java.lang.util的祖先logger. 而同时java.lang是java.lang.util的父logger

参考：Logger日志定义、级别、记录、继承

logger的appender默认具有累加性（默认日志输出到当前logger的appender和所有祖先logger的appender中），可通过配置 “additivity”属性修改默认行为

Logger、appender及layout
　　1. Logger作为日志的记录器，把它关联到应用的对应的context上后，主要用于存放日志对象，也可以定义日志类型、级别。
　　2. Appender主要用于指定日志输出的目的地，目的地可以是控制台、文件、远程套接字服务器、 MySQL、PostreSQL、 Oracle和其他数据库、 JMS和远程UNIX Syslog守护进程等。
　　3. Layout 负责把事件转换成字符串，格式化的日志信息的输出。

logger context

　　各个logger 都被关联到一个 LoggerContext，LoggerContext负责制造logger，也负责以树结构排列各logger。其他所有logger也通过org.slf4j.LoggerFactory 类的静态方法getLogger取得。 getLogger方法以 logger名称为参数。用同一名字调用LoggerFactory.getLogger 方法所得到的永远都是同一个logger对象的引用。

有效级别及级别的继承

　　Logger 可以被分配级别。级别包括：TRACE、DEBUG、INFO、WARN 和 ERROR，定义于ch.qos.logback.classic.Level类。如果 logger没有被分配级别，那么它将从有被分配级别的最近的祖先那里继承级别。root logger 默认级别是 DEBUG。

打印方法与基本的选择规则

　　打印方法决定记录请求的级别。例如，如果 L 是一个 logger 实例，那么，语句 L.info("..")是一条级别为 INFO的记录语句。记录请求的级别在高于或等于其 logger 的有效级别时被称为被启用，否则，称为被禁用。记录请求级别为 p，其 logger的有效级别为 q，只有则当 p>=q时，该请求才会被执行。
该规则是 logback 的核心。级别排序为： TRACE < DEBUG < INFO < WARN < ERROR

logback的默认配置

如果配置文件 logback-test.xml 和 logback.xml 都不存在，那么 logback 默认地会调用BasicConfigurator ，创建一个最小化配置。最小化配置由一个关联到根 logger 的ConsoleAppender 组成。输出用模式为%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n 的 PatternLayoutEncoder 进行格式化。root logger 默认级别是 DEBUG。

Logback的配置文件

　　Logback 配置文件的语法非常灵活。正因为灵活，所以无法用 DTD 或 XML schema 进行定义。尽管如此，可以这样描述配置文件的基本结构：以开头，后面有零个或多个元素，有零个或多个元素，有最多一个元素。

Logback默认配置的步骤
尝试在 classpath下查找文件logback-test.xml；
如果文件不存在，则查找文件logback.xml；
如果两个文件都不存在，logback用BasicConfigurator自动对自己进行配置，这会导致记录输出到控制台。

logback.xml常用配置详解

(1) 根节点，包含下面三个属性：
　　　　scan: 当此属性设置为true时，配置文件如果发生改变，将会被重新加载，默认值为true。
　　　　scanPeriod: 设置监测配置文件是否有修改的时间间隔，如果没有给出时间单位，默认单位是毫秒。当scan为true时，此属性生效。默认的时间间隔为1分钟。
　　　　debug: 当此属性设置为true时，将打印出logback内部日志信息，实时查看logback运行状态。默认值为false。
　　例如：

(2) 子节点：用来设置上下文名称，每个logger都关联到logger上下文，默认上下文名称为default。但可以使用设置成其他名字，用于区分不同应用程序的记录。一旦设置，不能修改。
　　例如：

 
     myAppName 
　　  
    

(3) 子节点 ：用来定义变量值，它有两个属性name和value，通过定义的值会被插入到logger上下文中，可以使“${}”来使用变量。
　　　　name: 变量的名称
　　　　value: 的值时变量定义的值
　　例如：

 
　　　 
　　　${APP_Name} 
　　　 

(4) 子节点：获取时间戳字符串，他有两个属性key和datePattern
　　　　key: 标识此 的名字；
　　　　datePattern: 设置将当前时间（解析配置文件的时间）转换为字符串的模式，遵循java.txt.SimpleDateFormat的格式。
　　例如：

 
　　　　　　 
　　　　　　${bySecond} 
　　　　　　 

(5) 子节点：负责写日志的组件，它有两个必要属性name和class。name指定appender名称，class指定appender的全限定名
　　　　5.1、ConsoleAppender 把日志输出到控制台，有以下子节点：
　　　　　　：对日志进行格式化。（具体参数稍后讲解 ）
　　　　　　：字符串System.out(默认)或者System.err（区别不多说了）
　　　　例如：

 
　　　 
　　　　　  
　　　　　　　　　%-4relative [%thread] %-5level %logger{35} - %msg %n 
　　　　　  
　　　 

　　　 
　　　　　　 
　　　 

　　　　上述配置表示把>=DEBUG级别的日志都输出到控制台

　　　　5.2、FileAppender：把日志添加到文件，有以下子节点：
　　　　　　：被写入的文件名，可以是相对目录，也可以是绝对目录，如果上级目录不存在会自动创建，没有默认值。
　　　　　　：如果是 true，日志被追加到文件结尾，如果是 false，清空现存文件，默认是true。
　　　　　　：对记录事件进行格式化。（具体参数稍后讲解 ）
　　　　　　：如果是 true，日志会被安全的写入文件，即使其他的FileAppender也在向此文件做写入操作，效率低，默认是 false。
　　　　例如：

 
　　　　　　 
　　　　　　　　testFile.log 
　　　　　　　　true 
　　　　　　　　 
　　　　　　　　　　%-4relative [%thread] %-5level %logger{35} - %msg%n 
　　　　　　　　 
　　　　　　 

　　　　　　 
　　　　　　 
　　　　　　 

　　　　上述配置表示把>=DEBUG级别的日志都输出到testFile.log

　　　　5.3、RollingFileAppender：滚动记录文件，先将日志记录到指定文件，当符合某个条件时，将日志记录到其他文件。有以下子节点：
　　　　　：被写入的文件名，可以是相对目录，也可以是绝对目录，如果上级目录不存在会自动创建，没有默认值。
　　　　　：如果是 true，日志被追加到文件结尾，如果是 false，清空现存文件，默认是true。
　　　　　:当发生滚动时，决定RollingFileAppender的行为，涉及文件移动和重命名。属性class定义具体的滚动策略类
　　　　　class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"： 最常用的滚动策略，它根据时间来制定滚动策略，既负责滚动也负责出发滚动。有以下子节点：
　　　　　 ：必要节点，包含文件名及“%d”转换符，“%d”可以包含一个java.text.SimpleDateFormat指定的时间格式，如：%d{yyyy-MM}。如果直接使用 %d，默认格式是 yyyy-MM-dd。RollingFileAppender的file字节点可有可无，通过设置file，可以为活动文件和归档文件指定不同位置，当前日志总是记录到file指定的文件（活动文件），活动文件的名字不会改变；
如果没设置file，活动文件的名字会根据fileNamePattern 的值，每隔一段时间改变一次。“/”或者“”会被当做目录分隔符。
　　　　　 :可选节点，控制保留的归档文件的最大数量，超出数量就删除旧文件。假设设置每个月滚动，且是6，则只保存最近6个月的文件，删除之前的旧文件。注意，删除旧文件是，那些为了归档而创建的目录也会被删除。
　　　　 class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy"： 查看当前活动文件的大小，如果超过指定大小会告知RollingFileAppender 触发当前活动文件滚动。只有一个节点:
　　　　　 :这是活动文件的大小，默认值是10MB。
　　　　　　 ：当为true时，不支持FixedWindowRollingPolicy。支持TimeBasedRollingPolicy，但是有两个限制，1不支持也不允许文件压缩，2不能设置file属性，必须留空。

　　　　　 : 告知 RollingFileAppender 合适激活滚动。
　　　　 class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy" 根据固定窗口算法重命名文件的滚动策略。有以下子节点：
　　　　　　　　:窗口索引最小值
　　　　　　　　:窗口索引最大值，当用户指定的窗口过大时，会自动将窗口设置为12。
　　　　　　　　:必须包含“%i”例如，假设最小值和最大值分别为1和2，命名模式为 mylog%i.log,会产生归档文件mylog1.log和mylog2.log。还可以指定文件压缩选项，例如，mylog%i.log.gz 或者 没有log%i.log.zip
　　　　　　例如： 　　　　　　　　

               
　　　　　　　　　　 
　　　　　　　　　　　　 
　　　　　　　　　　　　　　logFile.%d{yyyy-MM-dd}.log 
　　　　　　　　　　　　　　30 
　　　　　　　　　　　　 
　　　　　　　　　　　　 
　　　　　　　　　　　　　　%-4relative [%thread] %-5level %logger{35} - %msg%n 
　　　　　　　　　　　　 
　　　　　　　　　　 

　　　　　　　　　　 
　　　　　　　　　　　　 
　　　　　　　　　　 
　　　　　　　　

　　　　　　　　备注：上述配置表示每天生成一个日志文件，保存30天的日志文件。
　　　　　　　　

               
　　　　　　　　　　 
　　　　　　　　　　　　test.log 

　　　　　　　　　　　　 
　　　　　　　　　　　　　　tests.%i.log.zip 
　　　　　　　　　　　　　　1 
　　　　　　　　　　　　　　3 
　　　　　　　　　　　　 

　　　　　　　　　　　　 
　　　　　　　　　　　　　　5MB 
　　　　　　　　　　　　 
　　　　　　　　　　　　 
　　　　　　　　　　　　　　%-4relative [%thread] %-5level %logger{35} - %msg%n 
　　　　　　　　　　　　 
　　　　　　　　　　 

　　　　　　　　　　 
　　　　　　　　　　　　 
　　　　　　　　　　 
　　　　　　　　

备注：上述配置表示按照固定窗口模式生成日志文件，当文件大于20MB时，生成新的日志文件。窗口大小是1到3，当保存了3个归档文件后，将覆盖最早的日志。（分别为tests.1.log.zip、tests.2.log.zip、tests.3.log.zip）
：对记录事件进行格式化。负责两件事，一是把日志信息转换成字节数组，二是把字节数组写入到输出流。
PatternLayoutEncoder 是唯一有用的且默认的encoder ，有一个节点，用来设置日志的输入格式。使用“%”加“转换符”方式，如果要输出“%”，则必须用“”对“%”进行转义。

：
负责两件事，一是把日志信息转换成字节数组，二是把字节数组写入到输出流。
目前PatternLayoutEncoder 是唯一有用的且默认的encoder ，有一个节点，用来设置日志的输入格式。使用“%”加“转换符”方式，>如果要输出“%”，则必须用“”对“%”进行转义。
例如：
   
   %-4relative [%thread] %-5level %logger{35} - %msg%n   
  
里面的转换符说明：

　　　　5.4、还有SocketAppender、SMTPAppender、DBAppender、SyslogAppender、SiftingAppender，并不常用，这里就不详解了。
大家可以参考官方文档（http://logback.qos.ch/documen...），还可以编写自己的Appender。

（6）子节点：用来设置某一个包或具体的某一个类的日志打印级别、以及指定。仅有一个name属性，一个可选的level和一个可选的addtivity属性。
可以包含零个或多个元素，标识这个appender将会添加到这个loger
　　　　name: 用来指定受此loger约束的某一个包或者具体的某一个类。
　　　　level: 用来设置打印级别，大小写无关：TRACE, DEBUG, INFO, WARN, ERROR, ALL和OFF，还有一个特俗值INHERITED或者同义词NULL，代表强制执行上级的级别。 如果未设置此属性，那么当前loger将会继承上级的级别。
addtivity: 是否向上级loger传递打印信息。默认是true。同一样，可以包含零个或多个元素，标识这个appender将会添加到这个loger。

additivity的作用在于 children-logger是否使用 rootLogger配置的appender进行输出。
false：表示只用当前logger的appender-ref。
true：表示当前logger的appender-ref和rootLogger的appender-ref都有效。

（7）子节点:它也是元素，但是它是根loger,是所有的上级。只有一个level属性，因为name已经被命名为"root",且已经是最上级了。
　　　　level: 用来设置打印级别，大小写无关：TRACE, DEBUG, INFO, WARN, ERROR, ALL和OFF，不能设置为INHERITED或者同义词NULL。 默认是DEBUG。
六、常用loger配置

https://www.cnblogs.com/chenh...
https://www.cnblogs.com/warki...
http://www.cnblogs.com/yinz/p...
https://www.cnblogs.com/bigbe... Spring Boot 日志配置方法(超详细)