建站
咨詢
售后
建站咨詢
新聞中心
日志對(duì)于開發(fā)來說是非常重要的，不管是調(diào)試數(shù)據(jù)查看、bug問題追蹤定位、數(shù)據(jù)信息收集統(tǒng)計(jì)，日常工作運(yùn)行維護(hù)等等，都大量的使用到，本篇文章重點(diǎn)為大家講解一下開源日志庫Logger架構(gòu)。
成都創(chuàng)新互聯(lián)公司是網(wǎng)站建設(shè)技術(shù)企業(yè)，為成都企業(yè)提供專業(yè)的網(wǎng)站建設(shè)、成都網(wǎng)站建設(shè)，網(wǎng)站設(shè)計(jì)，網(wǎng)站制作，網(wǎng)站改版等技術(shù)服務(wù)。擁有10年豐富建站經(jīng)驗(yàn)和眾多成功案例，為您定制適合企業(yè)的網(wǎng)站。10年品質(zhì)，值得信賴！
庫的整體架構(gòu)圖
詳細(xì)剖析
我們從使用的角度來對(duì)Logger庫抽繭剝絲：
String userName = "Jerry";
Logger.i(userName);
看看Logger.i()這個(gè)方法：
public static void i(String message, Object... args) {
printer.i(message, args);
}
還有個(gè)可變參數(shù)，來看看printer.i(message, args)是啥：
public Interface Printer{
void i(String message, Object... args);
}
是個(gè)接口，那我們就要找到這個(gè)接口的實(shí)現(xiàn)類，找到printer對(duì)象在Logger類中聲明的地方：
private static Printer printer = new LoggerPrinter();
實(shí)現(xiàn)類是LoggerPrinter，而且這還是個(gè)靜態(tài)的成員變量，這個(gè)靜態(tài)是有用處的，后面會(huì)講到，那就繼續(xù)跟蹤LoggerPrinter類的i(String message, Object… args)方法的實(shí)現(xiàn)：
@Override public void i(String message, Object... args) {
log(INFO, null, message, args);
}
/**
* This method is synchronized in order to avoid messy of logs' order. */ private synchronized void log(int priority, Throwable throwable, String msg, Object... args) { // 判斷當(dāng)前設(shè)置的日志級(jí)別，為NONE則不打印日志 if (settings.getLogLevel() == LogLevel.NONE) { return; } // 獲取tag String tag = getTag(); // 創(chuàng)建打印的消息 String message = createMessage(msg, args); // 打印 log(priority, tag, message, throwable); } public enum LogLevel { /** * Prints all logs */ FULL, /** * No log will be printed */ NONE } 首先，log方法是一個(gè)線程安全的同步方法，為了防止日志打印時(shí)候順序的錯(cuò)亂，在多線程環(huán)境下，這是非常有必要的。 其次，判斷日志配置的打印級(jí)別，F(xiàn)ULL打印全部日志，NONE不打印日志。 再來，getTag()：
private final ThreadLocal
localTag = new ThreadLocal(); /** * @
return the appropriate tag based on
local or global */ private String
getTag() { // 從ThreadLocal
localTag里獲取本地一個(gè)緩存的tag String tag = localTag.get();
if (tag != null) { localTag.remove();
return tag; }
return this.tag; }
這個(gè)方法是獲取本地或者全局的tag值，當(dāng)localTag中有tag的時(shí)候就返回出去，并且清空localTag的值，關(guān)于ThreadLocal還不是很清楚的可以參考主席的文章：http://blog.csdn.net/singwhat…
接著，createMessage方法：
private String createMessage(String message, Object... args) {
return args == null || args.length == 0 ? message : String.format(message, args);
}
這里就很清楚了，為什么我們用Logger.i(message, args)的時(shí)候沒有寫args，也就是null，也可以打印，而且是直接打印的message消息的原因。同樣博主上一篇文章也提到了：
Logger.i("博主今年才%d，英文名是%s", 16, "Jerry");
像這樣的可以拼接不同格式的數(shù)據(jù)的打印日志，原來實(shí)現(xiàn)的方式是用String.format方法，這個(gè)想必小伙伴們?cè)陂_發(fā)Android應(yīng)用的時(shí)候String.xml里的動(dòng)態(tài)字符占位符用的也不少，應(yīng)該很容易理解這個(gè)format方法的用法。
重頭戲，我們把tag，打印級(jí)別，打印的消息處理好了，接下來該打印出來了：
@Override public synchronized void log(int priority, String tag, String message, Throwable throwable) {
// 同樣判斷一次庫配置的打印開關(guān)，為NONE則不打印日志
if (settings.getLogLevel() == LogLevel.NONE) {
return;
}
// 異常和消息不為空的時(shí)候，獲取異常的原因轉(zhuǎn)換成字符串后拼接到打印的消息中
if (throwable != null && message != null) {
message += " : " + Helper.getStackTraceString(throwable);
}
if (throwable != null && message == null) {
message = Helper.getStackTraceString(throwable);
}
if (message == null) {
message = "No message/exception is set";
}
// 獲取方法數(shù)
int methodCount = getMethodCount();
// 判斷消息是否為空
if (Helper.isEmpty(message)) {
message = "Empty/NULL log message";
}
// 打印日志體的上邊界
logTopBorder(priority, tag);
// 打印日志體的頭部內(nèi)容
logHeaderContent(priority, tag, methodCount);
//get bytes of message with system's default charset (which is UTF-8 for Android) byte[] bytes = message.getBytes(); int length = bytes.length; // 消息字節(jié)長度小于等于4000 if (length 0) { // 方法數(shù)大于0，打印出分割線 logDivider(priority, tag); } // 打印消息內(nèi)容 logContent(priority, tag, message); // 打印日志體底部邊界 logBottomBorder(priority, tag); return; } if (methodCount > 0) { logDivider(priority, tag); } for (int i = 0; i s default charset (which is UTF-8 for Android) logContent(priority, tag, new String(bytes, i, count)); } logBottomBorder(priority, tag); } 我們重點(diǎn)來看看logHeaderContent方法和logContent方法：
@SuppressWarnings("StringBufferReplaceableByString")
private void logHeaderContent(int logType, String tag, int methodCount) {
// 獲取當(dāng)前線程堆棧跟蹤元素?cái)?shù)組
//（里面存儲(chǔ)了虛擬機(jī)調(diào)用的方法的一些信息：方法名、類名、調(diào)用此方法在文件中的行數(shù)）
// 這也是這個(gè)庫的 “核心”
StackTraceElement[] trace = Thread.currentThread().getStackTrace();
// 判斷庫的配置是否顯示線程信息
if (settings.isShowThreadInfo()) {
// 獲取當(dāng)前線程的名稱，并且打印出來，然后打印分割線
logChunk(logType, tag, HORIZONTAL_DOUBLE_LINE + "Thread: " + Thread.currentThread().getName()); logDivider(logType, tag);
}
String level = "";
// 獲取追蹤棧的方法起始位置
int stackOffset = getStackOffset(trace) + settings.getMethodOffset();
//corresponding method count with the current stack may exceeds the stack trace. Trims the count
// 打印追蹤的方法數(shù)超過了當(dāng)前線程能夠追蹤的方法數(shù)，總的追蹤方法數(shù)扣除偏移量(從調(diào)用日志的起算扣除的方法數(shù))，就是需要打印的方法數(shù)量
if (methodCount + stackOffset > trace.length) {
methodCount = trace.length - stackOffset - 1;
}
for (int i = methodCount; i > 0; i--) {
int stackIndex = i + stackOffset;
if (stackIndex >= trace.length) {
continue;
}
// 拼接方法堆棧調(diào)用路徑追蹤字符串
StringBuilder builder = new StringBuilder();
builder.append("U ")
.append(level)
.append(getSimpleClassName(trace[stackIndex].getClassName())) // 追蹤到的類名
.append(".")
.append(trace[stackIndex].getMethodName()) // 追蹤到的方法名
.append(" ")
.append(" (")
.append(trace[stackIndex].getFileName()) // 方法所在的文件名
.append(":")
.append(trace[stackIndex].getLineNumber()) // 在文件中的行號(hào)
.append(")");
level += " ";
// 打印出頭部信息
logChunk(logType, tag, builder.toString());
}
}
接下來看logContent方法：
private void logContent(int logType, String tag, String chunk) {
// 這個(gè)作用就是獲取換行符數(shù)組，getProperty方法獲取的就是"http://n"的意思
String[] lines = chunk.split(System.getProperty("line.separator"));
for (String line : lines) {
// 打印出包含換行符的內(nèi)容
logChunk(logType, tag, HORIZONTAL_DOUBLE_LINE + " " + line);
}
}
如上圖來說內(nèi)容是字符串?dāng)?shù)組，本身里面是沒用換行符的，所以不需要換行，打印出來的效果就是一行，但是json、xml這樣的格式是有換行符的，所以打印呈現(xiàn)出來的效果就是：
上面說了大半天，都還沒看到具體的打印是啥，現(xiàn)在來看看logChunk方法：
private void logChunk(int logType, String tag, String chunk) {
// 最后格式化下tag
String finalTag = formatTag(tag);
// 根據(jù)不同的日志打印類型，然后交給LogAdapter這個(gè)接口來打印
switch (logType) {
case ERROR:
settings.getLogAdapter().e(finalTag, chunk);
break;
case INFO:
settings.getLogAdapter().i(finalTag, chunk);
break;
case VERBOSE:
settings.getLogAdapter().v(finalTag, chunk);
break;
case WARN:
settings.getLogAdapter().w(finalTag, chunk);
break;
case ASSERT:
settings.getLogAdapter().wtf(finalTag, chunk);
break;
case DEBUG:
// Fall through, log debug by default
default:
settings.getLogAdapter().d(finalTag, chunk);
break;
}
}
這個(gè)方法很簡單，就是最后格式化tag，然后根據(jù)不同的日志類型把打印的工作交給LogAdapter接口來處理，我們來看看settings.getLogAdapter()這個(gè)方法(Settings.java文件)：
public LogAdapter getLogAdapter() {
if (logAdapter == null) {
// 最終的實(shí)現(xiàn)類是AndroidLogAdapter
logAdapter = new AndroidLogAdapter();
}
return logAdapter;
}
找到AndroidLogAdapter類：
原來繞了一大圈，最終打印還是使用了：系統(tǒng)的Log。
好了Logger日志框架的源碼解析完了，有沒有更清晰呢，也許小伙伴會(huì)說這個(gè)最終的日志打印，我不想用系統(tǒng)的Log，是不是可以換呢。這是自然的，看開篇的那種整體架構(gòu)圖，這個(gè)LogAdapter是個(gè)接口，只要實(shí)現(xiàn)這個(gè)接口，里面做你自己想要打印的方式，然后通過Settings 的logAdapter(LogAdapter logAdapter)方法設(shè)置進(jìn)去就可以。
以上就是博主分析一個(gè)開源庫的思路，從使用的角度出發(fā)抽繭剝絲，基本上一個(gè)庫的核心部分都能搞懂。畫畫整個(gè)框架的大概類圖，對(duì)分析庫非常有幫助，每一個(gè)輪子都有值得學(xué)習(xí)的地方，吸收了就是進(jìn)步的開始，耐心的分析完一個(gè)庫，還是非常有成就感的。
分享標(biāo)題：開源日志庫Logger架構(gòu)詳解
分享網(wǎng)址：http://m.fisionsoft.com.cn/article/djhjehg.html
