com.dahuatech.hutool.log.LogFactory Maven / Gradle / Ivy

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

import com.dahuatech.hutool.core.io.resource.ResourceUtil;
import com.dahuatech.hutool.core.lang.caller.CallerUtil;
import com.dahuatech.hutool.log.dialect.commons.ApacheCommonsLogFactory;
import com.dahuatech.hutool.log.dialect.console.ConsoleLogFactory;
import com.dahuatech.hutool.log.dialect.jboss.JbossLogFactory;
import com.dahuatech.hutool.log.dialect.jdk.JdkLogFactory;
import com.dahuatech.hutool.log.dialect.log4j.Log4jLogFactory;
import com.dahuatech.hutool.log.dialect.log4j2.Log4j2LogFactory;
import com.dahuatech.hutool.log.dialect.slf4j.Slf4jLogFactory;
import com.dahuatech.hutool.log.dialect.tinylog.TinyLogFactory;

import java.net.URL;
import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;

/**
 * 日志工厂类
 *
 * @see Slf4jLogFactory
 * @see Log4j2LogFactory
 * @see Log4jLogFactory
 * @see ApacheCommonsLogFactory
 * @see TinyLogFactory
 * @see JbossLogFactory
 * @see ConsoleLogFactory
 * @see JdkLogFactory
 * @author Looly
 */
public abstract class LogFactory {

  /** 日志框架名，用于打印当前所用日志框架 */
  protected String name;
  /** 日志对象缓存 */
  private Map logCache;

  /**
   * 构造
   *
   * @param name 日志框架名
   */
  public LogFactory(String name) {
    this.name = name;
    logCache = new ConcurrentHashMap<>();
  }

  /** @return 当前使用的日志工厂 */
  public static LogFactory getCurrentLogFactory() {
    return GlobalLogFactory.get();
  }

  /**
   * 自定义日志实现
   *
   * @see Slf4jLogFactory
   * @see Log4j2LogFactory
   * @see Log4jLogFactory
   * @see ApacheCommonsLogFactory
   * @see TinyLogFactory
   * @see JbossLogFactory
   * @see ConsoleLogFactory
   * @see JdkLogFactory
   * @param logFactoryClass 日志工厂类
   * @return 自定义的日志工厂类
   */
  public static LogFactory setCurrentLogFactory(Class logFactoryClass) {
    return GlobalLogFactory.set(logFactoryClass);
  }

  /**
   * 自定义日志实现
   *
   * @see Slf4jLogFactory
   * @see Log4j2LogFactory
   * @see Log4jLogFactory
   * @see ApacheCommonsLogFactory
   * @see TinyLogFactory
   * @see JbossLogFactory
   * @see ConsoleLogFactory
   * @see JdkLogFactory
   * @param logFactory 日志工厂类对象
   * @return 自定义的日志工厂类
   */
  public static LogFactory setCurrentLogFactory(LogFactory logFactory) {
    return GlobalLogFactory.set(logFactory);
  }

  /**
   * 获得日志对象
   *
   * @param name 日志对象名
   * @return 日志对象
   */
  public static com.dahuatech.hutool.log.Log get(String name) {
    return getCurrentLogFactory().getLog(name);
  }

  /**
   * 获得日志对象
   *
   * @param clazz 日志对应类
   * @return 日志对象
   */
  public static com.dahuatech.hutool.log.Log get(Class clazz) {
    return getCurrentLogFactory().getLog(clazz);
  }

  /** @return 获得调用者的日志 */
  public static Log get() {
    return get(CallerUtil.getCallerCaller());
  }

  // ------------------------------------------------------------------------- Static start

