日志技术-日志门面

2022-04-06 本文已影响0人石头耳东

零、本文纲要

一、日志门面
二、JCL
三、SLF4J
四、Logback
五、log4j2

tips：Ctrl + F快速定位所需内容阅读吧。

一、日志门面

1、常见的日志门面

JCL、slf4j；

2、常见的日志实现

JUL、log4j、logback、log4j2

3、日志门面作用

① 面向接口开发，不再依赖具体的实现类，减少代码的耦合；
② 项目通过导入不同的日志实现类，可以灵活的切换日志框架；
③ 统一API，方便开发者学习和使用；
④ 统一配置便于项目日志的管理。

二、JCL

1、JCL简单介绍

全称为Jakarta Commons Logging，是Apache提供的一个通用日志API，自身提供日志实现SimpleLog（不推荐）。
它允许开发人员使用不同的具体日志实现工具: Log4j, Jdk自带的日志（JUL)。

JCL 有两个基本的抽象类：Log(基本记录器)和LogFactory(负责创建Log实例)。

image.png

2、快速入门

① 导入依赖

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

② 测试

@Test
public void testQuick() throws Exception{
    // 获取日志记录器对象
    Log log = LogFactory.getLog(JCLTest.class);
    // 日志记录输出
    log.info("hello jcl");
}

③ 改用log4j日志实现

Ⅰ 导入依赖

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

Ⅱ log4j.properties

# 指定 RootLogger 顶级父元素默认配置信息
# 指定日志级别为 trace，使用的 appender 为 console
log4j.rootLogger = fatal,console

# 指定控制台日志输出的 appender ，命名为 console
log4j.appender.console = org.apache.log4j.ConsoleAppender
# 指定消息格式 layout 为 PatternLayout
log4j.appender.console.layout = org.apache.log4j.PatternLayout
# 指定消息格式的内容
log4j.appender.console.layout.conversionPattern = [%-5p]%r %l %d{yyyy-MM-dd HH:mm:ss.SSS} %m%n

Ⅲ 测试

三、SLF4J

官方网址：SLF4J。

1、简单介绍

简单日志门面(Simple Logging Facade For Java) SLF4J主要是为了给Java日志访问提供一套标准、规范的API框架，其主要意义在于提供接口，具体的实现可以交由其他日志框架，例如log4j和logback等。

对于一般的Java项目而言，日志框架会选择slf4j-api作为门面，配上具体的实现框架（log4j、logback等），中间使用桥接器完成桥接。

2、SLF4J日志门面功能

① 日志框架的绑定；
② 日志框架的桥接。

3、快速入门

① 添加依赖

<!--slf4j 日志门面-->
<dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>slf4j-api</artifactId>
    <version>1.7.21</version>
</dependency>
<!--slf4j 内置简单实现-->
<dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>slf4j-simple</artifactId>
    <version>1.7.21</version>
</dependency>

② 测试

    @Test
    public void testSLF4J(){
        LOGGER.error("error");
        LOGGER.warn("warn");
        LOGGER.info("info");
        LOGGER.debug("debug");
        LOGGER.trace("trace");

        String hello = "Hello, ";
        String slf4j = "slf4j.";
        LOGGER.info("Say: {}{}", hello, slf4j);

        try {
            int i = 1 / 0;
        } catch (Exception e) {
            LOGGER.error("Something warn might have happened like:", e);
        }
    }

4、绑定日志的实现

绑定日志的实现.png

① 使用slf4j的日志绑定流程:
Ⅰ 添加slf4j-api的依赖；
Ⅱ 使用slf4j的API在项目中进行统一的日志记录；
Ⅲ 绑定具体的日志实现框架：
-- 绑定已经实现了slf4j的日志框架,直接添加对应依赖；
-- 绑定没有实现slf4j的日志框架,先添加日志的适配器,再添加实现类的依赖；
Ⅳ slf4j有且仅有一个日志实现框架的绑定（如果出现多个默认使用第一个依赖日志实现）。
② 快速入门

Ⅰ 引入依赖

