Tasks API

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

टास्क के नतीजे मैनेज करना

Google Play services और 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 से जुड़े लिसनर, ऐप्लिकेशन के मुख्य (यूआई) थ्रेड पर चलते हैं. इसका मतलब है कि आपको लंबे समय तक चलने वाले ऑपरेशन, Listener में करने से बचना चाहिए. अगर आपको लंबे समय तक चलने वाला कोई ऑपरेशन करना है, तो आपके पास एक ऐसा 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 के न दिखने पर, उन्हें कॉल होने से रोका जा सकता है. इसके लिए, गतिविधि के दायरे वाले Listener का इस्तेमाल किया जा सकता है. जब आपके 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
}
MainActivity.kt

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'
build.gradle
स्निपेट
import kotlinx.coroutines.tasks.await
// ...
  textView.text = simpleTask.await()
}
MainActivity.kt

अमरूद ListenableFuture

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

Gradle (मॉड्यूल-लेवल build.gradle, आम तौर पर app/build.gradle)
implementation "androidx.concurrent:concurrent-futures:1.2.0"
build.gradle
स्निपेट
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)
)
MainActivity.kt

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'
build.gradle
स्निपेट
import io.ashdavies.rx.rxtasks.toSingle
import java.util.concurrent.TimeUnit
// ...
simpleTask.toSingle(this).subscribe { result -> textView.text = result }
MainActivity.kt

अगले चरण