Tasks API

Task API, Google Play की सेवाओं में एसिंक्रोनस कार्रवाइयों को हैंडल करने का स्टैंडर्ड तरीका है. यह एसिंक्रोनस कॉल को मैनेज करने का एक असरदार और फ़्लेक्सिबल तरीका है. यह पुराने PendingResult पैटर्न की जगह लेता है. Task की मदद से, एक साथ कई कॉल किए जा सकते हैं, जटिल फ़्लो को हैंडल किया जा सकता है, और सफलता और गड़बड़ी को हैंडल करने वाले साफ़ तौर पर लिखे जा सकते हैं.

टास्क के नतीजे हैंडल करना

Google Play की सेवाओं और Firebase में कई एपीआई, एसिंक्रोनस कार्रवाइयों को दिखाने के लिए Task ऑब्जेक्ट दिखाते हैं. उदाहरण के लिए, FirebaseAuth.signInAnonymously() एक Task<AuthResult> दिखाता है. यह साइन-इन की कार्रवाई के नतीजे को दिखाता है. Task<AuthResult> से पता चलता है कि टास्क के सफलतापूर्वक पूरा होने पर, यह AuthResult ऑब्जेक्ट दिखाएगा.

Task के नतीजे को, लिसनर अटैच करके हैंडल किया जा सकता है. ये लिसनर, टास्क के सफलतापूर्वक पूरा होने, गड़बड़ी होने या दोनों स्थितियों में जवाब देते हैं:

Task<AuthResult> task = FirebaseAuth.getInstance().signInAnonymously();

टास्क के सफलतापूर्वक पूरा होने पर, OnSuccessListener अटैच करें:

task.addOnSuccessListener(new OnSuccessListener<AuthResult>() {
    @Override
    public void onSuccess(AuthResult authResult) {
        // Task completed successfully
        // ...
    }
});

टास्क में गड़बड़ी होने पर, OnFailureListener अटैच करें:

task.addOnFailureListener(new OnFailureListener() {
    @Override
    public void onFailure(@NonNull Exception e) {
        // Task failed with an exception
        // ...
    }
});

एक ही लिसनर में सफलता और गड़बड़ी, दोनों को हैंडल करने के लिए, OnCompleteListener अटैच करें:

task.addOnCompleteListener(new OnCompleteListener<AuthResult>() {
    @Override
    public void onComplete(@NonNull Task<AuthResult> task) {
        if (task.isSuccessful()) {
            // Task completed successfully
            AuthResult result = task.getResult();
        } else {
            // Task failed with an exception
            Exception exception = task.getException();
        }
    }
});

थ्रेड मैनेज करना

डिफ़ॉल्ट रूप से, Task से अटैच किए गए लिसनर, ऐप्लिकेशन के मुख्य (यूआई) थ्रेड पर चलते हैं. इसका मतलब है कि आपको लिसनर में लंबे समय तक चलने वाली कार्रवाइयां नहीं करनी चाहिए. अगर आपको लंबे समय तक चलने वाली कोई कार्रवाई करनी है, तो Executor तय किया जा सकता है. इसका इस्तेमाल, बैकग्राउंड थ्रेड पर लिसनर शेड्यूल करने के लिए किया जाता है.

// Create a new ThreadPoolExecutor with 2 threads for each processor on the
// device and a 60 second keep-alive time.
int numCores = Runtime.getRuntime().availableProcessors();
ThreadPoolExecutor executor = new ThreadPoolExecutor(numCores * 2, numCores *2,
        60L, TimeUnit.SECONDS, new LinkedBlockingQueue<Runnable>());

task.addOnCompleteListener(executor, new OnCompleteListener<AuthResult>() {
    @Override
    public void onComplete(@NonNull Task<AuthResult> task) {
        // ...
    }
});

ऐक्टिविटी-स्कोप वाले लिसनर इस्तेमाल करना

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

Activity activity = MainActivity.this;
task.addOnCompleteListener(activity, new OnCompleteListener<AuthResult>() {
    @Override
    public void onComplete(@NonNull Task<AuthResult> task) {
        // ...
    }
});

टास्क चेन करना

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

उदाहरण के लिए, मान लें कि आपके पास doSomething नाम का कोई तरीका है, जो Task<String> दिखाता है. हालांकि, इसके लिए पैरामीटर के तौर पर AuthResult की ज़रूरत होती है. इस AuthResult को, एसिंक्रोनस तरीके से किसी दूसरे Task से हासिल किया जा सकता है:

public Task<String> doSomething(AuthResult authResult) {
    // ...
}

Task.continueWithTask तरीके का इस्तेमाल करके, इन दोनों टास्क को चेन किया जा सकता है:

Task<AuthResult> signInTask = FirebaseAuth.getInstance().signInAnonymously();

