Nicander知识小站

Appearance

原文：SpringBoot之Logback 日志文件配置 - hyzs - 博客园

Logback 概述 ​

Logback 是由 log4j 的创始人设计的另一个开源的日志组件，官方网站是：http://logback.qos.ch。它当前分为下面下个模块：

  • logback-core：其他两个模块的基础模块
  • logback-classic：是 log4j 的改良版本，同时实现了 log4j 的 API，可以很方便地更换成其它日志系统如log4j或JDK14 Logging
  • logback-access：访问模块与 servlet 容器集成提供通过 Http 来访问日志的功能。

Logback 是 SpringBoot 内置的日志处理框架，在 spring-boot-starter 中包含了spring-boot-starter-logging，该依赖内容就是 Spring Boot 默认的日志框架 logback。它比所有现有的日志系统都要快，而且占用空间更小，还提供了在其他日志系统中没有的独特而有用的特性。

Logback 的配置介绍 ​

  • Logger，appender 和 layoutLogger作为日志的记录器，把它关联到应用的对应的context上后，主要用于存放日志对象，也可以定义日志类型、级别。 Appender主要用于指定日志输出的目的地，目的地可以是控制台、文件、远程套接字服务器、 MySQL、PostreSQL、 Oracle和其他数据库、 JMS和远程UNIX Syslog守护进程等。 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 的默认配置 ​

在 SprongBoot 项目中，logback 的 配置文件默认存放 在 src/main/resources 下面，配置文件的默认命名是 logback-spring.xml。

logback 默认配置的步骤 ​

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

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

logback-spring.xml 配置文件详解 ​

  1. 根节点 ，包含有以下的三个属性：scan: 当此属性设置为true时，配置文件如果发生改变，将会被重新加载，默认值为true。 scanPeriod: 设置监测配置文件是否有修改的时间间隔，如果没有给出时间单位，默认单位是毫秒。当scan为true时，此属性生效。默认的时间间隔为1分钟。 debug: 当此属性设置为true时，将打印出logback内部日志信息，实时查看logback运行状态。默认值为false。
  2. 子节点 ，用来设置上下文名称，每个logger都关联到logger上下文，默认上下文名称为default。但可以使用设置成其他名字，用于区分不同应用程序的记录。一旦设置，不能修改。
  3. 子节点，用来定义变量值，有两个属性name和value，通过定义的值会被插入到logger上下文中，可以使“${}”来使用变量。
  4. 子节点，获取时间戳字符串，有两个属性key和datePatternkey: 标识此 的名字； datePattern: 设置将当前时间（解析配置文件的时间）转换为字符串的模式，遵循java.txt.SimpleDateFormat的格式。
  5. 子节点：负责写日志的组件，它有两个必要属性name和class。name指定appender名称，class指定appender的全限定名ConsoleAppender 把日志输出到控制台，有以下子节点： ：对日志进行格式化。 ：字符串System.out(默认)或者System.err
  6. 子节点:它也是元素，
  7. 是根logger,是所有的上级。只有一个level属性，因为name已经被命名为"root",且已经是最上级了。level: 用来设置打印级别，大小写无关：TRACE, DEBUG, INFO, WARN, ERROR, ALL和OFF，不能设置为INHERITED或者同义词NULL。 默认是DEBUG。
xml
<configuration scan="true" scanPeriod="60 seconds" debug="false"> 
  <!--其他配置省略--> 
</configuration>
xml
<configuration scan="true" scanPeriod="60 seconds" debug="false"> 
  <contextName>myAppName</contextName> 
  <!--其他配置省略-->
</configuration>
xml
<configuration scan="true" scanPeriod="60 seconds" debug="false">
  <property name="APP_Name" value="myAppName" /> 
  <contextName>${APP_Name}</contextName> 
  <!--其他配置省略--> 
</configuration>
xml
<configuration scan="true" scanPeriod="60 seconds" debug="false"> 
  <timestamp key="bySecond" datePattern="yyyyMMdd'T'HHmmss"/>
  <contextName>${bySecond}</contextName>  　　<!-- 其他配置省略-->
</configuration>
xml
<configuration>  
  <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender"> 
    <encoder> 
      <pattern>%-4relative [%thread] %-5level %logger{35} - %msg %n</pattern> 
    </encoder>  　
  </appender>  　　
  <root level="DEBUG"> 
      <appender-ref ref="STDOUT" />  
  </root> 
</configuration>

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

xml
<!-- show parameters for hibernate sql 专为 Hibernate 定制 --> 
<logger name="org.hibernate.type.descriptor.sql.BasicBinder" level="TRACE" /> 
<logger name="org.hibernate.type.descriptor.sql.BasicExtractor" level="DEBUG" /> 
<logger name="org.hibernate.SQL" level="DEBUG" /> 
<logger name="org.hibernate.engine.QueryParameters" level="DEBUG" />
<logger name="org.hibernate.engine.query.HQLQueryPlan" level="DEBUG" /> 
<!--myibatis log configure--> 
<logger name="com.apache.ibatis" level="TRACE"/> 
<logger name="java.sql.Connection" level="DEBUG"/>
<logger name="java.sql.Statement" level="DEBUG"/> 
<logger name="java.sql.PreparedStatement" level="DEBUG"/>

demo 案例 ​

1.首先需要在 spring-boot-starter 中排除默认 的 logback 依赖 ，之后引入自定义 的 logback 所需的依赖 org.springframework.boot spring-boot-starter-web org.springframework.boot spring-boot-starter-logging org.slf4j slf4j-api ${slf4j.version} compile ch.qos.logback logback-core ${logback.version} ch.qos.logback logback-classic $

logback.xml 配置文件 ​

在 classpath 目录下新增 logback.xml 配置文件 %d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n ${LOG_HOME}/TestWeb.log.%d{yyyy-MM-dd}.log 1 %d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n 2MB

xml
<!-- 日志的输出级别 -->
<root level="INFO"> 
  <appender-ref  ref="STDOUT"/> 
  <appender-ref ref="FILE"/> 
</root>