Android इंटरफ़ेस डेफ़िनिशन लैंग्वेज (एआईडीएल)

Android इंटरफ़ेस डेफ़िनिशन लैंग्वेज (एआईडीएल), अन्य आईडीएल की तरह ही है: इसकी मदद से, प्रोग्रामिंग इंटरफ़ेस को तय किया जा सकता है. क्लाइंट और सेवा, दोनों ही इस इंटरफ़ेस का इस्तेमाल करके, इंटरप्रोसेस कम्यूनिकेशन (आईपीसी) के ज़रिए एक-दूसरे से कम्यूनिकेट कर सकते हैं.

Android पर, आम तौर पर एक प्रोसेस दूसरी प्रोसेस की मेमोरी को ऐक्सेस नहीं कर सकती. बात करने के लिए, उन्हें अपने ऑब्जेक्ट को प्रिमिटिव में बांटना होगा, ताकि ऑपरेटिंग सिस्टम उन्हें समझ सके और आपके लिए उस सीमा के पार ऑब्जेक्ट को मार्शल कर सके. मार्शलिंग करने के लिए कोड लिखना मुश्किल होता है. इसलिए, Android इसे AIDL की मदद से आपके लिए मैनेज करता है.

ध्यान दें: एआईडीएल की ज़रूरत सिर्फ़ तब होती है, जब आपको अलग-अलग ऐप्लिकेशन के क्लाइंट को आईपीसी के लिए अपनी सेवा ऐक्सेस करने की अनुमति देनी हो. साथ ही, आपको अपनी सेवा में मल्टीथ्रेडिंग को मैनेज करना हो. अगर आपको अलग-अलग ऐप्लिकेशन के बीच एक साथ आईपीसी करने की ज़रूरत नहीं है, तो Binder को लागू करके अपना इंटरफ़ेस बनाएं. अगर आपको आईपीसी का इस्तेमाल करना है, लेकिन मल्टीथ्रेडिंग को मैनेज करने की ज़रूरत नहीं है, तो Messenger का इस्तेमाल करके अपना इंटरफ़ेस लागू करें. हालांकि, एआईडीएल लागू करने से पहले, सीमित सेवाओं के बारे में अच्छी तरह से जान लें.

एआईडीएल इंटरफ़ेस को डिज़ाइन करने से पहले, यह ध्यान रखें कि एआईडीएल इंटरफ़ेस को किए जाने वाले कॉल, डायरेक्ट फ़ंक्शन कॉल होते हैं. उस थ्रेड के बारे में अनुमान न लगाएं जिसमें कॉल होता है. कॉल लोकल प्रोसेस के थ्रेड से किया गया है या रिमोट प्रोसेस से, इसके आधार पर अलग-अलग नतीजे मिलते हैं:

  • लोकल प्रोसेस से किए गए कॉल, उसी थ्रेड में एक्ज़ीक्यूट होते हैं जिससे कॉल किया जा रहा है. अगर यह आपका मुख्य यूज़र इंटरफ़ेस (यूआई) थ्रेड है, तो वह थ्रेड एआईडीएल इंटरफ़ेस में चलता रहेगा. अगर यह कोई दूसरा थ्रेड है, तो यह सेवा में आपके कोड को लागू करता है. इसलिए, अगर सिर्फ़ लोकल थ्रेड सेवा को ऐक्सेस कर रहे हैं, तो आपके पास यह कंट्रोल करने का पूरा अधिकार होता है कि उसमें कौनसे थ्रेड चल रहे हैं. हालांकि, अगर ऐसा है, तो एआईडीएल का बिलकुल इस्तेमाल न करें. इसके बजाय, Binder को लागू करके इंटरफ़ेस बनाएं.
  • रिमोट प्रोसेस से आने वाले कॉल, थ्रेड पूल से डिस्पैच किए जाते हैं. यह थ्रेड पूल, प्लैटफ़ॉर्म आपकी प्रोसेस के अंदर ही मैनेज करता है. अनजान थ्रेड से आने वाले इनकमिंग कॉल के लिए तैयार रहें. साथ ही, एक ही समय पर कई कॉल आ सकते हैं. दूसरे शब्दों में, एआईडीएल इंटरफ़ेस को लागू करने के लिए, थ्रेड-सेफ़ होना ज़रूरी है. एक ही रिमोट ऑब्जेक्ट पर एक थ्रेड से किए गए कॉल, रिसीवर के पास क्रम से पहुंचते हैं.
  • oneway कीवर्ड, रिमोट कॉल के व्यवहार में बदलाव करता है. इसका इस्तेमाल करने पर, रिमोट कॉल ब्लॉक नहीं होता. यह लेन-देन का डेटा भेजता है और तुरंत वापस आ जाता है. इंटरफ़ेस को लागू करने पर, आखिर में इसे Binder थ्रेड पूल से सामान्य रिमोट कॉल के तौर पर रेगुलर कॉल के तौर पर मिलता है. अगर oneway का इस्तेमाल लोकल कॉल के साथ किया जाता है, तो कोई असर नहीं पड़ता और कॉल अब भी सिंक्रोनस रहता है.

