Coroutines :: व्यावहारिक अनुभव

इस लेख में मैं बात करूंगा कि कोरटाइन कैसे काम करते हैं और उन्हें कैसे बनाते हैं। अनुक्रमिक, समानांतर निष्पादन में आवेदन पर विचार करें। आइए त्रुटि से निपटने, डिबगिंग, और कोरटाइन का परीक्षण करने के तरीकों के बारे में बात करते हैं। अंत में, मैं इस दृष्टिकोण को लागू करने के बाद बने छापों के बारे में संक्षेप में बताऊंगा।

पोस्ट के अंत में एमबीएलटी डीईवी 2018 पर मेरी रिपोर्ट की सामग्री के आधार पर लेख तैयार किया गया था - वीडियो का एक लिंक।

संगत शैली

अंजीर। 2.1

Corutin Developers का उद्देश्य क्या था? वे चाहते थे कि अतुल्यकालिक प्रोग्रामिंग यथासंभव सरल हो। भाषा के वाक्यात्मक निर्माण का उपयोग करके कोड "लाइन द्वारा लाइन" को निष्पादित करने से आसान कुछ भी नहीं है: कोशिश-कैच-आखिर, लूप्स, सशर्त बयान, और इसी तरह।

आइए दो कार्यों पर विचार करें। प्रत्येक को अपने स्वयं के धागे पर निष्पादित किया जाता है (चित्र 2.1)। पहले थ्रेड बी पर निष्पादित किया जाता है और कुछ परिणाम डेटाबी देता है , फिर हमें इस परिणाम को दूसरे फ़ंक्शन में पास करना होगा, जो डेटाबी को तर्क के रूप में लेता है और पहले से ही थ्रेड ए पर चल रहा है । Coroutine के साथ, हम अपना कोड लिख सकते हैं जैसा कि अंजीर में दिखाया गया है। 2.1। इस पर विचार करें कि इसे कैसे प्राप्त किया जाए।

फ़ंक्शंस longOpOnB, longOpOnA - तथाकथित सस्पेंड -functions, जिसके पहले थ्रेड को मुक्त कर दिया जाता है, और अपना काम पूरा होने के बाद यह फिर से व्यस्त हो जाता है।

वास्तव में इन दोनों कार्यों के लिए एक अलग थ्रेड में कहा जाता है, जिसे कॉलिंग कोड के "सुसंगत" शैली को बनाए रखने के लिए कहा जाता है, हमें उन्हें कोरटाइन के संदर्भ में डुबो देना चाहिए।

यह तथाकथित Coroutine बिल्डर का उपयोग करके कोरआउट बनाने के द्वारा किया जाता है। आकृति में, यह लॉन्च है , लेकिन अन्य हैं, उदाहरण के लिए, async , runBlocking । मैं उनके बारे में बाद में बात करूंगा।

अंतिम तर्क कॉरआउट के संदर्भ में निष्पादित कोड का एक ब्लॉक है: सस्पेंड फ़ंक्शंस को कॉल करना, जिसका अर्थ है कि उपरोक्त सभी व्यवहार केवल कॉरआउट के संदर्भ में या किसी अन्य सस्पेंड फ़ंक्शन में संभव है।

कॉरटीन बिल्डर विधि में अन्य पैरामीटर हैं, उदाहरण के लिए, लॉन्च का प्रकार, थ्रेड जिसमें ब्लॉक निष्पादित किया जाएगा, और अन्य।

जीवन चक्र प्रबंधन

Coroutine बिल्डर हमें रिटर्न वैल्यू के रूप में रिटर्न वैल्यू देता है - जॉब क्लास का उपवर्ग (Fig.2.2)। इसके साथ, हम कोरुटिन के जीवन चक्र का प्रबंधन कर सकते हैं।

प्रारंभ () विधि के साथ प्रारंभ करें, रद्द करें () विधि के साथ रद्द करें, जॉब के लिए जॉइन ( ) विधि का उपयोग करके पूरा करने की प्रतीक्षा करें, नौकरी पूरा होने की घटना की सदस्यता लें और बहुत कुछ।


अंजीर। 2.2

