Modularity

Appearance

get_it_binder › Classes › GetItBinder

GetItBinder ​

class GetItBinder

Standalone Binder implementation backed by a single scoped GetIt instance, with RegistrationAwareBinder support for strategy switching.

Uses one GetIt container for both private and exported registrations, tracking exported types via an internal set.

Registration Strategies ​

Supports RegistrationAwareBinder which enables switching between replace and preserveExisting strategies at runtime. This is useful for hot reload, where existing registrations should be preserved while factory delegates are updated.

Resolution Order ​

When get or tryGet is called, lookup proceeds as:

  1. Local GetIt container.
  2. Imported binders (public exports only).
  3. Parent binder (if any).

Note: A different class also named GetItBinder exists in the modularity_injectable package. That variant manages two separate GetIt instances (private + public) and is designed for injectable code-gen.

See also:

Constructors ​

GetItBinder() ​

GetItBinder([dynamic _parent, bool _useGlobalInstance = false])

Create a binder optionally linked to a _parent scope.

When _useGlobalInstance is true, the global GetIt.instance is used instead of a fresh isolated container.

Implementation
dart
GetItBinder([this._parent, this._useGlobalInstance = false]) {
  _getIt = _useGlobalInstance ? GetIt.instance : GetIt.asNewInstance();
}

Properties ​

hashCode no setter inherited ​

int get hashCode

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.

Implementation
dart
external int get hashCode;

isExportModeEnabled no setter ​

bool get isExportModeEnabled
Implementation
dart
@override
bool get isExportModeEnabled => _isExportMode;

isPublicScopeSealed no setter ​

bool get isPublicScopeSealed
Implementation
dart
@override
bool get isPublicScopeSealed => _publicSealed;

registrationStrategy no setter ​

dynamic get registrationStrategy
Implementation
dart
@override
RegistrationStrategy get registrationStrategy => _strategyStack.last;

runtimeType no setter inherited ​

Type get runtimeType

A representation of the runtime type of the object.

Inherited from Object.

Implementation
dart
external Type get runtimeType;

Methods ​

addImports() ​

void addImports(List<dynamic> binders)
Implementation
dart
@override
void addImports(List<Binder> binders) {
  _imports.addAll(binders);
}

contains() ​

bool contains(Type type)
Implementation
dart
@override
bool contains(Type type) {
  &#47;&#47; 1. Local
  if (_getIt.isRegistered(type: type)) return true;

  &#47;&#47; 2. Imports (only check public exports)
  for (final imported in _imports) {
    if (imported is ExportableBinder) {
      if (imported.containsPublic(type)) return true;
    } else {
      if (imported.contains(type)) return true;
    }
  }

  &#47;&#47; 3. Parent
  if (_parent?.contains(type) ?? false) return true;

  return false;
}

containsPublic() ​

bool containsPublic(Type type)
Implementation
dart
@override
bool containsPublic(Type type) {
  return _exportedTypes.contains(type) && _getIt.isRegistered(type: type);
}

disableExportMode() ​

void disableExportMode()
Implementation
dart
@override
void disableExportMode() => _isExportMode = false;

dispose() ​

Future<void> dispose()
Implementation
dart
@override
Future<void> dispose() => reset();

enableExportMode() ​

void enableExportMode()
Implementation
dart
@override
void enableExportMode() => _isExportMode = true;

get() ​

T get<T extends Object>()
Implementation
dart
@override
T get<T extends Object>() {
  final object = tryGet<T>();
  if (object == null) {
    throw DependencyNotFoundException(
      'Dependency of type $T not found in GetItBinder scope.',
      requestedType: T,
      lookupContext: 'GetItBinder scope',
    );
  }
  return object;
}

noSuchMethod() inherited ​

dynamic noSuchMethod(Invocation invocation)

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:

dart
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:

dart
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.

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

parent() ​

T parent<T extends Object>()
Implementation
dart
@override
T parent<T extends Object>() {
  final object = tryParent<T>();
  if (object == null) {
    throw DependencyNotFoundException(
      'Dependency of type $T not found in parent scope.',
      requestedType: T,
      lookupContext: 'parent scope',
    );
  }
  return object;
}

registerFactory() ​

