java日志框架如何选型？

2021-12-10 18:33:44 阅读：158 来源： 互联网

标签：java Slf4j 接口 Log4j 选型 logger Logback 日志

对于一个应用程序来说日志记录是必不可少的一部分。线上问题追踪，基于日志的业务逻辑统计分析等都离不日志。java领域存在多种日志框架，目前常用的日志框架包括Log4j 1，Log4j 2，Commons Logging，Slf4j，Logback，Jul

日志框架类别

Log4j Apache Log4j是一个基于Java的日志记录工具。它是由Ceki Gülcü首创的，现在则是Apache软件基金会的一个项目。 Log4j是几种Java日志框架之一
Log4j 2 Apache Log4j 2是apache开发的一款Log4j的升级产品
Commons Logging Apache基金会所属的项目，是一套Java日志接口，之前叫Jakarta Commons Logging，后更名为Commons Logging
Slf4j 类似于Commons Logging，是一套简易Java日志门面，本身并无日志的实现。（Simple Logging Facade for Java，缩写Slf4j）
Logback 一套日志组件的实现(Slf4j阵营)
Jul (Java Util Logging),自Java1.4以来的官方日志实现

日志框架关系

Log4j 2与Log4j 1发生了很大的变化，Log4j 2不兼容Log4j 1
Commons Logging和Slf4j是日志门面(门面模式是软件工程中常用的一种软件设计模式，也被称为正面模式、外观模式。它为子系统中的一组接口提供一个统一的高层接口，使得子系统更容易使用)。Log4j和Logback则是具体的日志实现方案。可以简单的理解为接口与接口的实现，调用者只需要关注接口而无需关注具体的实现，做到解耦
比较常用的组合使用方式是Slf4j与Logback组合使用，Commons Logging与Log4j组合使用
Logback必须配合Slf4j使用。由于Logback和Slf4j是同一个作者，其兼容性不言而喻

PS：Logback和Log4J的区别可以这样理解，就是在Log4J上进行优化的相当于增强版的
Slf4j而这个只是一个抽象的接口，并未有具体实现类类似JDBC一样提供了日志接口标准，如果jar包引入了Logback和Log4J，那么就实现了Slf4j接口具体方法，Slf4j只是一个门面模式，facade层
目前比较流行的组合无疑是Slf4j+Logback，那么原因有几点：
1、Logback是springboot自带的，也就说如果单独使用Logback都不需要引入任何jar，当然此处是和Slf4j进行组合所以需要引入是为了实现Slf4j
2、Slf4j和Logback出于同一个作者自然亲和力要强些
3、Logback拥有更好的性能。Logback声称：某些关键操作，比如判定是否记录一条日志语句的操作，其性能得到了显著的提高。这个操作在Logback中需要3纳秒，而在Log4J中则需要30纳秒。LogBack创建记录器（logger）的速度也更快：13毫秒，而在Log4J中需要23毫秒。更重要的是，它获取已存在的记录器只需94纳秒，而Log4J需要2234纳秒，时间减少到了1/23。跟JUL相比的性能提高也是显著的
4、Logback文档免费。Logback的所有文档是全面免费提供的，不象Log4J那样只提供部分免费文档而需要用户去购买付费文档

Slf4j+Logback

Slf4j与其它日志组件的关系说明

Slf4j的设计思想比较简洁，使用了Facade设计模式，Slf4j本身只提供了一个slf4j-api-version.jar包，这个jar中主要是日志的抽象接口，jar中本身并没有对抽象出来的接口做实现。
Slf4j的设计思想比较简洁，使用了Facade设计模式，Slf4j本身只提供了一个slf4j-api-version.jar包，这个jar中主要是日志的抽象接口，jar中本身并没有对抽象出来的接口做实现。

Slf4j与其它日志组件调用关系图

在这里插入图片描述

Slf4j与其他各种日志组件的桥接说明

在这里插入图片描述

具体的接入方式参见下图

快速入门

引入jar

首先知道logback是由三个模块组合
Logback是由log4j创始人设计的又一个开源日志组件。Logback当前分成三个模块：