प्रवाह परिवर्तन

आप coroutine के संदर्भ तत्व को बदलकर coroutine के निष्पादन के प्रवाह को बदल सकते हैं जो शेड्यूलिंग के लिए ज़िम्मेदार है। (चित्र। 2.3)

उदाहरण के लिए, कोरुटिन 1 एक यूआई थ्रेड में निष्पादित करेगा, जबकि कॉरपिन 2 डिस्पैचर .IO पूल से लिए गए थ्रेड में।


चित्रा 2.3

कोरटाइन लाइब्रेरी एक कॉन्टेक्ट फंक्शन भी प्रदान करता है जिसमें कॉन्टेक्स्ट (कॉरटाइन कॉन्टेक्स्ट) होता है , जिसके साथ आप एक कोरटाइन के संदर्भ में थ्रेड्स के बीच स्विच कर सकते हैं। इस प्रकार, धागे के बीच कूदना काफी सरल हो सकता है:


अंजीर। 2.4।

हम यूआई थ्रेड 1 पर अपना कोरआउट शुरू करते हैं। → लोड इंडिकेटर दिखाते हैं → काम थ्रेड 2 पर स्विच करते हैं, मुख्य एक को मुक्त करते हैं → हम एक लंबा ऑपरेशन करते हैं जो यूआई थ्रेड में नहीं किया जा सकता है → परिणाम वापस यूआई थ्रेड 3 → पर लौटें और पहले से ही वहां काम करें इसके साथ, प्राप्त आंकड़ों को प्रस्तुत करना और लोडिंग संकेतक को छिपाना।

यह अब तक बहुत आरामदायक लग रहा है, आगे बढ़ें।

समारोह निलंबित करें

सबसे आम मामले के उदाहरण पर कोरुटिन के काम पर विचार करें - रेट्रोफ़िट 2 लाइब्रेरी का उपयोग करके नेटवर्क अनुरोधों के साथ काम करना।

पहली चीज़ जो हमें करने की ज़रूरत है, वह है कॉलबैक कॉल को कोरटाइन सुविधा का लाभ उठाने के लिए एक सस्पेंड फ़ंक्शन में परिवर्तित करना।


अंजीर। 2.5

कॉरआउट की स्थिति को नियंत्रित करने के लिए, लाइब्रेरी फॉर्म सस्पेंडएक्सएएनएक्सएक्स कोरटाइन के कार्यों को प्रदान करती है , जो एक तर्क प्रदान करती है , जिसमें कॉन्टिन्यूशन इंटरफ़ेस को लागू किया जाता है, फिर से शुरू और फिर से शुरू होने वाले तरीकों का उपयोग करके हम क्रमशः त्रुटि और सफलता के मामले में कोरआउट को फिर से शुरू कर सकते हैं।

इसके बाद, हम यह पता लगाएंगे कि क्या होता है जब ResWithException विधि को बुलाया जाता है, और सबसे पहले, सुनिश्चित करें कि हमें किसी तरह नेटवर्क अनुरोध कॉल को रद्द करने की आवश्यकता है।

समारोह स्थगित करें। कॉल रद्द करना

अप्रयुक्त संसाधनों की रिहाई से संबंधित कॉल और अन्य कार्यों को रद्द करने के लिए, जब सस्पेंड फ़ंक्शन को कार्यान्वित करते हैं, तो आप बॉक्स से बाहर आने वाली सस्पेंड कांकेबलेबल विधि का उपयोग कर सकते हैं (छवि। 2.6)। यहां, ब्लॉक तर्क पहले से ही कैंसिलेबल इंटरफेस को लागू करता है, जिनमें से एक अतिरिक्त विधि - इनवोकऑनलाइनेशन - आपको एक त्रुटि या एक सफल कोरटाइन रद्द करने की घटना के लिए साइन अप करने की अनुमति देता है। इसलिए, यहां विधि कॉल को रद्द करना भी आवश्यक है।


अंजीर। 2.6

UI में परिवर्तन प्रदर्शित करें

