vlambda博客
学习文章列表

日志框架的体系结构及logback的使用


提到Java log日志,很多人不仅会想到各种各样的日志框架,还会想到各种日志框架之间冲突的jar包。下面我们来介绍一下他们之间的关系,以及如何选择他们。


日志框架

Log4j

由Java编写可靠、灵活的日志框架,是Apache旗下的一个开源项目,甚至提供了其他语言包括 C、C++、.Net、PL/SQL 的接口,从而实现多语言并存的分布式环境日志打印,目前已经停止更新。


LogBack

由Log4j创始人设计的一个开源日志组件,是SpringBoot的默认日志框架,被广泛使用。LogBack被分为3个组件:

logback-core,logback-classic 和 logback-access。


Log4j2

Log4j 1.x和Logback的改进版,采用了新技术(无锁异步、等等),使得日志的吞吐量、性能比Log4j 1.x提高10倍,并解决了一些死锁的bug,高吞吐,低延迟,而且配置更加简单灵活。


JUL

java.util.logging包:是 jdk1.4 发布的 java 日志包,应用比较久远的日志工具包。


JCL

jakarta.commons.logging包:继JUL之后Apache推出的日志抽象层,支持运行时动态加载日志组件的实现。


日志门面

Slf4j

目前应用最为广泛的日志门面,提供了一个日志抽象层,可以在后台使用任意一个日志类库(Log4j、Log4j2、Logback)


commons-logging

Apache下的开源项目,作为一个日志门面,能够自动选择使用 Log4j 还是 JDK logging,但是他不依赖Log4j,JDK Logging的API。如果项目的classpath中包含了Log4j的类库,就会使用Log4j,否则就使用JDK Logging。

每一种框架都有自己的API,使用对应框架就需要对应的API,这样就大大增加了程序代码对日志框架的耦合度。


所以应用程序和日志框架之间应该有一个沟通的桥梁,无论底层的日志框架如何变,应用程序都不需要有任何感知。有了日志门面之后,程序员永远都是面向日志门面编程就算更换日志框架,应用程序也不需要更改代码。日志门面主要的作用是提供接口,其他的由日志框架来实现


目前Java日志体系关系图如下:

日志框架的体系结构及logback的使用

在日志门面的选择上,Slf4j大家用的比较多,也成为日志门面事实上的标准。在使用 Slf4j 记录日志时,通常要在每个需要记录日志的类中定义 logger变量:

package com.javafamily.familydemo.controller;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class LogController {
    private static final Logger logger = LoggerFactory.getLogger(LogController.class);

    @GetMapping("/test")
    public void test() {
        logger.trace("Trace 日志...");
        logger.debug("Debug 日志...");
        logger.info("Info 日志...");
        logger.warn("Warn 日志...");
        logger.error("Error 日志...");
    }
}

这种写法非常的麻烦,只是写出来给大家参考。在之前的章节我们一直使用的Lombok插件可以直接通过@Slf4j注解来自动生成上面那个变量。


日志框架的选择

Spring Boot 默认的日志记录框架使用的是 Logback
Log4j 是过时的函数库,已经停止更新,不推荐
Logback性能上还是不及 Log4j2
SLF4J + Log4j2 是推荐的日志记录选型

在Log4j官网,我们可以看见性能对比图

