自拍偷在线精品自拍偷,亚洲欧美中文日韩v在线观看不卡

開源日志庫Logger的剖析

開源
上一篇介紹了開源日志庫Logger的使用,今天主要來分析Logger實現(xiàn)的原理。

上一篇介紹了開源日志庫Logger的使用,今天主要來分析Logger實現(xiàn)的原理。

庫的整體架構圖

 詳細剖析

我們從使用的角度來對Logger庫抽繭剝絲:

  1. String userName = "Jerry"
  2. Logger.i(userName);  

看看Logger.i()這個方法: 

  1. public static void i(String message, Object... args) {       
  2.     printer.i(message, args); 
  3.  

還有個可變參數(shù),來看看printer.i(message, args)是啥:

  1. public Interface Printer{ 
  2.     void i(String message, Object... args); 

 是個接口,那我們就要找到這個接口的實現(xiàn)類,找到printer對象在Logger類中聲明的地方: 

  1. private static Printer printer = new LoggerPrinter(); 

實現(xiàn)類是LoggerPrinter,而且這還是個靜態(tài)的成員變量,這個靜態(tài)是有用處的,后面會講到,那就繼續(xù)跟蹤LoggerPrinter類的i(String message, Object... args)方法的實現(xiàn): 

  1. @Override public void i(String message, Object... args) {   
  2.     log(INFO, null, message, args); 
  3. /**  
  4. * This method is synchronized in order to avoid messy of logs' order.  
  5. */ 
  6. private synchronized void log(int priority, Throwable throwable, String msg, Object... args) { 
  7.     // 判斷當前設置的日志級別,為NONE則不打印日志   
  8.     if (settings.getLogLevel() == LogLevel.NONE) {     
  9.         return;   
  10.     } 
  11.     // 獲取tag 
  12.     String tag = getTag();  
  13.     // 創(chuàng)建打印的消息 
  14.     String message = createMessage(msg, args);       
  15.     // 打印 
  16.     log(priority, tag, message, throwable); 
  17.  
  18. public enum LogLevel {   
  19.     /**    
  20.     * Prints all logs    
  21.     */   
  22.     FULL,   
  23.     /**    
  24.     * No log will be printed    
  25.     */   
  26.     NONE 
  27.  
  • 首先,log方法是一個線程安全的同步方法,為了防止日志打印時候順序的錯亂,在多線程環(huán)境下,這是非常有必要的。
  • 其次,判斷日志配置的打印級別,F(xiàn)ULL打印全部日志,NONE不打印日志。
  • 再來,getTag(): 
    1. private final ThreadLocal<String> localTag = new ThreadLocal<>(); 
    2. /**  
    3. * @return the appropriate tag based on local or global */ 
    4. private String getTag() {   
    5.     // 從ThreadLocal<String> localTag里獲取本地一個緩存的tag 
    6.     String tag = localTag.get();   
    7.     if (tag != null) {     
    8.         localTag.remove();     
    9.         return tag;   
    10.     }   
    11.     return this.tag; 
    12.  

這個方法是獲取本地或者全局的tag值,當localTag中有tag的時候就返回出去,并且清空localTag的值,關于ThreadLocal還不是很清楚的可以參考主席的文章:http://blog.csdn.net/singwhat...

接著,createMessage方法: 

  1. private String createMessage(String message, Object... args) {  
  2.     return args == null || args.length == 0 ? message : String.format(message, args); 

 這里就很清楚了,為什么我們用Logger.i(message, args)的時候沒有寫args,也就是null,也可以打印,而且是直接打印的message消息的原因。同樣博主上一篇文章也提到了: 

  1. Logger.i("博主今年才%d,英文名是%s", 16, "Jerry"); 

像這樣的可以拼接不同格式的數(shù)據的打印日志,原來實現(xiàn)的方式是用String.format方法,這個想必小伙伴們在開發(fā)Android應用的時候String.xml里的動態(tài)字符占位符用的也不少,應該很容易理解這個format方法的用法。

重頭戲,我們把tag,打印級別,打印的消息處理好了,接下來該打印出來了: 

  1. @Override public synchronized void log(int priority, String tag, String message, Throwable throwable) { 
  2.     // 同樣判斷一次庫配置的打印開關,為NONE則不打印日志 
  3.     if (settings.getLogLevel() == LogLevel.NONE) {     
  4.         return;   
  5.     } 
  6.     // 異常和消息不為空的時候,獲取異常的原因轉換成字符串后拼接到打印的消息中   
  7.     if (throwable != null && message != null) {     
  8.         message += " : " + Helper.getStackTraceString(throwable);   
  9.     }   
  10.     if (throwable != null && message == null) {     
  11.         message = Helper.getStackTraceString(throwable);   
  12.     }   
  13.     if (message == null) {     
  14.         message = "No message/exception is set";   
  15.     }   
  16.     // 獲取方法數(shù) 
  17.     int methodCount = getMethodCount();  
  18.     // 判斷消息是否為空  
  19.     if (Helper.isEmpty(message)) {     
  20.         message = "Empty/NULL log message";   
  21.     }   
  22.     // 打印日志體的上邊界 
  23.     logTopBorder(priority, tag); 
  24.     // 打印日志體的頭部內容   
  25.     logHeaderContent(priority, tag, methodCount);   
  26.     //get bytes of message with system's default charset (which is UTF-8 for Android)   
  27.     byte[] bytes = message.getBytes();   
  28.     int length = bytes.length;   
  29.     // 消息字節(jié)長度小于等于4000 
  30.     if (length <= CHUNK_SIZE) {     
  31.         if (methodCount > 0) {   
  32.             // 方法數(shù)大于0,打印出分割線     
  33.             logDivider(priority, tag);     
  34.         }     
  35.         // 打印消息內容 
  36.         logContent(priority, tag, message); 
  37.         // 打印日志體底部邊界 
  38.         logBottomBorder(priority, tag);     
  39.         return;   
  40.     }   
  41.     if (methodCount > 0) {     
  42.         logDivider(priority, tag);   
  43.     }   
  44.     for (int i = 0; i < length; i += CHUNK_SIZE) {     
  45.         int count = Math.min(length - i, CHUNK_SIZE); 
  46.         //create a new String with system's default charset (which is UTF-8 for Android)     
  47.         logContent(priority, tag, new String(bytes, i, count));   
  48.     }   
  49.     logBottomBorder(priority, tag); 

 我們重點來看看logHeaderContent方法和logContent方法: 

  1. @SuppressWarnings("StringBufferReplaceableByString"
  2. private void logHeaderContent(int logType, String tag, int methodCount) {   
  3.   // 獲取當前線程堆棧跟蹤元素數(shù)組 
  4.   //(里面存儲了虛擬機調用的方法的一些信息:方法名、類名、調用此方法在文件中的行數(shù)) 
  5.   // 這也是這個庫的 “核心” 
  6.   StackTraceElement[] trace = Thread.currentThread().getStackTrace(); 
  7.   // 判斷庫的配置是否顯示線程信息   
  8.   if (settings.isShowThreadInfo()) { 
  9.       // 獲取當前線程的名稱,并且打印出來,然后打印分割線     
  10.       logChunk(logType, tag, HORIZONTAL_DOUBLE_LINE + "Thread: " + Thread.currentThread().getName());    logDivider(logType, tag);   
  11.   }   
  12.   String level = "";   
  13.   // 獲取追蹤棧的方法起始位置 
  14.   int stackOffset = getStackOffset(trace) + settings.getMethodOffset();   
  15.   //corresponding method count with the current stack may exceeds the stack trace. Trims the count   
  16.   // 打印追蹤的方法數(shù)超過了當前線程能夠追蹤的方法數(shù),總的追蹤方法數(shù)扣除偏移量(從調用日志的起算扣除的方法數(shù)),就是需要打印的方法數(shù)量 
  17.   if (methodCount + stackOffset > trace.length) {     
  18.       methodCount = trace.length - stackOffset - 1;   
  19.   }   
  20.   for (int i = methodCount; i > 0; i--) {    
  21.       int stackIndex = i + stackOffset;     
  22.       if (stackIndex >= trace.length) {       
  23.           continue;     
  24.       }     
  25.       // 拼接方法堆棧調用路徑追蹤字符串 
  26.       StringBuilder builder = new StringBuilder();  
  27.       builder.append("║ ")         
  28.       .append(level)      
  29.       .append(getSimpleClassName(trace[stackIndex].getClassName()))  // 追蹤到的類名 
  30.       .append(".")  
  31.       .append(trace[stackIndex].getMethodName())  // 追蹤到的方法名       
  32.       .append(" ")         
  33.       .append(" (")        
  34.       .append(trace[stackIndex].getFileName()) // 方法所在的文件名 
  35.       .append(":")         
  36.       .append(trace[stackIndex].getLineNumber())  // 在文件中的行號       
  37.       .append(")");     
  38.       level += "   ";     
  39.       // 打印出頭部信息 
  40.       logChunk(logType, tag, builder.toString());  
  41.   } 

 接下來看logContent方法: 

  1. private void logContent(int logType, String tag, String chunk) {   
  2.     // 這個作用就是獲取換行符數(shù)組,getProperty方法獲取的就是"\\n"的意思 
  3.     String[] lines = chunk.split(System.getProperty("line.separator"));   
  4.     for (String line : lines) {     
  5.         // 打印出包含換行符的內容 
  6.         logChunk(logType, tag, HORIZONTAL_DOUBLE_LINE + " " + line);   
  7.     } 

 如上圖來說內容是字符串數(shù)組,本身里面是沒用換行符的,所以不需要換行,打印出來的效果就是一行,但是json、xml這樣的格式是有換行符的,所以打印呈現(xiàn)出來的效果就是:

 上面說了大半天,都還沒看到具體的打印是啥,現(xiàn)在來看看logChunk方法: 

  1. private void logChunk(int logType, String tag, String chunk) { 
  2.     // ***格式化下tag   
  3.     String finalTag = formatTag(tag);   
  4.     // 根據不同的日志打印類型,然后交給LogAdapter這個接口來打印 
  5.     switch (logType) {     
  6.         case ERROR:       
  7.             settings.getLogAdapter().e(finalTag, chunk);       
  8.         break;     
  9.         case INFO:       
  10.             settings.getLogAdapter().i(finalTag, chunk);       
  11.         break;     
  12.         case VERBOSE:       
  13.             settings.getLogAdapter().v(finalTag, chunk);       
  14.         break;     
  15.         case WARN:       
  16.             settings.getLogAdapter().w(finalTag, chunk);       
  17.         break;    
  18.         case ASSERT:       
  19.             settings.getLogAdapter().wtf(finalTag, chunk);       
  20.         break;     
  21.         case DEBUG:       
  22.             // Fall through, log debug by default     
  23.         default:             
  24.             settings.getLogAdapter().d(finalTag, chunk);       
  25.         break;   
  26.     } 
  27.  

這個方法很簡單,就是***格式化tag,然后根據不同的日志類型把打印的工作交給LogAdapter接口來處理,我們來看看settings.getLogAdapter()這個方法(Settings.java文件): 

  1. public LogAdapter getLogAdapter() {   
  2.     if (logAdapter == null) { 
  3.         // 最終的實現(xiàn)類是AndroidLogAdapter 
  4.         logAdapter = new AndroidLogAdapter();   
  5.     }   
  6.     return logAdapter; 
  7.  

找到AndroidLogAdapter類:

 原來繞了一大圈,最終打印還是使用了:系統(tǒng)的Log。

好了Logger日志框架的源碼解析完了,有沒有更清晰呢,也許小伙伴會說這個最終的日志打印,我不想用系統(tǒng)的Log,是不是可以換呢。這是自然的,看開篇的那種整體架構圖,這個LogAdapter是個接口,只要實現(xiàn)這個接口,里面做你自己想要打印的方式,然后通過Settings 的logAdapter(LogAdapter logAdapter)方法設置進去就可以。

以上就是博主分析一個開源庫的思路,從使用的角度出發(fā)抽繭剝絲,基本上一個庫的核心部分都能搞懂。畫畫整個框架的大概類圖,對分析庫非常有幫助,每一個輪子都有值得學習的地方,吸收了就是進步的開始,耐心的分析完一個庫,還是非常有成就感的。

感謝你耐心看完,以后博主還會繼續(xù)努力分析其它輪子的。

責任編輯:龐桂玉 來源: segmentfault
相關推薦

2016-09-22 19:31:30

開源日志庫Logger

2012-12-03 10:44:00

開源

2010-02-05 15:33:29

Android JDK

2012-07-10 16:22:01

開源架構

2010-02-04 11:05:56

ibmdw虛擬化

2019-11-27 14:41:50

Java技術語言

2009-10-28 13:44:40

linux庫文件路徑

2010-02-03 11:26:28

2019-04-22 15:40:33

2024-10-23 16:06:50

2010-04-21 11:43:33

Oracle數(shù)據庫

2010-01-07 18:03:03

Linux動態(tài)庫

2018-09-27 11:25:07

開源日志聚合

2019-01-30 18:00:21

開源Python庫

2021-08-10 08:52:15

微軟GCToolkit工具

2010-05-31 17:56:27

2010-05-20 18:05:38

2010-04-12 15:17:40

dump Oracle

2016-12-06 10:39:54

剖析建模開源工具

2009-06-05 09:45:44

Struts優(yōu)缺點開源
點贊
收藏

51CTO技術棧公眾號