Java log日志框架

本文主要是介绍Java log日志框架，对大家解决编程问题具有一定的参考价值，需要的程序猿们随着小编来一起学习吧！

一、总体介绍

1.1 基本日志框架之间关系

日志框架：

- - - 提供日志调用的接口，实际的日志输出托付给日志系统实现。
JCL(Jakarta Commons Logging)：比較流行的日志框架，非常多框架都依赖JCL，比如Spring等。
SLF4j：提供新的API，初衷是配合Logback使用，但同一时候兼容Log4j。

日志系统：

负责输出日志
Log4j：经典的一种日志解决方式。内部把日志系统抽象封装成Logger 、appender 、pattern 等实现。我们能够通过配置文件轻松的实现日志系统的管理和多样化配置。
Log4j2：Log4j的2.0版本号。对Log4j进行了优化。比方支持參数API、支持异步appender、插件式架构等
Logback：Log4j的替代产品。须要配合日志框架SLF4j使用
JUL(java.util.logging)：JDK提供的日志系统。较混乱，不经常使用

1.2 日志转换

二、日志框架

2.1 SFL4J-API

2.1.1 门面模式：

2.1.2 SLF4J官网图

2.1.3 源码分析

 1）LoggerFactory.getLogger();
 
 2）LoggerFactory.getILoggerFactory()
 
 3）LoggerFactory.performInitialization()
 
 4）LoggerFactory.bind()
 
 5) LoggerFactory.findPossibleStaticLoggerBinderPathSet();
 
 6) STATIC_LOGGER_BINDER_PATH = "org/slf4j/impl/StaticLoggerBinder.class"
 
 7) StaticLoggerBinder.getLoggerFactory()
 

2.2、Log4j2

2.2.1 log4j2 为什么高性能

1）无垃圾机制，对象重用和缓存区使用，避免频繁日志收集导致JVM GC
   2.6版本之后，默认情况下以log4j以“无垃圾方式运行”，并且尽可能不分配临时对象。         

2) 异步日志-> ArrayBlockingQueue
   两种方式：异步logger
             异步appender
     

2.2.2 log4j2 使用

虽然log4j2 也有自己的门面，但主流还是sfl4j + log4j2使用

2.2.3 springboot 日志使用

三、日志打印规范

3.1 日志级别

常见的日志级别有以下：

ALL级别 最低等级的，用于打开所有日志记录。
trace：跟踪日志，与debug差别不大
debug：调试问题使用，一定要打印出输入、输出数据
info：打印程序运行信息，启动信息等
warn：打印一些警告信息，比如参数校验错误等等
error：打印程序错误信息，必须要打印上下文信息，方便查找问题
fatal：重大灾难信息，比如数据库无法连接等需要立即处理的问题
OFF级别 最高等级的，用于关闭所有日志记录。

3.2 日志内容

3.2.1 不要使用System.out.println

3.2.2 除非业务需要，否则不要打印大文本

3.2.3 定义logger变量为static

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


public class Slf4j {


    /**
     * 日志记录器对象
     */
    private static final Logger logger = LoggerFactory.getLogger(Slf4j.class);
    
}

3.2.4 正确使用日志级别

3.2.5 不允许出现printStackTrace。

3.2.6 使用占位符

    // 使用{}占位符。避免字符串连接操作，减少String对象（不可变）带来的内存开销
	log.debug("XXX {}", String);

3.2.7 有意义的日志

3.3 日志要求

3.3.1 日志文件分开打印，便于查看和抓取日志

3.3.2 对于无法预知的异常，一定要打印堆栈

3.3.3 日期必须精确到毫秒，而不是秒

3.3.4 日志归档

3.3.5 确保日志是按事件顺序输出

3.3.6 配置日志滚动策略

3.3.7 【推荐】最好能打印调用方信息，比如访问者ip等信息

3.3.8 日志文件要可以方便使用grep语句查看

四、应用

4.1 log4j2 配置文件详解

