【JAVA日志框架大全】一文快速讲透JAVA日志体系

本文涉及的产品
日志服务 SLS,月写入数据量 50GB 1个月
简介: 【JAVA日志框架大全】一文快速讲透JAVA日志体系

1.概述

发展史:

java日志体系中是现有的log4j,后面才有了JDK自带的jul,两者是两套体系,互不兼容。后来为了不同日志体系之间的兼容,apache推出了jcl日志门面。后来log4j的作者因为和apache理念不合,离开apache后推出了一个全新的日志实现——logback,以及一个全新的日志门面——slf4j。最后apache优化了log4j推出了log4j2。

日志框架的核心问题:

日志是用来记录应用的一些运行信息的。假设没有日志框架,我们要在应用里手动实现日志相关功能,我们需要关注些什么?其实仔细想想无非两点:

  • 记录哪些信息?
  • 记录到哪里去?

当然作为日志框架来说,为了方便使用,它还要关注一点就是:

  • 如何进行方便的配置

以上三点核心问题,我们看作为日志框架的开山鼻祖的log4j是怎样解决的:

log4j给出的答案是:

  • 记录哪些信息——日志级别(level)
  • 记录到哪里去——提供不同的输出方式(appender),文件、控制台、其它等等
  • 如何进行方便的配置——除硬编码外,提供配置文件

2.jul

jul是JDK自带的日志框架,作者之前有一篇文章专门讲过,可以移步:

【JAVA日志框架】JUL,JDK原生日志框架详解。-CSDN博客

3.log4j

3.1.概述

log4j最后一个版本是12年发布的,如今apache已经停止对其维护,现在的项目基本上是不会选用log4j来作为日志框架了,但是作为第一款日志框架,其很多设计思想和体系架构,均成为了标准,后面的日志框架其实都是效仿的log4j。

依赖:

<dependency>
            <groupId>log4j</groupId>
            <artifactId>log4j</artifactId>
            <version>1.2.17</version>
</dependency>
 

3.2.日志级别

日志级别:

import org.apache.log4j.Logger;
import org.junit.Test;
 
public class test {
    private static Logger logger=Logger.getLogger(test.class);
    @Test
    public void test1(){
        logger.trace("trace");
        logger.debug("debug");
        logger.info("info");
        logger.warn("warn");
        logger.error("error");
        logger.fatal("fatal");
    }
}

3.3.配置

如果直接像上面一样使用,会报错:

原因很简单,log4j没有进行初始化的默认配置,需要手动去进行配置,才能使用。

log4j的配置,主要就是配置appender,以下将展示几个实际工程中常用的appender:


ConsoleAppender


FileAppender


DailyRollingFileAppender,将每天的日志单独写成一个文件,即每天一个日志文件。


1.ConsoleAppender:

#控制台的appender,stdout是自定义的一个appender的名字。

log4j.appender.stdout=org.apache.log4j.ConsoleAppender

#自定义的这个appender用什么方式来输出,这里用System.out

log4j.appender.stdout.Target=System.out

#自定义的这个appender的日志级别

log4j.appender.stdout.Threshold=INFO

#自定义的这个appender的日志的格式

#d:data %-5p:用5个字符来打印日志级别 %20c:用20个字符来打印全类名 %L:第几行 %m:打印自己的message

log4j.appender.stdout.layout=org.apache.log4j.PatternLayout

log4j.appender.stdout.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss} %-5p %20c %L:%m %n


2.FileAppender:


#文件appender

log4j.appender.a1=org.apache.log4j.FileAppender

#自定义的这个appender用什么方式来输出,这里用System.out

log4j.appender.a1.File=${user.home}/LogDemo/log4j/a1.log

#自定义的这个appender的日志级别

log4j.appender.a1.Threshold=INFO

#自定义的这个appender的日志的格式

#d:data %-5p:用5个字符来打印日志级别 %20c:用20个字符来打印全类名 %L:第几行 %m:打印自己的message

log4j.appender.a1.layout=org.apache.log4j.PatternLayout

log4j.appender.a1.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss} %-5p %20c %L:%m %n


3.DailyRollingFileAppender:


#将每天的日志单独写成一个文件,即每天一个日志文件的appender,stdout是自定义的一个appender的名字。

log4j.appender.a2=org.apache.log4j.DailyRollingFileAppender

#自定义的这个appender用什么方式来输出,这里用System.out

