Tasks API

Google Play services के 9.0.0 वर्शन से, Task एपीआई और कई तरीकों का इस्तेमाल किया जा सकता है. ये तरीके, Task या उसके सबक्लास दिखाते हैं. Task एक ऐसा एपीआई है जो Google Play services के पिछले वर्शन में PendingResult की तरह ही, असाइनोक्रोनस तरीके से कॉल करता है.

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

Task दिखाने वाला एक सामान्य तरीका FirebaseAuth.signInAnonymously() है. यह Task<AuthResult> दिखाता है. इसका मतलब है कि टास्क पूरा होने पर, यह AuthResult ऑब्जेक्ट दिखाएगा:

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();
        }
    }
});

थ्रेडिंग

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

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

चेन

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

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

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.
    // ...
}

किसी टास्क को ब्लॉक करते समय, टाइम आउट भी तय किया जा सकता है, ताकि आपका ऐप्लिकेशन hang न हो:

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 के कई लोकप्रिय तरीकों के साथ काम करता है. साथ ही, Task को आसानी से अन्य प्राइमिटिव में बदला जा सकता है. इनमें ListenableFuture और Kotlin कोरयूटीन शामिल हैं. AndroidX का सुझाव है कि इनका इस्तेमाल किया जाए.

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

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

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 से बदलने के लिए, नीचे दिए गए कोड का इस्तेमाल करें.

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 }

अगले चरण