अब जब नेटवर्क फ़ंक्शन के लिए सस्पेंड फ़ंक्शन तैयार किया गया है, तो आप इसके कॉल को कोरटाउन के UI थ्रेड में अनुक्रमिक के रूप में उपयोग कर सकते हैं, जबकि अनुरोध के निष्पादन के दौरान स्ट्रीम मुक्त हो जाएगा, और अनुरोध को चलाने के लिए रेट्रोफ़िट स्ट्रीम का उपयोग किया जाएगा।

इस प्रकार, हम यूआई स्ट्रीम के संबंध में व्यवहार को अतुल्यकालिक लागू करते हैं, लेकिन हम इसे एक सुसंगत शैली में लिखते हैं (चित्र 2.6)।

यदि उत्तर प्राप्त करने के बाद आपको कड़ी मेहनत करने की आवश्यकता है, उदाहरण के लिए, डेटाबेस को प्राप्त डेटा लिखना, तो यह फ़ंक्शन, जैसा कि पहले ही दिखाया गया है, आसानी से बैक-स्ट्रीम प्रवाह के पूल पर कॉन्टेक्स्ट का उपयोग करके प्रदर्शन किया जा सकता है और यूआई पर कोड की एक भी पंक्ति के बिना निष्पादन जारी रख सकता है।


अंजीर। 2.7

दुर्भाग्य से, यह सब हमें आवेदन विकास की आवश्यकता नहीं है। त्रुटि से निपटने पर विचार करें।

त्रुटि से निपटने: कोशिश-कैच-आखिर। रद्द करें Coroutine: CancellationException

एक अपवाद जिसे कॉरटीन के अंदर नहीं पकड़ा गया था, उसे अनहेल्दी माना जाता है और इससे एप्लिकेशन क्रैश हो सकता है। सामान्य स्थितियों के अलावा, कॉल को संबंधित फ़ंक्शन पर कॉल की संगत लाइन पर फिर से शुरू करें और फिर से शुरू करें। इस मामले में, एक तर्क के रूप में पारित किया गया अपवाद अपरिवर्तित है। (चित्र। 2.8)


अंजीर। 2.8

अपवाद हैंडलिंग के लिए, मानक प्रयास कैच अंततः भाषा निर्माण उपलब्ध है। अब यूआई में त्रुटि प्रदर्शित करने वाला कोड निम्नलिखित रूप ले सकता है:


अंजीर। 2.9

कॉरटाइन को रद्द करने के मामले में, जिसे जॉब # रद्द करने की विधि कहकर प्राप्त किया जा सकता है, एक रद्दीकरण अपवाद को फेंक दिया जाता है। यह अपवाद डिफ़ॉल्ट रूप से नियंत्रित किया जाता है और क्रैश या अन्य नकारात्मक परिणामों के लिए नेतृत्व नहीं करता है।

हालाँकि, जब कोशिश / कैच निर्माण का उपयोग करते हैं, तो यह कैच ब्लॉक में पकड़ा जाएगा, और यदि आपको केवल "गलत" स्थितियों को हैंडल करना है, तो आपको इसे उन मामलों में समझना होगा। उदाहरण के लिए, UI में त्रुटि से निपटने के लिए अनुरोधों को "रद्द" करना संभव है या त्रुटि लॉगिंग प्रदान की जाती है। पहले मामले में, त्रुटि उपयोगकर्ता को दिखाई जाएगी, हालांकि यह वास्तव में मौजूद नहीं है, और दूसरे में, एक बेकार अपवाद लॉग किया जाएगा और रिपोर्ट को अव्यवस्थित करेगा।

कोरआउट को रद्द करने की स्थिति को अनदेखा करने के लिए, आपको कोड को थोड़ा संशोधित करने की आवश्यकता है:


अंजीर। 2.10

लॉग करने में त्रुटि

अपवाद अपवाद स्टैक ट्रेस पर विचार करें।

यदि आप कोरटाइन कोड ब्लॉक (छवि 2.11) में सीधे एक अपवाद को फेंकते हैं, तो स्टैक ट्रेस साफ दिखता है, कोरटाइन से केवल कुछ कॉल के साथ, यह सही ढंग से लाइन और अपवाद के बारे में जानकारी इंगित करता है। इस मामले में, आप आसानी से स्टैक ट्रेस से समझ सकते हैं कि वास्तव में कहाँ, किस कक्षा और किस फ़ंक्शन में अपवाद फेंका गया था।