Logback-core
Logback- classic
Logback-access
Logback-core是其它两个模块的基础模块。Logback-classic是log4j的一个改良版本。此外Logback-classic完整实现SLF4J API使你可以很方便地更换成其它日志系统如log4j或JDK14 Logging。Logback-access访问模块与Servlet容器集成提供通过Http来访问日志的功能。
补充：门面模式，是指提供一个统一的接口去访问多个子系统的多个不同的接口，它为子系统中的一组接口提供一个统一的高层接口。使得子系统更容易使用

        <!-- Slf4j 依赖 -->
        <dependency>
            <groupId>org.slf4j</groupId>
            <artifactId>slf4j-api</artifactId>
            <version>1.7.30</version>
        </dependency>
        <!-- logback 依赖 -->
        <dependency>
            <groupId>ch.qos.logback</groupId>
            <artifactId>logback-classic</artifactId>
            <version>1.2.3</version>
        </dependency>
        <!-- Junit依赖 用于单元测试-->
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>4.13</version>
        </dependency>

import org.junit.Test;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
 
public class Slf4jTest {
    public static final Logger LOGGER = LoggerFactory.getLogger(Slf4jTest.class);
 
    @Test
    public void test01(){
        //日志输出
        LOGGER.error("error");
        LOGGER.warn("wring");
        LOGGER.info("info");
        LOGGER.debug("debug");
        LOGGER.trace("trance");
 
        //占位符输出
        String name = "bysen";
        Integer age = 24;
        LOGGER.info("姓名{}，年龄{}",name,age);
 
        //异常处理
        try{
            int i =1/0;
        }catch (Exception e){
            LOGGER.error("发生异常：",e);
        }
    }
    
}

PS：每次如果 public static final Logger LOGGER = LoggerFactory.getLogger(Slf4jTest.class);
比较麻烦，直接使用注解@slf4j

logback.xml 配置样例

在slf4j中，从小到大的日志级别依旧是trace、debug、info、warn、error

<?xml version="1.0" encoding="UTF-8"?>
<configuration debug="true" scan="true" scanPeriod="1 seconds">

    <contextName>logback</contextName>
    <!--定义参数,后面可以通过${app.name}使用-->
    <property name="app.name" value="logback_test"/>
    <!--ConsoleAppender 用于在屏幕上输出日志-->
    <appender name="stdout" class="ch.qos.logback.core.ConsoleAppender">
        <!--定义了一个过滤器,在LEVEL之下的日志输出不会被打印出来-->
        <!--这里定义了DEBUG，也就是控制台不会输出比ERROR级别小的日志-->
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <level>DEBUG</level>
        </filter>
        <!-- encoder 默认配置为PatternLayoutEncoder -->
        <!--定义控制台输出格式-->
        <encoder>
            <pattern>%d [%thread] %-5level %logger{36} [%file : %line] - %msg%n</pattern>
        </encoder>
    </appender>

    <appender name="file" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!--定义日志输出的路径-->
        <!--这里的scheduler.manager.server.home 没有在上面的配置中设定，所以会使用java启动时配置的值-->
        <!--比如通过 java -Dscheduler.manager.server.home=/path/to XXXX 配置该属性-->
        <file>${scheduler.manager.server.home}/logs/${app.name}.log</file>
        <!--定义日志滚动的策略-->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!--定义文件滚动时的文件名的格式-->
            <fileNamePattern>${scheduler.manager.server.home}/logs/${app.name}.%d{yyyy-MM-dd.HH}.log.gz
            </fileNamePattern>
            <!--60天的时间周期，日志量最大20GB-->
            <maxHistory>60</maxHistory>
            <!-- 该属性在 1.1.6版本后 才开始支持-->
            <totalSizeCap>20GB</totalSizeCap>
        </rollingPolicy>
        <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
            <!--每个日志文件最大100MB-->
            <maxFileSize>100MB</maxFileSize>
        </triggeringPolicy>
        <!--定义输出格式-->
        <encoder>
            <pattern>%d [%thread] %-5level %logger{36} [%file : %line] - %msg%n</pattern>
        </encoder>
    </appender>

    <!--root是默认的logger 这里设定输出级别是debug-->
    <root level="trace">
        <!--定义了两个appender，日志会通过往这两个appender里面写-->
        <appender-ref ref="stdout"/>
        <appender-ref ref="file"/>
    </root>

    <!--对于类路径以 com.example.logback 开头的Logger,输出级别设置为warn,并且只输出到控制台-->
    <!--这个logger没有指定appender，它会继承root节点中定义的那些appender-->
    <logger name="com.example.logback" level="warn"/>

    <!--通过 LoggerFactory.getLogger("mytest") 可以获取到这个logger-->
    <!--由于这个logger自动继承了root的appender，root中已经有stdout的appender了，自己这边又引入了stdout的appender-->
    <!--如果没有设置 additivity="false" ,就会导致一条日志在控制台输出两次的情况-->
    <!--additivity表示要不要使用rootLogger配置的appender进行输出-->
    <logger name="mytest" level="info" additivity="false">
        <appender-ref ref="stdout"/>
    </logger>
    
    <!--由于设置了 additivity="false" ，所以输出时不会使用rootLogger的appender-->
    <!--但是这个logger本身又没有配置appender，所以使用这个logger输出日志的话就不会输出到任何地方-->
    <logger name="mytest2" level="info" additivity="false"/>