  /**
   * 决定日志实现
   *
   * 依次按照顺序检查日志库的jar是否被引入，如果未引入任何日志库，则检查ClassPath下的logging.properties，存在则使用JdkLogFactory，否则使用ConsoleLogFactory
   *
   * @see Slf4jLogFactory
   * @see Log4j2LogFactory
   * @see Log4jLogFactory
   * @see ApacheCommonsLogFactory
   * @see TinyLogFactory
   * @see JbossLogFactory
   * @see ConsoleLogFactory
   * @see JdkLogFactory
   * @return 日志实现类
   */
  public static LogFactory create() {
    final LogFactory factory = doCreate();
    factory.getLog(LogFactory.class).debug("Use [{}] Logger As Default.", factory.name);
    return factory;
  }

  /**
   * 决定日志实现
   *
   * 依次按照顺序检查日志库的jar是否被引入，如果未引入任何日志库，则检查ClassPath下的logging.properties，存在则使用JdkLogFactory，否则使用ConsoleLogFactory
   *
   * @see Slf4jLogFactory
   * @see Log4j2LogFactory
   * @see Log4jLogFactory
   * @see ApacheCommonsLogFactory
   * @see TinyLogFactory
   * @see JbossLogFactory
   * @see ConsoleLogFactory
   * @see JdkLogFactory
   * @return 日志实现类
   */
  private static LogFactory doCreate() {
    try {
      return new Slf4jLogFactory(true);
    } catch (NoClassDefFoundError e) {
      // ignore
    }
    try {
      return new Log4j2LogFactory();
    } catch (NoClassDefFoundError e) {
      // ignore
    }
    try {
      return new Log4jLogFactory();
    } catch (NoClassDefFoundError e) {
      // ignore
    }
    try {
      return new ApacheCommonsLogFactory();
    } catch (NoClassDefFoundError e) {
      // ignore
    }
    try {
      return new TinyLogFactory();
    } catch (NoClassDefFoundError e) {
      // ignore
    }
    try {
      return new JbossLogFactory();
    } catch (NoClassDefFoundError e) {
      // ignore
    }

    // 未找到任何可支持的日志库时判断依据：当JDK Logging的配置文件位于classpath中，使用JDK Logging，否则使用Console
    final URL url = ResourceUtil.getResource("logging.properties");
    return (null != url) ? new JdkLogFactory() : new ConsoleLogFactory();
  }

  /**
   * 获取日志框架名，用于打印当前所用日志框架
   *
   * @return 日志框架名
   * @since 4.1.21
   */
  public String getName() {
    return this.name;
  }

  /**
   * 获得日志对象
   *
   * @param name 日志对象名
   * @return 日志对象
   */
  public com.dahuatech.hutool.log.Log getLog(String name) {
    com.dahuatech.hutool.log.Log log = logCache.get(name);
    if (null == log) {
      log = createLog(name);
      logCache.put(name, log);
    }
    return log;
  }

  /**
   * 获得日志对象
   *
   * @param clazz 日志对应类
   * @return 日志对象
   */
  public com.dahuatech.hutool.log.Log getLog(Class clazz) {
    com.dahuatech.hutool.log.Log log = logCache.get(clazz);
    if (null == log) {
      log = createLog(clazz);
      logCache.put(clazz, log);
    }
    return log;
  }

  /**
   * 创建日志对象
   *
   * @param name 日志对象名
   * @return 日志对象
   */
  public abstract com.dahuatech.hutool.log.Log createLog(String name);

  /**
   * 创建日志对象
   *
   * @param clazz 日志对应类
   * @return 日志对象
   */
  public abstract com.dahuatech.hutool.log.Log createLog(Class clazz);

  /**
   * 检查日志实现是否存在

   * 此方法仅用于检查所提供的日志相关类是否存在，当传入的日志类类不存在时抛出ClassNotFoundException

   * 此方法的作用是在detectLogFactory方法自动检测所用日志时，如果实现类不存在，调用此方法会自动抛出异常，从而切换到下一种日志的检测。
   *
   * @param logClassName 日志实现相关类
   */
  protected void checkLogExist(Class logClassName) {
    // 不做任何操作
  }
  // ------------------------------------------------------------------------- Static end
}