अंजीर। 2.11

हालाँकि, अपवाद जो निलंबित किए गए हैं, फिर से शुरू करें- निलंबित विधि के कार्य के रूप में, एक नियम के रूप में, इसमें कोरटाइन के बारे में जानकारी शामिल नहीं है जिसमें यह हुआ। उदाहरण के लिए (चित्र। 2.12), यदि आप पिछले उदाहरण की तरह ही अपवाद के साथ पहले से निलंबित सस्पेंड फ़ंक्शन से कोरटाइन को फिर से शुरू करते हैं, तो स्टैक ट्रेस जानकारी नहीं देगा कि त्रुटि के लिए विशेष रूप से कहां देखना है।


अंजीर। 2.12

यह समझने के लिए कि एक अपवाद के साथ कौन सा कोरटुइन फिर से शुरू हुआ, आप कॉरटीननेम संदर्भ तत्व का उपयोग कर सकते हैं। (चित्र। २.१३)

CoroutineName तत्व का उपयोग डिबगिंग के लिए किया जाता है, इसमें coroutine का नाम गुजरता है, आप इसे निलंबित कार्यों में निकाल सकते हैं और उदाहरण के लिए, अपवाद संदेश को पूरक करते हैं। यही है, कम से कम यह स्पष्ट होगा कि त्रुटि के लिए कहां देखना है।

यह कार्य केवल तभी कार्य करेगा जब निलंबित फ़ंक्शन को इससे बाहर रखा गया हो:


अंजीर। 2.13

लॉग करने में त्रुटि। ExceptionHandler

किसी विशेष coroutine के लिए अपवाद लॉगिंग को बदलने के लिए, आप अपना खुद का ExceptionHandler सेट कर सकते हैं, जो coroutine संदर्भ के तत्वों में से एक है। (चित्र २.१४)

हैंडलर को CoroutineExceptionHandler इंटरफ़ेस लागू करना चाहिए। Coroutine संदर्भ के लिए ओवररेटेड + ऑपरेटर का उपयोग करके, आप मानक अपवाद हैंडलर को अपने से बदल सकते हैं। अनहेल्ड अपवाद हैंडलएक्सैप्शन विधि में गिर जाएगा, जहां आप इसके साथ जो कुछ भी कर सकते हैं, वह कर सकते हैं। उदाहरण के लिए, पूरी तरह से अनदेखा करें। यदि आप हैंडलर को खाली छोड़ देते हैं या अपनी जानकारी जोड़ते हैं तो यह होगा:


अंजीर। 2.14

आइए देखें कि हमारे अपवाद की लॉगिंग क्या दिखती है:

1. आपको कैंसिलेशन एक्ससेप्शन के बारे में याद रखना होगा, जिसे हम अनदेखा करना चाहते हैं।
2. अपने स्वयं के लॉग जोड़ें।
3. डिफ़ॉल्ट व्यवहार के बारे में याद रखें, जिसमें लॉगिंग और एप्लिकेशन को समाप्त करना शामिल है, अन्यथा अपवाद बस "गायब" हो जाएगा और यह स्पष्ट नहीं होगा कि क्या हुआ।

अब, एक अपवाद को फेंकने के मामले के लिए, स्टैक ट्रेस लिस्टिंग को लॉगकैट में अतिरिक्त जानकारी के साथ भेजा जाएगा:


अंजीर। 2.15

समानांतर निष्पादन। async

निलंबित कार्यों के समानांतर संचालन पर विचार करें।

