Görev API'leri

Task API, Google Play Hizmetleri'nde asenkron işlemleri yönetmenin standart yoludur. Eski PendingResult kalıbının yerini alarak eşzamansız çağrıları yönetmenin güçlü ve esnek bir yolunu sunar. Task ile birden fazla çağrıyı zincirleyebilir, karmaşık akışları yönetebilir ve net başarı ve başarısızlık işleyicileri yazabilirsiniz.

Görev sonuçlarını işleme

Google Play Hizmetleri ve Firebase'deki birçok API, eşzamansız işlemleri temsil etmek için bir Task nesnesi döndürür. Örneğin, FirebaseAuth.signInAnonymously(), oturum açma işleminin sonucunu temsil eden bir Task<AuthResult> döndürür. Task<AuthResult>, görev başarıyla tamamlandığında bir AuthResult nesnesi döndürüleceğini gösterir.

Başarılı tamamlama, başarısızlık veya her ikisine de yanıt veren dinleyiciler ekleyerek Task sonucunu işleyebilirsiniz:

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

Görevin başarıyla tamamlandığını belirtmek için OnSuccessListener ekleyin:

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

Başarısız bir görevi işlemek için OnFailureListener ekleyin:

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

Aynı dinleyicide hem başarılı hem de başarısız durumları işlemek için bir OnCompleteListener ekleyin:

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

İleti dizilerini yönetme

Varsayılan olarak, Task'e bağlı dinleyiciler uygulamanın ana (kullanıcı arayüzü) iş parçacığında çalıştırılır. Bu nedenle, dinleyicilerde uzun süren işlemler yapmaktan kaçınmanız gerekir. Uzun süren bir işlem yapmanız gerekiyorsa dinleyicileri arka plan iş parçacığında planlamak için kullanılan bir Executor belirtebilirsiniz.

// 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) {
        // ...
    }
});

Etkinlik kapsamlı dinleyiciler kullanma

Bir Activity içinde görev sonuçlarını işlemeniz gerektiğinde, Activity artık görünmediğinde çağrılmalarını önlemek için dinleyicilerin yaşam döngüsünü yönetmeniz önemlidir. Bunun için etkinlik kapsamlı dinleyicileri kullanabilirsiniz. Bu dinleyiciler, Activity nesnenizin onStop yöntemi çağrıldığında otomatik olarak kaldırılır. Böylece Activity durdurulduktan sonra yürütülmezler.

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

Zincir görevler

Karmaşık bir işlevde Task nesneleri döndüren bir API grubu kullanıyorsanız devamları kullanarak bunları birbirine bağlayabilirsiniz. Bu, derin iç içe yerleştirilmiş geri çağırmalardan kaçınmanıza yardımcı olur ve birden fazla zincirlenmiş görev için hata işleme işlemini birleştirir.

Örneğin, Task<String> döndüren ancak parametre olarak AuthResult gerektiren bir doSomething yönteminiz olduğunu varsayalım. Bu AuthResult öğesini başka bir Task öğesinden ayarsız olarak alabilirsiniz:

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

Task.continueWithTask yöntemini kullanarak bu iki görevi birbirine bağlayabilirsiniz:

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

Görevleri engelleme

Programınız zaten arka planda bir iş parçacığında çalışıyorsa geri çağırma işlevi kullanmak yerine mevcut iş parçacığını engelleyebilir ve görevin tamamlanmasını bekleyebilirsiniz:

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

Ayrıca, bir görevi engellerken zaman aşımı da belirtebilirsiniz. Böylece, görevin tamamlanması çok uzun sürerse uygulamanızın süresiz olarak takılmasını önleyebilirsiniz:

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

Birlikte çalışabilirlik

Task, diğer yaygın Android asynkron programlama kalıplarıyla uyumlu çalışacak şekilde tasarlanmıştır. ListenableFuture ve Kotlin coroutine'leri gibi diğer ilkel türlere dönüştürülebilir. Bu türlerin AndroidX tarafından önerilmesi, ihtiyaçlarınıza en uygun yaklaşımı kullanmanıza olanak tanır.

Task kullanan bir örneği aşağıda bulabilirsiniz:

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

Kotlin eş yordam

Kotlin eş yordamlarını Task ile kullanmak için projenize aşağıdaki bağımlılığı ekleyin ve ardından Task'ten dönüştürmek için kod snippet'ini kullanın.

Gradle (modül düzeyinde build.gradle, genellikle 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
Snippet
import kotlinx.coroutines.tasks.await
// ...
  textView.text = simpleTask.await()
}
MainActivity.kt

Guava ListenableFuture

Guava ListenableFuture'ü Task ile kullanmak için projenize aşağıdaki bağımlılığı ekleyin ve ardından Task'ten dönüştürmek için kod snippet'ini kullanın.

Gradle (modül düzeyinde build.gradle, genellikle app/build.gradle)
implementation "androidx.concurrent:concurrent-futures:1.2.0"
build.gradle
Snippet
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

Projenize, tercih ettiğiniz göreli asenkron kitaplığa ek olarak aşağıdaki bağımlılığı ekleyin ve ardından Task'ten dönüştürmek için kod snippet'ini kullanın.

Gradle (modül düzeyinde build.gradle, genellikle app/build.gradle)
// Source: https://github.com/ashdavies/rx-tasks
implementation 'io.ashdavies.rx.rxtasks:rx-tasks:2.2.0'
build.gradle
Snippet
import io.ashdavies.rx.rxtasks.toSingle
import java.util.concurrent.TimeUnit
// ...
simpleTask.toSingle(this).subscribe { result -> textView.text = result }
MainActivity.kt

Sonraki adımlar