搜索插件、代码仓与 APP 分类

插件详情v9.3.0

get_it

一个简单直接的服务定位器,允许将接口与具体实现解耦,并从应用程序的任何位置访问具体实现。

AndroidiOSWebmacOSWindowsLinux
近 30 天下载
255万
喜欢数
4730
Pub 分数
160

安装插件

flutter pub add get_it

插件介绍

基于插件公开信息、社区数据与项目使用情况整理的选型参考。

GetIt 是一个轻量级、简单的 Dart 和 Flutter 服务定位器,通过将接口与其实现解耦来实现依赖注入。它允许开发者在应用程序的全局范围内注册和检索服务,且只需最少的样板代码。GetIt 支持延迟实例化、工厂注册以及通过模拟进行轻松测试。它非常适合管理应用程序不同部分之间的共享依赖项,如仓库、API 或状态管理器。

适合场景

  • 跨多个小部件管理共享服务
  • 使用模拟依赖项进行测试
  • 注入仓库和 API 客户端
  • 简化状态管理设置
  • 将用户界面与业务逻辑解耦

主要特点

  • 简单的 API,设置简单
  • 支持延迟和立即实例化
  • 工厂和单例注册
  • 易于模拟以进行单元测试
  • 轻量且快速

适合对象

  • 小型到中型的Flutter应用
  • 新入门的开发者
  • 需要快速DI集成的项目
  • 优先考虑简单性而非复杂性的团队
  • 需要可测试服务层的应用程序

使用建议

  • 不适合具有复杂依赖注入需求的大规模企业应用
  • 手动注册可能导致运行时错误,如果不小心管理的话
  • 与高级依赖注入框架相比,内置生命周期管理功能有限

原始 README

以下为关联源码仓库的 README 原文快照,最新内容请访问源码仓库。

get_it logo
Buy Me A Coffee
Sponsor

get_it codecov

📚 Complete documentation available at flutter-it.dev Check out the comprehensive docs with detailed guides, examples, and best practices!

A blazing-fast service locator for Dart and Flutter that makes dependency management simple.

As your app grows, you need a way to access services, models, and business logic from anywhere without tightly coupling your code to widget trees. get_it is a simple, type-safe service locator that gives you O(1) access to your objects from anywhere in your app—no BuildContext required, no code generation, no magic.

Think of it as a smart container that holds your app's important objects. Register them once at startup, then access them from anywhere. Simple, fast, and testable.

flutter_it is a construction set — get_it works perfectly standalone or combine it with other packages like watch_it (state management), command_it (commands), or listen_it (reactive operators). Use what you need, when you need it.

Why get_it?

  • ⚡ Blazing Fast — O(1) lookups using Dart's native Maps. No reflection, no slow searches.
  • 🎯 Type Safe — Full compile-time type checking with generics. Errors caught before runtime.
  • 🧪 Test Friendly — Easily swap real implementations for mocks. Reset and reconfigure between tests.
  • 🌳 No BuildContext — Access your objects from anywhere—business logic, utilities, even pure Dart packages.
  • 📦 Framework Agnostic — Works in Flutter, pure Dart, server-side, CLI apps. No Flutter dependencies required.
  • 🔧 Zero Boilerplate — No code generation, no build_runner, no annotations. Just register and use.

Learn more about the philosophy behind get_it →

💡 New to service locators? Read Martin Fowler's classic article on Inversion of Control Containers and the Dependency Injection pattern or check out this detailed blog post on using service locators with Flutter.

Quick Start

Installation

Add to your pubspec.yaml:

dependencies:
  get_it: ^8.0.2
Basic Usage
import 'package:get_it/get_it.dart';

// Create a global instance (or use GetIt.instance)
final getIt = GetIt.instance;

// 1. Define your services
class ApiClient {
  Future<void> fetchData() async { /* ... */ }
}

class UserRepository {
  final ApiClient apiClient;
  UserRepository(this.apiClient);
}

// 2. Register them at app startup
void configureDependencies() {
  getIt.registerSingleton<ApiClient>(ApiClient());
  getIt.registerLazySingleton<UserRepository>(
    () => UserRepository(getIt<ApiClient>())
  );
}

// 3. Access from anywhere in your app
class MyHomePage extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return ElevatedButton(
      onPressed: () {
        // No BuildContext passing needed!
        getIt<UserRepository>().apiClient.fetchData();
      },
      child: Text('Fetch Data'),
    );
  }
}

That's it! Three simple steps: define, register, access.

Key Features

Registration Types

Choose the lifetime that fits your needs:

  • Singleton — Create once, share everywhere. Perfect for services that maintain state. Read more →

  • LazySingleton — Create on first access. Delays initialization until needed. Read more →

  • Factory — New instance every time. Great for stateless services or objects with short lifetimes. Read more →

Avoid untyped tear-offs as factories. Registering getIt.call (or an untyped getIt.get tear-off) as registerLazySingleton<Iface>(...) re-enters get<Iface>() and used to overflow the stack. For lazy singletons (sync and async) and cached factories GetIt now detects this circular self-resolution and throws a descriptive StateError. Plain registerFactory factories are not guarded, since a factory that recursively resolves its own type (e.g. to build a tree) is a legitimate pattern. Prefer () => getIt<Impl>() or a named function that keeps the concrete type argument.