कई कार्यों से समानांतर परिणाम के आयोजन के लिए Async सबसे उपयुक्त है। Async, जैसे लॉन्च - Coroutine बिल्डर। इसकी सुविधा यह है कि प्रतीक्षित () पद्धति का उपयोग करते हुए, यह डेटा को वापस लौटाता है यदि सफल होता है या एक अपवाद को फेंकता है जो कोरटाइन के निष्पादन के दौरान हुआ है। प्रतीक्षा पद्धति कॉरटाइन के पूरा होने की प्रतीक्षा करेगी, अगर यह पहले से ही पूरा नहीं हुआ है, अन्यथा यह तुरंत काम का परिणाम लौटा देगा। ध्यान दें कि प्रतीक्षा एक निलंबित कार्य है, और इसलिए इसे कोरटाइन या अन्य निलंबित फ़ंक्शन के संदर्भ के बाहर निष्पादित नहीं किया जा सकता है।

Async का उपयोग करना, समानांतर में दो कार्यों से डेटा प्राप्त करना कुछ इस तरह होगा:


अंजीर। 2.16

कल्पना करें कि हम समानांतर में दो कार्यों से डेटा प्राप्त करने के कार्य के साथ सामना कर रहे हैं। फिर, आपको उन्हें संयोजित करने और प्रदर्शित करने की आवश्यकता है। त्रुटि के मामले में, सभी मौजूदा अनुरोधों को रद्द करते हुए, यूआई को आकर्षित करना आवश्यक है। ऐसा मामला अक्सर व्यवहार में पाया जाता है।

इस स्थिति में, त्रुटि निम्नानुसार होनी चाहिए:

1. Async-corutin में से प्रत्येक के अंदर त्रुटि हैंडलिंग लाओ।
2. त्रुटि के मामले में, सभी कोरआउट्स को रद्द कर दें। सौभाग्य से, इसके लिए माता-पिता की नौकरी निर्दिष्ट करना संभव है, जिसके रद्द करने पर उसके सभी बच्चे रद्द कर दिए जाते हैं।
3. हम यह समझने के लिए एक अतिरिक्त कार्यान्वयन के साथ आते हैं कि क्या सभी डेटा सफलतापूर्वक लोड किए गए हैं। उदाहरण के लिए, हम मानते हैं कि यदि वेट नॉट लौटाया जाता है, तो डेटा प्राप्त करते समय एक त्रुटि हुई।

इस सब को ध्यान में रखते हुए, माता-पिता की कोरटाइन को लागू करना थोड़ा और अधिक जटिल होता जा रहा है। Async-corutin का कार्यान्वयन भी जटिल है:


अंजीर। 2.17

यह दृष्टिकोण केवल एक ही संभव नहीं है। उदाहरण के लिए, आप ExceptionHandler या SupervisorJob का उपयोग करके त्रुटि से निपटने के साथ समानांतर निष्पादन को लागू कर सकते हैं।

नेस्टेड कॉरआउट

आइए नेस्टेड कोरटाइन के काम को देखें।

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

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

आप एक कॉरआउट बना सकते हैं जो वैश्विक दायरे का उपयोग करके बाहरी से स्वतंत्र है। इस मामले में, जब बाहरी कोरटाइन को रद्द कर दिया जाता है, तो नेस्टेड काम करना जारी रखेगा जैसे कि कुछ भी नहीं हुआ था:


अंजीर। 2.18

पैरेंट जॉब के साथ जॉब की के साथ रेफरेंस एलिमेंट को रिप्लेस करके आप ग्लोबल नेस्टेड कॉरआउट का बच्चा बना सकते हैं या पेरेंट कॉरआउट के संदर्भ का पूरी तरह से इस्तेमाल कर सकते हैं। लेकिन इस मामले में यह याद रखने योग्य है कि मूल कोरोटीन के सभी तत्वों को ले लिया गया है: थ्रेड पूल, अपवाद हैंडलर, और इसी तरह:


अंजीर। 2.19

अब यह स्पष्ट है कि यदि आप बाहर से कोरटाइन का उपयोग करते हैं, तो आपको उन्हें नौकरी के एक उदाहरण या माता-पिता के संदर्भ को स्थापित करने की क्षमता प्रदान करनी होगी। और पुस्तकालय डेवलपर्स को इसे एक बच्चे के रूप में स्थापित करने की संभावना पर विचार करने की आवश्यकता है, जो असुविधा का कारण बनता है।

breakpoints

