com.dahuatech.hutool.log.dialect.slf4j.Slf4jLog Maven / Gradle / Ivy

Go to download
package com.dahuatech.hutool.log.dialect.slf4j;

import com.dahuatech.hutool.core.util.StrUtil;
import com.dahuatech.hutool.log.AbstractLog;
import com.dahuatech.hutool.log.level.Level;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.slf4j.spi.LocationAwareLogger;

/**
 * SLF4J log.

 * 同样无缝支持 LogBack
 *
 * @author Looly
 */
public class Slf4jLog extends AbstractLog {
  private static final long serialVersionUID = -6843151523380063975L;

  private final transient Logger logger;
  /** 是否为 LocationAwareLogger ，用于判断是否可以传递FQCN */
  private final boolean isLocationAwareLogger;

  // ------------------------------------------------------------------------- Constructor
  public Slf4jLog(Logger logger) {
    this.logger = logger;
    this.isLocationAwareLogger = (logger instanceof LocationAwareLogger);
  }

  public Slf4jLog(Class clazz) {
    this(getSlf4jLogger(clazz));
  }

  public Slf4jLog(String name) {
    this(LoggerFactory.getLogger(name));
  }

  /**
   * 获取Slf4j Logger对象
   *
   * @param clazz 打印日志所在类，当为{@code null}时使用“null”表示
   * @return {@link Logger}
   */
  private static Logger getSlf4jLogger(Class clazz) {
    return (null == clazz)
        ? LoggerFactory.getLogger(StrUtil.EMPTY)
        : LoggerFactory.getLogger(clazz);
  }

  @Override
  public String getName() {
    return logger.getName();
  }

  // ------------------------------------------------------------------------- Trace
  @Override
  public boolean isTraceEnabled() {
    return logger.isTraceEnabled();
  }

  @Override
  public void trace(String fqcn, Throwable t, String format, Object... arguments) {
    if (isTraceEnabled()) {
      if (this.isLocationAwareLogger) {
        locationAwareLog(
            (LocationAwareLogger) this.logger,
            fqcn,
            LocationAwareLogger.TRACE_INT,
            t,
            format,
            arguments);
      } else {
        logger.trace(StrUtil.format(format, arguments), t);
      }
    }
  }

  // ------------------------------------------------------------------------- Debug
  @Override
  public boolean isDebugEnabled() {
    return logger.isDebugEnabled();
  }

  @Override
  public void debug(String fqcn, Throwable t, String format, Object... arguments) {
    if (isDebugEnabled()) {
      if (this.isLocationAwareLogger) {
        locationAwareLog(
            (LocationAwareLogger) this.logger,
            fqcn,
            LocationAwareLogger.DEBUG_INT,
            t,
            format,
            arguments);
      } else {
        logger.debug(StrUtil.format(format, arguments), t);
      }
    }
  }

  // ------------------------------------------------------------------------- Info
  @Override
  public boolean isInfoEnabled() {
    return logger.isInfoEnabled();
  }

  @Override
  public void info(String fqcn, Throwable t, String format, Object... arguments) {
    if (isInfoEnabled()) {
      if (this.isLocationAwareLogger) {
        locationAwareLog(
            (LocationAwareLogger) this.logger,
            fqcn,
            LocationAwareLogger.INFO_INT,
            t,
            format,
            arguments);
      } else {
        logger.info(StrUtil.format(format, arguments), t);
      }
    }
  }

  // ------------------------------------------------------------------------- Warn
  @Override
  public boolean isWarnEnabled() {
    return logger.isWarnEnabled();
  }

  @Override
  public void warn(String fqcn, Throwable t, String format, Object... arguments) {
    if (isWarnEnabled()) {
      if (this.isLocationAwareLogger) {
        locationAwareLog(
            (LocationAwareLogger) this.logger,
            fqcn,
            LocationAwareLogger.WARN_INT,
            t,
            format,
            arguments);
      } else {
        logger.warn(StrUtil.format(format, arguments), t);
      }
    }
  }

  // ------------------------------------------------------------------------- Error
  @Override
  public boolean isErrorEnabled() {
    return logger.isErrorEnabled();
  }

  @Override
  public void error(String fqcn, Throwable t, String format, Object... arguments) {
    if (isErrorEnabled()) {
      if (this.isLocationAwareLogger) {
        locationAwareLog(
            (LocationAwareLogger) this.logger,
            fqcn,
            LocationAwareLogger.ERROR_INT,
            t,
            format,
            arguments);
      } else {
        logger.error(StrUtil.format(format, arguments), t);
      }
    }
  }

  // -------------------------------------------------------------------------------------------------- Private method

  // ------------------------------------------------------------------------- Log
  @Override
  public void log(String fqcn, Level level, Throwable t, String format, Object... arguments) {
    switch (level) {
      case TRACE:
        trace(fqcn, t, format, arguments);
        break;
      case DEBUG:
        debug(fqcn, t, format, arguments);
        break;
      case INFO:
        info(fqcn, t, format, arguments);
        break;
      case WARN:
        warn(fqcn, t, format, arguments);
        break;
      case ERROR:
        error(fqcn, t, format, arguments);
        break;
      default:
        throw new Error(StrUtil.format("Can not identify level: {}", level));
    }
  }

  /**
   * 打印日志

   * 此方法用于兼容底层日志实现，通过传入当前包装类名，以解决打印日志中行号错误问题
   *
   * @param logger {@link LocationAwareLogger} 实现
   * @param fqcn 完全限定类名(Fully Qualified Class Name)，用于纠正定位错误行号
   * @param level_int 日志级别，使用LocationAwareLogger中的常量
   * @param t 异常
   * @param msgTemplate 消息模板
   * @param arguments 参数
   * @return 是否支持 LocationAwareLogger对象，如果不支持需要日志方法调用被包装类的相应方法
   */
  private void locationAwareLog(
      LocationAwareLogger logger,
      String fqcn,
      int level_int,
      Throwable t,
      String msgTemplate,
      Object[] arguments) {
    // ((LocationAwareLogger)this.logger).log(null, fqcn, level_int, msgTemplate, arguments, t);
    // 由于slf4j-log4j12中此方法的实现存在bug，故在此拼接参数
    logger.log(null, fqcn, level_int, StrUtil.format(msgTemplate, arguments), null, t);
  }
}