Concatenamento dei lavori

WorkManager ti consente di creare e mettere in coda una catena di lavoro che specifica più attività dipendenti e definisce l'ordine in cui devono essere eseguite. Questa funzionalità è particolarmente utile quando devi eseguire diverse attività in un ordine particolare.

Per creare una catena di lavoro, puoi utilizzare WorkManager.beginWith(OneTimeWorkRequest) o WorkManager.beginWith(List<OneTimeWorkRequest>) , che restituiscono ciascuna un'istanza di WorkContinuation.

Un WorkContinuation può essere utilizzato per aggiungere istanze OneTimeWorkRequest dipendenti utilizzando then(OneTimeWorkRequest) o then(List<OneTimeWorkRequest>) .

Ogni chiamata di WorkContinuation.then(...) restituisce una nuova istanza di WorkContinuation. Se aggiungi un List di OneTimeWorkRequest istanze, queste richieste possono essere eseguite in parallelo.

Infine, puoi utilizzare il metodo WorkContinuation.enqueue() per enqueue() la catena di WorkContinuation.

Vediamo un esempio. In questo esempio, sono configurati per l'esecuzione (potenzialmente in parallelo) tre diversi job worker. I risultati di questi worker vengono poi uniti e trasmessi a un job worker con cache. Infine, l'output del job viene passato a un worker di caricamento, che carica i risultati su un server remoto.

Kotlin


WorkManager.getInstance(myContext)
   // Candidates to run in parallel
   .beginWith(listOf(plantName1, plantName2, plantName3))
   // Dependent work (only runs after all previous work in chain)
   .then(cache)
   .then(upload)
   // Call enqueue to kick things off
   .enqueue()

Java


WorkManager.getInstance(myContext)
   // Candidates to run in parallel
   .beginWith(Arrays.asList(plantName1, plantName2, plantName3))
   // Dependent work (only runs after all previous work in chain)
   .then(cache)
   .then(upload)
   // Call enqueue to kick things off
   .enqueue();

Unioni di input

Quando colleghi più istanze di OneTimeWorkRequest, l'output delle richieste di lavoro principali viene passato come input ai secondari. Pertanto, nell'esempio precedente, gli output di plantName1, plantName2 e plantName3 verrebbero passati come input alla richiesta cache.

Per gestire gli input di più richieste di lavoro principali, WorkManager utilizza InputMerger.

Esistono due diversi tipi di InputMerger forniti da WorkManager:

  • OverwritingInputMerger tenta di aggiungere tutte le chiavi da tutti gli input all'output. In caso di conflitti, sovrascrive le chiavi impostate in precedenza.

  • ArrayCreatingInputMerger tenta di unire gli input, creando array se necessario.

Se hai un caso d'uso più specifico, puoi crearne uno tuo sottoclassificando InputMerger.

OverwritingInputMerger

OverwritingInputMerger è il metodo di unione predefinito. Se esistono conflitti di chiavi nella combinazione, l'ultimo valore di una chiave sovrascriverà eventuali versioni precedenti nei dati di output risultanti.

Ad esempio, se gli input della pianta hanno ciascuno una chiave corrispondente ai rispettivi nomi di variabile ("plantName1", "plantName2" e "plantName3"), i dati passati al worker cache avranno tre coppie chiave-valore.

Diagramma che mostra tre job che trasmettono output diversi al job successivo della catena. Poiché i tre output hanno chiavi diverse, il job successivo riceve tre coppie chiave/valore.

In caso di conflitto, "vince" l'ultimo worker completato e il relativo valore viene passato a cache.

Diagramma che mostra tre job che trasmettono gli output al job successivo della catena. In questo caso, due di questi job producono output con la stessa chiave. Di conseguenza, il job successivo riceve due coppie chiave/valore, con una delle uscite in conflitto omessa.

Poiché le richieste di lavoro vengono eseguite in parallelo, non hai alcuna garanzia sull'ordine di esecuzione. Nell'esempio precedente, plantName1 potrebbe contenere un valore "tulip" o "elm", a seconda del valore scritto per ultimo. Se esiste la possibilità di un conflitto di chiavi e devi conservare tutti i dati di output in un'unione, ArrayCreatingInputMerger potrebbe essere un'opzione migliore.

ArrayCreatingInputMerger

Per l'esempio precedente, dato che vogliamo conservare gli output di tutti i worker con nome pianta, dobbiamo utilizzare un ArrayCreatingInputMerger.

Kotlin


val cache: OneTimeWorkRequest = OneTimeWorkRequestBuilder<PlantWorker>()
   .setInputMerger(ArrayCreatingInputMerger::class)
   .setConstraints(constraints)
   .build()

Java