</configuration>

总结

首先configuration 节点下面分三个主要标签分别是appender 、logger 、root
其中appender主要是以什么形式或者说什么格式输出日志；logger 输出什么级别的日志；root 全局配置
首先说控制台输出，这个没什么好说的，基本上默认配置即可
重点说下文件输出：①在某个文件夹下按照天拆分②如果按照天拆分比如xx.2021-12-10.log但是这天如果出现了错误，哗啦啦出现很大的数据量造成了数据堆砌怎么办，那么这个时候就需要继续拆分，比如

        <fileNamePattern>${scheduler.manager.server.home}/logs/${app.name}.%d{yyyy-MM-dd.HH}.log.gz
       </fileNamePattern>
       <!--60天的时间周期，日志量最大20GB-->
       <maxHistory>60</maxHistory>
       <!-- 该属性在 1.1.6版本后 才开始支持-->
       <totalSizeCap>20GB</totalSizeCap>

这种形成了xx.2021-12-10.log.01 xx.2021-12-10.log.02，每个文件最大是60M，所有当天文件不超过20G

接下来继续说logger和root这两个都是指定日志级别，那么区别呢？
root节点和logger节点其实都是表示Logger组件。个人觉的可以把他们之间的关系可以理解为父子关系，root是最顶层的logger，正常情况getLogger(“name/class”)没有找到对应logger的情况下，都是使用root节点配置的logger
如果配置了logger，并且通过getLogger(“name/class”)获取到这个logger，输出日志的时候，就会使用这个logger配置的appender输出，同时还会使用rootLogger配置的appender。也就是说，如果root和logger都配置了debug级别的，那么日志会输出两次，我们可以使用logger节点的additivity="false"属性来屏蔽rootLogger的appender。这样就可以不使用rootLogger的appender输出日志了
所以logger一般都是为了单独给某些包下面输出日志的，比如这样的

	<!--记录druid-sql的记录-->
	<logger name="com.adups.vota.upgrade.mapper" level="debug" additivity="false">
		<appender-ref ref="stdout"/>
		<appender-ref ref="logfile"/>
	</logger>

标签：java,Slf4j,接口,Log4j,选型,logger,Logback,日志
来源： https://blog.csdn.net/lucky_love816/article/details/121861021

本站声明： 1. iCode9 技术分享网（下文简称本站）提供的所有内容，仅供技术学习、探讨和分享；
2. 关于本站的所有留言、评论、转载及引用，纯属内容发起人的个人观点，与本站观点和立场无关；
3. 关于本站的所有言论和文字，纯属内容发起人的个人观点，与本站观点和立场无关；
4. 本站文章均是网友提供，不完全保证技术分享内容的完整性、准确性、时效性、风险性和版权归属；如您发现该文章侵犯了您的权益，可联系我们第一时间进行删除；
5. 本站为非盈利性的个人网站，所有内容不会用来进行牟利，也不会利用任何形式的广告来间接获益，纯粹是为了广大技术爱好者提供技术内容和技术思想的分享性交流网站。

ICode9