最实用的logback讲解（1）

文章目录

• 1. pom依赖和logback.xml
• 2. configuration属性介绍
• 3. logger和root属性的使用
• 3.1 addtivity属性重点讲解
• 4. appender

logback，一个“可靠、通用、快速而又灵活的Java日志框架”,是springboot默认的日志框架。

1. pom依赖和logback.xml

1. pom依赖

<dependency>
    <groupId>ch.qos.logback</groupId>
    <artifactId>logback-classic</artifactId>
    <version>1.2.3</version>
</dependency>
<!--
引入以上依赖，会自动引入以下jar
	logback-classic.x.x.x.jar
	logback-core.x.x.x.jar
	slf4j-api-x.x.x.jar
-->

注意spring-boot-starter-parent里已集成logback，可直接使用。

2. logback.xml

在工程resources目录下建立logback.xml

1.logback首先会试着查找logback.groovy文件;

2.当没有找到时，继续试着查找logback-test.xml文件;

3.当没有找到时，继续试着查找logback.xml文件;

4.如果仍然没有找到，则使用默认配置（打印到控制台）。

2. configuration属性介绍

<?xml version="1.0" encoding="UTF-8"?>

<configuration scan="true" scanPeriod="60 seconds" debug="false" packagingData="true">

	<!-- 用来设置上下文名称，每个logger都关联到logger上下文，默认上下文名称为default。但可以使用<contextName>设置成其他名字，
	用于区分不同应用程序的记录。一旦设置，不能修改。-->
    <contextName>myApplicationName</contextName>


	<!--用来定义变量值，它有两个属性name和value，通过<property>定义的值会被插入到logger上下文中，可以使用“${}”来使用变量。
	name: 变量的名称，value: 的值时变量定义的值-->
    <property name="LOG_HOME" value="${catalina.base}/logs/cloudTest/" />
    
    
	<!--获取时间戳字符串，他有两个属性key和datePattern     key: 标识此<timestamp> 的名字；datePattern: 设置将当前时间（解析配置
	文件的时间）转换为字符串的模式，遵循	java.txt.SimpleDateFormat的格式。这个属性很少使用	-->
    <timestamp key="keyValue" datePattern="yyyy-MM-dd" />    
    <contextName>${keyValue}</contextName>

	<!--其他配置略-->
</configuration>

• configuration

  scan 属性设置为true时，配置文件如果发生改变，将会被重新加载，默认值为true。
  scanPeriod: 设置监测配置文件是否有修改的时间间隔，如果没有给出时间单位，默认单位是毫秒。当scan为true时，此属性生效。默认的时间间隔为1分钟。
  debug: 当此属性设置为true时，将打印出logback内部日志信息，实时查看logback运行状态。默认值为false。
  packagingData：Logback可以包括它输出的堆栈跟踪行的每一行的打包数据。打包数据由JAR文件的名称和版本组成，堆栈跟踪行的类就是在JAR文件中创建的。默认为false

• contextName

• property
  可以定义一些变量，常用于定义日志文件输出位置。

• timestamp

3. logger和root属性的使用

logger 是configuration的子节点，用来设置某一个包或者具体的某一个类的日志打印级别、以及指定appender。logger仅有一个name属性，一个可选的level和一个可选的addtivity属性。

• name: 用来指定受此logger约束的某一个包或者具体的某一个类。

• level: 用来设置打印级别，大小写无关：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF，还有一个特殊值INHERITED或者同义词NULL，代表强制执行上级的级别。如果未设置此属性，那么当前logger将会继承上级的级别。

• addtivity: 是否向上级logger传递打印信息。默认是true。

logger可以包含零个或多个appender-ref元素，标识这个appender将会添加到这个logger。

root也是logger元素，但是它是根logger。只有一个level属性，因为已经被命名为"root".

• level: 用来设置打印级别，大小写无关：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF，不能设置为INHERITED或者同义词NULL。默认是DEBUG。

• root可以包含零个或多个appender-ref元素，标识这个appender将会添加到这个logger。

3.1 addtivity属性重点讲解

下面重点说明addtivity的含义，例：