एआईडीएल इंटरफ़ेस तय करना

Java प्रोग्रामिंग लैंग्वेज सिंटैक्स का इस्तेमाल करके, .aidl फ़ाइल में अपना AIDL इंटरफ़ेस तय करें. इसके बाद, इसे सोर्स कोड में, src/ डायरेक्ट्री में सेव करें. यह डायरेक्ट्री, सेवा को होस्ट करने वाले ऐप्लिकेशन और सेवा से जुड़े किसी अन्य ऐप्लिकेशन, दोनों में मौजूद होती है.

.aidl फ़ाइल वाले हर ऐप्लिकेशन को बनाते समय, Android SDK के टूल .aidl फ़ाइल के आधार पर एक IBinder इंटरफ़ेस जनरेट करते हैं. साथ ही, उसे प्रोजेक्ट की gen/ डायरेक्ट्री में सेव करते हैं. सेवा को ज़रूरत के हिसाब से IBinder इंटरफ़ेस लागू करना चाहिए. इसके बाद, क्लाइंट ऐप्लिकेशन, सेवा से जुड़ सकते हैं और आईपीसी को पूरा करने के लिए, IBinder से मेथड को कॉल कर सकते हैं.

एआईडीएल का इस्तेमाल करके सीमित सेवा बनाने के लिए, यहां दिया गया तरीका अपनाएं. इसके बारे में यहां दिए गए सेक्शन में बताया गया है:

  1. .aidl फ़ाइल बनाना

    इस फ़ाइल में, मेथड सिग्नेचर के साथ प्रोग्रामिंग इंटरफ़ेस के बारे में बताया गया है.

  2. इंटरफ़ेस लागू करना

    Android SDK टूल, आपकी .aidl फ़ाइल के आधार पर Java प्रोग्रामिंग लैंग्वेज में एक इंटरफ़ेस जनरेट करते हैं. इस इंटरफ़ेस में Stub नाम की एक इनर ऐब्स्ट्रैक्ट क्लास होती है. यह क्लास, Binder को एक्सटेंड करती है और आपके एआईडीएल इंटरफ़ेस के तरीकों को लागू करती है. आपको Stub क्लास को एक्सटेंड करना होगा और तरीकों को लागू करना होगा.

  3. क्लाइंट को इंटरफ़ेस दिखाना

    Service को लागू करें और onBind() को बदलें, ताकि Stub क्लास को लागू करने का तरीका वापस लाया जा सके.

चेतावनी: पहली रिलीज़ के बाद, एआईडीएल इंटरफ़ेस में किए गए सभी बदलाव, पुराने सिस्टम के साथ काम करने की सुविधा के मुताबिक होने चाहिए. इससे, आपकी सेवा का इस्तेमाल करने वाले अन्य ऐप्लिकेशन को काम करने में कोई समस्या नहीं आएगी. इसका मतलब है कि आपकी .aidl फ़ाइल को अन्य ऐप्लिकेशन में कॉपी किया जाना चाहिए, ताकि वे आपकी सेवा के इंटरफ़ेस को ऐक्सेस कर सकें. इसके लिए, आपको ओरिजनल इंटरफ़ेस के लिए सहायता बनाए रखनी होगी.

.aidl फ़ाइल बनाना

एआईडीएल एक आसान सिंटैक्स का इस्तेमाल करता है. इसकी मदद से, एक या उससे ज़्यादा तरीकों वाले इंटरफ़ेस का एलान किया जा सकता है. ये तरीके, पैरामीटर ले सकते हैं और वैल्यू दिखा सकते हैं. पैरामीटर और रिटर्न वैल्यू किसी भी तरह की हो सकती हैं. यहां तक कि एआईडीएल से जनरेट किए गए अन्य इंटरफ़ेस भी हो सकते हैं.

आपको Java प्रोग्रामिंग लैंग्वेज का इस्तेमाल करके, .aidl फ़ाइल बनानी होगी. हर .aidl फ़ाइल में एक इंटरफ़ेस तय करना ज़रूरी है. साथ ही, इसमें सिर्फ़ इंटरफ़ेस डिक्लेरेशन और मेथड सिग्नेचर की ज़रूरत होती है.

