Flutter模拟数据插件fake_model的使用

Flutter模拟数据插件fake_model的使用

1. 功能特性

fake_model 提供了一个基于 Dart 构建系统的生成器，用于为模型类生成 fake model generation function。通过注解 [@FakeModel](/user/FakeModel) 和 [@FakeConfig](/user/FakeConfig)，你可以指定哪些模型类需要生成 fake model generation function 以及字段值的生成规则。

• [@FakeModel](/user/FakeModel)：用于标记你想要生成 fake model generation function 的模型类。
• [@FakeConfig](/user/FakeConfig)：用于配置字段值的生成规则。

2. 安装

fake_model 依赖于 build_runner 来生成代码，并且使用 fake_model_annotation 来定义注解。你需要在 pubspec.yaml 文件中添加以下依赖：

使用命令行安装：

对于 Flutter 项目：

flutter pub add fake_model_annotation
flutter pub add --dev build_runner
flutter pub add --dev fake_model

对于 Dart 项目：

dart pub add fake_model_annotation
dart pub add --dev build_runner
dart pub add --dev fake_model

手动添加到 pubspec.yaml：

dependencies:
  fake_model_annotation:

dev_dependencies:
  build_runner:
  fake_model:

3. 使用方法

假设我们有一个名为 Info 的模型类，位于 info.dart 文件中。我们希望为这个类生成 fake model generation function。首先，我们需要导入 fake_model_annotation 并添加 part 语句：

import 'package:fake_model_annotation/fake_model_annotation.dart';

part 'info.fake.dart';

接下来，我们使用 [@FakeModel](/user/FakeModel) 注解来标记 Info 类，并为其字段添加 [@FakeConfig](/user/FakeConfig) 注解以配置字段值的生成规则：

import 'package:fake_model_annotation/fake_model_annotation.dart';

part 'info.fake.dart';

[@FakeModel](/user/FakeModel)()
class Info {
  Info(this.age, this.name);

  final int age;
  final String name;

  /// 添加命名工厂构造函数 `fromFake`，以连接生成的 `fake model generation function` [_$InfoFromFake()]
  factory Info.fromFake() => _$InfoFromFake();
}

fake_model 会自动生成一个名为 info.fake.dart 的部分文件，其中包含 fake model generation function：

part of 'info.dart';

Info _$InfoFromFake() =>
    Info(
      intGenerator(minValue: 0, maxValue: 10000.0),
      stringGenerator('Info', 'name'),
    );

4. 生成代码

要生成代码，运行以下命令：

对于 Dart 项目：

dart run build_runner build

对于 Flutter 项目：

flutter pub run build_runner build

5. 支持的字段类型

fake_model 支持以下类型的字段：

• bool
• double
• Enum
• int
• Iterable
• List
• Map
• num
• Object
• Set
• String

6. 默认字段值生成规则

以下是支持类型的默认生成规则：

7. 自定义字段值生成规则

你可以通过 [@FakeConfig](/user/FakeConfig) 注解来自定义字段值的生成规则。例如：

[@FakeModel](/user/FakeModel)()
class Info {
  Info({required this.age, required this.chanceOfRain, required this.friends});

  /// age 始终为 18
  [@FakeConfig](/user/FakeConfig)(defaultValue: 18)
  final int age;

  /// 值在 50 到 100 之间
  [@FakeConfig](/user/FakeConfig)(minValue: 50, maxValue: 100)
  final double chanceOfRain;

  /// 生成 3 个元素
  [@FakeConfig](/user/FakeConfig)(itemSize: 3)
  final List<String> friends;

  factory Info.fromFake() => _$InfoFromFake();
}

生成的 fake model generation function 将如下所示：

Info _$InfoFromFake() =>
    Info(
      age: 18,
      chanceOfRain: doubleGenerator(minValue: 50, maxValue: 100),
      friends: [
        stringGenerator('Info', 'friends'),
        stringGenerator('Info', 'friends'),
        stringGenerator('Info', 'friends')
      ],
    );