<!--slf4j 日志门面-->
<dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>slf4j-api</artifactId>
    <version>1.7.21</version>
</dependency>
<!--slf4j 内置简单实现-->
<dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>slf4j-simple</artifactId>
    <version>1.7.21</version>
</dependency>
<!--logback 日志实现-->
<dependency>
    <groupId>ch.qos.logback</groupId>
    <artifactId>logback-classic</artifactId>
    <version>1.2.3</version>
</dependency>
<!--nop 日志开关：导入该依赖关闭日志记录-->
<dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>slf4j-nop</artifactId>
    <version>1.7.21</version>
</dependency>
<!--绑定 log4j 日志实现，需要导入适配器-->
<dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>slf4j-log4j12</artifactId>
    <version>1.7.21</version>
</dependency>
<!--log4j-->
<dependency>
    <groupId>log4j</groupId>
    <artifactId>log4j</artifactId>
    <version>1.2.17</version>
</dependency>
<!--绑定 jul 日志实现，需要导入适配器-->
<dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>slf4j-jdk14</artifactId>
    <version>1.7.25</version>
</dependency>
<!--log4j 桥接器-->
<dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>log4j-over-slf4j</artifactId>
    <version>1.7.25</version>
</dependency>

Ⅱ 根据上图搭配测试

5、桥接旧的日志框架

桥接旧的日志框架.png

① 添加依赖

<!-- log4j -->
<dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>log4j-over-slf4j</artifactId>
    <version>1.7.27</version>
</dependency>
<!-- jul -->
<dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>jul-to-slf4j</artifactId>
    <version>1.7.27</version>
</dependency>
<!-- jcl -->
<dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>jcl-over-slf4j</artifactId>
    <version>1.7.27</version>
</dependency>

② 根据桥接需求选择对应依赖测试

四、Logback

官方网址：Logback Home (qos.ch)。

1、简单介绍

Logback是由log4j创始人设计的另一个开源日志组件，性能比log4j要好。

2、Logback主要模块

① logback-core：其它两个模块的基础模块；
② logback-classic：它是log4j的一个改良版本，同时它完整实现了slf4j API；
③ logback-access：访问模块与Servlet容器集成提供通过Http来访问日志的功能。

3、快速入门

① 导入依赖

<!--slf4j 日志门面-->
<dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>slf4j-api</artifactId>
    <version>1.7.36</version>
</dependency>
<!--logback 日志实现-->
<dependency>
    <groupId>ch.qos.logback</groupId>
    <artifactId>logback-classic</artifactId>
    <version>1.2.11</version>
</dependency>

② 测试

public class LogbackTest {

    private static final Logger LOGGER = LoggerFactory.getLogger(LogbackTest.class);

    @Test
    public void testLogback(){
        LOGGER.error("error");
        LOGGER.warn("warn");
        LOGGER.info("info");
        LOGGER.debug("debug");
        LOGGER.trace("trace");
    }
}

4、logback配置

logback会依次读取以下类型配置文件：

① logback.groovy；
② logback-test.xml；
③ logback.xml（通常配置）。

如果均不存在会采用默认配置。

logback.xml实例如下：

① 配置通用属性property，以${name}方式引用；
② 配置appender，常用的有console、file、htmlFile、rollFile，特殊的async；
③ 配置rootLogger对象；
④ 配置自定义logger对象，配置addtivity="false"属性以不继承rootLogger对象。