डिफ़ॉल्ट रूप से, AIDL इन डेटा टाइप के साथ काम करता है:

  • Java प्रोग्रामिंग लैंग्वेज में short को छोड़कर, सभी प्रिमिटिव टाइप (जैसे, int, long, char, boolean वगैरह)
  • किसी भी तरह के ऐरे, जैसे कि int[] या MyParcelable[]
  • String
  • CharSequence
  • List

    List में मौजूद सभी एलिमेंट, इस सूची में मौजूद डेटा टाइप में से कोई एक होना चाहिए. इसके अलावा, वे एआईडीएल से जनरेट किए गए अन्य इंटरफ़ेस या पार्सल किए जा सकने वाले एलिमेंट में से कोई एक होना चाहिए. List को पैरामीटर वाली टाइप क्लास के तौर पर इस्तेमाल किया जा सकता है, जैसे कि List<String>. दूसरे पक्ष को मिलने वाली असल क्लास हमेशा ArrayList होती है. हालांकि, List इंटरफ़ेस का इस्तेमाल करने के लिए, मेथड जनरेट किया जाता है.

  • Map

    Map में मौजूद सभी एलिमेंट, इस सूची में मौजूद डेटा टाइप में से कोई एक होना चाहिए. इसके अलावा, AIDL से जनरेट किए गए अन्य इंटरफ़ेस या पार्सल किए जा सकने वाले एलिमेंट में से कोई एक होना चाहिए. पैरामीटर वाले टाइप मैप, जैसे कि Map<String,Integer> फ़ॉर्मैट वाले मैप का इस्तेमाल नहीं किया जा सकता. दूसरी ओर मिलने वाली असल क्लास हमेशा HashMap होती है. हालांकि, इस तरीके को Map इंटरफ़ेस का इस्तेमाल करने के लिए जनरेट किया जाता है. Map के विकल्प के तौर पर, Bundle का इस्तेमाल करें.

आपको पहले से मौजूद टाइप के अलावा, हर अतिरिक्त टाइप के लिए import स्टेटमेंट शामिल करना होगा. भले ही, उन्हें आपके इंटरफ़ेस के पैकेज में ही तय किया गया हो.

सेवा इंटरफ़ेस तय करते समय, इन बातों का ध्यान रखें:

  • मेथड में शून्य या उससे ज़्यादा पैरामीटर हो सकते हैं. साथ ही, ये कोई वैल्यू या शून्य वैल्यू दिखा सकते हैं.
  • सभी नॉन-प्रिमिटिव पैरामीटर के लिए, डायरेक्शनल टैग की ज़रूरत होती है. इससे पता चलता है कि डेटा किस तरफ़ जा रहा है: in, out या inout (नीचे दिया गया उदाहरण देखें).

    प्रिमिटिव, String, IBinder, और एआईडीएल से जनरेट किए गए इंटरफ़ेस, डिफ़ॉल्ट रूप से in होते हैं. इन्हें बदला नहीं जा सकता.

    चेतावनी: डायरेक्शन को सिर्फ़ ज़रूरी चीज़ों तक सीमित रखें, क्योंकि पैरामीटर को मार्शल करने में ज़्यादा खर्च आता है.

  • .aidl फ़ाइल में शामिल सभी कोड टिप्पणियां, जनरेट किए गए IBinder इंटरफ़ेस में शामिल होती हैं. हालांकि, इंपोर्ट और पैकेज स्टेटमेंट से पहले की टिप्पणियां शामिल नहीं होती हैं.
  • स्ट्रिंग और इंट कॉन्स्टेंट को एआईडीएल इंटरफ़ेस में तय किया जा सकता है, जैसे कि const int VERSION = 1;.
  • कॉल करने के तरीके, transact() कोड से भेजे जाते हैं. आम तौर पर, यह इंटरफ़ेस में मौजूद, कॉल करने के तरीके के इंडेक्स पर आधारित होता है. इस वजह से, वर्शन बनाना मुश्किल हो जाता है. इसलिए, किसी तरीके को मैन्युअल तरीके से लेन-देन कोड असाइन किया जा सकता है: void method() = 10;.
  • नलेबल आर्ग्युमेंट और रिटर्न टाइप को @nullable का इस्तेमाल करके एनोटेट किया जाना चाहिए.

यहां .aidl फ़ाइल का एक उदाहरण दिया गया है:

// IRemoteService.aidl
package com.example.android;

// Declare any non-default types here with import statements.

/** Example service interface. */
interface IRemoteService {
    /** Request the process ID of this service. */
    int getPid();

    /** Demonstrates some basic types that you can use as parameters
     * and return values in AIDL.
     */
    void basicTypes(int anInt, long aLong, boolean aBoolean, float aFloat,
            double aDouble, String aString);
}

