ModuleController#

Manages the full lifecycle of a single Module: dependency resolution, initialization, hot reload, and disposal.

The controller orchestrates the following sequence during initialize:

1. Resolves and initializes all imported modules via GraphResolver.
2. Validates Module.expects against available scopes.
3. Calls Module.binds (private scope) and Module.exports (public scope).
4. Applies any overrides to the binder.
5. Calls Module.onInit for async setup.

final controller = ModuleController(AppModule());
await controller.initialize({});

// Access dependencies:
final service = controller.binder.get<MyService>();

// Dispose when done:
await controller.dispose();

See also:

• Module for the lifecycle hooks.
• GraphResolver for the import resolution algorithm.
• ModuleOverrideScope for hierarchical dependency overrides.

Constructors#

ModuleController()#

Creates a controller for module with optional DI configuration.

When neither binder nor binderFactory is supplied, a default SimpleBinderFactory is used.

ModuleController(
  this.module, {
  Binder? binder,
  BinderFactory? binderFactory,
  this.overrides,
  ModuleOverrideScope? overrideScopeTree,
  this.interceptors = const [],
}) : _statusController = StreamController<ModuleStatus>.broadcast(),
     binder = binder ?? (binderFactory ?? SimpleBinderFactory()).create(),
     _binderFactory = binderFactory ?? SimpleBinderFactory(),
     overrideScope =
         overrideScopeTree?.withAdditionalOverride(overrides) ??
         (overrides != null
             ? ModuleOverrideScope(selfOverrides: overrides)
             : overrideScopeTree) {
  _statusController.add(ModuleStatus.initial);
}

Properties#

binder final#

The Binder that holds all dependency registrations for module.

final Binder binder;

currentStatus no setter#

Return the most recent ModuleStatus of this controller.

ModuleStatus get currentStatus => _currentStatus;

hashCode no setter inherited#

The hash code for this object.

A hash code is a single integer which represents the state of the object that affects operator == comparisons.

All objects have hash codes. The default hash code implemented by Object represents only the identity of the object, the same way as the default operator == implementation only considers objects equal if they are identical (see identityHashCode).

If operator == is overridden to use the object state instead, the hash code must also be changed to represent that state, otherwise the object cannot be used in hash based data structures like the default Set and Map implementations.

Hash codes must be the same for objects that are equal to each other according to operator ==. The hash code of an object should only change if the object changes in a way that affects equality. There are no further requirements for the hash codes. They need not be consistent between executions of the same program and there are no distribution guarantees.

Objects that are not equal are allowed to have the same hash code. It is even technically allowed that all instances have the same hash code, but if clashes happen too often, it may reduce the efficiency of hash-based data structures like HashSet or HashMap.

If a subclass overrides hashCode, it should override the operator == operator as well to maintain consistency.

Inherited from Object.

external int get hashCode;

importedControllers no setter#

References to the controllers of imported modules.

List<ModuleController> get importedControllers =>
    List.unmodifiable(_importedControllers);

interceptors final#

Ordered list of ModuleInterceptors notified at each lifecycle event.

final List<ModuleInterceptor> interceptors;

lastError no setter#

Return the error captured during the last failed initialize call, or null if no error occurred.

Object? get lastError => _lastError;

module final#

The Module whose lifecycle this controller manages.

final Module module;

overrides final#

Optional callback applied to the Binder after binds/exports to override registrations (e.g. for testing or feature flags).

final void Function(Binder)? overrides;

overrideScope final#

Hierarchical override scope propagated to imported modules.

final ModuleOverrideScope? overrideScope;

runtimeType no setter inherited#

A representation of the runtime type of the object.

Inherited from Object.

external Type get runtimeType;

status no setter#

Broadcast stream of ModuleStatus transitions.

Stream<ModuleStatus> get status => _statusController.stream;

Methods#

configure()#

Passes args to the module's Configurable.configure method.

Throws ModuleLifecycleException if the module implements Configurable but the argument type does not match.

void configure(dynamic args) {
  if (_currentStatus != ModuleStatus.initial) {
    throw ModuleLifecycleException(
      'Module ${module.runtimeType} cannot be configured after initialization has started.',
      moduleType: module.runtimeType,
      state: _currentStatus,
    );
  }

  if (module is Configurable) {
    try {
      (module as Configurable).configure(args);
    } catch (error) {
      // Handle generic type mismatch gracefully or rethrow
      // If we pass wrong type to configure(T args), Dart throws TypeError.
      final exception = ModuleLifecycleException(
        'Module ${module.runtimeType} failed to configure: '
        'Expected arguments of correct type for Configurable<T>.\n'
        'Error: $error',
        moduleType: module.runtimeType,
      );
      _lastError = exception;
      _updateStatus(ModuleStatus.error);
      throw exception;
    }
  }
}

dispose()#

Disposes the module, its Binder, and closes the status stream.

Calls Module.onDispose, then DisposableBinder.dispose if the binder supports it, and finally closes the status stream.