<?xml version="1.0" encoding="UTF-8"?>
 <!--日志级别以及优先级排序: OFF > FATAL > ERROR > WARN > INFO > DEBUG > TRACE > ALL -->
 <!--Configuration后面的status，这个用于设置log4j2自身内部的信息输出，可以不设置，当设置成trace时，你会看到log4j2内部各种详细输出-->
 <!--monitorInterval：Log4j能够自动检测修改配置 文件和重新配置本身，设置间隔秒数-->
 <configuration status="WARN" monitorInterval="30">
     <!--先定义所有的appender-->
     <appenders>
     <!--这个输出控制台的配置-->
         <console name="Console" target="SYSTEM_OUT">
         <!--输出日志的格式-->
             <PatternLayout pattern="[%d{HH:mm:ss:SSS}] [%p] - %l - %m%n"/>
         </console>
     <!--文件会打印出所有信息，这个log每次运行程序会自动清空，由append属性决定，这个也挺有用的，适合临时测试用-->
     <File name="log" fileName="log/test.log" append="false">
        <PatternLayout pattern="%d{HH:mm:ss.SSS} %-5level %class{36} %L %M - %msg%xEx%n"/>
     </File>
     <!-- 这个会打印出所有的info及以下级别的信息，每次大小超过size，则这size大小的日志会自动存入按年份-月份建立的文件夹下面并进行压缩，作为存档-->
         <RollingFile name="RollingFileInfo" fileName="${sys:user.home}/logs/info.log"
                      filePattern="${sys:user.home}/logs/$${date:yyyy-MM}/info-%d{yyyy-MM-dd}-%i.log">
             <!--控制台只输出level及以上级别的信息（onMatch），其他的直接拒绝（onMismatch）-->
             <ThresholdFilter level="info" onMatch="ACCEPT" onMismatch="DENY"/>
             <PatternLayout pattern="[%d{HH:mm:ss:SSS}] [%p] - %l - %m%n"/>
             <Policies>
                 <TimeBasedTriggeringPolicy/>
                 <SizeBasedTriggeringPolicy size="100 MB"/>
             </Policies>
         </RollingFile>
         <RollingFile name="RollingFileWarn" fileName="${sys:user.home}/logs/warn.log"
                      filePattern="${sys:user.home}/logs/$${date:yyyy-MM}/warn-%d{yyyy-MM-dd}-%i.log">
             <ThresholdFilter level="warn" onMatch="ACCEPT" onMismatch="DENY"/>
             <PatternLayout pattern="[%d{HH:mm:ss:SSS}] [%p] - %l - %m%n"/>
             <Policies>
                 <TimeBasedTriggeringPolicy/>
                 <SizeBasedTriggeringPolicy size="100 MB"/>
             </Policies>
         <!-- DefaultRolloverStrategy属性如不设置，则默认为最多同一文件夹下7个文件，这里设置了20 -->
             <DefaultRolloverStrategy max="20"/>
         </RollingFile>
         <RollingFile name="RollingFileError" fileName="${sys:user.home}/logs/error.log"
                      filePattern="${sys:user.home}/logs/$${date:yyyy-MM}/error-%d{yyyy-MM-dd}-%i.log">
             <ThresholdFilter level="error" onMatch="ACCEPT" onMismatch="DENY"/>
             <PatternLayout pattern="[%d{HH:mm:ss:SSS}] [%p] - %l - %m%n"/>
             <Policies>
                 <TimeBasedTriggeringPolicy/>
                 <SizeBasedTriggeringPolicy size="100 MB"/>
             </Policies>
         </RollingFile>
     </appenders>
     <!--然后定义logger，只有定义了logger并引入的appender，appender才会生效-->
     <loggers>
         <!--过滤掉spring和mybatis的一些无用的DEBUG信息-->
         <logger name="org.springframework" level="INFO"></logger>
         <logger name="org.mybatis" level="INFO"></logger>
         <root level="all">
             <appender-ref ref="Console"/>
             <appender-ref ref="RollingFileInfo"/>
             <appender-ref ref="RollingFileWarn"/>
             <appender-ref ref="RollingFileError"/>
         </root>
     </loggers>
 </configuration>

4.2 项目演示

Github地址

五、案例

5.1 log4j升级log4j2实战

5.1.1 适配器和桥接器不能同时使用

5.2 使用slf4j的实现类logback日志框架

   1.　引入slf4j & logback日志包和slf4j -> logback适配器；

　　2.　排除common-logging、log4j、log4j2日志包；

　　3.　引入jdk-logging -> slf4j、common-logging -> slf4j、log4j -> slf4j、log4j2 -> slf4j桥接器；

　　4.　排除slf4j -> jdk-logging、slf4j -> common-logging、slf4j -> log4j、slf4j -> log4j2适配器。

这篇关于Java log日志框架的文章就介绍到这儿，希望我们推荐的文章对大家有所帮助，也希望大家多多支持为之网！