अपनी .aidl फ़ाइल को अपने प्रोजेक्ट की src/ डायरेक्ट्री में सेव करें. ऐप्लिकेशन बनाते समय, एसडीके टूल आपके प्रोजेक्ट की gen/ डायरेक्ट्री में IBinder इंटरफ़ेस फ़ाइल जनरेट करते हैं. जनरेट की गई फ़ाइल का नाम, .aidl फ़ाइल के नाम से मेल खाता है. हालांकि, इसका एक्सटेंशन .java होता है. उदाहरण के लिए, IRemoteService.aidl से, नतीजे के तौर पर IRemoteService.java मिलता है.

अगर Android Studio का इस्तेमाल किया जाता है, तो इंक्रीमेंटल बिल्ड, बाइंडर क्लास को तुरंत जनरेट करता है. अगर Android Studio का इस्तेमाल नहीं किया जाता है, तो अगली बार ऐप्लिकेशन बनाने पर Gradle टूल, बाइंडर क्लास जनरेट करता है. .aidl फ़ाइल लिखने के बाद, gradle assembleDebug या gradle assembleRelease की मदद से अपना प्रोजेक्ट बनाएं, ताकि आपका कोड जनरेट की गई क्लास से लिंक हो सके.

इंटरफ़ेस लागू करना

ऐप्लिकेशन बनाते समय, Android SDK के टूल आपकी .aidl फ़ाइल के नाम पर एक .java इंटरफ़ेस फ़ाइल जनरेट करते हैं. जनरेट किए गए इंटरफ़ेस में Stub नाम की एक सबक्लास शामिल होती है. यह अपने पैरंट इंटरफ़ेस, जैसे कि YourInterface.Stub का ऐब्स्ट्रैक्ट इंप्लिमेंटेशन है. साथ ही, यह .aidl फ़ाइल के सभी तरीकों के बारे में बताती है.

ध्यान दें: Stub में कुछ हेल्पर तरीके भी तय किए गए हैं. इनमें सबसे अहम asInterface() है, जो IBinder लेता है. आम तौर पर, यह क्लाइंट के onServiceConnected() कॉलबैक के तरीके को पास किया जाता है और स्टब इंटरफ़ेस का इंस्टेंस दिखाता है. इस कास्ट को करने के तरीके के बारे में ज़्यादा जानने के लिए, आईपीसी मेथड को कॉल करना सेक्शन देखें.

.aidl से जनरेट किए गए इंटरफ़ेस को लागू करने के लिए, जनरेट किए गए Binder इंटरफ़ेस को बड़ा करें, जैसे कि YourInterface.Stub. साथ ही, .aidl फ़ाइल से इनहेरिट किए गए तरीकों को लागू करें.

यहां IRemoteService नाम के इंटरफ़ेस को लागू करने का एक उदाहरण दिया गया है. इसे पिछले IRemoteService.aidl उदाहरण में, पहचान छिपाने वाले इंस्टेंस का इस्तेमाल करके बताया गया है:

private val binder = object : IRemoteService.Stub() {

    override fun getPid(): Int =
        Process.myPid()

    override fun basicTypes(
        anInt: Int,
        aLong: Long,
        aBoolean: Boolean,
        aFloat: Float,
        aDouble: Double,
        aString: String
    ) {
        // Does nothing.
    }
}

अब binder, Stub क्लास (एक Binder) का इंस्टेंस है. यह सेवा के लिए आईपीसी इंटरफ़ेस तय करता है. अगले चरण में, इस इंस्टेंस को क्लाइंट के लिए उपलब्ध कराया जाता है, ताकि वे सेवा के साथ इंटरैक्ट कर सकें.

एआईडीएल इंटरफ़ेस लागू करते समय, इन नियमों का ध्यान रखें:

  • इस बात की कोई गारंटी नहीं है कि इनकमिंग कॉल, मुख्य थ्रेड पर ही लागू होंगे. इसलिए, आपको शुरुआत से ही मल्टीथ्रेडिंग के बारे में सोचना होगा. साथ ही, अपनी सेवा को थ्रेड-सेफ़ बनाने के लिए, उसे सही तरीके से बनाना होगा.
  • डिफ़ॉल्ट रूप से, आईपीसी कॉल सिंक्रोनस होते हैं. अगर आपको पता है कि सेवा को अनुरोध पूरा करने में कुछ मिलीसेकंड से ज़्यादा समय लगता है, तो उसे गतिविधि के मुख्य थ्रेड से कॉल न करें. इससे ऐप्लिकेशन हैंग हो सकता है. इस वजह से, Android पर "ऐप्लिकेशन काम नहीं कर रहा है" डायलॉग दिखता है. इसे क्लाइंट में किसी अलग थ्रेड से कॉल करें.
  • Parcel.writeException() के लिए रेफ़रंस दस्तावेज़ में, सिर्फ़ अपवाद के तौर पर शामिल किए गए टाइप को कॉलर को वापस भेजा जाता है.

क्लाइंट को इंटरफ़ेस दिखाना