void registerFactory<T extends Object>(T Function() factory)
Implementation
dart
@override
void registerFactory<T extends Object>(T Function() factory) {
  _assertCanExport();
  final isPreserve =
      registrationStrategy == RegistrationStrategy.preserveExisting;

  if (_getIt.isRegistered<T>()) {
    if (isPreserve && _factoryDelegates.containsKey(T)) {
      _factoryDelegates[T] = factory;
      return;
    }
    _ensureUnregistered<T>();
  }

  _factoryDelegates[T] = factory;
  _trackExport<T>();
  _trackRegistration<T>();
  _getIt.registerFactory<T>(() {
    final creator = _factoryDelegates[T] as T Function()?;
    if (creator == null) {
      throw DependencyNotFoundException(
        'Factory for $T is not registered.',
        requestedType: T,
      );
    }
    return creator();
  });
}

registerLazySingleton() ​

void registerLazySingleton<T extends Object>(T Function() factory)
Implementation
dart
@override
void registerLazySingleton<T extends Object>(T Function() factory) {
  _assertCanExport();
  final isPreserve =
      registrationStrategy == RegistrationStrategy.preserveExisting;

  if (_getIt.isRegistered<T>()) {
    if (isPreserve && _lazySingletonDelegates.containsKey(T)) {
      _lazySingletonDelegates[T] = factory;
      return;
    }
    _ensureUnregistered<T>();
  }

  _lazySingletonDelegates[T] = factory;
  _trackExport<T>();
  _trackRegistration<T>();
  _getIt.registerLazySingleton<T>(() {
    final creator = _lazySingletonDelegates[T] as T Function()?;
    if (creator == null) {
      throw DependencyNotFoundException(
        'Factory for $T is not registered.',
        requestedType: T,
      );
    }
    return creator();
  });
}

registerSingleton() ​

void registerSingleton<T extends Object>(T instance)
Implementation
dart
@override
void registerSingleton<T extends Object>(T instance) {
  _assertCanExport();
  final isPreserve =
      registrationStrategy == RegistrationStrategy.preserveExisting;

  if (_getIt.isRegistered<T>()) {
    if (isPreserve) {
      return;
    }
    _ensureUnregistered<T>();
  }

  _trackExport<T>();
  _trackRegistration<T>();
  _getIt.registerSingleton<T>(instance);
}

reset() ​

Future<void> reset()

Reset all registrations and clear internal tracking state.

When using the global GetIt instance, only types registered through this binder are unregistered; otherwise the entire container is reset.

Implementation
dart
Future<void> reset() async {
  if (_useGlobalInstance) {
    for (final callback in _cleanupCallbacks.reversed) {
      await callback();
    }
    _cleanupCallbacks.clear();
  } else {
    await _getIt.reset();
  }
  _exportedTypes.clear();
  _factoryDelegates.clear();
  _lazySingletonDelegates.clear();
}

resetPublicScope() ​

void resetPublicScope()
Implementation
dart
@override
void resetPublicScope() {
  _publicSealed = false;
}

runWithStrategy() ​

T runWithStrategy<T>(dynamic strategy, T Function() body)
Implementation
dart
@override
T runWithStrategy<T>(RegistrationStrategy strategy, T Function() body) {
  _strategyStack.add(strategy);
  try {
    return body();
  } finally {
    _strategyStack.removeLast();
  }
}

sealPublicScope() ​

void sealPublicScope()
Implementation
dart
@override
void sealPublicScope() => _publicSealed = true;

toString() inherited ​

String toString()

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.

Implementation
dart
external String toString();

tryGet() ​

T? tryGet<T extends Object>()
Implementation
dart
@override
T? tryGet<T extends Object>() {
  &#47;&#47; 1. Local
  if (_getIt.isRegistered<T>()) {
    return _getIt<T>();
  }

  &#47;&#47; 2. Imports
  for (final imported in _imports) {
    if (imported is ExportableBinder) {
      final found = imported.tryGetPublic<T>();
      if (found != null) return found;
    } else {
      &#47;&#47; Fallback for other binder types
      final found = imported.tryGet<T>();
      if (found != null) return found;
    }
  }

  &#47;&#47; 3. Parent
  return _parent?.tryGet<T>();
}

tryGetPublic() ​

T? tryGetPublic<T extends Object>()
Implementation
dart
@override
T? tryGetPublic<T extends Object>() {
  if (_exportedTypes.contains(T)) {
    if (_getIt.isRegistered<T>()) {
      return _getIt<T>();
    }
  }
  return null;
}

tryParent() ​

T? tryParent<T extends Object>()
Implementation
dart
@override
T? tryParent<T extends Object>() {
  return _parent?.tryGet<T>();
}

Operators ​

operator ==() inherited ​

bool operator ==(Object other)

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.

Implementation
dart
external bool operator ==(Object other);