getit Expert - Service Locator & Dependency Injection

get_it Expert - Service Locator & Dependency Injection

What: Type-safe service locator with O(1) lookup. Register services globally, retrieve anywhere without BuildContext. Pure Dart, no code generation.

CRITICAL RULES

• Register all services BEFORE runApp()
• pushNewScope() is synchronous. Use pushNewScopeAsync() for async init
• popScope() IS async (returns Future<void>)
• allReady() returns Future<void> - await it or use FutureBuilder/watch_it
• Dispose callbacks are a parameter on registration methods, not separate methods
• Once async singletons are initialized (after allReady()), access them with normal getIt<T>() - no getAsync needed
• If using watch_it, a global di alias for GetIt.I is already provided - use di<T>() instead of getIt<T>()
• NEVER register an untyped tear-off as a factory: registerLazySingleton<Iface>(getIt.call) re-enters get<Iface>(). Since 9.3.0 lazy singletons (sync/async) and cached factories throw a descriptive StateError for circular self-resolution instead of a StackOverflowError; plain factories are not guarded (recursive factories are legitimate). Use () => getIt<Impl>()

Registration

final getIt = GetIt.instance;

void configureDependencies() {
  // Singleton - created immediately
  getIt.registerSingleton<ApiClient>(ApiClient());

  // Singleton with dispose callback
  getIt.registerSingleton<StreamController>(
    StreamController(),
    dispose: (c) => c.close(),
  );

  // Lazy singleton - created on first access
  getIt.registerLazySingleton<Database>(() => Database());

  // Factory - new instance every call
  getIt.registerFactory<Logger>(() => Logger());

  // Factory with parameters
  getIt.registerFactoryParam<Logger, String, void>(
    (tag, _) => Logger(tag),
  );