ऐप्लिकेशन ऑप्टिमाइज़ेशन की सुविधा चालू करने के लिए, आपको ऐसी लाइब्रेरी इस्तेमाल करनी होंगी जो Android ऑप्टिमाइज़ेशन के साथ काम करती हों. अगर किसी लाइब्रेरी को Android के लिए ऑप्टिमाइज़ नहीं किया गया है, तो हो सकता है कि वह Android ऐप्लिकेशन के लिए सही न हो. उदाहरण के लिए, अगर वह लाइब्रेरी, उससे जुड़े कीप रूल को बंडल किए बिना रिफ़्लेक्शन का इस्तेमाल करती है. इस पेज पर बताया गया है कि कुछ लाइब्रेरी, ऐप्लिकेशन को ऑप्टिमाइज़ करने के लिए बेहतर क्यों होती हैं. साथ ही, लाइब्रेरी चुनने में आपकी मदद करने के लिए सामान्य सलाह दी गई है.
लाइब्रेरी चुनते समय ध्यान रखने वाली सामान्य बातें
इन सुझावों का इस्तेमाल करके, यह पक्का करें कि आपकी लाइब्रेरी, ऐप्लिकेशन ऑप्टिमाइज़ेशन के साथ काम करती हों.
रिफ़्लेक्शन के बजाय कोडजेन को प्राथमिकता दें
रिफ़्लेक्शन के बजाय, कोड जनरेशन (codegen) का इस्तेमाल करने वाली लाइब्रेरी चुनें. कोड जनरेशन की मदद से, ऑप्टिमाइज़र यह तय कर सकता है कि रनटाइम के दौरान कौनसा कोड इस्तेमाल किया जा रहा है और कौनसा कोड हटाया जा सकता है. यह बताना मुश्किल हो सकता है कि कोई लाइब्रेरी, कोडजेन या रिफ़्लेक्शन का इस्तेमाल करती है या नहीं. हालांकि, इसके कुछ संकेत होते हैं. मदद पाने के लिए, सलाह देखें.
कोडजेन और रिफ़्लेक्शन के बारे में ज़्यादा जानने के लिए, लाइब्रेरी तैयार करने वालों के लिए ऑप्टिमाइज़ेशन लेख पढ़ें.
रिफ़्लेक्शन के इस्तेमाल की जांच करना (ऐडवांस)
किसी लाइब्रेरी के कोड की जांच करके, यह पता लगाया जा सकता है कि वह रिफ़्लेक्शन का इस्तेमाल करती है या नहीं. अगर लाइब्रेरी, रिफ़्लेक्शन का इस्तेमाल करती है, तो देखें कि वह डेटा बनाए रखने के लिए ज़रूरी नियम उपलब्ध कराती है या नहीं. अगर कोई लाइब्रेरी ये काम करती है, तो हो सकता है कि वह रिफ़्लेक्शन का इस्तेमाल करती हो:
kotlin.reflectयाjava.lang.reflectपैकेज की क्लास या तरीकों का इस्तेमाल करता है.Class.forNameयाclassLoader.getClassफ़ंक्शन का इस्तेमाल किया गया है.- रनटाइम के दौरान एनोटेशन को पढ़ता है. उदाहरण के लिए, अगर यह
val value = myClass.getAnnotation()याval value = myMethod.getAnnotation()का इस्तेमाल करके एनोटेशन की वैल्यू को सेव करता है और फिरvalueके साथ कुछ करता है. स्ट्रिंग के तौर पर मेथड के नाम का इस्तेमाल करके, मेथड को कॉल करता है. जैसे, इस उदाहरण में:
// Calls the private `processData` API with reflection myObject.javaClass.getMethod("processData", DataType::class.java) ?.invoke(myObject, data)
ऑप्टिमाइज़ेशन से जुड़ी समस्याओं की जांच करना
किसी नई लाइब्रेरी का इस्तेमाल करने से पहले, लाइब्रेरी के Issue Tracker और ऑनलाइन चर्चाओं को देखें. इससे आपको यह पता चलेगा कि काट-छांट करने या ऐप्लिकेशन ऑप्टिमाइज़ेशन को कॉन्फ़िगर करने से जुड़ी समस्याएं हैं या नहीं. अगर ऐसा है, तो आपको उस लाइब्रेरी के विकल्प ढूंढने चाहिए. इन बातों का ध्यान रखें:
- AndroidX लाइब्रेरी और Hilt जैसी लाइब्रेरी, ऐप्लिकेशन ऑप्टिमाइज़ेशन के साथ अच्छी तरह से काम करती हैं. इसकी वजह यह है कि वे रिफ़्लेक्शन के बजाय, ज़्यादातर codegen का इस्तेमाल करती हैं. जब वे रिफ़्लेक्शन का इस्तेमाल करते हैं, तो वे डेटा बनाए रखने के लिए कम से कम नियम उपलब्ध कराते हैं. इससे सिर्फ़ ज़रूरी कोड को बनाए रखा जाता है.
- सीरियलाइज़ेशन लाइब्रेरी, ऑब्जेक्ट को इंस्टैंशिएट या सीरियलाइज़ करते समय, छोटे-मोटे बदलाव वाले कोड से बचने के लिए अक्सर रिफ़्लेक्शन का इस्तेमाल करती हैं. रिफ़्लेक्शन पर आधारित तरीकों (जैसे, JSON के लिए Gson) के बजाय, ऐसी लाइब्रेरी ढूंढें जो इन समस्याओं से बचने के लिए codegen का इस्तेमाल करती हैं. उदाहरण के लिए, Kotlin Serialization या codegen के साथ Moshi का इस्तेमाल करें.
- अगर हो सके, तो ऐसी लाइब्रेरी का इस्तेमाल न करें जिनमें पैकेज-वाइड कीप रूल शामिल हों. पूरे पैकेज पर लागू होने वाले कीप रूल, गड़बड़ियों को ठीक करने में मदद कर सकते हैं. हालांकि, ब्रॉड कीप रूल को बेहतर बनाया जाना चाहिए, ताकि सिर्फ़ ज़रूरी कोड को सेव रखा जा सके. ज़्यादा जानकारी के लिए, ऑप्टिमाइज़ेशन को धीरे-धीरे अपनाना लेख पढ़ें.
- तीसरे पक्ष की लाइब्रेरी का इस्तेमाल करने वाले ऐप्लिकेशन को पब्लिश करने से पहले, R8 Configuration Analyzer का इस्तेमाल करके, लाइब्रेरी के 'कीप रूल' की जांच करें. रिपोर्ट की समीक्षा करके, यह पुष्टि की जा सकती है कि लाइब्रेरी के कीप रूल बहुत ज़्यादा ब्रॉड तो नहीं हैं. ऐसा होने पर, R8 आपके कोड बेस पर ज़रूरी ऑप्टिमाइज़ेशन नहीं कर पाता. इस जांच से यह पक्का होता है कि चुनी गई लाइब्रेरी, आपके ऐप्लिकेशन की परफ़ॉर्मेंस के लक्ष्यों के मुताबिक हों. साथ ही, कॉन्फ़िगरेशन में ग़ैर-ज़रूरी चीज़ें शामिल न हों.
- लाइब्रेरी के लिए, आपको दस्तावेज़ से कीप रूल को कॉपी करके अपने प्रोजेक्ट की किसी फ़ाइल में चिपकाने की ज़रूरत नहीं पड़नी चाहिए. खास तौर पर, पूरे पैकेज पर लागू होने वाले कीप रूल के लिए ऐसा करने की ज़रूरत नहीं पड़नी चाहिए. ये नियम, लंबे समय में ऐप्लिकेशन डेवलपर के लिए रखरखाव का बोझ बन जाते हैं. साथ ही, समय के साथ इन्हें ऑप्टिमाइज़ करना और इनमें बदलाव करना मुश्किल हो जाता है.
नई लाइब्रेरी जोड़ने के बाद ऑप्टिमाइज़ेशन की सुविधा चालू करना
नई लाइब्रेरी जोड़ने के बाद, ऑप्टिमाइज़ेशन की सुविधा चालू करें और देखें कि कोई गड़बड़ी तो नहीं है. अगर गड़बड़ियां हैं, तो उस लाइब्रेरी के विकल्प ढूंढें या कीप रूल लिखें. अगर कोई लाइब्रेरी ऑप्टिमाइज़ेशन के साथ काम नहीं करती है, तो उस लाइब्रेरी में गड़बड़ी की शिकायत करें.
खराब कीप रूल को फ़िल्टर करना (ऐडवांस)
डेटा सेव रखने के नियम, एक-दूसरे के साथ मिलकर काम करते हैं. इसका मतलब है कि लाइब्रेरी डिपेंडेंसी में शामिल कुछ नियमों को हटाया नहीं जा सकता. साथ ही, ये नियम आपके ऐप्लिकेशन के अन्य हिस्सों के कंपाइलेशन पर असर डाल सकते हैं. उदाहरण के लिए, अगर किसी लाइब्रेरी में कोड ऑप्टिमाइज़ेशन को बंद करने का नियम शामिल है, तो वह नियम आपके पूरे प्रोजेक्ट के लिए ऑप्टिमाइज़ेशन को बंद कर देता है.
आपको ऐसी लाइब्रेरी का इस्तेमाल करने से बचना चाहिए जिनमें ऐसे कोड को बनाए रखने के नियम हों जिन्हें असल में हटा दिया जाना चाहिए. हालांकि, अगर आपको उनका इस्तेमाल करना ही है, तो यहां दिए गए कोड के मुताबिक नियमों को फ़िल्टर किया जा सकता है:
// If you're using AGP 8.4 and higher
buildTypes {
release {
optimization.keepRules {
it.ignoreFrom("com.somelibrary:somelibrary")
}
}
}
// If you're using AGP 7.3-8.3
buildTypes {
release {
optimization.keepRules {
it.ignoreExternalDependencies("com.somelibrary:somelibrary")
}
}
}
लाइब्रेरी के लिए लागू होने वाले सामान्य नियमों के लिए सुझाया गया वर्कफ़्लो
अगर R8 कॉन्फ़िगरेशन ऐनलाइज़र से पता चलता है कि किसी लाइब्रेरी में बहुत ज़्यादा 'कीप रूल' बंडल किए गए हैं, तो उन नियमों को सिर्फ़ लोकल बिल्ड में फ़िल्टर करें, न कि प्रोडक्शन बिल्ड में. यह जांचने के लिए कि नियमों का आपके ऐप्लिकेशन पर कितना असर पड़ता है, यह तरीका अपनाएं:
- लाइब्रेरी अपडेट करें: पक्का करें कि आपके पास उस लाइब्रेरी का नया वर्शन हो जिसे R8 कॉन्फ़िगरेशन ऐनलाइज़र ने फ़्लैग किया है. ऐसा इसलिए, क्योंकि नए वर्शन में, उपभोक्ता के लिए 'कीप रूल' ज़्यादा सटीक हो सकते हैं. नया वर्शन ढूंढने के लिए, लाइब्रेरी के दस्तावेज़ या उसकी Maven रिपॉज़िटरी देखें. Android Studio, कई डिपेंडेंसी के नए वर्शन को भी फ़्लैग करता है. अपडेट करने के बाद, R8 कॉन्फ़िगरेशन ऐनलाइज़र को फिर से चलाएं. इससे यह पता चलेगा कि ब्रॉड कीप रूल अब भी मौजूद हैं या नहीं.
- लोकल लेवल पर संभावित सुधार देखें: लाइब्रेरी के बंडल किए गए उपभोक्ता नियमों को अपनी लोकल कीप नियमों की फ़ाइल में कॉपी करें. इसके बाद, बंडल किए गए नियमों को फ़िल्टर करें, जैसा कि खराब कीप नियमों को फ़िल्टर करें में दिखाया गया है. साथ ही, कॉपी किए गए नियमों को छोटा करें. नियमों को सीमित करने से पहले और बाद में, R8 कॉन्फ़िगरेशन ऐनालाइज़र चलाएं. इससे, अपने ऐप्लिकेशन के छोटा होने, ऑप्टिमाइज़ेशन, और कोड को छिपाने के स्कोर की तुलना की जा सकती है.
- नतीजों की रिपोर्ट करना: लाइब्रेरी के रखरखाव करने वाले व्यक्ति को गड़बड़ी की रिपोर्ट भेजें. इसमें R8 कॉन्फ़िगरेशन ऐनलाइज़र की रिपोर्ट से मिला डेटा शामिल होना चाहिए. उदाहरण के लिए, वाइल्डकार्ड नियम की वजह से सेव की गई, बिना रेफ़रंस वाली क्लास या तरीकों की संख्या.
केस स्टडी: Gson, ऑप्टिमाइज़ेशन के साथ काम क्यों नहीं करता
Gson एक सीरियलाइज़ेशन लाइब्रेरी है. इसकी वजह से, अक्सर ऐप्लिकेशन ऑप्टिमाइज़ेशन में समस्याएं आती हैं, क्योंकि यह रिफ़्लेक्शन का बहुत ज़्यादा इस्तेमाल करती है. यहां दिए गए कोड स्निपेट में दिखाया गया है कि Gson का इस्तेमाल आम तौर पर कैसे किया जाता है. इससे रनटाइम के दौरान क्रैश हो सकते हैं. ध्यान दें कि जब User ऑब्जेक्ट की सूची पाने के लिए Gson का इस्तेमाल किया जाता है, तो कंस्ट्रक्टर को कॉल नहीं किया जाता या fromJson() फ़ंक्शन को फ़ैक्ट्री पास नहीं की जाती. ऐप्लिकेशन में तय की गई क्लास को इनमें से किसी के बिना बनाना या इस्तेमाल करना, इस बात का संकेत है कि कोई लाइब्रेरी ओपन-एंडेड रिफ़्लेक्शन का इस्तेमाल कर रही है:
- लाइब्रेरी, स्टैंडर्ड इंटरफ़ेस या क्लास को लागू करने वाली ऐप्लिकेशन क्लास
- कोड जनरेट करने वाला प्लग इन, जैसे कि KSP
class User(val name: String)
class UserList(val users: List<User>)
// This code runs in debug mode, but crashes when optimizations are enabled
Gson().fromJson("""[{"name":"myname"}]""", User::class.java).toString()
Gson पर R8 के काम करने का तरीका समझने के लिए, Gson के उपभोक्ता नियम देखें. जब R8 इस कोड का विश्लेषण करता है और उसे UserList या User कहीं भी इंस्टैंशिएट किया हुआ नहीं दिखता, तो वह फ़ील्ड का नाम बदल सकता है या उन कंस्ट्रक्टर को हटा सकता है जो इस्तेमाल नहीं किए जा रहे हैं. इससे आपका ऐप्लिकेशन क्रैश हो सकता है. अगर इसी तरह से किसी अन्य लाइब्रेरी का इस्तेमाल किया जा रहा है, तो आपको यह देखना चाहिए कि वे ऐप्लिकेशन ऑप्टिमाइज़ेशन में रुकावट न डालें. अगर वे ऐसा करती हैं, तो उनसे बचें.
Gson के नए वर्शन के साथ @SerializedName का इस्तेमाल करना
अपने डेटा मॉडल को इस तरह से तय करें कि वे Gson के उपभोक्ता नियमों के साथ काम कर सकें. इसके लिए, अपने फ़ील्ड को @SerializedName के साथ एनोटेट करें, जैसा कि इस स्निपेट में दिखाया गया है:
import com.google.gson.annotations.SerializedName
class User(@SerializedName("name") val name: String)
class UserList(@SerializedName("users") val users: List<User>)
@SerializedName एनोटेशन का इस्तेमाल करके, R8 को आपके मॉडल की क्लास को Gson के 2.11.0 और इसके बाद के वर्शन में बंडल किए गए नियमों को बनाए रखने के साथ मैच करने की अनुमति मिलती है.
R8, एनोटेट किए गए फ़ील्ड और ज़रूरी कंस्ट्रक्टर को अपने-आप सुरक्षित रखता है. इससे आपको अपने प्रोजेक्ट में ProGuard कॉन्फ़िगरेशन को मैन्युअल तरीके से मैनेज करने की ज़रूरत नहीं पड़ती. साथ ही, लाइब्रेरी के बंडल किए गए नियमों पर भरोसा किया जा सकता है.
ध्यान दें कि Room, Hilt, और Moshi with codegen, ऐप्लिकेशन के तय किए गए टाइप बनाते हैं. हालांकि, रिफ़्लेक्शन की ज़रूरत से बचने के लिए, codegen का इस्तेमाल करते हैं.