अपनी सेवा के लिए इंटरफ़ेस लागू करने के बाद, आपको इसे क्लाइंट के लिए उपलब्ध कराना होगा, ताकि वे इससे जुड़ सकें. अपनी सेवा के लिए इंटरफ़ेस को एक्सपोज़ करने के लिए, Service को एक्सटेंड करें और onBind() को लागू करें. इससे आपकी क्लास का एक इंस्टेंस वापस मिलेगा, जो जनरेट किए गए Stub को लागू करता है. इसके बारे में पिछले सेक्शन में बताया गया है. यहां एक उदाहरण दिया गया है सेवा जो क्लाइंट को IRemoteService उदाहरण इंटरफ़ेस दिखाती है.

class RemoteService : Service() {

    override fun onCreate() {
        super.onCreate()
    }

    override fun onBind(intent: Intent): IBinder {
        // Return the interface.
        return binder
    }

    private val binder = object : IRemoteService.Stub() {
        override fun getPid(): Int {
            return Process.myPid()
        }

        override fun basicTypes(
            anInt: Int,
            aLong: Long,
            aBoolean: Boolean,
            aFloat: Float,
            aDouble: Double,
            aString: String
        ) {
            // Does nothing.
        }
    }
}

अब जब कोई क्लाइंट, जैसे कि कोई गतिविधि, इस सेवा से कनेक्ट करने के लिए bindService() को कॉल करता है, तो क्लाइंट के onServiceConnected() कॉलबैक को सेवा के onBind() तरीके से मिला binder इंस्टेंस मिलता है.

क्लाइंट के पास इंटरफ़ेस क्लास का ऐक्सेस भी होना चाहिए. इसलिए, अगर क्लाइंट और सेवा अलग-अलग ऐप्लिकेशन में हैं, तो क्लाइंट के ऐप्लिकेशन की src/ डायरेक्ट्री में .aidl फ़ाइल की एक कॉपी होनी चाहिए. इससे android.os.Binder इंटरफ़ेस जनरेट होता है, जिससे क्लाइंट को एआईडीएल के तरीकों का ऐक्सेस मिलता है.

जब क्लाइंट को onServiceConnected() कॉलबैक में IBinder मिलता है, तो उसे YourServiceInterface.Stub.asInterface(service) को कॉल करना होगा, ताकि वह दिखाए गए पैरामीटर को YourServiceInterface टाइप में कास्ट कर सके:

var iRemoteService: IRemoteService? = null

val mConnection = object : ServiceConnection {

    // Called when the connection with the service is established.
    override fun onServiceConnected(className: ComponentName, service: IBinder) {
        // Following the preceding example for an AIDL interface,
        // this gets an instance of the IRemoteInterface, which we can use to call on the service.
        iRemoteService = IRemoteService.Stub.asInterface(service)
    }

    // Called when the connection with the service disconnects unexpectedly.
    override fun onServiceDisconnected(className: ComponentName) {
        Log.e(TAG, "Service has unexpectedly disconnected")
        iRemoteService = null
    }
}

ज़्यादा सैंपल कोड के लिए, ApiDemos में RemoteService.java क्लास देखें.

आईपीसी पर ऑब्जेक्ट पास करना

Android 10 (एपीआई लेवल 29 या इसके बाद के वर्शन) में, एआईडीएल में सीधे तौर पर Parcelable ऑब्जेक्ट तय किए जा सकते हैं. एआईडीएल इंटरफ़ेस आर्ग्युमेंट के तौर पर इस्तेमाल किए जा सकने वाले टाइप और अन्य पार्सल किए जा सकने वाले टाइप भी यहां इस्तेमाल किए जा सकते हैं. इससे, मार्शलिंग कोड और कस्टम क्लास को मैन्युअल तरीके से लिखने की ज़रूरत नहीं पड़ती. हालांकि, इससे एक खाली स्ट्रक्चर भी बनता है. अगर आपको कस्टम ऐक्सेसर या अन्य फ़ंक्शन चाहिए, तो Parcelable लागू करें.

package android.graphics;

// Declare Rect so AIDL can find it and knows that it implements
// the parcelable protocol.
parcelable Rect {
    int left;
    int top;
    int right;
    int bottom;
}

ऊपर दिया गया कोड सैंपल, अपने-आप एक Java क्लास जनरेट करता है. इसमें इंटीजर फ़ील्ड left, top, right, और bottom शामिल होते हैं. सभी ज़रूरी मार्शलिंग कोड अपने-आप लागू हो जाते हैं. साथ ही, ऑब्जेक्ट को सीधे तौर पर इस्तेमाल किया जा सकता है. इसके लिए, कोई कोड लागू करने की ज़रूरत नहीं होती.

