工具篇-日志框架logback

1.为什么要使用logback

这里写图片描述

在开发中不建议使用System.out,因为大量的使用会增加资源的消耗，system.out是在当前线程执行的。而log工具不但可以控制日志输出的格式，怎么输出，它的处理机制也是通知写日志，继续执行后面的代码不必等日志写完。LogBack和Log4j都是开源日记工具库，LogBack是Log4j的改良版本，比Log4j拥有更多的特性，同时也带来很大性能提升。

2.Logback,slf4j,log4j的关系

1） Slf4j是The Simple Logging Facade for Java的简称，是一个简单日志门面抽象框架，它本身只提供了日志Facade API和一个简单的日志类实现，一般常配合Log4j，LogBack，java.util.logging使用。Slf4j作为应用层的Log接入时，程序可以根据实际应用场景动态调整底层的日志实现框架(Log4j/LogBack/JdkLog…)；
2） LogBack和Log4j都是开源日记工具库，LogBack是Log4j的改良版本，比Log4j拥有更多的特性，同时也带来很大性能提升。
3） LogBack官方建议配合Slf4j使用，这样可以灵活地替换底层日志框架。

3.Logback的结构

1）LogBack被分为3个组件：

logback-core:核心功能
2）logback-classic:实现了slf4j的API,所以当想配合Slf4j使用时，需要1将logback-classic加入classpath。
3）logback-access:为了集成Servlet环境准备的，提供Http-access的日志接口。

4.Slf4j+Logback的快速实践

spring-boot默认支持logback，所以无需引用任何以来只需要，配置application.properties即可，如果要功能丰富些，则配置下logback.xml。(我这里用logback.xml为例子)

这里写图片描述

1）添加依赖

<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-logging</artifactId>
</dependency>

2）配置logback.xml

configuration
appender
root
logger

<?xml version="1.0" encoding="UTF-8" ?>
<configuration scan="true" scanPeriod="60" debug="false">
    <contextName>logback</contextName>
    <property name="log.path" value="logback.log" />

    <!--输出到控制台-->
    <appender name="console" class="ch.qos.logback.core.ConsoleAppender">
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <level>ERROR</level>
        </filter>
        <encoder>
            <pattern>%d{HH:mm:ss} %contextName [%thread] %-5level %logger{36} - %msg%n </pattern>
        </encoder>
    </appender>

    <!--输出到文件-->
    <appender name="file" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>${log.path}</file>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>logback.%d{yyyy-MM-dd}.log</fileNamePattern>
            <maxHistory>30</maxHistory>
            <totalSizeCap>1GB</totalSizeCap>
        </rollingPolicy>
        <encoder>
            <pattern>%d{HH:mm:ss.SSS} %contextName [%thread] %-5level %logger{36} - %msg%n</pattern>
        </encoder>
    </appender>
    <!--类的全路径 -->
    <logger name="com.example.logback" level="INFO" additivity="false">
        <appender-ref ref="console" />
    </logger>
    <!-- LoggerFactory.getLogger("demo")-->
    <logger name="demo" level="WARN" additivity="false">
        <appender-ref ref="console"/>
    </logger>
    <!--没匹配到就走默认的-->
    <root level="debug">
        <appender-ref ref="file" />
    </root>

</configuration>

3) 测试类

package com.example.logback;

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

/**
 * @author lanxinghua
 * @date 2018/08/23 21:27
 * @description
 */
public class LogTest {
    private static final Logger logger = LoggerFactory.getLogger("demo");

    public static void main(String[] args) {
        logger.trace("日志输出 trace");
        logger.debug("日志输出 debug");
        logger.info("日志输出 info");
        logger.warn("日志输出 warn");
        logger.error("日志输出 error");
    }
}

4) 结果
这里写图片描述

这里写图片描述

5.多环境日志输出

根据不同环境（daily:公共环境，test:测试环境，dev:开发环境，pre:线上环境）来定义不同的日志输出，在 logback-spring.xml中使用 springProfile 节点来定义，方法如下

 <!-- 测试环境+开发环境. 多个使用逗号隔开. -->
<springProfile name="test,dev">
    <logger name="org.springframework.web" level="INFO"/>
    <logger name="org.springboot.sample" level="INFO" />
    <logger name="com.kfit" level="info" />
</springProfile>

 <!-- 线上环境. -->