Future<void> dispose() {
  return _disposeFuture ??= _disposeInternal(<ModuleController>{});
}

hotReload()#

Re-runs Module.binds and Module.exports under RegistrationStrategy.preserveExisting to refresh factory closures without losing singleton state.

No-op if the module is not in the ModuleStatus.loaded state.

void hotReload() {
  if (_currentStatus != ModuleStatus.loaded) return;

  // Re-run binds to update factories.
  // For MVP we simply call the hook and overwrite registrations.
  // In the future SimpleBinder should support "updateFactoryOnly".

  final aware = _registrationAwareBinder;
  if (aware != null) {
    aware.runWithStrategy(RegistrationStrategy.preserveExisting, () {
      _runBindsAndExports(resetPublicScope: true);
    });
  } else {
    _runBindsAndExports(resetPublicScope: true);
  }

  // User hook
  module.hotReload(binder);
}

initialize()#

Runs the full initialization lifecycle for this module.

Uses globalModuleRegistry to deduplicate module controllers across concurrent import branches. Pass graphResolutionStack for cycle detection when resolving nested imports.

Throws CircularDependencyException, ModuleConfigurationException, or ModuleLifecycleException on failure.

Future<void> initialize(
  Map<ModuleRegistryKey, ModuleController> globalModuleRegistry, {

  &#47;&#47;&#47; Legacy type-only cycle stack. Prefer [graphResolutionStack].
  Set<Type>? resolutionStack,
  Set<ModuleGraphNodeKey>? graphResolutionStack,
}) {
  switch (_currentStatus) {
    case ModuleStatus.initial:
      _initializeFuture ??= _initializeInternal(
        globalModuleRegistry,
        resolutionStack: resolutionStack,
        graphResolutionStack: graphResolutionStack,
      );
      return _initializeFuture!;
    case ModuleStatus.loading:
      return _initializeFuture ?? Future<void>.value();
    case ModuleStatus.loaded:
      return Future<void>.value();
    case ModuleStatus.error:
      return Future<void>.error(
        ModuleLifecycleException(
          'Module ${module.runtimeType} failed to initialize previously. '
          'Create a new ModuleController to retry initialization.',
          moduleType: module.runtimeType,
          state: ModuleStatus.error,
        ),
      );
    case ModuleStatus.disposed:
      return Future<void>.error(
        ModuleLifecycleException(
          'Module ${module.runtimeType} has been disposed and cannot be initialized again.',
          moduleType: module.runtimeType,
          state: ModuleStatus.disposed,
        ),
      );
  }
}

noSuchMethod() inherited#

Invoked when a nonexistent method or property is accessed.

A dynamic member invocation can attempt to call a member which doesn't exist on the receiving object. Example:

dynamic object = 1;
object.add(42); // Statically allowed, run-time error

This invalid code will invoke the noSuchMethod method of the integer 1 with an Invocation representing the .add(42) call and arguments (which then throws).

Classes can override noSuchMethod to provide custom behavior for such invalid dynamic invocations.

A class with a non-default noSuchMethod invocation can also omit implementations for members of its interface. Example:

class MockList<T> implements List<T> {
  noSuchMethod(Invocation invocation) {
    log(invocation);
    super.noSuchMethod(invocation); // Will throw.
  }
}
void main() {
  MockList().add(42);
}

This code has no compile-time warnings or errors even though the MockList class has no concrete implementation of any of the List interface methods. Calls to List methods are forwarded to noSuchMethod, so this code will log an invocation similar to Invocation.method(#add, [42]) and then throw.

If a value is returned from noSuchMethod, it becomes the result of the original invocation. If the value is not of a type that can be returned by the original invocation, a type error occurs at the invocation.

The default behavior is to throw a NoSuchMethodError.

Inherited from Object.

@pragma("vm:entry-point")
@pragma("wasm:entry-point")
external dynamic noSuchMethod(Invocation invocation);

toString() inherited#

A string representation of this object.

Some classes have a default textual representation, often paired with a static parse function (like int.parse). These classes will provide the textual representation as their string representation.

Other classes have no meaningful textual representation that a program will care about. Such classes will typically override toString to provide useful information when inspecting the object, mainly for debugging or logging.

Inherited from Object.

external String toString();

Operators#

operator ==() inherited#

The equality operator.

The default behavior for all Objects is to return true if and only if this object and other are the same object.

Override this method to specify a different equality relation on a class. The overriding method must still be an equivalence relation. That is, it must be:

• Total: It must return a boolean for all arguments. It should never throw.

• Reflexive: For all objects o, o == o must be true.

• Symmetric: For all objects o1 and o2, o1 == o2 and o2 == o1 must either both be true, or both be false.

• Transitive: For all objects o1, o2, and o3, if o1 == o2 and o2 == o3 are true, then o1 == o3 must be true.

The method should also be consistent over time, so whether two objects are equal should only change if at least one of the objects was modified.

If a subclass overrides the equality operator, it should override the hashCode method as well to maintain consistency.

Inherited from Object.

external bool operator ==(Object other);