Creazione di attività push

Questa pagina descrive come creare le attività e inserirle nelle code in modalità push. Quando vuoi elaborare un'attività, devi creare un nuovo oggetto attività e inserirlo in una coda. Puoi specificare in modo esplicito il servizio e il gestore che elaborano l'attività e, facoltativamente, trasmettere al gestore dati specifici dell'attività. Puoi anche ottimizzare la configurazione dell'attività, ad esempio pianificare un orario futuro in cui deve essere eseguita o limitare il numero di tentativi se l'attività non va a buon fine.

Creazione di una nuova attività

Per creare e mettere in coda un'attività, ottieni un Queue utilizzando QueueFactory e chiama il relativo metodo add(). Puoi ottenere una coda denominata specificata nel file queue.xml utilizzando il metodo getQueue() della factory oppure puoi ottenere la coda predefinita utilizzando getDefaultQueue(). Puoi chiamare il metodo add() di Queue con un'istanza TaskOptions (prodotta da TaskOptions.Builder) oppure puoi chiamarlo senza argomenti per creare un'attività con le opzioni predefinite per la coda.

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

Specificare il servizio di worker

Quando un'attività viene rimossa dalla coda, il servizio Task Queue la invia a un servizio worker. Ogni attività ha un target e un URL, che determinano quale servizio e gestore eseguiranno l'attività.

target

La destinazione specifica il servizio che riceverà la richiesta HTTP per eseguire l'attività. È una stringa che specifica un servizio/versione/istanza in una qualsiasi delle forme canoniche. I moduli più utilizzati sono:

    service
    version.service
    instance.version.service

La stringa di destinazione viene anteposta al nome di dominio della tua app. Esistono tre modi per impostare la destinazione di un'attività:

  • Dichiara il target quando crei l'attività. Puoi impostare esplicitamente la destinazione quando crei l'attività impostando l'intestazione Host utilizzando TaskOptions:

    taskOptions.header("Host", versionHostname)

  • Includi una direttiva target quando definisci una coda nel queue.xml, come nella definizione di queue-blue. Tutte le attività aggiunte a una coda con un target utilizzeranno questa destinazione, anche se all'attività è stata assegnata una destinazione diversa al momento della creazione.

  • Se non viene specificata alcuna destinazione in base a uno dei due metodi precedenti, la destinazione del task è la versione del servizio che lo mette in coda. Tieni presente che se metti in coda un'attività dal servizio e dalla versione predefiniti in questo modo e la versione predefinita cambia prima dell'esecuzione dell'attività, quest'ultima verrà eseguita nella nuova versione predefinita.

url

url seleziona uno dei gestori nel servizio di destinazione, che eseguirà l'attività.

url deve corrispondere a uno dei pattern URL del gestore nel servizio di destinazione. url può includere parametri di ricerca se il metodo specificato nell'attività è GET o PULL. Se non viene specificato alcun url, viene utilizzato l'URL predefinito /_ah/queue/[QUEUE_NAME], dove [QUEUE_NAME] è il nome della coda del task.

Trasferimento dei dati al gestore

Puoi trasmettere i dati al gestore come parametri di ricerca nell'URL dell'attività, ma solo se il metodo specificato nell'attività è GET o PULL.

Il costruttore TaskOptions.Builder ha metodi per aggiungere dati come payload della richiesta HTTP e come parametri, che vengono aggiunti all'URL come parametri di query.

params
Non specificare i parametri se utilizzi il metodo POST insieme a un payload, o se utilizzi il metodo GET e hai incluso un URL con parametri di query.

Assegnare un nome a un'attività

Quando crei una nuova attività, App Engine le assegna un nome univoco per impostazione predefinita. Tuttavia, puoi assegnare il tuo nome a un'attività utilizzando il parametro name. Un vantaggio dell'assegnazione di nomi alle attività è che le attività con nome vengono deduplicate, il che significa che puoi utilizzare i nomi delle attività per garantire che un'attività venga aggiunta una sola volta. La deduplicazione continua per 9 giorni dopo il completamento o l'eliminazione dell'attività.

Tieni presente che la logica di deduplicazione introduce un overhead delle prestazioni significativo, con conseguente aumento delle latenze e potenzialmente dei tassi di errore associati alle attività denominate. Questi costi possono aumentare notevolmente se i nomi delle attività sono sequenziali, ad esempio con i timestamp. Pertanto, se assegni i tuoi nomi, ti consigliamo di utilizzare un prefisso ben distribuito per i nomi delle attività, ad esempio un hash dei contenuti.

Se assegni i tuoi nomi alle attività, tieni presente che la lunghezza massima del nome è di 500 caratteri e che il nome può contenere lettere maiuscole e minuscole, numeri, trattini bassi e trattini.

Aggiunta di attività in modo asincrono

Per impostazione predefinita, le chiamate che aggiungono attività alle code sono sincrone. Nella maggior parte degli scenari, le chiamate sincrone funzionano bene. L'aggiunta di un'attività a una coda è in genere un'operazione rapida. Una piccola percentuale di operazioni di aggiunta di attività può richiedere molto più tempo, ma il tempo mediano per aggiungere un'attività è inferiore a 5 ms.

Le operazioni di aggiunta di attività a code diverse non possono essere raggruppate in batch, pertanto l'API Task Queue fornisce anche chiamate asincrone che ti consentono di aggiungere queste attività in parallelo, riducendo ulteriormente questa latenza. Questa operazione è utile se stai creando un'applicazione estremamente sensibile alla latenza che deve eseguire contemporaneamente diverse operazioni di aggiunta di attività a code diverse.

Se vuoi effettuare chiamate asincrone a una coda di attività, utilizza i metodi asincroni forniti dalla classe Queue. Chiama get sul Future restituito per forzare il completamento della richiesta. Quando aggiungi in modo asincrono attività in una transazione, devi chiamare get() su Future prima di eseguire il commit della transazione per assicurarti che la richiesta sia stata completata.

Accodamento delle attività nelle transazioni Cloud Datastore

Puoi mettere in coda un'attività nell'ambito di una transazione Datastore, in modo che l'attività venga messa in coda, e garantita per la messa in coda, solo se la transazione viene eseguita correttamente. Le attività aggiunte in una transazione sono considerate parte della transazione e hanno lo stesso livello di isolamento e coerenza.

Un'applicazione non può inserire più di cinque attività transazionali in code di attività durante una singola transazione. Le attività transazionali non devono avere nomi specificati dall'utente.

Il seguente esempio di codice mostra come inserire attività transazionali in una coda in modalità pushh nell'ambito di una transazione 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) {
}

Utilizzo di DeferredTasks anziché di un servizio worker

La configurazione di un gestore per ogni attività distinta (come descritto nelle sezioni precedenti) può essere complessa, così come la serializzazione e la deserializzazione di argomenti complessi per l'attività, in particolare se hai molte attività diverse ma piccole che vuoi eseguire nella coda. L'SDK Java include un'interfaccia chiamata DeferredTask. Questa interfaccia consente di definire un'attività come un singolo metodo. Questa interfaccia utilizza la serializzazione Java per raggruppare un'unità di lavoro in una coda delle attività. Un semplice ritorno da questo metodo viene considerato riuscito. La generazione di qualsiasi eccezione da questo metodo viene considerata un errore.


/** 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!");
}

Utilizzare le attività in un'applicazione multi-tenant

Per impostazione predefinita, le code push utilizzano lo spazio dei nomi corrente impostato nel gestore dello spazio dei nomi al momento della creazione dell'attività. Se la tua applicazione utilizza il multitenancy, consulta l'API Namespaces Java 8.

Passaggi successivi