<?xml version="1.0" encoding="UTF-8" ?>
<configuration>
    <!--
        配置集中管理属性
        可以直接修改属性的value值
        格式：${name}
    -->
    <property name="pattern" value="[%-5level] %d{yyyy-MM-dd HH:mm:ss.SSS} %c %M %L [%thread] %m%n"></property>
    <!--
        日志输出格式：
        %-5level
        %d{yyyy-MM-dd HH:mm:ss.SSS}日期
        %c类的完整名称
        %M为method
        %L为行号
        %thread线程名称
        %m或者%msg为信息
        %n换行
    -->
    <!--定义日志文件保存路径属性-->
    <property name="log_dir" value="D:/tmp"></property>

    <!--控制台日志输出的 appender-->
    <appender name="console" class="ch.qos.logback.core.ConsoleAppender">
        <!--控制台输出流对象 默认System.out(黑色) 改为System.err(红色)-->
        <target>System.err</target>
        <!--日志消息格式设置-->
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <pattern>${pattern}</pattern>
        </encoder>
    </appender>

    <!--日志文件输出的 appender-->
    <appender name="file" class="ch.qos.logback.core.FileAppender">
        <!--日志文件保存路径-->
        <file>${log_dir}/logback.log</file>
        <!--日志消息格式设置-->
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <pattern>${pattern}</pattern>
        </encoder>
    </appender>

    <!--html 格式日志文件输出的 appender-->
    <appender name="htmlFile" class="ch.qos.logback.core.FileAppender">
        <!--日志文件保存路径-->
        <file>${log_dir}/logback.html</file>
        <!--html 消息格式配置-->
        <encoder class="ch.qos.logback.core.encoder.LayoutWrappingEncoder">
            <layout class="ch.qos.logback.classic.html.HTMLLayout">
                <pattern>%-5level%d{yyyy-MM-dd HH:mm:ss.SSS}%c%M%L%thread%m</pattern>
            </layout>
        </encoder>
    </appender>

    <!--日志拆分和归档压缩的 appender 对象-->
    <appender name="rollFile" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!--日志文件保存路径-->
        <file>${log_dir}/roll_logback.log</file>
        <!--日志消息格式设置-->
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <pattern>${pattern}</pattern>
        </encoder>
        <!--指定拆分规则-->
        <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
            <!--按照时间和压缩格式声明拆分的文件名-->
            <fileNamePattern>${log_dir}/rolling.%d{yyyy-MM-dd}.log%i.tar.gz</fileNamePattern>
            <!--按照文件大小拆分-->
            <maxFileSize>1MB</maxFileSize>
        </rollingPolicy>
        <!--日志级别过滤器-->
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <!--日志过滤规则-->
            <level>ERROR</level>
            <onMatch>ACCEPT</onMatch>
            <onMissmatch>DENY</onMissmatch>
        </filter>
    </appender>

    <!--异步日志-->
    <appender name="async" class="ch.qos.logback.classic.AsyncAppender">
        <!--指定某个具体的appender-->
        <appender-ref ref="rollFile"/>
    </appender>

    <!--root logger 配置-->
    <root level="ALL">
        <appender-ref ref="console"/>
<!--        <appender-ref ref="file"/>-->
<!--        <appender-ref ref="htmlFile"/>-->
<!--        <appender-ref ref="rollFile"/>-->
        <appender-ref ref="async"/>
    </root>

    <!--
        自定义logger对象
        addtivity="false" 自定义logger对象是否继承 rootLogger
    -->
    <logger name="com.stone" level="info" addtivity="false">
        <appender-ref ref="console"/>
    </logger>

</configuration>

5、log4j.properties转换成logback.xml工具

官方转换工具：log4j.properties Translator (qos.ch)。

五、log4j2

官方网址：Log4j – Apache Log4j 2。

1、认识log4j2

Apache Log4j 2是对Log4j的升级版，参考了logback的一些优秀的设计，并且修复了一些问题，因此带来了一些重大的提升，主要有：

① 异常处理，在logback中，Appender中的异常不会被应用感知到，但是在log4j2中，提供了一些异常处理机制；
② 性能提升， log4j2相较于log4j 和logback都具有很明显的性能提升，后面会有官方测试的数据；
③ 自动重载配置，参考了logback的设计，当然会提供自动刷新参数配置，最实用的就是我们在生产上可以动态的修改日志的级别而不需要重启应用；
④ 无垃圾机制，log4j2在大部分情况下，都可以使用其设计的一套无垃圾机制，避免频繁的日志收集导致的jvm gc。

2、快速入门

① 引入依赖

<!--log4j2 日志门面-->
<dependency>
    <groupId>org.apache.logging.log4j</groupId>
    <artifactId>log4j-api</artifactId>
    <version>2.17.2</version>
