使用指南

提供更聰明的保留規則:程式庫供應商如何解除應用程式層級 DEX 程式碼最佳化限制

閱讀時間:6 分鐘
查看 Breana Tate 的個人資料
Breana Tate 開發人員關係工程師

身為 Android 應用程式和程式庫開發人員,我們都致力於達成同一個目標:打造高效能應用程式,提供流暢的使用者體驗。其中一項重要工作是使用 Android 的應用程式最佳化工具 R8。R8 會移除未使用的程式碼,並最佳化及模糊處理其餘程式碼,藉此提升應用程式效能。

Google Play 最近宣布應用程式和遊戲的新 DEX 程式碼最佳化門檻,有助於縮短啟動時間、減少記憶體用量,並符合 Android 的承諾,避免應用程式使用過多記憶體,影響使用者體驗。雖然這些門檻適用於應用程式和遊戲,但達到門檻是整個生態系統的共同責任。R8 只能在指定的參數範圍內最佳化應用程式,包括應用程式依賴的程式庫所綁定的保留規則。

R8 設定分析器是評估應用程式最佳化、縮減和模糊處理百分比的絕佳工具,這些都是 Google Play 技術相關規定的核心。除了追蹤這些百分比外,R8 設定分析工具也會找出效率不佳的保留規則,這些規則可能來自應用程式,也可能來自應用程式依附程式庫中隨附的消費者保留規則。

本指南將說明如何解決程式庫供應商最常遇到的問題,並提供精確、高效能的規則,協助客戶符合 Google Play 技術相關規定。

什麼是消費者保留規則?

消費者保留規則是 Android 或 JAR 程式庫中隨附的指令,可指示 R8 在應用程式層級編譯過程中,哪些程式庫程式碼可能無法最佳化。應用程式或程式庫在壓縮構件時,會使用標準保留規則,而消費者保留規則則內嵌在程式庫中,會影響程式庫在整個應用程式最佳化期間的壓縮方式,確保內部反射目標和原生介面保持不變,應用程式開發人員不必手動識別。

刻意縮小範圍的消費者保留規則是一項重要的最佳做法,對程式庫和使用程式庫的應用程式都有好處。過於廣泛的消費者保留規則會保留未使用的程式碼,進而影響應用程式的最佳化和效能。DEX 程式碼最佳化洞察資料已加入 Play 管理中心,應用程式開發人員看到的指標,代表應用程式和整合程式庫規則的綜合影響。

兼顧穩定性和效能

程式庫供應商通常會出於善意,提供廣泛的消費者保留規則。沒有人希望 SDK 在反射期間因類別移除而觸發當機。

不過,我們不建議將套件範圍或其他廣泛的保留規則做為防止當機的長期解決方案,因為這會嚴重限制 R8 的全程式應用程式最佳化潛力。以下提供幾項建議策略,協助您在不影響穩定性的情況下,推出精細的高效能規則:

1. 測試及推出範圍較小的規則

為確保您能安心發布精確規則,請參考下列最佳做法:

  • 在範例應用程式中測試:測試最佳化中的本機測試指南也適用於範例應用程式。啟用 R8 後,請測試關鍵使用者歷程,確保功能正常運作。
  • 在範例應用程式上執行 R8 設定分析器,瞭解應用程式開發人員在稽核 R8 設定時會看到什麼。您可以輕鬆查看保留規則對下游應用程式的影響。
  • 使用 Android CLI 的 analyze 指令,評估 AAR 或 JAR 的最佳化,包括保留的方法、類別和欄位。您可以比較不同版本的這些數據,監控是否有迴歸問題。
  • 在 Google Play SDK 管理中心監控程式庫版本使用情形和當機事件。
  • 請參閱程式庫作者最佳化指南和 R8 說明文件,瞭解最佳做法。

2. 保留反射和 JNI 目標,不使用廣泛的保留規則

如果程式庫採用廣泛或套件層級的保留規則,不僅會影響 SDK,還會迫使開發人員接受程式碼膨脹,導致應用程式啟動時間變慢,並增加應用程式下載大小、記憶體用量和 ANR 發生率。此外,注重效能的應用程式也可能編寫自訂規則,取代程式庫隨附的規則,這也會降低這些應用程式採用未來程式庫更新的意願,以降低風險。

如果 SDK 指定原生程式碼 (例如遊戲或相片和影片編輯器中的程式碼),請為所有使用 JNI 的類別提供規則。大多數遊戲都是在 Unity 和 Unreal 等遊戲引擎上執行,這些引擎會將遊戲編譯為原生程式碼。遊戲原生程式碼和外掛程式會透過 JNI 呼叫與 Android 架構通訊。

Jetpack Keep 註解目前處於 Alpha 版階段,可讓您為反射用法加上註解,並在建構時產生保留規則,減少反射所需的維護作業。

