手把手教你從零設(shè)計(jì)一個(gè)java日志框架

更新時(shí)間：2021年02月15日 23:46:34 作者：空無(wú)

Java里的各種日志框架，相信大家都不陌生。Log4j/Log4j2/Logback/jboss logging等等，其實(shí)這些日志框架核心結(jié)構(gòu)沒(méi)什么區(qū)別，只是細(xì)節(jié)實(shí)現(xiàn)上和其性能上有所不同。本文帶你從零開(kāi)始，一步一步的設(shè)計(jì)一個(gè)日志框架

輸出內(nèi)容 - LoggingEvent

提到日志框架，最容易想到的核心功能，那就是輸出日志了。那么對(duì)于一行日志內(nèi)容來(lái)說(shuō)，應(yīng)該至少包含以下幾個(gè)信息：

日志時(shí)間戳
線程信息
日志名稱(chēng)（一般是全類(lèi)名）
日志級(jí)別
日志主體（需要輸出的內(nèi)容，比如info（str））

為了方便的管理輸出內(nèi)容，現(xiàn)在需要?jiǎng)?chuàng)建一個(gè)輸出內(nèi)容的類(lèi)來(lái)封裝這些信息：

public class LoggingEvent {
 public long timestamp;//日志時(shí)間戳
 private int level;//日志級(jí)別
 private Object message;//日志主題
 private String threadName;//線程名稱(chēng)
 private long threadId;//線程id
 private String loggerName;//日志名稱(chēng)
 
 //getter and setters...
 
 @Override
 public String toString() {
  return "LoggingEvent{" +
    "timestamp=" + timestamp +
    ", level=" + level +
    ", message=" + message +
    ", threadName='" + threadName + '\'' +
    ", threadId=" + threadId +
    ", loggerName='" + loggerName + '\'' +
    '}';
 }
}

對(duì)于每一次日志打印，應(yīng)該屬于一次輸出的“事件-Event”，所以這里命名為L(zhǎng)oggingEvent

輸出組件 - Appender

有了輸出內(nèi)容之后，現(xiàn)在需要考慮輸出方式。輸出的方式可以有很多：標(biāo)準(zhǔn)輸出/控制臺(tái)（Standard Output/Console）、文件（File）、郵件（Email）、甚至是消息隊(duì)列（MQ）和數(shù)據(jù)庫(kù)。

現(xiàn)在將輸出功能抽象成一個(gè)組件“輸出器” - Appender，這個(gè)Appender組件的核心功能就是輸出，下面是Appender的實(shí)現(xiàn)代碼：

public interface Appender {
 void append(LoggingEvent event);
}

不同的輸出方式，只需要實(shí)現(xiàn)Appender接口做不同的實(shí)現(xiàn)即可，比如ConsoleAppender - 輸出至控制臺(tái)

public class ConsoleAppender implements Appender {
 private OutputStream out = System.out;
 private OutputStream out_err = System.err;

 @Override
 public void append(LoggingEvent event) {
  try {
   out.write(event.toString().getBytes(encoding));
  } catch (IOException e) {
   e.printStackTrace();
  }
 }
}

日志級(jí)別設(shè)計(jì) - Level

日志框架還應(yīng)該提供日志級(jí)別的功能，程序在使用時(shí)可以打印不同級(jí)別的日志，還可以根據(jù)日志級(jí)別來(lái)調(diào)整那些日志可以顯示，一般日志級(jí)別會(huì)定義為以下幾種，級(jí)別從左到右排序，只有大于等于某級(jí)別的LoggingEvent才會(huì)進(jìn)行輸出

ERROR > WARN > INFO > DEBUG > TRACE
現(xiàn)在來(lái)創(chuàng)建一個(gè)日志級(jí)別的枚舉，只有兩個(gè)屬性，一個(gè)級(jí)別名稱(chēng)，一個(gè)級(jí)別數(shù)值（方便做比較）

public enum Level {
 ERROR(40000, "ERROR"), WARN(30000, "WARN"), INFO(20000, "INFO"), DEBUG(10000, "DEBUG"), TRACE(5000, "TRACE");

 private int levelInt;
 private String levelStr;

 Level(int i, String s) {
  levelInt = i;
  levelStr = s;
 }

 public static Level parse(String level) {
  return valueOf(level.toUpperCase());
 }

 public int toInt() {
  return levelInt;
 }

 public String toString() {
  return levelStr;
 }

 public boolean isGreaterOrEqual(Level level) {
  return levelInt>=level.toInt();
 }

}

日志級(jí)別定義完成之后，再將LoggingEvent中的日志級(jí)別替換為這個(gè)Level枚舉