</dependency>
<!--log4j2 日志实现-->
<dependency>
    <groupId>org.apache.logging.log4j</groupId>
    <artifactId>log4j-core</artifactId>
    <version>2.13.3</version>
</dependency>

② 测试

    // 定义日志记录器对象
    public static final Logger LOGGER = LogManager.getLogger(Log4j2Test.class);

    @Test
    public void testLog4j2(){
        LOGGER.fatal("fatal");
        LOGGER.error("error");
        LOGGER.warn("warn");
        LOGGER.info("info");
        LOGGER.debug("debug");
        LOGGER.trace("trace");
    }

3、使用slf4j作为日志的门面,使用log4j2作为日志的实现

① 添加依赖

<!--slf4j 作为日志门面-->
<dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>slf4j-api</artifactId>
    <version>1.7.36</version>
</dependency>
<!--使用 log4j2 的适配器进行绑定-->
<dependency>
    <groupId>org.apache.logging.log4j</groupId>
    <artifactId>log4j-slf4j-impl</artifactId>
    <version>2.13.3</version>
</dependency>

<!--使用slf4j作为日志的门面 使用log4j2来记录日志-->
<dependency>
    <groupId>org.apache.logging.log4j</groupId>
    <artifactId>log4j-api</artifactId>
    <version>2.17.2</version>
</dependency>
<!--log4j2 日志实现-->
<dependency>
    <groupId>org.apache.logging.log4j</groupId>
    <artifactId>log4j-core</artifactId>
    <version>2.13.3</version>
</dependency>

② 配置log4j2.xml

Ⅰ 配置通用属性property；
Ⅱ 配置Appenders，常见的有Console、File、RandomAccessFile、RollingFile；
Ⅲ 配置Root Logger。

<!--
    status="warn" 日志框架本身的输出日志级别
    monitorInterval="5" 自动加载配置文件的间隔时间，不低于 5 秒
 -->
<Configuration status="warn" monitorInterval="5">

    <!--
            集中配置属性进行管理
            使用时通过:${name}
         -->
    <properties>
        <property name="LOG_HOME">/logs</property>
    </properties>

    <!-- 日志处理 -->
    <Appenders>
        <!-- 控制台输出 appender -->
        <Console name="Console" target="SYSTEM_ERR">
            <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] [%-5level] %c{36}:%L --- %m%n"/>
        </Console>

        <!-- 日志文件输出 appender -->
        <File name="file" fileName="${LOG_HOME}/myfile.log">
            <PatternLayout pattern="[%d{yyyy-MM-dd HH:mm:ss.SSS}] [%-5level] %l %c{36} - %m%n"/>
        </File>

        <!-- 使用随机读写流的日志文件输出 appender，性能提高 -->
        <RandomAccessFile name="accessFile" fileName="${LOG_HOME}/myAcclog.log">
            <PatternLayout pattern="[%d{yyyy-MM-dd HH:mm:ss.SSS}] [%-5level] %l %c{36} - %m%n"/>
        </RandomAccessFile>

        <!-- 按照一定规则拆分的日志文件的 appender -->
        <RollingFile name="rollingFile" fileName="${LOG_HOME}/myrollog.log"
                     filePattern="/logs/$${date:yyyy-MM-dd}/myrollog-%d{yyyy-MM-dd-HH-mm}-%i.log">
            <!-- 日志级别过滤器 -->
            <ThresholdFilter level="debug" onMatch="ACCEPT" onMismatch="DENY"/>
            <!-- 日志消息格式 -->
            <PatternLayout pattern="[%d{yyyy-MM-dd HH:mm:ss.SSS}] [%-5level] %l %c{36} - %msg%n"/>
            <Policies>
                <!-- 在系统启动时，触发拆分规则，生产一个新的日志文件 -->
                <OnStartupTriggeringPolicy/>
                <!-- 按照文件大小拆分，10MB  -->
                <SizeBasedTriggeringPolicy size="10 MB"/>
                <!-- 按照时间节点拆分，规则根据filePattern定义的 -->
                <TimeBasedTriggeringPolicy/>
            </Policies>
            <!-- 在同一个目录下，文件的个数限定为 30 个，超过进行覆盖 -->
            <DefaultRolloverStrategy max="30"/>
        </RollingFile>
    </Appenders>

    <!-- logger 定义 -->
    <Loggers>
        <!-- 使用 rootLogger 配置 日志级别 level="trace" -->
        <Root level="trace">
            <!-- 指定日志使用的处理器 -->
            <AppenderRef ref="Console"/>
        </Root>
    </Loggers>
