Trojan是一個(gè)穩(wěn)定高效的移動(dòng)端輕量級(jí)日志SDK贪婉,穩(wěn)定運(yùn)行于餓了么物流多個(gè)產(chǎn)品線上户辱,已無(wú)bug。既可以記錄通用日志疏哗,比如網(wǎng)絡(luò)請(qǐng)求呛讲、電量變化、頁(yè)面生命周期返奉,也可以記錄自定義的日志圣蝎,從而可以通過(guò)用戶(hù)日志來(lái)幫助我們定位分析問(wèn)題。具有以下特點(diǎn):
- 簡(jiǎn)潔的 API衡瓶,通過(guò)幾行代碼就可以接入徘公,實(shí)現(xiàn)日記記錄功能;
- 使用 AOP 技術(shù) Lancet 框架插樁收集通用日志哮针,并且支持增量編譯关面;
- 使用 mmap 技術(shù),保證日記記錄的高效性十厢;
- 擴(kuò)展性高等太,開(kāi)發(fā)者可以自定義日志文件的上傳功能;
- 流量開(kāi)銷(xiāo)小蛮放,支持在線配置缩抡,遠(yuǎn)程控制用戶(hù)日志文件上傳與否;
- 穩(wěn)定性高包颁,目前已穩(wěn)定運(yùn)行在餓了么物流團(tuán)隊(duì)眾包等多個(gè) APP 上瞻想。
綜述
在開(kāi)源的 Trojan SDK中,目前采集了 Activity 和 Fragment 生命周期娩嚼,View Click 事件蘑险,網(wǎng)絡(luò)狀態(tài)變化,手機(jī)電量狀態(tài)變化等基礎(chǔ)日志岳悟,還通過(guò) AOP 技術(shù)插樁 KLog采集 Log 日志佃迄,要是項(xiàng)目中未使用 KLog,也可以根據(jù)項(xiàng)目情況具體定制贵少『乔危考慮到每個(gè)項(xiàng)目中網(wǎng)絡(luò)模塊的實(shí)現(xiàn)框架都不盡相同,有 OkHttp滔灶、Volley普碎、Android-Async-Http 等等,所以采集網(wǎng)絡(luò)日志這一部分不方便統(tǒng)一處理宽气,需要使用者通過(guò) Lancet 插樁具體網(wǎng)絡(luò)框架來(lái)收集日志随常。在 Demo 中具體以 OkHttp 為例,實(shí)現(xiàn)采集 Http request 和 response 的功能萄涯,可作為參考绪氛。而與業(yè)務(wù)相關(guān)的日志,需要使用者自己采集涝影。
配置
在根目錄的 build.gradle 添加:
buildscript {
dependencies {
.......
classpath 'me.ele:lancet-plugin:1.0.2'
}
}
在 app 目錄的 'build.gradle' 添加:
apply plugin: 'me.ele.lancet'
dependencies {
......
provided 'me.ele:lancet-base:1.0.2'
compile 'me.ele:trojan-library:0.0.4'
}
使用
1. 初始化
在自定義的 Application
添加:
TrojanConfig config = new TrojanConfig.Builder(this)
// Set user information
.userInfo("xxxx")
// Set device id
.deviceId("xxxx")
// Set cipher key if need encry log
.cipherKey("xxxx")
// Optional, save log file in sdcard by default
.logDir("xxxx")
// Console log switch, the default is open
.enableLog(true)
.build();
Trojan.init(config);
特別說(shuō)明:
- 日志文件默認(rèn)保存在 sdcard 中枣察,即使應(yīng)用被卸載,也不會(huì)丟失日志燃逻;
- 為兼容多進(jìn)程序目,避免文件相互干擾,日志文件保存在各自的目錄下伯襟,目錄以進(jìn)程名來(lái)命名猿涨;
- 默認(rèn)情況下日志不加密,考慮到加密的高效性姆怪,目前僅提供TEA加密方式叛赚,解密工具仍在探索中,敬請(qǐng)期待稽揭。
2. 記錄日志
Trojan 提供兩種方式記錄日志:
第一種:
Trojan.log("Trojan", "We have a nice day!");
第二種:
List<String> msgList = new LinkedList<>();
msgList.add("Hello Trojan!");
msgList.add("We have a nice day!");
msgList.add("Hello world!");
Trojan.log("Trojan", msgList);
默認(rèn)情況下俺附,對(duì)于單行日志不加密,如果需要加密溪掀,則使用如下:
Trojan.log("Trojan", "We have a nice day!", true);
3. 用戶(hù)信息
當(dāng)用戶(hù)信息發(fā)生改變或者切換用戶(hù)時(shí)事镣,可以調(diào)用:
Trojan.refreshUser("new user info");
當(dāng)然了,要是用戶(hù)登出揪胃,可以傳空值璃哟,即表示登出操作:
Trojan.refreshUser(null);
4. 上傳方案
針對(duì)日志上傳,在 Demo 中提供了 LeanCloud 這種免費(fèi)簡(jiǎn)單的方式喊递,可以實(shí)現(xiàn)上傳沮稚、瀏覽、下載等文件服務(wù)的基本功能册舞,可供參考蕴掏。
備注
通過(guò)集成 Trojan,可以輕松實(shí)現(xiàn)用戶(hù)日志的記錄功能调鲸,是不是很簡(jiǎn)單呀盛杰!要是對(duì) Lancet 的使用有疑問(wèn),大家可以參考 https://github.com/eleme/lancet/blob/dev/README_zh.md藐石,這里就不贅述即供。
最后
非常歡迎大家使用并且star,要是有任何疑問(wèn)于微,可以留言或者提issues逗嫡!非常感謝您的關(guān)注青自!