public class LoggingEvent {
 public long timestamp;//日志時(shí)間戳
 private Level level;//替換后的日志級(jí)別
 private Object message;//日志主題
 private String threadName;//線程名稱(chēng)
 private long threadId;//線程id
 private String loggerName;//日志名稱(chēng)
 
 //getter and setters...
}

現(xiàn)在基本的輸出方式和輸出內(nèi)容都已經(jīng)基本完成，下一步需要設(shè)計(jì)日志打印的入口，畢竟有入口才能打印嘛

日志打印入口 - Logger

現(xiàn)在來(lái)考慮日志打印入口如何設(shè)計(jì)，作為一個(gè)日志打印的入口，需要包含以下核心功能：

提供error/warn/info/debug/trace幾個(gè)打印的方法
擁有一個(gè)name屬性，用于區(qū)分不同的logger
調(diào)用appender輸出日志
擁有自己的專(zhuān)屬級(jí)別（比如自身級(jí)別為INFO，那么只有INFO/WARN/ERROR才可以輸出）

先來(lái)簡(jiǎn)單創(chuàng)建一個(gè)Logger接口，方便擴(kuò)展

public interface Logger{
 void trace(String msg);
 void info(String msg);
 void debug(String msg);
 void warn(String msg);
 void error(String msg);
 String getName();
}

再創(chuàng)建一個(gè)默認(rèn)的Logger實(shí)現(xiàn)類(lèi)：

public class LogcLogger implements Logger{
 private String name;
 private Appender appender;
 private Level level = Level.TRACE;//當(dāng)前Logger的級(jí)別，默認(rèn)最低
 private int effectiveLevelInt;//冗余級(jí)別字段，方便使用
 
 @Override
 public void trace(String msg) {
  filterAndLog(Level.TRACE,msg);
 }

 @Override
 public void info(String msg) {
  filterAndLog(Level.INFO,msg);
 }

 @Override
 public void debug(String msg) {
  filterAndLog(Level.DEBUG,msg);
 }

 @Override
 public void warn(String msg) {
  filterAndLog(Level.WARN,msg);
 }

 @Override
 public void error(String msg) {
  filterAndLog(Level.ERROR,msg);
 }
 
 /**
  * 過(guò)濾并輸出，所有的輸出方法都會(huì)調(diào)用此方法
  * @param level 日志級(jí)別
  * @param msg 輸出內(nèi)容
  */
 private void filterAndLog(Level level,String msg){
  LoggingEvent e = new LoggingEvent(level, msg,getName());
  //目標(biāo)的日志級(jí)別大于當(dāng)前級(jí)別才可以輸出
  if(level.toInt() >= effectiveLevelInt){
   appender.append(e);
  }
 }
 
 @Override
 public String getName() {
  return name;
 }
 
 //getters and setters...
}

好了，到現(xiàn)在為止，現(xiàn)在已經(jīng)完成了一個(gè)最最最基本的日志模型，可以創(chuàng)建Logger，輸出不同級(jí)別的日志。不過(guò)顯然還不太夠，還是缺少一些核心功能

日志層級(jí) - Hierarchy

一般在使用日志框架時(shí)，有一個(gè)很基本的需求：不同包名的日志使用不同的輸出方式，或者不同包名下類(lèi)的日志使用不同的日志級(jí)別，比如我想讓框架相關(guān)的DEBUG日志輸出，便于調(diào)試，其他默認(rèn)用INFO級(jí)別。

而且在使用時(shí)并不希望每次創(chuàng)建Logger都引用一個(gè)Appender，這樣也太不友好了；最好是直接使用一個(gè)全局的Logger配置，同時(shí)還支持特殊配置的Logger，且這個(gè)配置需要讓程序中創(chuàng)建Logger時(shí)無(wú)感（比如LoggerFactory.getLogger(XXX.class)）

可上面現(xiàn)有的設(shè)計(jì)可無(wú)法滿足這個(gè)需求，需要稍加改造

現(xiàn)在設(shè)計(jì)一個(gè)層級(jí)結(jié)構(gòu)，每一個(gè)Logger擁有一個(gè)Parent Logger，在filterAndLog時(shí)優(yōu)先使用自己的Appender，如果自己沒(méi)有Appender，那么就向上調(diào)用父類(lèi)的appnder，有點(diǎn)反向“雙親委派（parents delegate）”的意思

上圖中的Root Logger，就是全局默認(rèn)的Logger，默認(rèn)情況下它是所有Logger（新創(chuàng)建的）的Parent Logger。所以在filterAndLog時(shí)，默認(rèn)都會(huì)使用Root Logger的appender和level來(lái)進(jìn)行輸出

