Membuat Tugas Push

Halaman ini menjelaskan cara membuat tugas dan menempatkannya di push queue. Saat ingin memproses tugas, Anda harus membuat objek tugas baru dan meletakkannya di antrean. Anda dapat secara eksplisit menetapkan layanan dan pengendali yang memproses tugas, dan meneruskan data khusus tugas ke pengendali secara opsional. Anda juga dapat menyesuaikan konfigurasi untuk tugas, seperti menjadwalkan waktu pada masa mendatang saat tugas harus dijalankan atau membatasi frekuensi percobaan ulang tugas yang diinginkan jika gagal.

Membuat tugas baru

Untuk membuat dan mengantrekan tugas, dapatkan Queue menggunakan QueueFactory, dan panggil metode add(). Anda bisa mendapatkan antrean bernama yang ditentukan dalam file queue.xml menggunakan metode getQueue() dari factory, atau Anda bisa mendapatkan antrean default menggunakan getDefaultQueue(). Anda dapat memanggil metode add() Queue dengan instance TaskOptions (diproduksi oleh TaskOptions.Builder, atau Anda dapat memanggilnya tanpa argumen untuk membuat tugas dengan opsi default untuk antrean.

import com.google.appengine.api.taskqueue.Queue;
import com.google.appengine.api.taskqueue.QueueFactory;
import com.google.appengine.api.taskqueue.TaskOptions;
Queue queue = QueueFactory.getDefaultQueue();
queue.add(TaskOptions.Builder.withUrl("/worker").param("key", key));

Menentukan layanan worker

Saat tugas dikeluarkan dari antreannya, layanan Task Queue akan mengirimkannya ke layanan worker. Setiap tugas memiliki target dan url, yang menentukan layanan dan pengendali yang nantinya akan menjalankan tugas.

target

Target tersebut menentukan layanan yang akan menerima permintaan HTTP untuk menjalankan tugas. Ini adalah string yang menentukan layanan/versi/instance dalam salah satu formulir kanonis. Bentuk yang paling sering digunakan adalah:

    service
    version.service
    instance.version.service

String target ditambahkan ke nama domain aplikasi Anda. Ada tiga cara menetapkan target untuk tugas:

  • Deklarasikan target saat Anda membuat tugas. Anda dapat menetapkan target secara eksplisit saat membuat tugas dengan menetapkan header Host menggunakan TaskOptions:

    taskOptions.header("Host", versionHostname)

  • Sertakan perintah target saat Anda menentukan antrean di queue.xml, sesuai dengan definisi queue-blue. Semua tugas yang ditambahkan ke antrean dengan target akan menggunakan target tersebut, meskipun target yang berbeda ditetapkan ke tugas tersebut saat proses pembuatan.

  • Jika tidak ada target yang ditentukan berdasarkan salah satu dari dua metode sebelumnya, target tugas adalah versi layanan yang mengantrekannya. Perhatikan bahwa jika Anda mengantrekan tugas dari layanan dan versi default dengan cara ini, dan versi default berubah sebelum tugas dijalankan, tugas tersebut akan berjalan dalam versi default yang baru.

url

url memilih salah satu pengendali dalam layanan target, yang akan menjalankan tugas.

url harus cocok dengan salah satu pola URL pengendali di layanan target. url dapat menyertakan parameter kueri jika metode yang ditentukan dalam tugas adalah GET atau PULL. Jika url tidak ditentukan, URL default /_ah/queue/[QUEUE_NAME] akan digunakan, dengan [QUEUE_NAME] sebagai nama antrean tugas.

Meneruskan data ke pengendali

Anda dapat meneruskan data ke pengendali sebagai parameter kueri di URL tugas, tetapi hanya jika metode yang ditentukan dalam tugas adalah GET atau PULL.

Konstruktor TaskOptions.Builder memiliki metode untuk menambahkan data sebagai payload permintaan HTTP, dan sebagai parameter, yang ditambahkan ke URL sebagai parameter kueri.

params
Jangan tentukan parameter jika Anda menggunakan metode POST bersama dengan payload, atau jika Anda menggunakan metode GET dan telah menyertakan URL dengan parameter kueri ini.

Menamai tugas

Saat Anda membuat tugas baru, App Engine akan menetapkan nama yang unik pada tugas tersebut secara default. Namun, Anda dapat menetapkan nama Anda sendiri untuk tugas menggunakan parameter name. Keuntungan menetapkan nama tugas sendiri adalah tugas yang dinamai sendiri akan dihapus duplikatnya. Artinya, Anda dapat menggunakan nama tugas untuk menjamin bahwa tugas hanya ditambahkan sekali. Penghapusan duplikat akan berlanjut selama 9 hari setelah tugas diselesaikan atau dihapus.

Perlu diperhatikan bahwa logika penghapusan duplikat menimbulkan beban performa yang signifikan, sehingga mengakibatkan peningkatan latensi dan berpotensi meningkatkan tingkat error yang terkait dengan tugas bernama. Biaya ini dapat meningkat secara signifikan jika nama tugas berurutan, seperti dengan stempel waktu. Jadi, jika Anda menetapkan nama Anda sendiri, sebaiknya gunakan imbuhan yang didistribusikan dengan baik untuk nama tugas, seperti hash konten.

Jika Anda menetapkan sendiri nama tugas, perhatikan bahwa panjang nama maksimum adalah 500 karakter dan berisi huruf besar dan kecil, angka garis bawah, dan tanda hubung.

Menambahkan tugas secara asinkron

Secara default, panggilan yang menambahkan tugas ke antrean akan bersifat sinkron. Untuk sebagian besar skenario, panggilan sinkron berfungsi dengan baik. Menambahkan tugas ke antrean biasanya merupakan operasi yang cepat. Ada sebagian kecil operasi penambahan tugas yang dapat memerlukan waktu yang jauh lebih lama, tetapi waktu median untuk menambahkan tugas kurang dari 5 milidetik.

Operasi tambahkan tugas ke antrean yang berbeda tidak dapat dilakukan dalam batch, sehingga Task Queue API juga menyediakan panggilan asinkron yang memberi Anda kemampuan untuk menambahkan tugas ini secara paralel, sehingga semakin meminimalkan latensi ini. Hal ini berguna jika Anda membangun aplikasi yang sangat sensitif terhadap latensi, dan perlu melakukan beberapa operasi tambahkan tugas ke antrean yang berbeda secara bersamaan.

Jika ingin melakukan panggilan asinkron ke task queue, gunakan metode asinkron yang disediakan oleh class Queue. Panggil get pada Future yang ditampilkan untuk memaksa permintaan diselesaikan. Saat menambahkan tugas secara asinkron dalam transaksi, Anda harus memanggil get() pada Future sebelum melakukan transaksi untuk memastikan bahwa permintaan telah selesai.

Menambahkan tugas ke dalam antrean di transaksi Cloud Datastore

Anda dapat menambahkan tugas ke dalam antrean sebagai bagian dari transaksi Datastore, sehingga tugas tersebut hanya diantrekan—dan dijamin diantrekan—jika transaksi berhasil di-commit. Tugas yang ditambahkan ke transaksi dianggap sebagai bagian darinya dan memiliki tingkat isolasi dan konsistensi yang sama.

Aplikasi tidak dapat memasukkan lebih dari lima tugas transaksi ke task queue pada satu transaksi. Tugas transaksi tidak boleh menggunakan nama yang ditentukan pengguna.

Contoh kode berikut menunjukkan cara memasukkan tugas transaksi ke push queue sebagai bagian dari transaksi Datastore:

DatastoreService ds = DatastoreServiceFactory.getDatastoreService();
Queue queue = QueueFactory.getDefaultQueue();
try {
    Transaction txn = ds.beginTransaction();

    // ...

    queue.add(TaskOptions.Builder.withUrl("/path/to/my/worker"));

    // ...
    txn.commit();
} catch (DatastoreFailureException e) {
}

Menggunakan DeferredTasks, sebagai ganti layanan worker

Menyiapkan pengendali untuk setiap tugas yang berbeda (seperti yang dijelaskan di bagian sebelumnya) bisa jadi cukup rumit, karena proses serialisasi dan deserialisasi argumen yang kompleks untuk tugas tersebut dapat menjadi hal yang rumit—terutama jika Anda memiliki banyak variasi tugas kecil yang ingin Anda jalankan pada antrean. Java SDK menyertakan antarmuka yang disebut DeferredTask. Antarmuka ini memungkinkan Anda menentukan tugas sebagai satu metode. Antarmuka ini menggunakan serialisasi Java untuk mengemas unit pekerjaan ke dalam Task Queue. Hasil sederhana dari metode tersebut dianggap berhasil. Menampilkan pengecualian apa pun dari metode tersebut dianggap sebagai kegagalan.


/** A hypothetical expensive operation we want to defer on a background task. */
public static class ExpensiveOperation implements DeferredTask {

  @Override
  public void run() {
    System.out.println("Doing an expensive operation...");
    // expensive operation to be backgrounded goes here
  }
}

/**
 * Basic demonstration of adding a deferred task.
 *
 * @param request servlet request
 * @param resp servlet response
 */
@Override
public void doGet(final HttpServletRequest request, final HttpServletResponse resp)
    throws IOException {
  // Add the task to the default queue.
  Queue queue = QueueFactory.getDefaultQueue();

  // Wait 5 seconds to run for demonstration purposes
  queue.add(
      TaskOptions.Builder.withPayload(new ExpensiveOperation())
          .etaMillis(System.currentTimeMillis() + DELAY_MS));

  resp.setContentType("text/plain");
  resp.getWriter().println("Task is backgrounded on queue!");
}

Bekerja dengan tugas di aplikasi multi-tenant

Secara default, push queue menggunakan namespace terbaru seperti yang ditetapkan dalam pengelola namespace pada saat tugas dibuat. Jika aplikasi Anda menggunakan multitenancy, lihat Namespaces Java 8 API.

Langkah selanjutnya