java代码：

	package com.jun.springdemo.controller;
	、 、 、
	private final Logger logger = LoggerFactory.getLogger(DemoController.class);

    @RequestMapping("/get")
    public String get(){
        logger.trace("======trace");
        logger.debug("======debug");
        logger.info("======info");
        logger.warn("======warn");
        logger.error("======error");
        return "222";
    }

logback.xml配置文件

1. 只配置root

 <configuration scan="true" scanPeriod="60 seconds" debug="false">

    <!-- 控制台输出 -->
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <!--格式化输出：%d表示日期，%thread表示线程名，%-5level：级别从左显示5个字符宽度%msg：日志消息，%n是换行符-->
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level [%logger{15}:%line] - %msg%n</pattern>
            <charset>UTF-8</charset>
        </encoder>
    </appender>

    <!-- 日志输出级别 -->
    <root level="info">
        <appender-ref ref="STDOUT" />
    </root>

</configuration>

其中appender的配置表示打印到控制台；
<root level="INFO">将root的打印级别设置为“INFO”，指定了名字为“STDOUT”的appender。当执行DemoController类的get方法时，root将级别为“INFO”及大于“INFO”的日志信息交给已经配置好的名为“STDOUT”的appender处理，“STDOUT”appender将信息打印到控制台；

打印结果如下：

2019-03-07 09:59:17.257 [http-nio-8080-exec-1] INFO  [c.h.j.s.c.DemoController:22] - ======info
2019-03-07 09:59:17.257 [http-nio-8080-exec-1] WARN  [c.h.j.s.c.DemoController:23] - ======warn
2019-03-07 09:59:17.257 [http-nio-8080-exec-1] ERROR [c.h.j.s.c.DemoController:24] - ======error

2. 带有logger的配置，不指定级别，不指定appender

<configuration scan="true" scanPeriod="60 seconds" debug="false">

    <!-- 控制台输出 -->
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <!--格式化输出：%d表示日期，%thread表示线程名，%-5level：级别从左显示5个字符宽度%msg：日志消息，%n是换行符-->
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level [%logger{15}:%line] - %msg%n</pattern>
            <charset>UTF-8</charset>
        </encoder>
    </appender>

    <logger name="com.jun.springdemo.controller" ></logger>

    <!-- 日志输出级别 -->
    <root level="debug">
        <appender-ref ref="STDOUT" />
    </root>

</configuration>

<logger name="com.jun.springdemo.controller" />将控制com.jun.springdemo.controller包下的所有类的日志的打印，但是并没用设置打印级别，所以继承他的上级的日志级别“DEBUG”；没有设置addtivity，默认为true，将此logger的打印信息向上级传递；没有设置appender，此logger本身不打印任何信息。

       <root level="DEBUG">将root的打印级别设置为“DEBUG”，指定了名字为“STDOUT”的appender。
当执行com.jun.springdemo.controller.DemoController类的get方法时，因为DemoController在包com.jun.springdemo.controller中，所以首先执行<logger name="com.jun.springdemo.controller" />，将级别为“DEBUG”及大于“DEBUG”的日志信息传递给root，本身并不打印；

root接到下级传递的信息，交给已经配置好的名为“STDOUT”的appender处理，“STDOUT”appender将信息打印到控制台；
打印结果如下：

2019-03-07 10:06:36.564 [http-nio-8080-exec-1] DEBUG [c.h.j.s.c.DemoController:21] - ======debug
2019-03-07 10:06:36.564 [http-nio-8080-exec-1] INFO  [c.h.j.s.c.DemoController:22] - ======info
2019-03-07 10:06:36.564 [http-nio-8080-exec-1] WARN  [c.h.j.s.c.DemoController:23] - ======warn
2019-03-07 10:06:36.564 [http-nio-8080-exec-1] ERROR [c.h.j.s.c.DemoController:24] - ======error

3. 带有多个logger的配置，指定级别，指定appender