現(xiàn)在將filterAndLog方法調(diào)整一下，增加向上調(diào)用的邏輯：

private LogcLogger parent;//先給增加一個(gè)parent屬性

private void filterAndLog(Level level,String msg){
 LoggingEvent e = new LoggingEvent(level, msg,getName());
 //循環(huán)向上查找可用的logger進(jìn)行輸出
 for (LogcLogger l = this;l != null;l = l.parent){
  if(l.appender == null){
   continue;
  }
  if(level.toInt()>effectiveLevelInt){
   l.appender.append(e);
  }
  break;
 }
}

好了，現(xiàn)在這個(gè)日志層級(jí)的設(shè)計(jì)已經(jīng)完成了，不過(guò)上面提到不同包名使用不同的logger配置，還沒(méi)有做到，包名和logger如何實(shí)現(xiàn)對(duì)應(yīng)呢？

其實(shí)很簡(jiǎn)單，只需要為每個(gè)包名的配置單獨(dú)定義一個(gè)全局Logger，在解析包名配置時(shí)直接為不同的包名

日志上下文 - LoggerContext

考慮到有一些全局的Logger，和Root Logger需要被各種Logger引用，所以得設(shè)計(jì)一個(gè)Logger容器，用來(lái)存儲(chǔ)這些Logger

/**
 * 一個(gè)全局的上下文對(duì)象
 */
public class LoggerContext {

 /**
  * 根logger
  */
 private Logger root;

 /**
  * logger緩存，存放解析配置文件后生成的logger對(duì)象，以及通過(guò)程序手動(dòng)創(chuàng)建的logger對(duì)象
  */
 private Map<String,Logger> loggerCache = new HashMap<>();

 public void addLogger(String name,Logger logger){
  loggerCache.put(name,logger);
 }

 public void addLogger(Logger logger){
  loggerCache.put(logger.getName(),logger);
 }
 //getters and setters...
}

有了存放Logger對(duì)象們的容器，下一步可以考慮創(chuàng)建Logger了

日志創(chuàng)建 - LoggerFactory

為了方便的構(gòu)建Logger的層級(jí)結(jié)構(gòu)，每次new可不太友好，現(xiàn)在創(chuàng)建一個(gè)LoggerFactory接口

public interface ILoggerFactory {
 //通過(guò)class獲取/創(chuàng)建logger
 Logger getLogger(Class<?> clazz);
 //通過(guò)name獲取/創(chuàng)建logger
 Logger getLogger(String name);
 //通過(guò)name創(chuàng)建logger
 Logger newLogger(String name);
}

再來(lái)一個(gè)默認(rèn)的實(shí)現(xiàn)類(lèi)

public class StaticLoggerFactory implements ILoggerFactory {

 private LoggerContext loggerContext;//引用LoggerContext

 @Override
 public Logger getLogger(Class<?> clazz) {
  return getLogger(clazz.getName());
 }

 @Override
 public Logger getLogger(String name) {
  Logger logger = loggerContext.getLoggerCache().get(name);
  if(logger == null){
   logger = newLogger(name);
  }
  return logger;
 }
 
 /**
  * 創(chuàng)建Logger對(duì)象
  * 匹配logger name，拆分類(lèi)名后和已創(chuàng)建（包括配置的）的Logger進(jìn)行匹配
  * 比如當(dāng)前name為com.aaa.bbb.ccc.XXService，那么name為com/com.aaa/com.aaa.bbb/com.aaa.bbb.ccc
  * 的logger都可以作為parent logger，不過(guò)這里需要順序拆分，優(yōu)先匹配“最近的”
  * 在這個(gè)例子里就會(huì)優(yōu)先匹配com.aaa.bbb.ccc這個(gè)logger，作為自己的parent
  *
  * 如果沒(méi)有任何一個(gè)logger匹配，那么就使用root logger作為自己的parent
  *
  * @param name Logger name
  */
 @Override
 public Logger newLogger(String name) {
  LogcLogger logger = new LogcLogger();
  logger.setName(name);
  Logger parent = null;
  //拆分包名，向上查找parent logger
  for (int i = name.lastIndexOf("."); i >= 0; i = name.lastIndexOf(".",i-1)) {
   String parentName = name.substring(0,i);
   parent = loggerContext.getLoggerCache().get(parentName);
   if(parent != null){
    break;
   }
  }
  if(parent == null){
   parent = loggerContext.getRoot();
  }
  logger.setParent(parent);
  logger.setLoggerContext(loggerContext);
  return logger;
 }
}

再來(lái)一個(gè)靜態(tài)工廠類(lèi)，方便使用：