<springProfile name="pre">
    <logger name="org.springframework.web" level="ERROR"/>
    <logger name="org.springboot.sample" level="ERROR" />
    <logger name="com.kfit" level="ERROR" />
</springProfile>

6.通过web查看日志

Logback-classic带了一个叫ViewStatusMessagesServlet的Servlet，它以HTML表格的格式打印与当前LoggerContext关联的StatusManager的内容:

 <servlet>     
    <servlet-name>ViewStatusMessages</servlet-name>
  <servlet-class>ch.qos.logback.classic.ViewStatusMessagesServlet</servlet-class>
</servlet>
<servlet-mapping>     
    <servlet-name>ViewStatusMessages</servlet-name>
  <url-pattern>/lbClassicStatus</url-pattern>
</servlet-mapping>

访问地址是http://host/yourWebapp/lbClassicStatus

注意

Logback如何查找配置文件：

1.在classpath中查找logback.groovy
2. 如果不存在，则在classpath中查找logback-test.xml
3. 如果不存在，继续查找logback.xml
4. 如果不存在，则由jdk1.6中提出的service-provider loading facility 通过查找META-INF\services\ch.qos.logback.classic.spi.Configurator这个文件中定义的继承 com.qos.logback.classic.spi.Configurator接口的配置实现类的全限定名
5. 如果还不存在，logback则会使用基本的配置，将日志输出定向到控制台。

补充（Logback打印日志）

LoggerContext lc = (LoggerContext) org.slf4j.LoggerFactory.getILoggerFactory();
ch.qos.logback.classic.Logger aa = lc.getLogger("Test1.class");
aa.info("hello world!");

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

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

<configuration scan="true" scanPeriod="60 seconds" debug="false"> 
　　<property name="APP_Name" value="myAppName" /> 
　　<contextName>${APP_Name}</contextName> 
　　<!--其他配置省略--> 
</configuration>

RollingFileAppender：滚动记录文件，先将日志记录到指定文件，当符合某个条件时，将日志记录到其他文件

　<configuration> 
　　<appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender"> 
　　　　<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"> 
　　　　　　<fileNamePattern>logFile.%d{yyyy-MM-dd}.log</fileNamePattern> 
　　　　　　<maxHistory>30</maxHistory> 
　　　　</rollingPolicy> 
　　　　<encoder> 
　　　　　　<pattern>%-4relative [%thread] %-5level %logger{35} - %msg%n</pattern> 
　　　　</encoder> 
　　</appender> 
   <root level="DEBUG"> 
　　　  <appender-ref ref="FILE" /> 
　</root> 
</configuration>

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

参考配置：

<?xml version="1.0" encoding="UTF-8"?>
<configuration debug="false">
<!--定义日志文件的存储地址 勿在 LogBack 的配置中使用相对路径-->
<property name="LOG_HOME" value="/home" />
<!-- 控制台输出 -->
<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{50} - %msg%n</pattern>
</encoder>
</appender>
<!-- 按照每天生成日志文件 -->
<appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<!--日志文件输出的文件名-->
<FileNamePattern>${LOG_HOME}/TestWeb.log.%d{yyyy-MM-dd}.log</FileNamePattern>
<!--日志文件保留天数-->
<MaxHistory>30</MaxHistory>
</rollingPolicy>
<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{50} - %msg%n</pattern>
</encoder>
<!--日志文件最大的大小-->
<triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
<MaxFileSize>10MB</MaxFileSize>
</triggeringPolicy>
</appender>

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

spring整合logback

<properties>
　　　　<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
　　　　<logback.version>1.1.7</logback.version>
　　　　<slf4j.version>1.7.21</slf4j.version>
　　</properties>

　　<dependencies>
　　　　<dependency>
　　　　　　<groupId>org.slf4j</groupId>
　　　　　　<artifactId>slf4j-api</artifactId>
　　　　　　<version>${slf4j.version}</version>
　　　　　　<scope>compile</scope>
　　　　</dependency>
　　　　<dependency>
　　　　　　<groupId>ch.qos.logback</groupId>
　　　　　　<artifactId>logback-core</artifactId>
　　　　　　<version>${logback.version}</version>
　　　　</dependency>
　　　　<dependency>
　　　　　　<groupId>ch.qos.logback</groupId>
　　　　　　<artifactId>logback-classic</artifactId>
　　　　　　<version>${logback.version}</version>
　　　　　　</dependency>
　　</dependencies>