Fundamentos de Streams

Parte da seção Programação Orientada a Objetos do Journey de Dart da Coddy — lição 77 de 110.

Enquanto um Future entrega um único valor, um Stream entrega uma sequência de valores ao longo do tempo. Pense nisso como um tubo que pode emitir múltiplos pedaços de dados — perfeito para eventos, atualizações em tempo real ou processamento de dados pedaço por pedaço.

Você pode criar uma stream simples usando Stream.fromIterable() ou uma função geradora assíncrona com async* e yield:

Stream<int> countToThree() async* {
  yield 1;
  yield 2;
  yield 3;
}

Future<void> main() async {
  await for (var number in countToThree()) {
    print(number);
  }
}
// Saída: 1, 2, 3

A palavra-chave async* marca uma função que retorna um Stream, e yield emite cada valor. Para consumir o stream, use await for, que processa cada valor conforme ele chega.

Você também pode ouvir um stream usando o método listen(), que recebe uma função de callback:

Stream<String> greetings() async* {
  yield 'Hello';
  yield 'Hi';
  yield 'Hey';
}

void main() {
  greetings().listen((message) {
    print(message);
  });
}

A principal diferença em relação aos Futures: um Future é concluído uma única vez com um valor individual, enquanto um Stream pode emitir muitos valores antes de ser finalizado. Isso torna os Streams ideais para lidar com dados contínuos, como interações do usuário, leituras de sensores ou dados que chegam em partes.

Desafio

Fácil

Vamos construir um sistema de cronômetro de contagem regressiva que emite valores ao longo do tempo usando streams! Você criará uma classe que gera uma sequência de números de contagem regressiva, demonstrando como as streams entregam múltiplos valores em vez de apenas um.

Você organizará seu código em dois arquivos:

countdown.dart: Crie uma classe Countdown que gera streams de contagem regressiva. Sua classe deve ter:
- Um campo start (int) que armazena o número inicial para a contagem regressiva
- Um construtor que recebe o número inicial
- Um método countDown() que retorna um Stream<int>. Use async* e yield para emitir números de start até 0 (inclusive)
- Um método countDownWithMessage() que retorna um Stream<String>. Este deve emitir strings no formato 'T-minus [number]' para cada número de start até 1, e então emitir 'Liftoff!' como o valor final
main.dart: Importe seu arquivo de contagem regressiva e demonstre ambos os métodos de stream. Sua função main deve ser async e:
- Criar uma instância de Countdown começando de 3
- Imprimir 'Number countdown:'
- Usar await for para iterar através de countDown() e imprimir cada número
- Imprimir uma linha vazia
- Imprimir 'Launch sequence:'
- Usar await for para iterar através de countDownWithMessage() e imprimir cada mensagem

Observe como cada instrução yield emite um valor através da stream, e o await for processa cada valor conforme ele chega. Diferente de um Future que entrega um único resultado, suas streams emitirão múltiplos valores em sequência!

Saída esperada:

Number countdown:
3
2
1
0

Launch sequence:
T-minus 3
T-minus 2
T-minus 1
Liftoff!

Folha de consulta

Um Stream fornece uma sequência de valores ao longo do tempo, ao contrário de um Future, que fornece um único valor. Streams são ideais para eventos, atualizações em tempo real ou processamento de dados peça por peça.

Crie um stream usando uma função geradora assíncrona com async* e yield:

Stream<int> countToThree() async* {
  yield 1;
  yield 2;
  yield 3;
}

Consuma um stream usando await for:

Future<void> main() async {
  await for (var number in countToThree()) {
    print(number);
  }
}

Alternativamente, use o método listen() com um callback:

void main() {
  greetings().listen((message) {
    print(message);
  });
}

Você também pode criar um stream a partir de um iterável usando Stream.fromIterable().

Experimente você mesmo

import 'countdown.dart';

Future<void> main() async {
  // TODO: Crie uma instância de Countdown começando de 3
  
  // TODO: Imprima 'Number countdown:'
  
  // TODO: Use await for para iterar através de countDown() e imprimir cada número
  
  // TODO: Imprima uma linha vazia
  
  // TODO: Imprima 'Launch sequence:'
  
  // TODO: Use await for para iterar através de countDownWithMessage() e imprimir cada mensagem
}