आईपीसी इंटरफ़ेस की मदद से, कस्टम क्लास को एक प्रोसेस से दूसरी प्रोसेस में भी भेजा जा सकता है. हालांकि, पक्का करें कि आपकी क्लास का कोड, आईपीसी चैनल के दूसरी ओर उपलब्ध हो. साथ ही, आपकी क्लास को Parcelable इंटरफ़ेस के साथ काम करना चाहिए. Parcelable को सपोर्ट करना ज़रूरी है, क्योंकि इससे Android सिस्टम, ऑब्जेक्ट को प्रिमिटिव में बांट पाता है. इन्हें प्रोसेस के दौरान मार्शल किया जा सकता है.

Parcelable के साथ काम करने वाली कस्टम क्लास बनाने के लिए, यह तरीका अपनाएं:

  1. अपनी क्लास को Parcelable इंटरफ़ेस लागू करने के लिए कहें.
  2. writeToParcel को लागू करें. यह ऑब्जेक्ट की मौजूदा स्थिति को लेता है और उसे Parcel में लिखता है.
  3. अपनी क्लास में CREATOR नाम का एक स्टैटिक फ़ील्ड जोड़ें. यह एक ऐसा ऑब्जेक्ट है जो Parcelable.Creator इंटरफ़ेस को लागू करता है.
  4. आखिर में, एक .aidl फ़ाइल बनाएं, जो आपकी पार्सल की जा सकने वाली क्लास के बारे में बताती हो. जैसा कि यहां दी गई Rect.aidl फ़ाइल के लिए दिखाया गया है.

    अगर कस्टम बिल्ड प्रोसेस का इस्तेमाल किया जा रहा है, तो अपने बिल्ड में .aidl फ़ाइल को न जोड़ें. C लैंग्वेज में मौजूद हेडर फ़ाइल की तरह, इस .aidl फ़ाइल को कंपाइल नहीं किया जाता.

AIDL, अपने जनरेट किए गए कोड में इन तरीकों और फ़ील्ड का इस्तेमाल करता है, ताकि आपके ऑब्जेक्ट को मार्शल और अनमार्शल किया जा सके.

उदाहरण के लिए, यहां एक Rect.aidl फ़ाइल दी गई है, ताकि पार्सल की जा सकने वाली Rect क्लास बनाई जा सके:

package android.graphics;

// Declare Rect so AIDL can find it and knows that it implements
// the parcelable protocol.
parcelable Rect;

यहां एक उदाहरण दिया गया है, जिसमें बताया गया है कि Rect क्लास, Parcelable प्रोटोकॉल को कैसे लागू करती है.

// import android.os.Parcel
// import android.os.Parcelable

class Rect() : Parcelable {
    var left: Int = 0
    var top: Int = 0
    var right: Int = 0
    var bottom: Int = 0

    companion object CREATOR : Parcelable.Creator<Rect> {
        override fun createFromParcel(parcel: Parcel): Rect {
            return Rect(parcel)
        }

        override fun newArray(size: Int): Array<Rect?> {
            return Array(size) { null }
        }
    }

    private constructor(inParcel: Parcel) : this() {
        readFromParcel(inParcel)
    }

    override fun writeToParcel(outParcel: Parcel, flags: Int) {
        outParcel.writeInt(left)
        outParcel.writeInt(top)
        outParcel.writeInt(right)
        outParcel.writeInt(bottom)
    }

    private fun readFromParcel(inParcel: Parcel) {
        left = inParcel.readInt()
        top = inParcel.readInt()
        right = inParcel.readInt()
        bottom = inParcel.readInt()
    }

    override fun describeContents(): Int {
        return 0
    }
}

Rect क्लास में मार्शलिंग करना आसान है. Parcel पर मौजूद अन्य तरीके देखें, ताकि आपको पता चल सके कि Parcel में किस तरह की अन्य वैल्यू लिखी जा सकती हैं.

चेतावनी: अन्य प्रोसेस से डेटा पाने पर, सुरक्षा से जुड़े जोखिमों को ध्यान में रखें. इस मामले में, Rect, Parcel से चार नंबर पढ़ता है. हालांकि, यह पक्का करना आपकी ज़िम्मेदारी है कि ये नंबर, कॉलर की कोशिश के लिए तय की गई वैल्यू की रेंज में हों. अपने ऐप्लिकेशन को मैलवेयर से सुरक्षित रखने के तरीके के बारे में ज़्यादा जानने के लिए, सुरक्षा से जुड़ी सलाह देखें.

Parcelables वाले बंडल आर्ग्युमेंट वाले तरीके

अगर कोई तरीका Bundle ऑब्जेक्ट को स्वीकार करता है, जिसमें पार्सल किए जा सकने वाले ऑब्जेक्ट शामिल होने की उम्मीद है, तो पक्का करें कि आपने Bundle से पढ़ने की कोशिश करने से पहले, Bundle.setClassLoader(ClassLoader) को कॉल करके Bundle का क्लासलोडर सेट किया हो. ऐसा न करने पर, आपको ClassNotFoundException गड़बड़ी का सामना करना पड़ सकता है. भले ही, आपके ऐप्लिकेशन में Parcelable को सही तरीके से तय किया गया हो.

