Tasks API

Task एपीआई, 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 से जुड़े लिसनर, ऐप्लिकेशन के मुख्य (यूआई) थ्रेड पर चलते हैं. इसका मतलब है कि आपको लिसनर में लंबे समय तक चलने वाले ऑपरेशन नहीं करने चाहिए. अगर आपको लंबे समय तक चलने वाली कोई कार्रवाई करनी है, तो 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()
}

अमरूद 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 }

अगले चरण