Flutter浏览器引擎插件kiwi的使用

kiwi简介

kiwi是一个简单而高效的Dart和Flutter的IoC（控制反转）容器。它不依赖于反射，而是基于Map实现，因此速度非常快。kiwi可以用于代码生成或不使用代码生成。虽然代码生成能让你编码更快，但它需要额外的一次性配置。

• Pub Package
• Donate via PayPal

注意：使用此包需要Dart2

配置

在pubspec.yaml中添加kiwi作为依赖项：

dependencies:
  kiwi: ^latest_version

导入

在你的库中添加以下导入语句：

import 'package:kiwi/kiwi.dart';

使用方法

kiwi的核心是KiwiContainer类，所有实例和工厂都存储在此处。KiwiContainer作为一个单例模式实现，可以通过以下方式访问唯一实例：

KiwiContainer container = KiwiContainer();

如果你想要不同的容器，可以轻松创建作用域容器：

KiwiContainer container = KiwiContainer.scoped();

注册对象

你可以注册三种类型的对象：实例、工厂和单例。

实例

注册简单的实例：

container.registerInstance(Sith('Anakin', 'Skywalker'));

给特定实例命名：

container.registerInstance(Sith('Anakin', 'Skywalker'), name: 'DartVader');

如果你想将实例注册为超类型，只需在泛型中添加超类型：

container.registerInstance<Character>(Sith('Anakin', 'Skywalker'), name: 'DartVader');

工厂

注册工厂：

container.registerFactory((c) => Sith('Anakin', 'Skywalker'));

给特定工厂命名：

container.registerFactory((c) => Sith('Anakin', 'Skywalker'), name: 'DartVader');

如果你想将工厂注册为超类型，需要指定两者：

container.registerFactory<Character>((c) => Sith('Anakin', 'Skywalker'), name: 'DartVader');

单例

单例类似于工厂，但只在首次获取其值时调用：

container.registerSingleton((c) => Sith('Anakin', 'Skywalker'));

解析对象

你可以通过以下方式解析已注册的类型：

Sith theSith = container.resolve<Sith>();

如果它被命名注册，你可以这样获取它的值：

Sith theSith = container.resolve<Sith>('DartVader');

如果它被注册为超类型，你可以这样获取它的值：

Sith theSith = container.resolveAs<Character, Sith>();

如果它被注册为超类型并命名，你可以这样获取它的值：

Sith theSith = container.resolveAs<Character, Sith>('DartVader');

你也可以直接调用KiwiContainer来解析类型：

Sith theSith = container<Sith>('DartVader');

处理依赖关系

如果服务依赖于其他服务，可以在构造函数中添加依赖项。注册服务时，可以使用c参数解析依赖项：

class Service {}

class ServiceA extends Service {}

class ServiceB extends Service {
  ServiceB(ServiceA serviceA);
}

// 注册复杂工厂，解析依赖项
KiwiContainer container = KiwiContainer();
container.registerFactory((c) => ServiceB(c.resolve<ServiceA>()));

对于具有多个依赖项的服务，编写此类代码可能会很繁琐，因此kiwi提供了一个生成器！

注销对象

你可以随时注销工厂或实例：

// 注销Sith类型
container.unregister<Sith>();

// 注销名为DartVader的Sith类型
container.unregister<Sith>('DartVader');

清理

你可以通过调用clear方法移除所有已注册的类型：

container.clear();

忽略开发模式中的KiwiErrors

默认情况下，kiwi在以下情况下会抛出KiwiError：

• 如果你尝试再次注册同名的同一类型。
• 如果你尝试解析未注册的类型。
• 如果你尝试注销未注册的类型。

这有助于防止生产环境中可能出现的错误，但在开发模式下你可能想忽略这些KiwiError。为此，可以将KiwiContainer的silent属性设置为true：

container.silent = true;

在生产环境或当silent为true时，如果你尝试解析未注册的类型，将返回null。

示例代码

下面是一个完整的示例代码，展示了如何使用kiwi进行依赖注入和服务注册：

import 'package:kiwi/kiwi.dart';

void main() {
  KiwiContainer container = KiwiContainer();

  // 注册实例
  container.registerInstance(Logger());
  
  // 注册命名单例
  container.registerSingleton((c) => Logger(), name: 'namedLogger');
  
  // 注册带有依赖项的工厂
  container.registerFactory(
      (c) => ServiceA(logger: c.resolve<Logger>('namedLogger')));

  // 解析对象
  final commonLogger = container.resolve<Logger>();
  final namedLogger = container.resolve<Logger>('namedLogger');
  final serviceA = container.resolve<ServiceA>();

  // 打印结果
  print(commonLogger.toString()); // Hey, I'm a logger!
  print(namedLogger.toString()); // Hey, I'm a logger!
  print(serviceA.toString()); // Hey, I'm a service A!
}

class Service {
  const Service();

  @override
  String toString() {
    return 'Hey, I\'m a service!';
  }
}

class ServiceA extends Service {
  final Logger logger;

  const ServiceA({required this.logger});

  @override
  String toString() {
    return 'Hey, I\'m a service A!';
  }
}

class Logger {
  const Logger();

  @override
  String toString() {
    return 'Hey, I\'m a logger!';
  }
}

通过这个示例，你可以看到如何使用kiwi进行依赖注入，并且如何管理不同类型的对象注册和解析。希望这对你理解和使用kiwi有所帮助！