उदाहरण के लिए, यहां दी गई सैंपल .aidl फ़ाइल देखें:

// IRectInsideBundle.aidl
package com.example.android;

/** Example service interface. */
interface IRectInsideBundle {
    /** Rect parcelable is stored in the bundle with key "rect". */
    void saveRect(in Bundle bundle);
}
यहां दिए गए उदाहरण में, Rect को पढ़ने से पहले, ClassLoader को Bundle में साफ़ तौर पर सेट किया गया है:
private val binder = object : IRectInsideBundle.Stub() {
    override fun saveRect(bundle: Bundle) {
        bundle.classLoader = classLoader
        val rect = BundleCompat.getParcelable(bundle, "rect", Rect::class.java)
        process(rect) // Do more with the parcelable.
    }
}

आईपीसी मेथड को कॉल करना

एआईडीएल की मदद से तय किए गए रिमोट इंटरफ़ेस को कॉल करने के लिए, अपनी कॉलिंग क्लास में यह तरीका अपनाएं:

  1. .aidl फ़ाइल को प्रोजेक्ट की src/ डायरेक्ट्री में शामिल करें.
  2. IBinder इंटरफ़ेस का एक इंस्टेंस तय करें, जो एआईडीएल के आधार पर जनरेट होता है.
  3. ServiceConnection लागू करें.
  4. Context.bindService() को कॉल करें. इसके लिए, ServiceConnection को पास करें.
  5. onServiceConnected() को लागू करने पर, आपको IBinder का एक इंस्टेंस मिलता है. इसे service कहा जाता है. YourInterface टाइप में, दिखाए गए पैरामीटर को कास्ट करने के लिए, YourInterfaceName.Stub.asInterface((IBinder)service) को कॉल करें.
  6. अपने इंटरफ़ेस पर तय किए गए तरीकों को कॉल करें. हमेशा DeadObjectException अपवादों को ट्रैप करें, जो कनेक्शन टूटने पर थ्रो होते हैं. साथ ही, SecurityException अपवादों को ट्रैप करें. ये अपवाद तब थ्रो होते हैं, जब आईपीसी करने का तरीका कॉल में शामिल दो प्रोसेस में, एआईडीएल की परिभाषाएं अलग-अलग होती हैं.
  7. डिसकनेक्ट करने के लिए, अपने इंटरफ़ेस के इंस्टेंस के साथ Context.unbindService() को कॉल करें.

आईपीसी सेवा को कॉल करते समय इन बातों का ध्यान रखें:

  • ऑब्जेक्ट को सभी प्रोसेस में रेफ़रंस के तौर पर गिना जाता है.
  • मेथड आर्ग्युमेंट के तौर पर, अनाम ऑब्जेक्ट भेजे जा सकते हैं.

किसी सेवा से बाइंड करने के बारे में ज़्यादा जानने के लिए, सीमित सेवाओं की खास जानकारी पढ़ें.

यहां कुछ सैंपल कोड दिए गए हैं. इनसे AIDL की मदद से बनाई गई सेवा को कॉल करने का तरीका पता चलता है. यह सैंपल कोड, ApiDemos प्रोजेक्ट में मौजूद रिमोट सर्विस के सैंपल से लिया गया है.

private const val BUMP_MSG = 1

class Binding : Activity() {

    /** The primary interface you call on the service.  */
    private var mService: IRemoteService? = null

    /** Another interface you use on the service.  */
    internal var secondaryService: ISecondary? = null

    private lateinit var killButton: Button
    private lateinit var callbackText: TextView
    private lateinit var handler: InternalHandler

    private var isBound: Boolean = false

    /**
     * Class for interacting with the main interface of the service.
     */
    private val mConnection = object : ServiceConnection {

        override fun onServiceConnected(className: ComponentName, service: IBinder) {
            // This is called when the connection with the service is
            // established, giving us the service object we can use to
            // interact with the service.  We are communicating with our
            // service through an IDL interface, so get a client-side
            // representation of that from the raw service object.
            mService = IRemoteService.Stub.asInterface(service)
            killButton.isEnabled = true
            callbackText.text = "Attached."

            // We want to monitor the service for as long as we are
            // connected to it.
            try {
                mService?.registerCallback(mCallback)
            } catch (e: RemoteException) {
                // In this case, the service crashes before we can
                // do anything with it. We can count on soon being
                // disconnected (and then reconnected if it can be restarted)
                // so there is no need to do anything here.
            }

            // As part of the sample, tell the user what happened.
            Toast.makeText(
                    this@Binding,
                    R.string.remote_service_connected,
                    Toast.LENGTH_SHORT
            ).show()
        }

        override fun onServiceDisconnected(className: ComponentName) {
            // This is called when the connection with the service is
            // unexpectedly disconnected&mdash;that is, its process crashed.
            mService = null
            killButton.isEnabled = false
            callbackText.text = "Disconnected."

            // As part of the sample, tell the user what happened.
            Toast.makeText(
                    this@Binding,
                    R.string.remote_service_disconnected,
                    Toast.LENGTH_SHORT
            ).show()
        }
    }