डीबग मोड में ऑब्जेक्ट मानों को देखने के लिए कोराटाइन प्रभावित करते हैं। यदि आप लॉगडैटा फ़ंक्शन पर अगले कोरआउट के अंदर एक ब्रेकपॉइंट लगाते हैं, तो जब यह फायर करता है, तो हम देखते हैं कि यहां सब कुछ ठीक है और मान सही तरीके से प्रदर्शित किए गए हैं:


अंजीर। 2.20

अब डेटा प्राप्त करें नेस्टेड कॉरटाइन का उपयोग करके, लॉगडाउन पर एक ब्रेकपॉइंट छोड़ कर:


अंजीर। 2.21

वांछित मानों को विफल करने का प्रयास करने के लिए इस ब्लॉक का विस्तार करने का प्रयास किया जा रहा है। इस प्रकार, निलंबन-कार्यों की उपस्थिति में डिबगिंग मुश्किल हो जाता है।

इकाई परीक्षण

यूनिट परीक्षण बहुत सीधा है। आप इसके लिए Coroutine Builder RunBlocking का उपयोग कर सकते हैं। runBlocking तब तक एक थ्रेड को ब्लॉक करता है जब तक कि उसके सभी नेस्टेड कॉरटाइन खत्म नहीं हो जाते, जो कि आपको परीक्षण के लिए ठीक है।

उदाहरण के लिए, यदि यह ज्ञात है कि इसे लागू करने के लिए विधि के अंदर कहीं कोरूटीन का उपयोग किया जाता है, तो उस विधि का परीक्षण करने के लिए जिसे आपको केवल रनबॉकिंग में लपेटने की आवश्यकता है।

रनबलॉकिंग का उपयोग एक निलंबित समारोह का परीक्षण करने के लिए किया जा सकता है:


अंजीर। 2.22

उदाहरण

अंत में, मैं कोरुटिन के उपयोग के कुछ उदाहरण दिखाना चाहूंगा।

कल्पना कीजिए कि हमें समानांतर में तीन प्रश्नों ए, बी और सी को निष्पादित करने की आवश्यकता है, उनके पूरा होने को दिखाएं और अनुरोध ए और बी के पूरा होने के क्षण को प्रतिबिंबित करें।

ऐसा करने के लिए, आप क्वेरी कोरआउट्स A और B को एक आम में लपेट सकते हैं और एक पूरे के साथ इसे पूरा कर सकते हैं:


अंजीर। 2.23

निम्न उदाहरण प्रदर्शित करता है कि 5 सेकंड के अंतराल के साथ आवधिक प्रश्नों को निष्पादित करने के लिए लूप के लिए नियमित उपयोग कैसे करें:


अंजीर। 2.24

निष्कर्ष

Minuses में से, मैं ध्यान देता हूं कि कोरआउट एक अपेक्षाकृत युवा उपकरण है, इसलिए यदि आप उन्हें उत्पादों का उपयोग करना चाहते हैं, तो आपको सावधानी से करना चाहिए। डिबगिंग में कठिनाइयां होती हैं, स्पष्ट चीजों के कार्यान्वयन में एक छोटा बॉयलरप्लेट।

सामान्य तौर पर, विशेष रूप से जटिल अतुल्यकालिक कार्यों को लागू करने के लिए, कोराउटाइन का उपयोग करना काफी आसान है। विशेष रूप से, इस तथ्य के कारण कि मानक भाषा निर्माण का उपयोग किया जा सकता है। यूनिट टेस्ट के लिए आसानी से कॉरुटाइन्स मिल जाते हैं और यह सब उसी कंपनी के बॉक्स से निकलता है जो भाषा विकसित करती है।

रिपोर्ट वीडियो

यह बहुत सारे पत्र निकला। उन लोगों के लिए जो अधिक सुनना पसंद करते हैं - एमबीएलटी डीईवी 2018 पर मेरी रिपोर्ट से वीडियो:

विषय पर उपयोगी सामग्री:

• Coroutines का परिचय
• कोरटाइन में गहरी गोता लगाएँ
• उदाहरण के लिए kotlinx.coroutines के लिए गाइड
• कोरआउट के साथ यूआई प्रोग्रामिंग के लिए गाइड
• Coroutines design document (KEEP)