(http://logging.apache.org/log4j/2.x/manual/async.html)

日志框架的体系结构及logback的使用

日志级别一共有8个:

OFF、FATAL、ERROR、WARN、INFO、DEBUG、TRACE、 ALL

但是常见的级别只有5个:

ERROR、WARN、INFO、DEBUG、TRACE

ERROR(错误 在捕获异常时输出,不影响系统的正常运行
WARN(警告) 记录可能会引发错误的信息
INFO(信息) 记录了一些交互信息请求参数等
DEBUG(调试) 打印记录一些运行信息
TRACE(追踪) 对核心系统进行性能调试或者跟踪

日志级别排序:

TRACE<DEBUG<INFO<WARN<ERROR


常见术语

appender

日志输出目的地(文件、数据库、打印到控制台)


logger

日志记录器,负责收集处理日志记录 


layout

日志格式化,负责对输出的日志格式化

root

是一个特殊的父logger,除非在子logger中配置了additivity="false"否则所有的子logger最终都将输出流交给root


rollingPolicy
设置日志滚动策略


rolloverStrategy
日志清理策略


同步日志与异步日志
同步日志:
输出日志时,必须等日志输出语句执行完后,才能执行后面的业务逻辑语句


异步日志:
日志输出语句与业务逻辑语句不是在同一个线程中运行,有专门的线程用于进行日志输出操作,处理业务逻辑的主线程不用等待即可执行后续业务逻辑。

日志框架的体系结构及logback的使用

在异步日志中,主线程将日志写在队列里就继续向下执行。这个过程是在内存层面完成的。之后由专门的线程从队列中获取日志数据写入磁盘,所以不阻塞主线程。效率很高。


Logback使用
Logback有两种使用方式,一种是通过配置文件进行配置(application.yml),另一种是对日志的输出有非常个性化的要求,使用logback-spring.xml的配置方式。


配置文件
在application.yml中进行配置:
logging:
  level:
    # 日志级别统一化,都是info
    root: info
    # 当前package的级别是debug
    com.javafamily.familydemo.controller: debug
  file:
    # 日志输出到制定目录
    path: /Users/admin/Documents/log
    # 配置日志文件名称,如果不配置,默认名称为spring.log
    name: /Users/admin/Documents/log/JavaFamily.log
    # 每个日志文件的最大容量
    max-size: 10MB
    # 日志文件的保留时间,单位为天
    max-history: 10
执行代码,在浏览器访问:
http://localhost:8888/test



logback-spring.xml配置
<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <!--引入默认的一些设置-->
    <include resource="org/springframework/boot/logging/logback/defaults.xml"/>
    <!--web信息-->
    <logger name="org.springframework.web" level="info"/>

    <!--写入日志到控制台的appender,用默认的,但是要去掉charset,否则windows下tomcat下乱码-->
    <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>${CONSOLE_LOG_PATTERN}</pattern>
        </encoder>
    </appender>

    <!--定义日志文件的存储地址 勿在 LogBack 的配置中使用相对路径-->
    <property name="LOG_PATH" value="/Users/admin/Documents/log/JavaFamily"/>
    <!--写入日志到文件的appender-->
    <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!--日志文件输出的文件名,每天一个文件-->
            <FileNamePattern>${LOG_PATH}.%d{yyyy-MM-dd}.log</FileNamePattern>
            <!--日志文件保留天数-->
            <maxHistory>30</maxHistory>
        </rollingPolicy>
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <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>

    <!--异步写日志到文件-->
    <appender name="asyncFileAppender" class="ch.qos.logback.classic.AsyncAppender">
        <discardingThreshold>0</discardingThreshold>
        <queueSize>256</queueSize>
        <appender-ref ref="FILE"/>
    </appender>

    <!--生产环境:打印控制台和输出到文件-->
    <springProfile name="prod">
        <root level="info">
            <appender-ref ref="CONSOLE"/>
            <appender-ref ref="asyncFileAppender"/>
        </root>
    </springProfile>

    <!--开发环境:打印控制台-->
    <springProfile name="dev">
        <!-- 打印sql -->
        <logger name="com.javafamily.familydemo" level="DEBUG"/>
        <root level="DEBUG">
            <appender-ref ref="CONSOLE"/>
        </root>
    </springProfile>

    <!--测试环境:打印控制台-->
    <springProfile name="test">
        <root level="info">
            <appender-ref ref="CONSOLE"/>
        </root>
    </springProfile>
</configuration>
异步日志配置:
queueSize 默认值256,异步日志队列的容量。
discardingThreshold:
异步日志队列的剩余容 量小于这个阈值,会丢弃TRACE、DEBUG、INFO级别的日志,如果不想丢弃日志,那可以设置为0。
执行代码,得到想要的个性化需求。
点击下方阅读原文,查看上一篇