Flutter未知功能插件gate的探索使用

Flutter未知功能插件gate的探索使用

Gate

Dart/Flutter依赖注入生成器

动机

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

特性

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

开始使用

在pubspec.yaml文件中安装gate及其构建工具：

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注解来注入我们的可注入类。

InjectedChild使用：

• 要注入的类型
• 要使用的工厂名称（你可以有多个提供的工厂）
• 属性名称（以防你想重命名它或使其私有）

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 - 生成代码

使用构建运行器可以在你的shell中运行命令：

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

一旦构建运行器完成，你就可以运行你的Flutter应用并使用所有注入的类。

如果你更改了工厂或想注入其他类…只需重新运行构建运行器。

属性

Inject 注解

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('模拟注入组', () {
    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('测试模拟注入', () 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