</Configuration>

4、log4j2异步日志

① 添加依赖

<!--异步日志依赖-->
<dependency>
    <groupId>com.lmax</groupId>
    <artifactId>disruptor</artifactId>
    <version>3.3.2</version>
</dependency>

② 配置log4j2.xml

Ⅰ AsyncAppender方式

<!--
    status="warn" 日志框架本身的输出日志级别
    monitorInterval="5" 自动加载配置文件的间隔时间，不低于 5 秒
 -->
<Configuration status="warn" monitorInterval="5">

    <!--
            集中配置属性进行管理
            使用时通过:${name}
         -->
    <properties>
        <property name="LOG_HOME">/logs</property>
    </properties>

    <!-- 日志处理 -->
    <Appenders>

        <!-- 日志文件输出 appender -->
        <File name="file" fileName="${LOG_HOME}/myfile.log">
            <PatternLayout pattern="[%d{yyyy-MM-dd HH:mm:ss.SSS}] [%-5level] %l %c{36} - %m%n"/>
        </File>

         <Async name="Async"> 
         <AppenderRef ref="file"/> 
         </Async> 
    </Appenders>

    <!-- logger 定义 -->
    <Loggers>
        <!-- 使用 rootLogger 配置 日志级别 level="trace" -->
        <Root level="trace">
            <!-- 使用异步 appender -->
            <AppenderRef ref="Async"/>
        </Root>
    </Loggers>
</Configuration>

Ⅱ AsyncLogger方式（推荐）
全局异步，需要添加一个log4j2.component.properties 配置，其余不变，内容如下：

Log4jContextSelector=org.apache.logging.log4j.core.async.AsyncLoggerContextSelector

混合异步，同时使用同步日志和异步日志，修改log4j2.xml，如下配置：

<!--
    status="warn" 日志框架本身的输出日志级别
    monitorInterval="5" 自动加载配置文件的间隔时间，不低于 5 秒
 -->
<Configuration status="warn" monitorInterval="5">

    <!--
            集中配置属性进行管理
            使用时通过:${name}
         -->
    <properties>
        <property name="LOG_HOME">/logs</property>
    </properties>

    <!-- 日志处理 -->
    <Appenders>

        <!-- 日志文件输出 appender -->
        <File name="file" fileName="${LOG_HOME}/myfile.log">
            <PatternLayout pattern="[%d{yyyy-MM-dd HH:mm:ss.SSS}] [%-5level] %l %c{36} - %m%n"/>
        </File>

         <Async name="Async"> 
         <AppenderRef ref="file"/> 
         </Async> 
    </Appenders>

    <!-- logger 定义 -->
    <Loggers>
        <!-- 自定义异步 logger 对象
                    includeLocation="false" 关闭日志记录的行号信息
                    additivity="false" 不在继承 rootLogger 对象
                 -->
        <AsyncLogger name="com.stone" level="trace" includeLocation="false" additivity="false">
            <AppenderRef ref="Console"/>
        </AsyncLogger>
        <!-- 使用 rootLogger 配置 日志级别 level="trace" -->
        <Root level="trace">
            <!-- 使用异步 appender -->
            <AppenderRef ref="Async"/>
        </Root>
    </Loggers>
</Configuration>

③ 异步日志注意的问题

Ⅰ 如果使用异步日志，AsyncAppender、AsyncLogger和全局日志，不要同时出现。性能会和AsyncAppender一致，降至最低；
Ⅱ 设置includeLocation=false ，不然打印位置信息会急剧降低异步日志的性能，比同步日志还要慢。

六、结尾

以上即为日志门面的全部内容，感谢阅读。