Nelle coroutine, un flusso è un tipo che può emettere più valori in sequenza invece che nelle funzioni di sospensione che restituiscono un solo valore. Ad esempio, puoi utilizzare un flusso per ricevere aggiornamenti in tempo reale da un database.
I flussi sono basati su coroutine e possono fornire più valori.
Un flusso è concettualmente un flusso di dati che può essere calcolato in modo asincrono. I valori emessi devono essere dello stesso tipo. Ad esempio, Flow<Int>
è un flusso che emette valori interi.
Un flusso è molto simile a un Iterator
che produce una sequenza di valori, ma utilizza le funzioni di sospensione per produrre e utilizzare i valori in modo asincrono. Ciò significa, ad esempio, che il flusso può effettuare in modo sicuro una richiesta di rete per produrre il valore successivo senza bloccare il thread principale.
I flussi di dati sono correlati a tre entità:
- Un produttore produce dati che vengono aggiunti al flusso. Grazie alle canalizzazioni, i flussi possono produrre dati in modo asincrono.
- (Facoltativo) Gli intermediari possono modificare ogni valore emesso nel flusso o nel flusso stesso.
- Un consumatore consuma i valori dello stream.

In Android, un repository è in genere un produttore di dati dell'interfaccia utente che ha l'interfaccia utente (UI) come consumer che mostra i dati. Altre volte, il livello UI è produttore di eventi di input degli utenti e di altri livelli della gerarchia. I livelli tra il produttore e il consumatore solitamente fungono da intermediari che modificano il flusso di dati per adattarli ai requisiti del livello seguente.
Creazione di un flusso
Per creare i flussi, utilizza le API del generatore di flussi. La funzione del builder flow
crea un nuovo flusso in cui puoi
emettere manualmente i nuovi valori nel flusso di dati utilizzando la funzione
emit
.
Nel seguente esempio, un'origine dati recupera automaticamente le ultime notizie a intervalli fissi. Poiché una funzione di sospensione non può restituire più valori consecutivi, l'origine dati crea e restituisce un flusso per soddisfare questo requisito. In questo caso, l'origine dati agisce come produttore.
class NewsRemoteDataSource(
private val newsApi: NewsApi,
private val refreshIntervalMs: Long = 5000
) {
val latestNews: Flow<List<ArticleHeadline>> = flow {
while(true) {
val latestNews = newsApi.fetchLatestNews()
emit(latestNews) // Emits the result of the request to the flow
delay(refreshIntervalMs) // Suspends the coroutine for some time
}
}
}
// Interface that provides a way to make network requests with suspend functions
interface NewsApi {
suspend fun fetchLatestNews(): List<ArticleHeadline>
}
Il builder flow
viene eseguito all'interno di una coroutine. Pertanto, beneficia delle stesse API asincrone, ma si applicano alcune restrizioni:
- I flussi sono sequenziali. Dato che il produttore si trova in una condizione di sospensione, quando chiama una funzione di sospensione, il produttore sospende l'operazione finché la funzione di sospensione non la restituisce. Nell'esempio, il producer sospende fino al completamento della richiesta di rete
fetchLatestNews
. Solo allora il risultato viene inviato al flusso. - Con il builder
flow
, il produttore non puòemit
valori diCoroutineContext
diversi. Pertanto, non chiamareemit
in unCoroutineContext
diverso creando nuove coroutine o usandowithContext
blocchi di codice. In questi casi puoi utilizzare altri generatori di flussi comecallbackFlow
.
Modifica del flusso
Gli intermediari possono utilizzare gli operatori intermedi per modificare il flusso di dati senza consumare i valori. Questi operatori sono funzioni che, quando applicate a un flusso di dati, impostano una catena di operazioni che non vengono eseguite finché i valori non vengono consumati in futuro. Scopri di più sugli operatori intermedi nella documentazione di riferimento per il flusso.
Nell'esempio seguente, il livello repository utilizza l'operatore intermedio
map
per trasformare i dati da visualizzare in View
:
class NewsRepository(
private val newsRemoteDataSource: NewsRemoteDataSource,
private val userData: UserData
) {
/**
* Returns the favorite latest news applying transformations on the flow.
* These operations are lazy and don't trigger the flow. They just transform
* the current value emitted by the flow at that point in time.
*/
val favoriteLatestNews: Flow<List<ArticleHeadline>> =
newsRemoteDataSource.latestNews
// Intermediate operation to filter the list of favorite topics
.map { news -> news.filter { userData.isFavoriteTopic(it) } }
// Intermediate operation to save the latest news in the cache
.onEach { news -> saveInCache(news) }
}
Gli operatori intermedi possono essere applicati uno dopo l'altro, formando una catena di operazioni che vengono eseguite lentamente quando un elemento viene emesso nel flusso. Tieni presente che la semplice applicazione di un operatore intermedio a un flusso non avvia la raccolta del flusso.
Raccolta da un flusso
Utilizza un operatore del terminale per attivare il flusso per iniziare ad ascoltare i valori. Per ottenere tutti i valori del flusso quando vengono emessi, utilizza collect
.
Scoprite di più sugli operatori di terminali nella documentazione ufficiale sul flusso.
Dato che collect
è una funzione di sospensione, deve essere eseguita all'interno di una coroutine. Prende una funzione lambda come parametro chiamato
in ogni nuovo valore. Poiché è una funzione di sospensione, la chiamata che chiama collect
potrebbe sospendere fino alla chiusura del flusso.
Continuando l'esempio precedente, ecco una semplice implementazione di un elemento ViewModel
che utilizza i dati del livello del repository:
class LatestNewsViewModel(
private val newsRepository: NewsRepository
) : ViewModel() {
init {
viewModelScope.launch {
// Trigger the flow and consume its elements using collect
newsRepository.favoriteLatestNews.collect { favoriteNews ->
// Update View with the latest favorite news
}
}
}
}
La raccolta del flusso attiva il producer che aggiorna le ultime notizie ed emette il risultato della richiesta di rete a intervalli fissi. Poiché il producer rimane sempre attivo con il loop while(true)
, il flusso di dati verrà chiuso quando il valore di ModelModel viene cancellato e l'elemento viewModelScope
viene annullato.
La raccolta dei flussi può essere interrotta per i seguenti motivi:
- La coroutine che raccoglie viene annullata, come mostrato nell'esempio precedente. In questo modo, si interrompe anche il produttore sottostante.
- Il produttore termina di emettere articoli. In questo caso, il flusso di dati viene chiuso e l'esecuzione di coroutine chiamata
collect
viene ripristinata.
I flussi sono freddi e lanti a meno che non siano specificati con altri operatori intermedi. Ciò significa che il codice producer viene eseguito ogni volta che viene richiamato un operatore del terminale sul flusso. Nell'esempio precedente, la presenza di più raccoglitori di flussi fa sì che l'origine dati recuperi le ultime notizie più volte a intervalli fissi diversi. Per ottimizzare e condividere un flusso quando più consumatori raccolgono contemporaneamente, utilizza l'operatore shareIn
.
Individuare eccezioni impreviste
L'implementazione del produttore può provenire da una raccolta di terze parti.
Ciò significa che possono generare eccezioni impreviste. Per gestire queste eccezioni, utilizza l'operatore intermedio catch
.
class LatestNewsViewModel(
private val newsRepository: NewsRepository
) : ViewModel() {
init {
viewModelScope.launch {
newsRepository.favoriteLatestNews
// Intermediate catch operator. If an exception is thrown,
// catch and update the UI
.catch { exception -> notifyError(exception) }
.collect { favoriteNews ->
// Update View with the latest favorite news
}
}
}
}
Nell'esempio precedente, quando si verifica un'eccezione, la funzione lambda collect
non viene chiamata perché non è stato ricevuto un nuovo elemento.
catch
può anche emit
elementi al flusso. Il livello del repository di esempio potrebbe invece emit
i valori memorizzati nella cache:
class NewsRepository(...) {
val favoriteLatestNews: Flow<List<ArticleHeadline>> =
newsRemoteDataSource.latestNews
.map { news -> news.filter { userData.isFavoriteTopic(it) } }
.onEach { news -> saveInCache(news) }
// If an error happens, emit the last cached values
.catch { exception -> emit(lastCachedNews()) }
}
In questo esempio, quando si verifica un'eccezione, la funzione lambda collect
viene chiamata, in quanto il nuovo elemento è stato emesso nel flusso per via dell'eccezione.
Esecuzione in un'altra CoroutineContext
Per impostazione predefinita, il producer diflow
il builder viene eseguito nel
CoroutineContext
della coroutine che raccoglie e,
come accennato in precedenza, non puòemit
valori di un'altra
CoroutineContext
, Questo comportamento potrebbe essere indesiderato in alcuni casi.
Ad esempio, negli esempi utilizzati in questo argomento, il livello del repository non deve eseguire operazioni su Dispatchers.Main
utilizzate da viewModelScope
.
Per modificare il CoroutineContext
di un flusso, utilizza l'operatore intermedio
flowOn
.
flowOn
modifica il CoroutineContext
del flusso a monte, ovvero il producer e gli eventuali operatori intermedi applicati prima (o sopra)
flowOn
; Il flusso a valle (gli operatori intermedi dopo flowOn
, insieme al consumatore) non è interessato ed viene eseguito sul CoroutineContext
utilizzato per collect
dal flusso. Se sono presenti più operatori flowOn
, ognuno modifica l'upstream dalla propria posizione attuale.
class NewsRepository(
private val newsRemoteDataSource: NewsRemoteDataSource,
private val userData: UserData,
private val defaultDispatcher: CoroutineDispatcher
) {
val favoriteLatestNews: Flow<List<ArticleHeadline>> =
newsRemoteDataSource.latestNews
.map { news -> // Executes on the default dispatcher
news.filter { userData.isFavoriteTopic(it) }
}
.onEach { news -> // Executes on the default dispatcher
saveInCache(news)
}
// flowOn affects the upstream flow ↑
.flowOn(defaultDispatcher)
// the downstream flow ↓ is not affected
.catch { exception -> // Executes in the consumer's context
emit(lastCachedNews())
}
}
Con questo codice,onEach
emap
operatori utilizzanodefaultDispatcher
,
mentre il metodocatch
e l'utente vengono eseguitiDispatchers.Main
utilizzato daviewModelScope
,
Poiché il livello di origine dati svolge il lavoro di I/O, devi utilizzare un committente ottimizzato per le operazioni di I/O:
class NewsRemoteDataSource(
...,
private val ioDispatcher: CoroutineDispatcher
) {
val latestNews: Flow<List<ArticleHeadline>> = flow {
// Executes on the IO dispatcher
...
}
.flowOn(ioDispatcher)
}
Flussi nelle librerie Jetpack
Flow è integrato in molte librerie Jetpack ed è popolare tra le librerie di terze parti di Android. Flow è un'ottima soluzione per aggiornamenti in tempo reale e flussi di dati infiniti.
Puoi utilizzare Flusso con Stanza per ricevere notifiche sulle modifiche in un database. Quando utilizzi oggetti di accesso ai dati (DAO), restituisci un tipo Flow
per ricevere aggiornamenti in tempo reale.
@Dao
abstract class ExampleDao {
@Query("SELECT * FROM Example")
abstract fun getExamples(): Flow<List<Example>>
}
Ogni volta che viene apportata una modifica alla tabella Example
, viene emesso un nuovo elenco con i nuovi elementi nel database.
Converti le API basate su callback in flussi
callbackFlow
è un generatore di flussi che ti consente di convertire le API basate su callback in flussi.
Ad esempio, le API Android di Firebase Firestore utilizzano i callback.
Per convertire queste API in flussi e ascoltare gli aggiornamenti del database Firestore, puoi utilizzare il seguente codice:
class FirestoreUserEventsDataSource(
private val firestore: FirebaseFirestore
) {
// Method to get user events from the Firestore database
fun getUserEvents(): Flow<UserEvents> = callbackFlow {
// Reference to use in Firestore
var eventsCollection: CollectionReference? = null
try {
eventsCollection = FirebaseFirestore.getInstance()
.collection("collection")
.document("app")
} catch (e: Throwable) {
// If Firebase cannot be initialized, close the stream of data
// flow consumers will stop collecting and the coroutine will resume
close(e)
}
// Registers callback to firestore, which will be called on new events
val subscription = eventsCollection?.addSnapshotListener { snapshot, _ ->
if (snapshot == null) { return@addSnapshotListener }
// Sends events to the flow! Consumers will get the new events
try {
offer(snapshot.getEvents())
} catch (e: Throwable) {
// Event couldn't be sent to the flow
}
}
// The callback inside awaitClose will be executed when the flow is
// either closed or cancelled.
// In this case, remove the callback from Firestore
awaitClose { subscription?.remove() }
}
}
A differenza del builder flow
, callbackFlow
consente l'emissione di valori da un elemento CoroutineContext
diverso con funzione Funzione send
o al di fuori di un elemento con la funzione
trySend
.
Internamente, callbackFlow
utilizza un
canale,
che è concettualmente molto simile a una
coda di blocco.
Un canale è configurato con una capacità, ovvero il numero massimo di elementi che possono essere presenti nel buffer. Il canale creato in callbackFlow
ha una capacità predefinita di 64 elementi. Quando provi ad aggiungere un nuovo elemento
a un canale completo, send
sospende il produttore finché non c'è spazio per il nuovo elemento, offer
non aggiunge l'elemento al canale e restituisce
false
immediatamente.
Ulteriori risorse per il flusso
- Testare i flussi Kotlin su Android
StateFlow
eSharedFlow
- Risorse aggiuntive per le coroutine e il flusso di Kotlin