Mybatis日志模块

最新推荐文章于 2024-06-05 21:00:00 发布

一只懒鱼a

最新推荐文章于 2024-06-05 21:00:00 发布

阅读量943

点赞数 23

分类专栏： mybatis 文章标签： mybatis java 后端

本文链接：https://blog.csdn.net/qq_38257958/article/details/138387828

版权

mybatis 专栏收录该内容

17 篇文章 0 订阅

订阅专栏

前言

良好的日志在一个软件中占了非常重要的地位，日志是开发与运维管理之间的桥梁。日志可以帮助运维人员和管理人员快速查找系统的故障和瓶颈，也可以帮助开发人员与运维人员沟通，更好地完成开发和运维任务。但日志的信息量会随着软件运行时间不断变多，所以需要定期汇总和清理，避免影响服务器的正常运行。
在 Java 开发中常用的日志框架有 Log4j、Log4j2、Apache Commons Log、java.util.logging、slf4j等，这些工具对外的接口不尽相同。为了统一这些工具的接口，MyBatis 定义了一套统一的日志接口供上层使用，并为上述常用的日志框架提供了相应的适配器。

日志适配器

多种第三方日志组件都有各自的 Log级别，且都有所不同。例如java.util.logging提供了 All、FINEST、FINER、FINE、CONFIG、INFO、WARNING 等9种级别，而 Log4j2 则只有 trace、debug、info、warn、error、fatal这6种日志级别。MyBatis 统一提供了 trace、debug、warn、enor 四个级别，这基本与主流日志框架的日志级别类似，可以满足绝大多数场景的日志需求。
MyBatis 的日志模块位于 org.apache.ibatis.logging 包中，该模块中通过 Log接口定义了日志模块的功能，当然日志适配器也会实现此接口。

LogFactory 工厂类负责创建对应的日志组件适配器，类结构如下所示：

public final class LogFactory {

  /**
   * Marker to be used by logging implementations that support markers.
   */
  public static final String MARKER = "MYBATIS";

  private static Constructor<? extends Log> logConstructor;

  static {
    tryImplementation(LogFactory::useSlf4jLogging);
    tryImplementation(LogFactory::useCommonsLogging);
    tryImplementation(LogFactory::useLog4J2Logging);
    tryImplementation(LogFactory::useLog4JLogging);
    tryImplementation(LogFactory::useJdkLogging);
    tryImplementation(LogFactory::useNoLogging);
  }

  private LogFactory() {
    // disable construction
  }

  public static Log getLog(Class<?> clazz) {
    return getLog(clazz.getName());
  }

  public static Log getLog(String logger) {
    try {
      return logConstructor.newInstance(logger);
    } catch (Throwable t) {
      throw new LogException("Error creating logger for logger " + logger + ".  Cause: " + t, t);
    }
  }

  public static synchronized void useCustomLogging(Class<? extends Log> clazz) {
    setImplementation(clazz);
  }

  public static synchronized void useSlf4jLogging() {
    setImplementation(org.apache.ibatis.logging.slf4j.Slf4jImpl.class);
  }

  public static synchronized void useCommonsLogging() {
    setImplementation(org.apache.ibatis.logging.commons.JakartaCommonsLoggingImpl.class);
  }

  /**
   * @deprecated Since 3.5.9 - See https://github.com/mybatis/mybatis-3/issues/1223. This method will remove future.
   */
  @Deprecated
  public static synchronized void useLog4JLogging() {
    setImplementation(org.apache.ibatis.logging.log4j.Log4jImpl.class);
  }

  public static synchronized void useLog4J2Logging() {
    setImplementation(org.apache.ibatis.logging.log4j2.Log4j2Impl.class);
  }

  public static synchronized void useJdkLogging() {
    setImplementation(org.apache.ibatis.logging.jdk14.Jdk14LoggingImpl.class);
  }

  public static synchronized void useStdOutLogging() {
    setImplementation(org.apache.ibatis.logging.stdout.StdOutImpl.class);
  }

  public static synchronized void useNoLogging() {
    setImplementation(org.apache.ibatis.logging.nologging.NoLoggingImpl.class);
  }

  private static void tryImplementation(Runnable runnable) {
    if (logConstructor == null) {
      try {
        runnable.run();
      } catch (Throwable t) {
        // ignore
      }
    }
  }

  private static void setImplementation(Class<? extends Log> implClass) {
    try {
      Constructor<? extends Log> candidate = implClass.getConstructor(String.class);
      Log log = candidate.newInstance(LogFactory.class.getName());
      if (log.isDebugEnabled()) {
        log.debug("Logging initialized using '" + implClass + "' adapter.");
      }
      logConstructor = candidate;
    } catch (Throwable t) {
      throw new LogException("Error setting Log implementation.  Cause: " + t, t);
    }
  }

}

LogFactory通过tryImplementation方法，依次尝试加载日志组件适配器，加载顺序如下：

useSlf4jLogging ：Slf4j
useCommonsLogging ：JCL
useLog4J2Logging ：Log4j2
useLog4JLogging : Log4j
useJdkLogging : JUL
useNoLogging

日志简介

日志门面：Slf4j、JCL、Log4j2；只提供日志相关的接口定义，即相应的 API，而不提供具体的接口实现。日志门面在使用时，可以动态或者静态地指定具体的日志框架实现，解除了接口和实现的耦合，使用户可以灵活地选择日志的具体实现框架。
日志系统：Logback、Log4j、Log4j2、JUL等；与日志门面相对，它提供了具体的日志接口实现，应用程序通过它执行日志打印的功能。

PS : Log4j2即可以作为日志门面，也可以作为日志的具体实现，一般用作日志的具体实现

Slf4j

Slf4j的日志绑定和日志桥接，如下图所示：

日志绑定

日志桥接

JCL

JCL 全称为Jakarta Commons Logging，是Apache提供的一个通用日志API。它适配的日志实现：Log4j、JDK自带的日志(JUL）

Mybatis使用各种日志