考慮使用程式碼生成而非反射

如要避免因反射而當機,最有效的做法是避免使用反射,並盡可能使用 codegen。

執行階段反射會在編譯期間向 R8 隱藏程式碼用量,因此需要保留規則,以免發生當機。如果使用程式碼產生功能,程式碼會在建構過程中最佳化,讓 R8 具備必要瀏覽權限,能以最少的保留規則安全地最佳化程式碼。適合使用程式碼生成的常見情境包括序列化和反序列化,以及依附元件插入 (Hilt 是使用程式碼生成的程式庫範例)。

不過,程式碼產生功能並非適用於所有情境。對於選用依附元件等模式,仍須使用反射。建議您將反射與精確的保留規則搭配使用,只保護必要的進入點,如反射以支援選用依附元件指南所述。

縮小規則範圍,即使是預先最佳化的程式庫建構作業也一樣

如果無法避免反射,請確保消費者保留規則僅指定程式庫反射的內容。程式庫動態存取類別或方法時,您只需要指定進入點,R8 就會處理其餘部分。R8 會使用進入點建構參照程式碼的圖表,並移除任何未參照的類別、方法和欄位。

如果您已最佳化或模糊化程式庫建構作業,也適用這項做法,這有助於確保 SDK 效能良好且輕量。由於規則會在應用程式編譯步驟中套用,R8 仍可根據下游應用程式使用的實際類別和方法,進一步最佳化程式庫。Android CLI 分析指令會主動顯示已使用和未使用的套件層級保留規則,這些規則會導致最佳化作業受阻。

縮小第三方依附元件的保留規則範圍

我們發現的常見模式如下:

-keep public class com.google.android.gms.** { *; }

如果整合 SDK 的應用程式也使用其他 GMS 程式庫,並包含保留規則來限制保留的程式碼量,這項廣泛規則會取代該規則,導致應用程式不必要地膨脹。

叫用外部程式庫時,請設計保留規則,嚴格保留程式庫透過反射存取的特定元素。此外,事實上許多程式庫 (包括 GMS) 都已提供自己的消費者保留規則,因此導入套件層級的保留規則,也可能涵蓋下游程式庫中精心編寫、範圍狹窄的消費者規則。

考慮為廣告中介服務轉接程式設定條件式保留規則

如果廣告程式庫是使用中介服務轉接程式載入,您仍可使用精確保留規則。在這種情況下,建議您使用條件式保留規則,只有在應用程式包含對應的轉接器時,才保留特定功能或格式。這樣一來,R8 仍可縮減應用程式未使用的功能。此外,您也可以使用 Jetpack Keep 註解,直接在原始碼中註解反射呼叫,並自動產生條件式消費者保留規則 (包括選用外掛程式模組),而不必手動編寫複雜的規則。

在消費者規則中提供規則,而非說明文件

在程式庫中提供消費者規則,可確保啟用 R8 建構作業的應用程式能直接使用程式庫,並發揮最大最佳化效果。

在說明文件中指定規則會增加手動設定的阻礙 (特別是 AAR 和 JAR 多年來都支援組合消費者保留規則),並產生持續維護的負擔。更新程式庫時 (包括重構、重新命名類別,以及變更反射的使用方式),請務必更新說明文件,應用程式也必須檢查是否有新規則。隨著時間推移,應用程式會升級多個程式庫版本,可能會累積不再需要的舊版保留規則,導致應用程式不必要地膨脹。

3. 讀取發布堆疊追蹤

您可能會因為程式碼經過模糊處理,而遇到無法讀取的堆疊追蹤。為了順利進行重要分析,您可能會想使用 keepnames,因為這項工具允許縮減,但會禁止其他最佳化作業,例如在消費者應用程式中重新命名,也就是偵錯堆疊追蹤時所需的精確值。

您不需要為了取得可讀的堆疊追蹤,而阻止其他最佳化作業。

Firebase Crashlytics、Play 管理中心和 Android Studio 中的 Logcat 會為應用程式開發人員反模糊處理堆疊追蹤。也就是說,如果應用程式開發人員與您共用堆疊追蹤,您不必停用模糊處理,就能讀取堆疊追蹤。

將對應檔上傳到 SDK 管理中心後,您就能在 SDK 管理中心查看去模糊化的堆疊追蹤。

不必再憑空臆測最佳化成效

最佳化媒體庫不應該像是在玩試誤遊戲。

只要維護消費者保留規則,程式庫供應商就能確保整個生態系統中的應用程式都能順利進行最佳化。

程式庫提供的規則越好,應用程式就越小、越快。立即開始稽核消費者保留規則,協助依附於程式庫的應用程式發揮最佳效能。

作者:
繼續閱讀