Flutter服务定位插件dart_service_locator的使用

dart_service_locator 是一个轻量级且易于使用的依赖注入包，适用于Flutter应用程序。它提供了简单的API来注册和解析依赖项，并支持同步和异步依赖解析。

功能

• 简单的API用于注册和解析依赖项。
• 支持同步和异步依赖解析。
• 单例和工厂实例管理。
• 内置清理机制以释放资源。
• 最小化样板代码。

安装

在你的项目中添加以下内容到 pubspec.yaml 文件：

dependencies:
  dart_service_locator: any

然后运行以下命令安装依赖：

$ flutter pub get

使用

设置依赖项

首先，你需要设置应用所需的依赖项。这些依赖项可以是同步的也可以是异步的。

import 'package:dart_service_locator/dart_service_locator.dart';

void setupDependencies() {
  // 注册同步依赖项
  register<Logger>(() => ConsoleLogger());
  register<User>(() => User());

  // 注册异步依赖项
  register<Future<Database>>(() async {
    final db = Database();
    await db.initialize();
    return db;
  });

  // 注册依赖项，该依赖项依赖于其他依赖项
  register<Future<UserRepository>>(() async {
    final db = await locate<Future<Database>>();
    return UserRepository(db);
  });
}

使用依赖项

在需要使用依赖项的地方，通过调用 locate 方法来获取它们。

import 'package:flutter/material.dart';
import 'package:dart_service_locator/dart_service_locator.dart';

class MyWidget extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return FutureBuilder<Future<UserRepository>>(
      future: locate<Future<UserRepository>>(),
      builder: (context, snapshot) {
        if (snapshot.connectionState == ConnectionState.done) {
          final userRepo = snapshot.data!;
          // 使用 userRepo
          return Text('User count: ${userRepo.getUserCount()}');
        } else {
          return CircularProgressIndicator();
        }
      },
    );
  }
}

清理

当你不再需要某些依赖项时，可以通过调用 clear 方法来清理它们。

import 'package:dart_service_locator/dart_service_locator.dart';

clear();

API参考

• register<T>(T Function() creator): 注册同步依赖项。
• locate<T>(): 获取或创建依赖项的实例。
• create<T>(): 创建一个新的依赖项实例。
• remove<T>(): 移除依赖项的实例。
• clear(): 清除所有已注册的依赖项。

示例

以下是一个完整的示例，展示了如何使用 dart_service_locator 包。

import 'package:dart_service_locator/dart_service_locator.dart';
import 'package:flutter/material.dart';

class MyService {
  String fetchData() => 'Hello from MyService!';
}

void main() {
  // 注册服务
  register<MyService>(() => MyService());

  runApp(const MyApp());
}

class MyApp extends StatelessWidget {
  const MyApp({super.key});

  [@override](/user/override)
  Widget build(BuildContext context) {
    return const MaterialApp(
      home: MyHomePage(),
    );
  }
}

class MyHomePage extends StatelessWidget {
  const MyHomePage({super.key});

  [@override](/user/override)
  Widget build(BuildContext context) {
    final myService = locate<MyService>();

    return Scaffold(
      appBar: AppBar(
        title: const Text('服务定位器示例'),
      ),
      body: Center(
        child: Text(myService.fetchData()),
      ),
    );
  }
}