Stream Controller

Teil des Abschnitts Objektorientierte Programmierung der Dart-Journey von Coddy — Lektion 78 von 110.

Während async* Generatoren hervorragend zum Erstellen von Streams mit vordefinierten Daten geeignet sind, benötigen Sie manchmal mehr Kontrolle – zum Beispiel das Hinzufügen von Daten zu einem Stream aus verschiedenen Teilen Ihres Codes. Hier kommt der StreamController ins Spiel.

Ein StreamController fungiert als Manager für einen Stream. Er bietet Ihnen einen „Sink“, um Daten hinzuzufügen, und einen „Stream“, den Listener abonnieren können:

import 'dart:async';

void main() {
  var controller = StreamController<String>();
  
  // Den Stream abhören
  controller.stream.listen((data) {
    print('Received: $data');
  });
  
  // Daten über den Sink hinzufügen
  controller.add('Hello');
  controller.add('World');
  
  controller.close();  // Immer schließen, wenn fertig
}

Die add()-Methode fügt dem Stream neue Werte hinzu, und alle Listener empfangen diese sofort. Sie sollten immer close() aufrufen, wenn Sie fertig sind, um Ressourcen freizugeben.

Standardmäßig kann ein Stream nur einen Listener haben. Für mehrere Listener verwenden Sie einen Broadcast-Controller:

import 'dart:async';

void main() {
  var controller = StreamController<int>.broadcast();
  
  controller.stream.listen((n) => print('Listener 1: $n'));
  controller.stream.listen((n) => print('Listener 2: $n'));
  
  controller.add(42);
  controller.close();
}

StreamControllers sind in der OOP unerlässlich für die Erstellung ereignisgesteuerter Klassen – etwa um mehrere Teile Ihrer App zu benachrichtigen, wenn sich Daten ändern, Benutzeraktionen zu verarbeiten oder Echtzeit-Updates innerhalb Ihrer Objekte zu verwalten.

Aufgabe

Einfach

Lassen Sie uns ein Nachrichten-Hub-System bauen, das es mehreren Abonnenten ermöglicht, Nachrichten in Echtzeit zu empfangen! Sie werden einen StreamController verwenden, um den Nachrichtenfluss zu verwalten und zu demonstrieren, wie Broadcast-Streams mehrere Listener ermöglichen.

Sie werden Ihren Code in zwei Dateien organisieren:

message_hub.dart: Erstellen Sie eine MessageHub-Klasse, die die Nachrichtenverteilung mithilfe eines StreamControllers verwaltet. Ihr Hub sollte:
- Intern einen Broadcast-StreamController<String> verwenden, damit mehrere Listener abonnieren können
- Einen Getter namens messages bereitstellen, der den Stream zurückgibt, den Listener abonnieren können
- Eine broadcast(String message)-Methode haben, die eine Nachricht zum Stream hinzufügt
- Eine shutdown()-Methode haben, die den Controller schließt
main.dart: Importieren Sie Ihren Nachrichten-Hub und richten Sie ein Szenario mit mehreren Abonnenten ein, die denselben Stream abhören:
- Erstellen Sie eine MessageHub-Instanz
- Fügen Sie einen ersten Listener hinzu, der Nachrichten im Format Subscriber A: [message] ausgibt
- Fügen Sie einen zweiten Listener hinzu, der Nachrichten im Format Subscriber B: [message] ausgibt
- Senden Sie drei Nachrichten per Broadcast: Hello everyone, Welcome to the hub und Goodbye
- Schalten Sie den Hub aus

Denken Sie daran, dart:async in Ihrer Nachrichten-Hub-Datei zu importieren, um auf den StreamController zuzugreifen. Beachten Sie, wie beide Abonnenten jede gesendete Nachricht erhalten – das ist die Stärke von Broadcast-Streams!

Erwartete Ausgabe:

Subscriber A: Hello everyone
Subscriber B: Hello everyone
Subscriber A: Welcome to the hub
Subscriber B: Welcome to the hub
Subscriber A: Goodbye
Subscriber B: Goodbye

Spickzettel

Ein StreamController verwaltet einen Stream und bietet Kontrolle darüber, wann und wie Daten hinzugefügt werden. Er stellt einen „Sink“ zum Hinzufügen von Daten und einen „Stream“ bereit, den Listener abonnieren können.

Grundlegende Verwendung:

import 'dart:async';

var controller = StreamController<String>();

// Listen to the stream
controller.stream.listen((data) {
  print('Received: $data');
});

// Add data through the sink
controller.add('Hello');
controller.add('World');

controller.close();  // Always close when done

Die Methode add() schiebt neue Werte in den Stream. Listener empfangen diese sofort. Rufen Sie nach Abschluss immer close() auf, um Ressourcen freizugeben.

Standardmäßig kann ein Stream nur einen Listener haben. Verwenden Sie für mehrere Listener einen Broadcast-Controller:

var controller = StreamController<int>.broadcast();

controller.stream.listen((n) => print('Listener 1: $n'));
controller.stream.listen((n) => print('Listener 2: $n'));

controller.add(42);
controller.close();

StreamController sind essenziell für die Erstellung ereignisgesteuerter Klassen, die Benachrichtigung mehrerer Teile Ihrer App bei Datenänderungen, die Verarbeitung von Benutzeraktionen oder die Verwaltung von Echtzeit-Updates.

Probier es selbst

import 'message_hub.dart';

void main() {
  // TODO: Erstelle eine MessageHub-Instanz
  
  // TODO: Füge den ersten Listener hinzu, der Folgendes ausgibt: Subscriber A: [message]
  
  // TODO: Füge den zweiten Listener hinzu, der Folgendes ausgibt: Subscriber B: [message]
  
  // TODO: Übertrage drei Nachrichten:
  // - "Hello everyone"
  // - "Welcome to the hub"
  // - "Goodbye"
  
  // TODO: Fahre den Hub herunter
}