signInTask.continueWithTask(new Continuation<AuthResult, Task<String>>() {
    @Override
    public Task<String> then(@NonNull Task<AuthResult> task) throws Exception {
        // Take the result from the first task and start the second one
        AuthResult result = task.getResult();
        return doSomething(result);
    }
}).addOnSuccessListener(new OnSuccessListener<String>() {
    @Override
    public void onSuccess(String s) {
        // Chain of tasks completed successfully, got result from last task.
        // ...
    }
}).addOnFailureListener(new OnFailureListener() {
    @Override
    public void onFailure(@NonNull Exception e) {
        // One of the tasks in the chain failed with an exception.
        // ...
    }
});

किसी टास्क को ब्लॉक करना

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

try {
    // Block on a task and get the result synchronously. This is generally done
    // when executing a task inside a separately managed background thread. Doing this
    // on the main (UI) thread can cause your application to become unresponsive.
    AuthResult authResult = Tasks.await(task);
} catch (ExecutionException e) {
    // The Task failed, this is the same exception you'd get in a non-blocking
    // failure handler.
    // ...
} catch (InterruptedException e) {
    // An interrupt occurred while waiting for the task to complete.
    // ...
}

किसी टास्क को ब्लॉक करते समय, टाइम आउट भी तय किया जा सकता है. इससे, अगर टास्क को पूरा होने में ज़्यादा समय लगता है, तो आपका ऐप्लिकेशन हमेशा के लिए अटकने से बच जाएगा:

try {
    // Block on the task for a maximum of 500 milliseconds, otherwise time out.
    AuthResult authResult = Tasks.await(task, 500, TimeUnit.MILLISECONDS);
} catch (ExecutionException e) {
    // ...
} catch (InterruptedException e) {
    // ...
} catch (TimeoutException e) {
    // Task timed out before it could complete.
    // ...
}

इंटरोऑपरेबिलिटी

Task को, Android में एसिंक्रोनस प्रोग्रामिंग के अन्य सामान्य पैटर्न के साथ मिलकर काम करने के लिए डिज़ाइन किया गया है. इसे ListenableFuture और Kotlin कोरूटीन जैसे अन्य प्रिमिटिव में बदला जा सकता है. साथ ही, इनसे वापस भी बदला जा सकता है. AndroidX, इन प्रिमिटिव का इस्तेमाल करने का सुझाव देता है. इससे, अपनी ज़रूरत के हिसाब से सबसे सही तरीका इस्तेमाल किया जा सकता है.

Task का इस्तेमाल करने का एक उदाहरण यहां दिया गया है:

// ...
simpleTask.addOnCompleteListener(this) {
  completedTask -> textView.text = completedTask.result
}

Kotlin कोरूटीन

Task के साथ Kotlin कोरूटीन का इस्तेमाल करने के लिए, अपने प्रोजेक्ट में यह डिपेंडेंसी जोड़ें. इसके बाद, Task से बदलने के लिए, कोड स्निपेट का इस्तेमाल करें.

Gradle (मॉड्यूल-लेवल build.gradle, आम तौर पर app/build.gradle)
// Source: https://github.com/Kotlin/kotlinx.coroutines/tree/master/integration/kotlinx-coroutines-play-services
implementation 'org.jetbrains.kotlinx:kotlinx-coroutines-play-services:1.7.3'
स्निपेट
import kotlinx.coroutines.tasks.await
// ...
  textView.text = simpleTask.await()
}

Guava ListenableFuture

Task के साथ Guava ListenableFuture का इस्तेमाल करने के लिए, अपने प्रोजेक्ट में यह डिपेंडेंसी जोड़ें. इसके बाद, Task से बदलने के लिए, कोड स्निपेट का इस्तेमाल करें.

Gradle (मॉड्यूल-लेवल build.gradle, आम तौर पर app/build.gradle)
implementation "androidx.concurrent:concurrent-futures:1.2.0"
स्निपेट
import com.google.common.util.concurrent.ListenableFuture
// ...
/** Convert Task to ListenableFuture. */
fun <T> taskToListenableFuture(task: Task<T>): ListenableFuture<T> {
  return CallbackToFutureAdapter.getFuture { completer ->
    task.addOnCompleteListener { completedTask ->
      if (completedTask.isCanceled) {
        completer.setCancelled()
      } else if (completedTask.isSuccessful) {
        completer.set(completedTask.result)
      } else {
        val e = completedTask.exception
        if (e != null) {
          completer.setException(e)
        } else {
          throw IllegalStateException()
        }
      }
    }
  }
}
// ...
this.listenableFuture = taskToListenableFuture(simpleTask)
this.listenableFuture?.addListener(
  Runnable {
    textView.text = listenableFuture?.get()
  },
  ContextCompat.getMainExecutor(this)
)

RxJava2 Observable

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

Gradle (मॉड्यूल-लेवल build.gradle, आम तौर पर app/build.gradle)
// Source: https://github.com/ashdavies/rx-tasks
implementation 'io.ashdavies.rx.rxtasks:rx-tasks:2.2.0'
स्निपेट
import io.ashdavies.rx.rxtasks.toSingle
import java.util.concurrent.TimeUnit
// ...
simpleTask.toSingle(this).subscribe { result -> textView.text = result }

अगले चरण