    /**
     * Class for interacting with the secondary interface of the service.
     */
    private val secondaryConnection = object : ServiceConnection {

        override fun onServiceConnected(className: ComponentName, service: IBinder) {
            // Connecting to a secondary interface is the same as any
            // other interface.
            secondaryService = ISecondary.Stub.asInterface(service)
            killButton.isEnabled = true
        }

        override fun onServiceDisconnected(className: ComponentName) {
            secondaryService = null
            killButton.isEnabled = false
        }
    }

    private val mBindListener = View.OnClickListener {
        // Establish a couple connections with the service, binding
        // by interface names. This lets other applications be
        // installed that replace the remote service by implementing
        // the same interface.
        val intent = Intent(this@Binding, RemoteService::class.java)
        intent.action = IRemoteService::class.java.name
        bindService(intent, mConnection, Context.BIND_AUTO_CREATE)
        intent.action = ISecondary::class.java.name
        bindService(intent, secondaryConnection, Context.BIND_AUTO_CREATE)
        isBound = true
        callbackText.text = "Binding."
    }

    private val unbindListener = View.OnClickListener {
        if (isBound) {
            // If we have received the service, and hence registered with
            // it, then now is the time to unregister.
            try {
                mService?.unregisterCallback(mCallback)
            } catch (e: RemoteException) {
                // There is nothing special we need to do if the service
                // crashes.
            }

            // Detach our existing connection.
            unbindService(mConnection)
            unbindService(secondaryConnection)
            killButton.isEnabled = false
            isBound = false
            callbackText.text = "Unbinding."
        }
    }

    private val killListener = View.OnClickListener {
        // To kill the process hosting the service, we need to know its
        // PID.  Conveniently, the service has a call that returns
        // that information.
        try {
            secondaryService?.pid?.also { pid ->
                // Note that, though this API lets us request to
                // kill any process based on its PID, the kernel
                // still imposes standard restrictions on which PIDs you
                // can actually kill. Typically this means only
                // the process running your application and any additional
                // processes created by that app, as shown here. Packages
                // sharing a common UID are also able to kill each
                // other's processes.
                Process.killProcess(pid)
                callbackText.text = "Killed service process."
            }
        } catch (ex: RemoteException) {
            // Recover gracefully from the process hosting the
            // server dying.
            // For purposes of this sample, put up a notification.
            Toast.makeText(this@Binding, R.string.remote_call_failed, Toast.LENGTH_SHORT).show()
        }
    }

    // ----------------------------------------------------------------------
    // Code showing how to deal with callbacks.
    // ----------------------------------------------------------------------

    /**
     * This implementation is used to receive callbacks from the remote
     * service.
     */
    private val mCallback = object : IRemoteServiceCallback.Stub() {
        /**
         * This is called by the remote service regularly to tell us about
         * new values.  Note that IPC calls are dispatched through a thread
         * pool running in each process, so the code executing here is
         * NOT running in our main thread like most other things. So,
         * to update the UI, we need to use a Handler to hop over there.
         */
        override fun valueChanged(value: Int) {
            handler.sendMessage(handler.obtainMessage(BUMP_MSG, value, 0))
        }
    }

    /**
     * Standard initialization of this activity.  Set up the UI, then wait
     * for the user to interact with it before doing anything.
     */
    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)

        setContentView(R.layout.remote_service_binding)

        // Watch for button taps.
        var button: Button = findViewById(R.id.bind)
        button.setOnClickListener(mBindListener)
        button = findViewById(R.id.unbind)
        button.setOnClickListener(unbindListener)
        killButton = findViewById(R.id.kill)
        killButton.setOnClickListener(killListener)
        killButton.isEnabled = false

        callbackText = findViewById(R.id.callback)
        callbackText.text = "Not attached."
        handler = InternalHandler(callbackText)
    }

    private class InternalHandler(
            textView: TextView,
            private val weakTextView: WeakReference<TextView> = WeakReference(textView)
    ) : Handler() {
        override fun handleMessage(msg: Message) {
            when (msg.what) {
                BUMP_MSG -> weakTextView.get()?.text = "Received from service: ${msg.arg1}"
                else -> super.handleMessage(msg)
            }
        }
    }
}