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

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

DepGen

简而言之，这个包允许你在项目中实现依赖注入。

功能

该包让你生成特殊的方法来创建类的实例，并自动从环境中替换依赖项。提前展示一下这些方法的作用：

手动指定依赖项

// 一个示例类，带有依赖项
class MyPet {
    MyPet({
        required String name,
        required IPetsRepository petsRepository,
        required IShopRepository shopRepository,
    }) {
        // ...一些魔法...
    }
}

void main() {
    ...
    final pet = MyPet(
        name: 'Lucky',
        petsRepository: context.read<IPetsRepository>(),
        shopRepository: context.read<IShopRepository>(),
    );
    ...
}

使用特殊方法自动生成依赖项

[@DepGen](/user/DepGen)()
class MyPet {
    MyPet({
        required String name,
        @DepArg() required IPetsRepository petsRepository,
        @DepArg() required IShopRepository shopRepository,
    }) {
        // ...一些魔法...
    }
}

void main() {
    ...
    final pet = context.depGen().buildMyPet(name: 'Lucky');
    ...
}

如何开始

以下是开始使用的一些步骤：

• 导入包
• 注解放置
• 代码生成
• 环境描述
• 集成到小部件层次结构
• 使用构建方法

注意：其中一些步骤在设计阶段只需执行一次，因此使用此包不会带来任何不便

导入包

使用Dart：

dart pub add dep_gen

使用Flutter：

flutter pub add dep_gen

注解放置

为了进行代码生成，使用了特殊的注解 - [@DepGen](/user/DepGen) 和 @DepArg。第一个（DepGen）用于指示将为其创建构建方法的类。第二个注解（DepArg）用于指示需要自动替换的依赖项。

[@DepGen](/user/DepGen)()
class MyPet {
    MyPet({
        required String name,
        @DepArg() required IPetsRepository petsRepository,
        @DepArg() required IShopRepository shopRepository,
    }) {
        // ...一些魔法...
    }
}

❗️ 重要提示：只有命名参数可以标记此注解

代码生成

从项目目录运行代码生成器。

flutter pub run dep_gen:generate -p lib/domain/environment

命令行上作为参数指定要生成的文件路径：

-p lib/domain/environment

默认情况下，生成的文件名为：

builders.dep_gen.dart

环境描述

那些将被替换为依赖项的类实例不能凭空而来。我们需要描述所谓的环境，在该环境中注册这些类的实例。上一步生成的文件包含 DepGenEnvironment 类，它允许你注册必要的依赖项。为此有一个特殊方法：

void registry<T>(Object instance)

如果你需要锁定你的环境设置，有一个特殊的方法来创建环境的新实例。

DepGenEnvironment lock()

一个简单的环境描述方式：

class Environment extends DepGenEnvironment {
  void prepare() {
    registry<IPetsRepository>(PetsRepository());
    registry<IShopRepository>(ShopRepository());
  }
}

集成到小部件层次结构

为了能够使用上下文中的生成方法，你需要将 DepProvider 实例嵌入到小部件层次结构中。

void main() {
  final environment = Environment()..prepare();
  runApp(
    DepProvider(
      environment: environment.lock(),
      child: Application(),
    ),
  );
}

使用构建方法

为了创建具有注入依赖项的类实例，我们需要上下文。有两种方式：

final myPetLucky = DepProvider.of(context).buildMyPet(name: 'Lucky');

final myPetChester = context.depGen().buildMyPet(name: 'Lucky');

🔥 恭喜，你已经将依赖注入添加到了你的项目中。

参数组合示例

你可以将位置、命名和可选参数与自动替换的参数结合起来。例如，对于具有以下参数集的构造函数：

[@DepGen](/user/DepGen)()
class UserDetails {
  const UserDetails(final int id,
      String? username, {
        @DepArg() required this.api,
        int? userGroup,
        @DepArg() required this.cartRepository,
        @DepArg() StoreRepository storeRepository,
      }) : _storeRepository = storeRepository;
}

将生成以下构建方法：

{
    DepProvider.of(context).buildUserDetails(
        id,
        username,
        userGroup: userGroup,
    )
}

其他带有特殊注解的参数将从环境中自动替换。

示例代码

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

// -----------------------------------------------------------------------------
// 一些仓库的实现对本示例不重要
class PetsRepository {}

class ShopRepository {}

// -----------------------------------------------------------------------------
// 示例类，其构造函数使用依赖项
//
// 在示例中，为了简单起见，忽略了依赖倒置原则
[@DepGen](/user/DepGen)()
class MyPet {
  MyPet({
    required String name,
    @DepArg() required PetsRepository petsRepository,
    @DepArg() required PetsRepository shopRepository,
  }) {
    // ...一些魔法...
  }
}

// -----------------------------------------------------------------------------
// 我们的环境配置，其中规定了所有用于替换的服务
class Environment extends DepGenEnvironment {
  Environment prepare() {
    // 注册仓库实例
    registry<PetsRepository>(PetsRepository());
    // 注册仓库实例
    registry<PetsRepository>(PetsRepository());
    // 锁定配置防止更改
    return this;
  }
}

// -----------------------------------------------------------------------------
// 小部件层次结构集成示例
void main() {
  runApp(DepProvider(
    // 准备环境并锁定以防止更改
    environment: Environment().prepare().lock(),
    child: Application(),
  ));
}

// -----------------------------------------------------------------------------
// 使用生成方法的示例
class Application extends StatelessWidget {
  const Application({Key? key}) : super(key: key);

  [@override](/user/override)
  Widget build(BuildContext context) {
    // 创建实例的一种方式
    final myPetLucky = DepProvider.of(context).buildMyPet(name: 'Lucky');

    // 创建实例的另一种方式
    final myPetChester = context.depGen().buildMyPet(name: 'Lucky');

    return ... 一些漂亮的控件 ...;
  }
}