Advanced Features
  • Scopes — Create hierarchical registration scopes for different app states (login/logout, sessions, feature flags). Read more →

  • Async Objects — Register objects that need async initialization with dependency ordering. Read more →

  • Startup Orchestration — Easily orchestrate initialization of asynchronous objects during startup. Read more →

  • Named Instances — Register multiple implementations of the same type with different names. Read more →

  • Multiple Registrations — Register multiple implementations and retrieve them all as a collection. Read more →

  • Unregistering — Remove registrations with unregister(), optionally disposing the instance. By default unregister() throws if nothing matching is registered (usually a sign that you dispose once too often); set getIt.skipUnregisterIfNotRegistered = true to silently ignore a missing registration instead. Read more →

Testing Support

get_it makes testing a breeze:

  • Easy Mocking — Replace real implementations with mocks using allowReassignment or reset()
  • Test Isolation — reset() clears all registrations between tests
  • Constructor Injection — Use optional constructor parameters to inject mocks in tests
// In tests
setUp(() {
  getIt.registerSingleton<ApiClient>(MockApiClient());
});

tearDown(() async {
  await getIt.reset();
});

Read testing guide →

DevTools Extension

get_it includes a DevTools extension that lets you visualize and inspect all registered objects in your running app:

  • View all registrations — See type, instance name, scope, registration mode, async status, ready state, and creation status
  • Instance details — View the toString() output of created instances to inspect their state
  • Manual refresh — Update the registration list anytime with the refresh button
Setup
  1. Enable debug events in your app (typically in main.dart). This enables the extension to receive automatic updates when registrations change:

    void main() {
      GetIt.instance.debugEventsEnabled = true;
      // ... rest of your setup
      runApp(MyApp());
    }
    
  2. Run your app in debug mode and open DevTools

  3. Open DevTools in the browser — The extension currently only works in the browser-based DevTools, not in the IDE-embedded version.

  4. Enable the extension — Click the Extensions button (puzzle piece icon) in the top right corner of DevTools and enable the get_it extension.

  5. Find the "get_it" tab — The extension will appear as a new tab in DevTools

For more information on using DevTools extensions, see the official Flutter DevTools documentation.

💡 Tip: Override toString() in your registered classes to see meaningful details in the DevTools extension. By default, Dart's toString() only shows the type name and instance ID.

class UserRepository {
  final String userId;
  
  @override
  String toString() => 'UserRepository(userId: $userId)';
}
Flutter Widget Previews

get_it works seamlessly with Flutter's widget previewer. Since previews run in isolation, you need to initialize get_it within the preview itself:

@Preview()
Widget myPreview() {
  if (!getIt.isRegistered<MyService>()) {
    getIt.registerSingleton<MyService>(MockService());
  }
  return const MyWidget();
}

Or use a reusable wrapper for automatic cleanup:

@Preview(name: 'My Widget', wrapper: myWrapper)
Widget myPreview() => const MyWidget();

Read Flutter previews guide →

Ecosystem Integration

get_it works independently — use it standalone for dependency injection in any Dart or Flutter project.

Want more? Combine with other packages from the flutter_it ecosystem:

  • Optional: watch_it — Reactive state management built on get_it. Watch registered objects and rebuild widgets automatically.

  • Optional: command_it — Command pattern with loading/error states. Integrates seamlessly with get_it services.

  • Optional: listen_it — ValueListenable operators (map, where, debounce). Use with objects registered in get_it.

Remember: flutter_it is a construction set. Each package works independently. Pick what you need, combine as you grow.

Learn about the ecosystem →

AI-Assisted Development

This package ships an Agent Skill for AI coding assistants (Claude Code, Cursor, GitHub Copilot, Codex, Gemini CLI and others) in skills/get-it-expert/. It teaches them the critical rules, common patterns and anti-patterns of get_it. Install it into your project with the official Dart skills tool:

dart run skills@ get

For the ecosystem-wide skills (architecture guidance, feed/data-source patterns, overview) and the skills of the other flutter_it packages run:

dart run skills@ add flutter-it/flutter_it

Learn more about AI skills →

Learn More

Documentation
  • Getting Started — Installation, basic concepts, when to use what
  • Object Registration — All registration types, parameters, disposing
  • Scopes — Hierarchical scopes, shadowing, scope management
  • Async Objects — Async initialization, dependencies, allReady()
  • Testing — Unit tests, integration tests, mocking strategies
  • Advanced Topics — Named instances, multiple GetIt instances, runtime types
  • FAQ — Common questions and troubleshooting
Community & Support
Articles & Resources

Contributing

Contributions are welcome! Please read the contributing guidelines before submitting PRs.

License

MIT License - see LICENSE file for details.

Acknowledgements

Many thanks to Brian Egan and Simon Lightfoot for the insightful discussions on the API design.


Part of the flutter_it ecosystem — Build reactive Flutter apps the easy way. No codegen, no boilerplate, just code.

所属分类

依赖

依赖清单 3 项

源码仓库

使用此插件的项目

所在榜单