Flutter未知功能插件gate_generator的潜在用途探索

Gate

Dart/Flutter 依赖注入生成器

动机

提供服务应该与您的页面或其他代码无关。依赖注入模式将创建服务类对象的责任从客户端类中分离出来。此外，使用代码生成可以摆脱样板代码。

特性

• 提供可注入为单例的服务
• 提供可动态注入的服务
• 将可注入类注入到另一个类中

入门

在您的 pubspec.yaml 文件中安装 gate 和 build_runner：

dependencies:
  build_runner: ^X.X.X
  gate: ^X.X.X

dev_dependencies:
  gate_generator: ^X.X.X

替换 X.X.X 为 pub.dev 上的最新版本。

使用

1 - 创建一个要注入的类

import 'package:gate/gate.dart';

@Injectable()
class CoffeeService {
  final S1 s1;

  CoffeeService._(this.s1);

  @Singleton()
  factory CoffeeService.simple(S1 s1) => CoffeeService._(s1);

  void pump() {
    print("CoffeeService it's working");
  }
}

您只需要：

• 在您的类上方添加 @Injectable() 注解
• 在工厂上方添加 @Singleton() 或 @Provide() 注解

2 - 注入依赖项

现在我们可以使用 @Inject 注解来注入我们的可注入对象。

import 'package:gate_example/gate/gate_provider.dart';
import 'package:gate_example/gate/coffee_service.dart';
part 'coffee_page.gate_inject.g.part';

@Inject(children: [
  InjectedChild(S1, factoryName: "build"),
  InjectedChild(CoffeeService, factoryName: "simple", attrName: "coffeeService"),
])
class CoffeePage extends StatelessWidget {
  const CoffeePage({Key? key}) : super(key: key);

  @override
  Widget build(BuildContext context) {
    coffeeService.pump();
    return Container();
  }
}

您可以根据需要向您的类中注入多个依赖项，只要它们是可注入的。

part 'coffee_page.gate_inject.g.part'; 将被添加到您的文件中。 这个文件将在下一步中生成，请勿忘记导入生成的 gate_provider.dart。

3 - 生成代码

使用 build_runner 可以在命令行中运行以下命令：

flutter packages pub run build_runner build --delete-conflicting-outputs

一旦 build_runner 完成，您就可以运行您的 Flutter 应用程序并使用所有已注入的类。

如果您更改了工厂或想要注入其他类…只需重新运行 build_runner 即可。

属性

注解

注入注解

InjectedChild 注解

为测试模拟注入的依赖项

为了替换您的服务为模拟对象，您必须在测试之前设置它们。Gate 会为您生成所有方法。

首先，使用您喜欢的库声明您的模拟服务。

然后使用 appProvider 设置模拟对象。

最后，别忘了通过将其设置为 null 来重置模拟对象。

class CoffeeServiceMock extends Mock implements CoffeeService {}

class S1ServiceMock extends Mock implements S1 {}

class S2BServiceMock extends Mock implements S2B {}

class TodoServiceMock extends Mock implements TodoService {}

void main() {
  // 初始化模拟对象
  final CoffeeService coffeeServiceMock = CoffeeServiceMock();
  final S1 s1ServiceMock = S1ServiceMock();
  final S2B s2BServiceMock = S2BServiceMock();
  final TodoService todoServiceMock = TodoServiceMock();

  group('Mock injection group', () {
    setUp(() {
      when(() => coffeeServiceMock.getMenu()).thenReturn("Best menu");
      // 设置注入的服务为模拟对象
      appProvider.setCoffeeServiceSimpleMock(coffeeServiceMock);
      appProvider.setS1BuildMock(s1ServiceMock);
      appProvider.setS2BBuildMock(s2BServiceMock);
      appProvider.setTodoServiceBeanMock(todoServiceMock);
    });

    tearDownAll(() {
      // 从 appProvider 中移除模拟对象（将使用真实对象）
      appProvider.setCoffeeServiceSimpleMock(null);
      appProvider.setS1BuildMock(null);
      appProvider.setS2BBuildMock(null);
      appProvider.setTodoServiceBeanMock(null);
    });

    test('Test mocks injection', () async {
      expect(appProvider.getCoffeeServiceSimple().getMenu(), equals('Best menu')); // 模拟返回值

      appProvider.setCoffeeServiceSimpleMock(null);

      expect(appProvider.getCoffeeServiceSimple().getMenu(), equals('No menu')); // 真实值（未模拟）
    });
  });
}

运行测试

dart pub global activate coverage
dart test --coverage="coverage"
format_coverage --lcov --in=coverage --out=coverage.lcov --packages=.packages --report-on=lib