event_bus

Description:

event bus

Event Bus #
A simple Event Bus using Dart Streams
for decoupling applications.


GitHub |
Pub |
Demos and Examples
Event Bus Pattern #
An Event Bus follows the publish/subscribe pattern. It allows listeners to
subscribe for events and publishers to fire events. This enables objects to
interact without requiring to explicitly define listeners and keeping track of
them.
Event Bus and MVC #
The Event Bus pattern is especially helpful for decoupling MVC
(or MVP) applications.
One group of MVC is not a problem.

But as soon as there are multiple groups of MVCs, those groups will have to talk
to each other. This creates a tight coupling between the controllers.

By communication through an Event Bus, the coupling is reduced.

Usage #
1. Create an Event Bus #
Create an instance of EventBus and make it available to other classes.
Usually there is just one Event Bus per application, but more than one may be
set up to group a specific set of events.
import 'package:event_bus/event_bus.dart';

EventBus eventBus = EventBus();
copied to clipboard
Note: The default constructor will create an asynchronous event bus. To
create a synchronous bus you must provide the optional sync: true attribute.
2. Define Events #
Any Dart class can be used as an event.
class UserLoggedInEvent {
User user;

UserLoggedInEvent(this.user);
}

class NewOrderEvent {
Order order;

NewOrderEvent(this.order);
}
copied to clipboard
3. Register Listeners #
Register listeners for specific events:
eventBus.on<UserLoggedInEvent>().listen((event) {
// All events are of type UserLoggedInEvent (or subtypes of it).
print(event.user);
});
copied to clipboard
Register listeners for all events:
eventBus.on().listen((event) {
// Print the runtime type. Such a set up could be used for logging.
print(event.runtimeType);
});
copied to clipboard
About Dart Streams
EventBus uses Dart Streams
as its underlying mechanism to keep track of listeners. You may use all
functionality available by the Stream
API. One example is the use of StreamSubscriptions
to later unsubscribe from the events.
StreamSubscription loginSubscription = eventBus.on<UserLoggedInEvent>().listen((event) {
print(event.user);
});

loginSubscription.cancel();
copied to clipboard
4. Fire Events #
Finally, we need to fire an event.
User myUser = User('Mickey');
eventBus.fire(UserLoggedInEvent(myUser));
copied to clipboard
Using Custom Stream Controllers #
Instead of using the default StreamController you can use the following constructor
to provide your own.
An example would be to use an RxDart Subject
as the controller.
import 'package:rxdart/rxdart.dart';

EventBus behaviorBus = EventBus.customController(BehaviorSubject());
copied to clipboard
Running / Building / Testing #

Run from the terminal: webdev serve
Build from the terminal: webdev build
Testing: pub run build_runner test -- -p chrome

License #
The MIT License (MIT)