<configuration scan="true" scanPeriod="60 seconds" debug="false">

    <!-- 控制台输出 -->
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <!--格式化输出：%d表示日期，%thread表示线程名，%-5level：级别从左显示5个字符宽度%msg：日志消息，%n是换行符-->
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level [%logger{15}:%line] - %msg%n</pattern>
            <charset>UTF-8</charset>
        </encoder>
    </appender>

    <logger name="com.jun.springdemo.controller" ></logger>

    <logger name="com.jun.springdemo.controller.DemoController" level="info" additivity="false">
        <appender-ref ref="STDOUT" />
    </logger>

    <!-- 日志输出级别 -->
    <root level="error">
        <appender-ref ref="STDOUT" />
    </root>

</configuration>

       <logger name="com.jun.springdemo.controller" />将控制com.jun.springdemo.controller包下的所有类的日志的打印，但是并没用设置打印级别，所以继承他的上级的日志级别“error”；没有设置addtivity，默认为true，将此logger的打印信息向上级传递；没有设置appender，此logger本身不打印任何信息。

        <logger name="com.jun.springdemo.controller.DemoController" level="INFO" additivity="false">控制com.jun.springdemo.controller.DemoController类的日志打印，打印级别为“INFO”；additivity属性为false，表示此logger的打印信息不再向上级传递，指定了名字为“STDOUT”的appender。

<root level="ERROR">将root的打印级别设置为“ERROR”，指定了名字为“STDOUT”的appender。

       当执行com.jun.springdemo.controller.DemoController类的get方法时，先执行<logger name="com.jun.springdemo.controller.DemoController" level="INFO" additivity="false">，将级别为“INFO”及大于“INFO”的日志信息交给此logger指定的名为“STDOUT”的appender处理，在控制台中打出日志，不再向logger的上级 <logger name="com.jun.springdemo.controller"/> 传递打印信息； 注意此时因为DemoController位于com.jun.springdemo.controller包下，所以 <logger name="com.jun.springdemo.controller"/>是<logger name="com.jun.springdemo.controller.DemoController" level="INFO" additivity="false">的上级！

<logger name="com.jun.springdemo.controller"/>未接到任何打印信息，当然也不会给它的上级root传递任何打印信息；

打印结果如下：

2019-03-07 10:14:23.472 [http-nio-8080-exec-1] INFO  [c.h.j.s.c.DemoController:22] - ======info
2019-03-07 10:14:23.474 [http-nio-8080-exec-1] WARN  [c.h.j.s.c.DemoController:23] - ======warn
2019-03-07 10:14:23.475 [http-nio-8080-exec-1] ERROR [c.h.j.s.c.DemoController:24] - ======error

       如果将<logger name="com.jun.springdemo.controller.DemoController" level="INFO" additivity="false">修改为 <logger name="com.jun.springdemo.controller.DemoController" level="INFO" additivity="true">那打印结果将是什么呢？

       没错，日志打印了两次，想必大家都知道原因了，因为打印信息向上级传递，logger本身打印一次， <logger name="com.jun.springdemo.controller"/>接到后本身因为没有设置appender不会打印但向上继续传递给root，root会再打印一次。

2019-03-07 11:39:17.131 [http-nio-8080-exec-1] INFO  [c.h.j.s.c.DemoController:22] - ======info
2019-03-07 11:39:17.131 [http-nio-8080-exec-1] INFO  [c.h.j.s.c.DemoController:22] - ======info
2019-03-07 11:39:17.134 [http-nio-8080-exec-1] WARN  [c.h.j.s.c.DemoController:23] - ======warn
2019-03-07 11:39:17.134 [http-nio-8080-exec-1] WARN  [c.h.j.s.c.DemoController:23] - ======warn
2019-03-07 11:39:17.134 [http-nio-8080-exec-1] ERROR [c.h.j.s.c.DemoController:24] - ======error
2019-03-07 11:39:17.134 [http-nio-8080-exec-1] ERROR [c.h.j.s.c.DemoController:24] - ======error

       此处可能令人困惑， <root>日志级别不是error么，怎么还会打印info和warn级别的日志？这里是因为日志信息向上传递后，日志级别会由下级的level来决定！所以即使info日志也会打印！！ 因此注意一般实际使用中additivity常常设置为false。

4. appender

见最实用的logback讲解（2）