log4j.appender.a2.File=${user.home}/LogDemo/log4j/a1.log

#自定义的这个appender的日志级别

log4j.appender.a2.Threshold=INFO

#自定义的这个appender的日志的格式

#d:data %-5p:用5个字符来打印日志级别 %20c:用20个字符来打印全类名 %L:第几行 %m:打印自己的message

log4j.appender.a2.layout=org.apache.log4j.PatternLayout

log4j.appender.a2.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss} %-5p %20c %L:%m %n


光是配置好了,还不能用,要把配置的appender关联到根logger上去:


#日志级别以及appender

log4j.rootLogger=Info,stdout,a1,a2


将配置文件放到classpath下面去即可,log4j会去classpath下找配置文件:

再运行就可以看到效果:

4.日志门面

4.1.jcl+log4j

4.1.1.使用

jcl也是apache推出的一个日志门面,jcl可能听起来比较陌生,它的另一个名字大家就会觉得很熟悉了——commons-logging。jcl最后一次更新是14年,后面apache放弃了对jcl的维护,所以jcl和log4j一样都不太会在新项目里面被使用,学jcl主要是理解它的思想。


依赖:

<dependency>
            <groupId>commons-logging</groupId>
            <artifactId>commons-logging</artifactId>
            <version>1.2</version>
 </dependency>
 

jcl默认使用jul进行输出,其支持的日志级别和log4j一样:

package com.eryi;
 
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.junit.Test;
 
public class test {
    private static Log log= LogFactory.getLog(test.class);
    @Test
    public void test1(){
        log.trace("trace");
        log.debug("debug");
        log.info("info");
        log.warn("warn");
        log.error("error");
        log.fatal("fatal");
    }
}

要切换成log4j,直接引入log4j的依赖即可:

<dependencies>
    <dependency>
            <groupId>ch.qos.logback</groupId>
            <artifactId>logback-classic</artifactId>
            <version>1.2.3</version>
        </dependency>        
</dependencies>
 

然后记得把log4j的配置文件放到classpath下面。

然后执行效果如下,可以看到是log4j输出的:

4.1.2.原理

其实源码没什么看头,核心就是去获取log的时候,这个log的底层实现用什么?

jcl里面写死了要适配的所有日志框架的logger的类全路径:

private static final String[] classesToDiscover = new String[]{"org.apache.commons.logging.impl.Log4JLogger", "org.apache.commons.logging.impl.Jdk14Logger", "org.apache.commons.logging.impl.Jdk13LumberjackLogger", "org.apache.commons.logging.impl.SimpleLog"};


去load这些实现类,然后用反射实例化出来作为底层提供能力的内核。获取实现类的时候用了一个简单的模板模式,提供能力的时候用了一个简单的适配器模式,经此而已。

4.2.sl4j+logback

4.2.1.使用

sl4j是目前常用的日志门面,logback是目前常用的日志框架。

依赖:

<dependencies>
        <dependency>
            <groupId>org.slf4j</groupId>
            <artifactId>slf4j-api</artifactId>
            <version>1.7.25</version>
        </dependency>
        <dependency>
            <groupId>ch.qos.logback</groupId>
            <artifactId>logback-core</artifactId>
            <version>1.2.3</version>
        </dependency>
        <dependency>
            <groupId>ch.qos.logback</groupId>
            <artifactId>logback-classic</artifactId>
            <version>1.2.3</version>
        </dependency>
</dependencies>
 

slf4j和jcl使用上是相似的,只是工程的叫法不同,jcl里面叫LogFactory,slf4j里面叫LoggerFactory:

package com.eryi;
 
 
import org.junit.Test;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
 
public class test {
    private static Logger logger= LoggerFactory.getLogger(test.class);
    @Test
    public void test1(){
        logger.trace("trace");
        logger.debug("debug");
        logger.info("info");
        logger.warn("warn");
        logger.error("error");
    }
}

输出结果:

4.2.2.配置

logback默认会去classpath里面寻找配置文件。

配置文件示例:

<?xml version="1.0" encoding="UTF-8"?>
<configuration scan="true" scanPeriod="10 seconds">
    <!-- 日志级别从低到高分为TRACE < DEBUG < INFO < WARN < ERROR < FATAL,如果设置为WARN,则低于WARN的信息都不会输出 -->
    <!-- scan:当此属性设置为true时,配置文件如果发生改变,将会被重新加载,默认值为true -->
    <!-- scanPeriod:设置监测配置文件是否有修改的时间间隔,如果没有给出时间单位,默认单位是毫秒。当scan为true时,此属性生效。默认的时间间隔为1分钟。 -->
    <!-- debug:当此属性设置为true时,将打印出logback内部日志信息,实时查看logback运行状态。默认值为false。 -->
    <contextName>logback</contextName>
    <!--定义日志文件的存储地址 勿在 LogBack 的配置中使用相对路径-->
    <property name="LOG_SAVE_PATH" value="logs"></property>
    <!-- 定义输出日志记录格式 -->
    <property name="DEFAULT_PATTERN" value="%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level [%logger] - (%F:%L\\) : %msg%n"/>
 
    <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <Pattern>${DEFAULT_PATTERN}</Pattern>
            <!-- 设置字符集 -->
            <charset>UTF-8</charset>
        </encoder>
    </appender>
 
    <!-- 时间滚动输出 level为 INFO 日志 -->
    <appender name="RollingFileInfo" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>${LOG_SAVE_PATH}/console.log</file>
        <encoder>
            <pattern>${DEFAULT_PATTERN}</pattern>
            <charset>UTF-8</charset>
        </encoder>
        <!-- 日志记录器的滚动策略,按日期,按大小记录 -->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!-- 每天日志归档路径以及格式 -->
            <fileNamePattern>${LOG_SAVE_PATH}/info/log-info-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>100MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
            <!--日志文件保留单位数-->
            <maxHistory>15</maxHistory>
        </rollingPolicy>
        <!-- 此日志文件只记录info级别的 -->
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>INFO</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
    </appender>
 
    <!-- 时间滚动输出 level为 WARN 日志 -->
    <appender name="RollingFileWarn" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>${LOG_SAVE_PATH}/warn.log</file>
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level [%logger{50}] - %msg%n</pattern>
            <charset>UTF-8</charset>
        </encoder>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>${LOG_SAVE_PATH}/warn/log-warn-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>100MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
            <maxHistory>15</maxHistory>
        </rollingPolicy>
        <!-- 此日志文件只记录warn级别的 -->
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>warn</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
    </appender>
 
    <!-- 时间滚动输出 level为 ERROR 日志 -->
    <appender name="RollingFileError" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>${LOG_SAVE_PATH}/error.log</file>
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level [%logger{50}] - %msg%n</pattern>
            <charset>UTF-8</charset>
        </encoder>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>${LOG_SAVE_PATH}/error/log-error-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>100MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
            <!--日志文件保留单位数-->
            <maxHistory>15</maxHistory>
        </rollingPolicy>
        <!-- 此日志文件只记录ERROR级别的 -->
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>ERROR</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
    </appender>
 
    <!--additivity:是否继承root节点,默认是true继承。默认情况下子Logger会继承父Logger的appender,
    也就是说子Logger会在父Logger的appender里输出。
    若是additivity设为false,则子Logger只会在自己的appender里输出,而不会在父Logger的appender里输出。-->
    <logger name="org.springframework" level="INFO" additivity="false">
        <appender-ref ref="CONSOLE"/>
        <appender-ref ref="RollingFileInfo"/>
    </logger>
    <logger name="org.springframework.security" level="INFO"></logger>
    <Logger name="org.apache.ibatis.io.DefaultVFS" level="INFO"/>
    <Logger name="org.apache.ibatis.io" level="INFO"/>
    <!-- 设置日志输出级别,从低到高为:All < Trace < Debug < Info < Warn < Error < Fatal < OFF-->
    <root level="ALL">
        <appender-ref ref="CONSOLE"/>
        <appender-ref ref="DEFAULT_FILE"/>
        <appender-ref ref="RollingFileWarn"/>
        <appender-ref ref="RollingFileError"/>
    </root>
</configuration>

5.适配

由于api均不统一,jcl兼容log4j,slf4j兼容logback,当想交叉组合,比如slf4j+log4j时,需要用到适配包,各门面和各实现之间的适配关系如下图所示,用到的时候去查一下即可:


相关实践学习
日志服务之使用Nginx模式采集日志
本文介绍如何通过日志服务控制台创建Nginx模式的Logtail配置快速采集Nginx日志并进行多维度分析。
目录
相关文章
|
5天前
|
Java 数据库连接 Apache
java编程语言常用框架有哪些?
Java作为一种广泛使用的编程语言,拥有众多常用框架,这些框架帮助开发者提高开发效率和代码质量。
15 3
|
6天前
|
测试技术 API Android开发
《手把手教你》系列基础篇(九十七)-java+ selenium自动化测试-框架设计篇-Selenium方法的二次封装和页面基类(详解教程)
【7月更文挑战第15天】这是关于自动化测试框架中Selenium API二次封装的教程总结。教程中介绍了如何设计一个支持不同浏览器测试的页面基类(BasePage),该基类包含了对Selenium方法的二次封装,如元素的输入、点击、清除等常用操作,以减少重复代码。此外,页面基类还提供了获取页面标题和URL的方法。
20 2
|
7天前
|
Web App开发 XML Java
《手把手教你》系列基础篇(九十六)-java+ selenium自动化测试-框架之设计篇-跨浏览器(详解教程)
【7月更文挑战第14天】这篇教程介绍了如何使用Java和Selenium构建一个支持跨浏览器测试的自动化测试框架。设计的核心是通过读取配置文件来切换不同浏览器执行测试用例。配置文件中定义了浏览器类型(如Firefox、Chrome)和测试服务器的URL。代码包括一个`BrowserEngine`类,它初始化配置数据,根据配置启动指定的浏览器,并提供关闭浏览器的方法。测试脚本`TestLaunchBrowser`使用`BrowserEngine`来启动浏览器并执行测试。整个框架允许在不同浏览器上运行相同的测试,以确保兼容性和一致性。
17 3
|
9天前
|
存储 Web App开发 Java
《手把手教你》系列基础篇(九十五)-java+ selenium自动化测试-框架之设计篇-java实现自定义日志输出(详解教程)
【7月更文挑战第13天】这篇文章介绍了如何在Java中创建一个简单的自定义日志系统,以替代Log4j或logback。
32 5
|
10天前
|
设计模式 Java 测试技术
《手把手教你》系列基础篇(九十四)-java+ selenium自动化测试-框架设计基础-POM设计模式实现-下篇(详解教程)
【7月更文挑战第12天】在本文中,作者宏哥介绍了如何在不使用PageFactory的情况下,用Java和Selenium实现Page Object Model (POM)。文章通过一个百度首页登录的实战例子来说明。首先,创建了一个名为`BaiduHomePage1`的页面对象类,其中包含了页面元素的定位和相关操作方法。接着,创建了测试类`TestWithPOM1`,在测试类中初始化WebDriver,设置驱动路径,最大化窗口,并调用页面对象类的方法进行登录操作。这样,测试脚本保持简洁,遵循了POM模式的高可读性和可维护性原则。
14 2
|
2天前
|
Java 程序员 Linux
如何使用日志框架记录日志
如何使用日志框架记录日志
|
5天前
|
Java 开发者
Java并发编程之Executor框架详解
【7月更文挑战第18天】本文旨在深入探讨Java中的Executor框架,揭示其对并发编程的优化作用。通过解析Executor接口、ThreadPoolExecutor和ScheduledExecutorService等关键组件,文章展示了如何有效管理和控制线程资源。同时,结合实例分析,本文阐释了Executor框架在提高程序性能、简化代码结构方面的实际应用价值。旨在为Java开发者提供并发编程的高级工具,帮助他们构建更加高效、稳定的多线程应用。
|
26天前
|
存储 关系型数据库 MySQL
|
11天前
|
监控
查看服务器/IIS日志、log、访问信息基本方法
除了手动查看,你也可以使用日志分析工具,如Log Parser、AWStats等,这些工具可以帮助你更方便地分析日志数据。
8 1
|
19天前
|
Java 测试技术 Apache
《手把手教你》系列基础篇(八十六)-java+ selenium自动化测试-框架设计基础-Log4j实现日志输出(详解教程)
【7月更文挑战第4天】Apache Log4j 是一个广泛使用的 Java 日志框架,它允许开发者控制日志信息的输出目的地、格式和级别。Log4j 包含三个主要组件:Loggers(记录器)负责生成日志信息,Appenders(输出源)确定日志输出的位置(如控制台、文件、数据库等),而 Layouts(布局)则控制日志信息的格式。通过配置 Log4j,可以灵活地定制日志记录行为。
33 4