public class LoggerFactory {

 private static ILoggerFactory loggerFactory = new StaticLoggerFactory();

 public static ILoggerFactory getLoggerFactory(){
  return loggerFactory;
 }

 public static Logger getLogger(Class<?> clazz){
  return getLoggerFactory().getLogger(clazz);
 }

 public static Logger getLogger(String name){
  return getLoggerFactory().getLogger(name);
 }
}

至此，所有基本組件已經(jīng)完成，剩下的就是裝配了

配置文件設(shè)計(jì)

配置文件需至少需要有以下幾個(gè)配置功能：

配置Appender
配置Logger
配置Root Logger

下面是一份最小配置的示例

<configuration>

 <appender name="std_plain" class="cc.leevi.common.logc.appender.ConsoleAppender">
 </appender>

 <logger name="cc.leevi.common.logc">
  <appender-ref ref="std_plain"/>
 </logger>

 <root level="trace">
  <appender-ref ref="std_pattern"/>
 </root>
</configuration>

除了XML配置，還可以考慮增加YAML/Properties等形式的配置文件，所以這里需要將解析配置文件的功能抽象一下，設(shè)計(jì)一個(gè)Configurator接口，用于解析配置文件：

public interface Configurator {
 void doConfigure();
}

再創(chuàng)建一個(gè)默認(rèn)的XML形式的配置解析器：

public class XMLConfigurator implements Configurator{
 
 private final LoggerContext loggerContext;
 
 public XMLConfigurator(URL url, LoggerContext loggerContext) {
  this.url = url;//文件url
  this.loggerContext = loggerContext;
 }
 
 @Override
 public void doConfigure() {
  try{
   DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
   DocumentBuilder documentBuilder = factory.newDocumentBuilder();
   Document document = documentBuilder.parse(url.openStream());
   parse(document.getDocumentElement());
   ...
  }catch (Exception e){
   ...
  }
 }
 private void parse(Element document) throws IllegalAccessException, ClassNotFoundException, InstantiationException {
  //do parse...
 }
}

解析時(shí)，裝配LoggerContext，將配置中的Logger/Root Logger/Appender等信息構(gòu)建完成，填充至傳入的LoggerContext

現(xiàn)在還需要一個(gè)初始化的入口，用于加載/解析配置文件，提供加載/解析后的全局LoggerContext

public class ContextInitializer {
 final public static String AUTOCONFIG_FILE = "logc.xml";//默認(rèn)使用xml配置文件
 final public static String YAML_FILE = "logc.yml";

 private static final LoggerContext DEFAULT_LOGGER_CONTEXT = new LoggerContext();
 
 /**
 * 初始化上下文
 */
 public static void autoconfig() {
  URL url = getConfigURL();
  if(url == null){
   System.err.println("config[logc.xml or logc.yml] file not found!");
   return ;
  }
  String urlString = url.toString();
  Configurator configurator = null;

  if(urlString.endsWith("xml")){
   configurator = new XMLConfigurator(url,DEFAULT_LOGGER_CONTEXT);
  }
  if(urlString.endsWith("yml")){
   configurator = new YAMLConfigurator(url,DEFAULT_LOGGER_CONTEXT);
  }
  configurator.doConfigure();
 }

 private static URL getConfigURL(){
  URL url = null;
  ClassLoader classLoader = ContextInitializer.class.getClassLoader();
  url = classLoader.getResource(AUTOCONFIG_FILE);
  if(url != null){
   return url;
  }
  url = classLoader.getResource(YAML_FILE);
  if(url != null){
   return url;
  }
  return null;
 }
 
 /**
 * 獲取全局默認(rèn)的LoggerContext
 */
 public static LoggerContext getDefautLoggerContext(){
  return DEFAULT_LOGGER_CONTEXT;
 }
}

現(xiàn)在還差一步，將加載配置文件的方法嵌入LoggerFactory，讓LoggerFactory.getLogger的時(shí)候自動(dòng)初始化，來(lái)改造一下StaticLoggerFactory：

public class StaticLoggerFactory implements ILoggerFactory {

 private LoggerContext loggerContext;

 public StaticLoggerFactory() {
  //構(gòu)造StaticLoggerFactory時(shí)，直接調(diào)用配置解析的方法，并獲取loggerContext
  ContextInitializer.autoconfig();
  loggerContext = ContextInitializer.getDefautLoggerContext();
 }
}

現(xiàn)在，一個(gè)日志框架就已經(jīng)基本完成了。雖然還有很多細(xì)節(jié)沒(méi)有完善，但主體功能都已經(jīng)包含，麻雀雖小五臟俱全