已經(jīng)有很久沒有更新文章了你雌，我想做過客戶端開發(fā)的應(yīng)該都有干過數(shù)據(jù)埋點(diǎn)的事吧，其實(shí)我之前一直在思考怎么讓數(shù)據(jù)埋點(diǎn)更優(yōu)雅二汛，好在最近有了新的想法匪蝙，所以分享出來給大家一起參考參考。
有人說我的之前文章很些難懂习贫，需要一些知識基礎(chǔ)，所以這次我把涉及的知識點(diǎn)先說明一下：
- 了解 Gradle 自定義插件的 Transform
- 了解 AOP 概念
- 最好有使用過 Mocktio 或類似的其他測試框架
本文目錄
1. 目前大部分?jǐn)?shù)據(jù)埋點(diǎn)的實(shí)現(xiàn)方式
2. 它們各自的優(yōu)點(diǎn)和缺點(diǎn)
3. 新的思考與探索
4. 著手實(shí)現(xiàn)
目前大部分?jǐn)?shù)據(jù)埋點(diǎn)的實(shí)現(xiàn)方式
首先千元，先分享一下目前我所知道的苫昌，絕大多數(shù)的數(shù)據(jù)埋點(diǎn)的實(shí)現(xiàn)方式，無外乎兩種：
其一幸海，是直接寫在源代碼中祟身，也許這些代碼經(jīng)過了封裝，可能只有一行物独，但總歸是要寫在源代碼中的
其二袜硫，使用 AOP，利用 AspectJ 工具將數(shù)據(jù)埋點(diǎn)的字節(jié)碼插入到源代碼中挡篓，我本身是非惩裣荩看好這種辦法帚称，但真正使用起來，卻的確有諸多不方便的地方秽澳。
它們各自的優(yōu)點(diǎn)和缺點(diǎn)
先說傳統(tǒng)的直接寫入源碼的方式闯睹，這的確是最容易最省力的實(shí)現(xiàn)方法了，直接在源碼中我們可以非常輕松的拿到上下文信息担神，包括內(nèi)部對象等等楼吃，但同時缺點(diǎn)也很明顯，這樣實(shí)現(xiàn)的埋點(diǎn)代碼分布分散妄讯，不易統(tǒng)一管理孩锡，試想一下萬一想移除或者更換埋點(diǎn)的實(shí)現(xiàn)，工作量不可謂不小亥贸。
所以很快就有了第二種的實(shí)現(xiàn)了躬窜，利用AOP，我們可以把代碼動態(tài)的插入的想要插入的地方砌函，這樣我們可以把所有的數(shù)據(jù)埋點(diǎn)代碼寫在統(tǒng)一的一個地方斩披，待到編譯時自動的插入到它們本該存在的位置。但你真的這樣做了讹俊，你就會發(fā)現(xiàn)垦沉，有時候數(shù)據(jù)埋點(diǎn)是需要上下文信息的，比如當(dāng)前類中的一個私有變量的值仍劈，比如某個函數(shù)的參數(shù)是什么等等厕倍。對于這個問題，AspectJ 也有其解決方案贩疙，它提供了某些語法來獲取之：
@AfterReturning(
pointcut="execution(* com.abc.service.*.access*(..)) && args(time, name)",
returning="returnValue")
在我看來讹弯，這雖然能解決問題，但是明顯對于沒有接觸過 AspectJ 的人語法來說这溅，這無法需要增加一些前期學(xué)習(xí)的成本组民，在團(tuán)隊(duì)開發(fā)中，這種成本愈發(fā)顯得格外的大悲靴。而且臭胜，不僅如此，我們還可以注意到癞尚，這些語法最終需要以字符串的形式來編寫耸三，這就是一個很大的問題了，首先我們怎么來確保寫出的語法表達(dá)式是正確的呢浇揩？難仪壮！其次，如果對應(yīng)的參數(shù)名胳徽，方法名积锅，甚至類名有重命名或包位置移動了爽彤，誰來確保該代碼還能正常工作呢？更難乏沸！ 而且錯誤的表達(dá)式并不會導(dǎo)致整個項(xiàng)目的編譯失敗淫茵，所以非常容易發(fā)生這樣的囧境。再三考慮下蹬跃，這樣的方案并不能算完美匙瘪，甚至從某些方面來說，是不穩(wěn)定的蝶缀。
新的思考與探索
現(xiàn)在我們該好好想想我們要的是什么了：
- 數(shù)據(jù)埋點(diǎn)代碼可以跟源代碼隔離
- 數(shù)據(jù)埋點(diǎn)代碼可以訪問到方法參數(shù)或類的內(nèi)部成員變量
- 方法參數(shù)或類的內(nèi)部成員變量的重命名不會影響到數(shù)據(jù)埋點(diǎn)代碼
前面說到的 AspectJ 能做的第一點(diǎn)和第二點(diǎn)丹喻，但滿足不了第三點(diǎn)。究其原因翁都，還是因?yàn)槠涫褂昧俗址愋偷恼Z法匹配規(guī)則碍论，這樣建立起來的關(guān)系是軟并且薄弱的。那用什么來替換字符串呢柄慰？這個問題我想了很久...
直到一天我看到一段 Unit Test 代碼時鳍悠，才突然有了靈感
class TestClass {
int getNumber() {
return 0;
}
}
// ...
void test() {
TestClass mockClass = Mockito.mock(TestClass.class);
doAnswer(invocation -> {
System.out.println("測試");
return -1;
}).when(mockClass).getNumber();
}
UT 的框架其實(shí)是個很好的實(shí)現(xiàn)，它既和源代碼直接有隔離坐搔，又清晰的就定位到了 TestClass.getNumber() 方法藏研，試想一下，如果我們的數(shù)據(jù)埋點(diǎn)代碼可以這么寫：
void doTrackForMainActivity() {
insertToFirst(invocation -> {
System.out.println("數(shù)據(jù)埋點(diǎn)代碼");
}).when(MainActivity.class).onCreate();
}
這么看著確實(shí)不錯概行，但很快我就發(fā)現(xiàn)蠢挡，這樣的話，只能訪問到 MainActivity 的公有方法凳忙，這想在私有方法中埋點(diǎn)的需求就完成不了业踏。
所以盡管我很喜歡這個方案，但最終還是不得不放棄它涧卵。
看起來要想在私有方法中插入數(shù)據(jù)埋點(diǎn)勤家，還是只能通過字符串來指明方法了，那就應(yīng)該想辦法自動生成這些字符串柳恐，像這樣：
- Segment.kt
fun doTrackForMainActivity() {
insertToFirst(object : TrackTask {
override fun doTrack(target: Any, methodArgs: Array<out Any>?) {
System.out.println("數(shù)據(jù)埋點(diǎn)代碼");
}
}).with(MainActivitySt.`fun$onCreate$Bundle`)
}
- MainActivity.kt
class MainActivity : Activity() {
private val field = "I'm private field"
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
setContentView(R.layout.activity_main)
}
}
- MainActivitySt.kt
// Auto-Generated by Segment-plugin.
// method num: 1
public final class MainActivitySt {
public static final TargetMethod fun$onCreate$Bundle = new TargetMethod("com.segment.demo.MainActivity", "onCreate", Arrays.asList(android.os.Bundle.class));
}
像這樣的曲線救國好像也不錯...還有最后一個問題却紧，在數(shù)據(jù)埋點(diǎn)中對類中私有內(nèi)部成員的使用。
對于這個問題胎撤，我們也可以同樣使用自動生成的對象來處理：
- 改造后的 MainActivitySt.kt
// Auto-Generated by Segment-plugin.
// method num: 1
// field num: 1
public final class MainActivitySt {
public static final TargetMethod fun$onCreate$Bundle = new TargetMethod(MainActivity.class, "onCreate", Arrays.asList(android.os.Bundle.class));
public static final TargetClassField<java.lang.String> field$field = new TargetClassField<>(MainActivity.class, java.lang.String.class, "field");
}
之后，我們的數(shù)據(jù)埋點(diǎn)就可以這樣寫了：
fun doTrackForMainActivity() {
insertToFirst(object : TrackTask {
override fun doTrack(target: Any, methodArgs: Array<out Any>?) {
println("數(shù)據(jù)埋點(diǎn)代碼")
println(MainActivitySt.`field$field`.get())
}
}).with(MainActivitySt.`fun$onCreate$Bundle`)
}
到這里應(yīng)該算是完成了我們整個數(shù)據(jù)埋點(diǎn)框架的最初想法和大概思路了断凶。
著手實(shí)現(xiàn)
在剛剛重新的思考與設(shè)計(jì)中伤提，我們用到的幾個比較關(guān)鍵的地方分別有：
-
需要在編譯期對將數(shù)據(jù)埋點(diǎn)的代碼插入到源代碼的字節(jié)碼中
-> 可以通過自定義 Gradle 插件的 Transform 實(shí)現(xiàn) -
需要找到我們的數(shù)據(jù)埋點(diǎn)代碼
-> 可以通過使用注解標(biāo)記我們的數(shù)據(jù)埋點(diǎn)代碼 -
對目標(biāo)類生成一個含有其所有方法和私有成員的幫助類
-> 有很多這樣的工具可以實(shí)現(xiàn)，比如 Javapoet -
字節(jié)碼編輯/插入
-> 同樣有很多工具可以使用认烁，筆者喜歡使用 Javassist
到這里肿男，剩下的就只有耐心的碼代碼以及部分細(xì)節(jié)的處理了介汹。
結(jié)語
寫這篇文章只是想跟大家分享下這個思路，有興趣的同學(xué)可以按照自己的設(shè)計(jì)來實(shí)現(xiàn)下舶沛，我也會把我自己實(shí)現(xiàn)的代碼整理出來嘹承，之后會開源出來供大家參考。