OneTimeWorkRequest cache = new OneTimeWorkRequest.Builder(PlantWorker.class)
       .setInputMerger(ArrayCreatingInputMerger.class)
       .setConstraints(constraints)
       .build();

ArrayCreatingInputMerger associa ogni chiave a un array. Se ciascuna delle chiavi è univoca, il risultato è una serie di array di un elemento.

Diagramma che mostra tre job che trasmettono output diversi al job successivo della catena. Al job successivo vengono passati tre array, uno per ogni chiave di output. Ogni array ha un singolo elemento.

In caso di collisioni di chiavi, tutti i valori corrispondenti vengono raggruppati in un array.

Diagramma che mostra tre job che trasmettono gli output al job successivo della catena. In questo caso, due di questi job producono output con la stessa chiave. Al job successivo vengono passati due array, uno per ogni chiave. Uno di questi array ha due membri, poiché erano presenti due output con quella chiave.

Stati di chaining e di lavoro

Le catene di OneTimeWorkRequest vengono eseguite in sequenza purché il loro lavoro sia completato correttamente (ovvero restituiscano un Result.success()). Le richieste di lavoro possono non riuscire o essere annullate durante l'esecuzione, con effetti a valle sulle richieste di lavoro dipendenti.

Quando il primo OneTimeWorkRequest viene inserito in coda in una catena di richieste di lavoro, tutte le richieste di lavoro successive vengono bloccate fino al completamento del lavoro della prima richiesta di lavoro.

Diagramma che mostra una catena di job. Il primo job viene inserito in coda; tutti i job successivi vengono bloccati fino al termine del primo.

Una volta inserita in coda e soddisfatti tutti i vincoli di lavoro, la prima richiesta di lavoro inizia a essere eseguita. Se il lavoro viene completato correttamente in OneTimeWorkRequest o List<OneTimeWorkRequest> principale (ovvero restituisce un Result.success()), l'insieme successivo di richieste di lavoro dipendenti verrà messo in coda.

Diagramma che mostra una catena di job. Il primo job è andato a buon fine e i suoi due successori immediati sono in coda. I job rimanenti vengono bloccati fino al completamento dei job precedenti.

Se ogni richiesta di lavoro viene completata correttamente, lo stesso pattern si propaga nel resto della catena di richieste di lavoro fino al completamento di tutto il lavoro nella catena. Sebbene si tratti del caso più semplice e spesso preferito, gli stati di errore sono altrettanto importanti da gestire.

Quando si verifica un errore durante l'elaborazione della richiesta di lavoro da parte di un worker, puoi riprovare in base a un criterio di backoff definito. Se viene eseguito un nuovo tentativo per una richiesta che fa parte di una catena, verrà eseguito il nuovo tentativo solo per quella richiesta con i dati di input forniti. Qualsiasi lavoro in esecuzione in parallelo non sarà interessato.

Diagramma che mostra una catena di job. Uno dei job non è riuscito, ma è stato definito un criterio di backoff. Il job verrà eseguito di nuovo dopo il tempo appropriato. I job successivi nella catena vengono bloccati finché non viene eseguito correttamente.

Per ulteriori informazioni sulla definizione di strategie di ripetizione personalizzate, consulta le norme relative alla ripetizione e al ritiro.

Se il criterio di ripetizione non è definito o è esaurito oppure raggiungi uno stato in cui un OneTimeWorkRequest restituisce Result.failure(), la richiesta di lavoro e tutte le richieste di lavoro dipendenti vengono contrassegnate come FAILED.

Diagramma che mostra una catena di job. Un job non è riuscito e non è possibile riprovare. Di conseguenza, non riescono nemmeno tutti i job successivi nella catena.

La stessa logica si applica quando un OneTimeWorkRequest viene annullato. Anche le richieste di lavoro dipendenti sono contrassegnate da CANCELLED e il relativo lavoro non verrà eseguito.

Diagramma che mostra una catena di job. Un job è stato annullato. Di conseguenza, vengono annullati anche tutti i job successivi nella catena.

Tieni presente che se aggiungi altre richieste di lavoro a una catena che non è andata a buon fine o che ha annullato le richieste di lavoro, anche la richiesta di lavoro appena aggiunta verrà contrassegnata rispettivamente come FAILED o CANCELLED. Se vuoi estendere il lavoro di una catena esistente, consulta APPEND_OR_REPLACE in ExistingWorkPolicy.

Quando crei catene di richieste di lavoro, le richieste di lavoro dipendenti devono definire le regole di ripetizione per garantire che il lavoro venga sempre completato in modo tempestivo. Le richieste di lavoro non riuscite potrebbero comportare catene incomplete e/o stati imprevisti.

Per ulteriori informazioni, consulta la sezione Annullare e interrompere il lavoro.