kapt से KSP में माइग्रेट करें

Kapt (Kotlin Annotation Processing Tool) की मदद से, Kotlin कोड के साथ Java व्याख्या प्रोसेसर का इस्तेमाल किया जा सकता है. भले ही, उन प्रोसेसर में Kotlin के लिए खास सहायता न हो. इसके लिए, आपकी Kotlin फ़ाइलों से Java स्टब जनरेट किए जाते हैं. इसके बाद, प्रोसेसर उन्हें पढ़ सकते हैं. स्टब जनरेट करने की प्रोसेस में काफ़ी समय लगता है. साथ ही, इससे बिल्ड की स्पीड पर काफ़ी असर पड़ता है.

केएसपी (Kotlin Symbol Processing), kapt का एक विकल्प है. इसे Kotlin के लिए बनाया गया है. केएसपी, Kotlin कोड का सीधे तौर पर विश्लेषण करता है. यह दो गुना ज़्यादा तेज़ी से काम करता है. यह Kotlin भाषा के कंस्ट्रक्ट को भी बेहतर तरीके से समझता है.

माइग्रेट करते समय, अपने प्रोजेक्ट में kapt और केएसपी को एक साथ चलाया जा सकता है. साथ ही, माइग्रेशन को मॉड्यूल के हिसाब से और लाइब्रेरी के हिसाब से किया जा सकता है.

माइग्रेशन के चरणों के बारे में खास जानकारी यहां दी गई है:

  1. केएसपी के साथ काम करने वाली लाइब्रेरी देखना
  2. अपने प्रोजेक्ट में केएसपी प्लगिन जोड़ना
  3. एनोटेशन प्रोसेसर को केएसपी से बदलना
  4. kapt प्लगिन को हटाना

केएसपी के साथ काम करने वाली लाइब्रेरी देखना

शुरू करने के लिए, देखें कि kapt के साथ इस्तेमाल की जा रही लाइब्रेरी में, केएसपी की सुविधा पहले से मौजूद है या नहीं. यह कई लोकप्रिय लाइब्रेरी के लिए सही है. इनमें Dagger, Glide, Room, और Moshi शामिल हैं. साथ ही, अन्य लाइब्रेरी भी इसके लिए सहायता जोड़ रही हैं.

दस्तावेज़ में, इस्तेमाल की जा सकने वाली लाइब्रेरी की सूची देखी जा सकती है. इसके अलावा, इस्तेमाल की जा रही लाइब्रेरी के दस्तावेज़ और समस्या ट्रैकर को भी देखा जा सकता है.

अपने प्रोजेक्ट में केएसपी प्लगिन जोड़ना

सबसे पहले, टॉप लेवल की build.gradle.kts फ़ाइल में केएसपी प्लग इन का एलान करें. KSP GitHub पेज पर, रिलीज़ की सूची देखी जा सकती है.

Kotlin

plugins {
    id("com.google.devtools.ksp") version "2.3.4" apply false
}

Groovy

plugins {
    id 'com.google.devtools.ksp' version '2.3.4' apply false
}

इसके बाद, मॉड्यूल-लेवल की build.gradle.kts फ़ाइल में केएसपी चालू करें:

Kotlin

plugins {
    id("com.google.devtools.ksp")
}

Groovy

plugins {
    id 'com.google.devtools.ksp'
}

एनोटेशन प्रोसेसर को केएसपी से बदलना

केएसपी चालू करने के बाद, kapt की जगह केएसपी का इस्तेमाल किया जा सकता है. ज़्यादातर लाइब्रेरी के लिए, डिपेंडेंसी एलान में kapt को ksp में बदलना ज़रूरी है. ऐसा इसलिए, क्योंकि वे अपने व्याख्या प्रोसेसर और केएसपी प्रोसेसर को एक ही आर्टफ़ैक्ट में शिप करती हैं.

उनके दस्तावेज़ ज़रूर देखें.

Kotlin

dependencies {
    kapt("androidx.room:room-compiler:2.5.0")
    ksp("androidx.room:room-compiler:2.5.0")
}

Groovy

dependencies {
    kapt 'androidx.room:room-compiler:2.5.0'
    ksp 'androidx.room:room-compiler:2.5.0'
}

केएसपी पर माइग्रेट करने के बाद, अपने प्रोजेक्ट को सिंक करें और बिल्ड करें. इससे यह पता चलेगा कि वह अब भी सही तरीके से काम कर रहा है या नहीं.

यहां कुछ ऐसी ही वीडियो कैटगरी के बारे में बताया गया है:

  • कुछ लाइब्रेरी में, kapt और केएसपी के साथ सुविधाओं का एक जैसा सेट काम नहीं करता. अगर माइग्रेट करने के बाद आपका कोड काम नहीं करता है, तो लाइब्रेरी का दस्तावेज़ देखें.
  • केएसपी के पास, kapt की तुलना में Kotlin टाइप की ज़्यादा सटीक जानकारी होती है. उदाहरण के लिए, शून्यता के बारे में. इसका मतलब है कि केएसपी प्रोसेसर, टाइप की ज़रूरी शर्तों के बारे में ज़्यादा सटीक जानकारी दे सकते हैं. इसके लिए, आपको अपनी बिल्ड फ़ाइलों को अपडेट करने के साथ-साथ, अपने सोर्स कोड में भी कुछ बदलाव करने पड़ सकते हैं.
  • अगर आपने पहले व्याख्या प्रोसेसर को आर्ग्युमेंट पास किए थे, तो हो सकता है कि अब आपको वे आर्ग्युमेंट केएसपी को पास करने पड़ें. ध्यान दें कि kapt और केएसपी के बीच आर्ग्युमेंट का फ़ॉर्मैट अलग-अलग हो सकता है. केएसपी के दस्तावेज़ देखें. साथ ही, ज़्यादा जानने के लिए, उस लाइब्रेरी के दस्तावेज़ देखें जिसका इस्तेमाल किया जा रहा है.

kapt प्लगिन को हटाना

जब आपके मॉड्यूल में kapt के साथ कोई डिपेंडेंसी शामिल न हो, तो kapt प्लगिन को हटा दें.

अगर इसे प्लगिन ब्लॉक में एलान किया गया था, तो:

Kotlin

plugins {
    id("org.jetbrains.kotlin.kapt")
}

Groovy

plugins {
    id 'org.jetbrains.kotlin.kapt'
}

अगर Groovy का इस्तेमाल करके, apply plugin सिंटैक्स का इस्तेमाल किया जा रहा था, तो:

apply plugin: 'kotlin-kapt'

आपको kapt से जुड़ा कोई भी बचा हुआ कॉन्फ़िगरेशन भी हटा देना चाहिए, जैसे कि:

Kotlin


kapt {
    correctErrorTypes = true
    useBuildCache = true
}

Groovy


kapt {
    correctErrorTypes true
    useBuildCache true
}

अन्य संसाधन