8. 示例代码

以下是一个完整的示例代码，展示了如何使用 fake_model 生成模拟数据：

import 'package:fake_model_annotation/fake_model_annotation.dart';

/// [fake_model] 生成的 'part of' 文件名为 'example.fake.dart'。
/// 不要忘记添加 part 文件。
part 'example.fake.dart';

/// [FakeModel.randomValue] 决定生成的 `fake model generation function` [_$PersonalInfoFromFake]
/// 是返回 `final model` 还是 `new instance model`。
/// `final model` 的字段值在生成 `example.fake.dart` 时确定。
/// `new instance model` 的字段值每次调用 `PersonalInfo.fromFake()` 时都会随机生成，
/// 除非你在字段上使用了 [FakeConfig.defaultValue]。
[@FakeModel](/user/FakeModel)(randomValue: false)
class PersonalInfo {
  PersonalInfo({
    required this.name,
    required this.married,
    required this.age,
    required this.height,
    required this.weight,
    required this.gender,
    required this.friends,
    required this.bankAccounts,
    required this.secretInfo,
  });

  /// 默认情况下，创建格式为 '${Class.name}_${Field.name}_${}' 的字符串值。
  /// 你可以为字段提供默认值。
  [@FakeConfig](/user/FakeConfig)(defaultValue: "Jerry")
  final String name;
  final bool married;

  /// 默认情况下，`num` 类型的字段值在 0 - 10000 之间随机生成。
  /// 你可以通过 [FakeConfig.minValue] 和 [FakeConfig.maxValue] 来指定范围。
  [@FakeConfig](/user/FakeConfig)(minValue: -100, maxValue: 100)
  final int age;
  final double? height;
  final num? weight;

  /// 枚举
  /// 默认情况下，枚举值随机生成。
  final Gender gender;

  /// 列表
  /// 默认情况下，`List` 的长度为 1。
  /// 你可以通过 [FakeConfig.itemSize] 来指定长度。
  [@FakeConfig](/user/FakeConfig)(itemSize: 3)
  final List<String> friends;

  /// 映射
  /// 默认情况下，`Map` 的长度为 1。
  /// 你可以通过 [FakeConfig.itemSize] 来指定长度。
  [@FakeConfig](/user/FakeConfig)(itemSize: 2)
  final Map<String, Bank> bankAccounts;

  /// 类
  /// 字段类型也可以是类！
  /// 你可以为字段提供默认值，或者让 [fake_model] 自动创建。
  [@FakeConfig](/user/FakeConfig)(
    defaultValue: SecretInfo(
      lover: "fake_model",
      realAge: 18,
      realHeight: 190,
      realWeight: 70,
    ),
  )
  final SecretInfo secretInfo;

  /// 调用生成的 `fake model generation function` [_$PersonalInfoFromFake]。
  /// `fake model generation function` 的格式为 '_$[Class Name]FromFake()'。
  factory PersonalInfo.fromFake() => _$PersonalInfoFromFake();

  [@override](/user/override)
  String toString() {
    return 'PersonalInfo{name: $name, married: $married, age: $age, height: $height, weight: $weight, gender: $gender, friends: $friends, bankAccounts: $bankAccounts, secretInfo: $secretInfo}';
  }
}

[@FakeModel](/user/FakeModel)()
class Bank {
  final int money;

  Bank(this.money);

  [@override](/user/override)
  String toString() {
    return 'Bank{money: $money}';
  }
}

enum Gender { male, female }

class SecretInfo {
  final int realAge;
  final double realHeight;
  final num realWeight;
  final String lover;

  const SecretInfo({
    required this.realAge,
    required this.realHeight,
    required this.realWeight,
    required this.lover,
  });

  [@override](/user/override)
  String toString() {
    return 'SecretInfo{realAge: $realAge, realHeight: $realHeight, realWeight: $realWeight, lover: $lover}';
  }
}

void main() {
  for (int i = 0; i < 10; i++) {
    print(PersonalInfo.fromFake());
  }
}