Flutter反射机制插件 reflection_factory 的使用

reflection_factory 是一个用于 Dart 的反射库，通过代码生成的方式为所有 Dart 平台提供简单的反射功能。以下是详细的使用指南和示例代码。

依赖项

在你的 pubspec.yaml 文件中添加以下依赖：

dependencies:
  reflection_factory: ^1.2.10

dev_dependencies:
  build_runner: ^2.2.0

使用方法

@EnableReflection

[@EnableReflection](/user/EnableReflection) 注解用于指示某个类/类型将启用反射。

示例代码

文件：some_source_file.dart

import 'package:reflection_factory/reflection_factory.dart';

// 添加对生成代码的引用：
// $> dart run build_runner build
part 'some_source_file.reflection.g.dart';

// 指示反射将为类 `User` 生成/启用：
[@EnableReflection](/user/EnableReflection)()
class User {
  String? email;
  String pass;

  User(this.email, this.pass);

  User.empty() : this(null, '');

  bool get hasEmail => email != null;

  bool checkPassword(String pass) {
    return this.pass == pass;
  }
}

void main() {
  var user = User('joe@mail.com', '123');

  // 生成的反射：
  var userReflection = user.reflection;

  var fieldEmail = userReflection.field('email')!;
  print('email: ${fieldEmail.get()}');

  var methodCheckPassword = userReflection.method('checkPassword')!;

  var passOk1 = methodCheckPassword.invoke(['wrong']); // false
  print('pass("wrong"): $passOk1');

  var passOk2 = methodCheckPassword.invoke(['123']); // true
  print('pass("123"): $passOk2');

  // 使用生成的 `toJson` 扩展方法：
  print('User JSON:');
  print(user.toJson());

  // 使用生成的 `toJsonEncoded` 扩展方法：
  print('User JSON encoded:');
  print(user.toJsonEncoded());
  
  // 通过类访问反射：
  var userReflection2 = User$reflection();

  // 从默认或空构造函数创建 `User` 实例：
  var user2 = userReflection2.createInstance()!;

  user2.email = 'smith@mail.com';
  user2.pass = 'abc';

  print('User 2 JSON:');
  print(user2.toJson());
}

输出结果：

email: joe@mail.com
pass("wrong"): false
pass("123"): true
User JSON:
{email: joe@mail.com, hasEmail: true, pass: 123}
User JSON encoded:
{"email":"joe@mail.com","hasEmail":true,"pass":"123"}
User 2 JSON:
{email: smith@mail.com, hasEmail: true, pass: abc}

@ReflectionBridge

[@ReflectionBridge](/user/ReflectionBridge) 注解用于桥接类，并指示第三方类型的反射将被生成。

示例代码

文件：some_source_file.dart

import 'package:reflection_factory/reflection_factory.dart';

// 类 `User` 来自第三方包：
import 'package:some_api/user.dart';

// 添加对生成代码的引用：
// $> dart run build_runner build
part 'some_source_file.reflection.g.dart';

// 指示反射将通过桥接类为类 `User` 生成/启用：
[@ReflectionBridge](/user/ReflectionBridge)([User])
class UserReflectionBridge {}

void main() {
  var user = User('joe@mail.com', '123');

  // 通过桥接类生成的反射：
  var userReflection = UserReflectionBridge().reflection(user);

  var fieldEmail = userReflection.field('email')!;
  print('email: ${fieldEmail.get()}');

  print('User JSON encoded:');
  print(user.toJsonEncoded());
}

输出结果：

email: joe@mail.com
User JSON encoded:
{"email":"joe@mail.com","pass":"123","hasEmail":true}

生成代码

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

$> dart run build_runner build

你可以在项目中配置 build.yaml 文件以调整生成选项：

targets:
  $default:
    builders:
      reflection_factory:
        options:
          verbose: true
          sequential: true
          timeout: 2 sec

• verbose: 如果为 true，则以详细模式构建反射代码（默认：false）。
• sequential: 如果为 true，则顺序处理 BuildStep（默认：true）。
• timeout: 顺序 BuildStep 超时时间（默认：30 sec）。

完整示例

以下是一个完整的示例，展示了如何使用 reflection_factory 库来实现反射功能：

import 'package:reflection_factory/reflection_factory.dart';

// 添加对生成代码的引用：
// $> dart run build_runner build
part 'reflection_factory_example.reflection.g.dart';

// 指示反射将为类 `User` 生成/启用：
[@EnableReflection](/user/EnableReflection)()
class User {
  String? email;
  String pass;

  User(this.email, this.pass);

  User.empty() : this(null, '');

  bool get hasEmail => email != null;

  bool checkPassword(String pass) {
    return this.pass == pass;
  }
}

void main() {
  var user = User('joe@mail.com', '123');

  // 生成的反射：
  var userReflection = user.reflection;

  var fieldEmail = userReflection.field('email')!;
  print('email: ${fieldEmail.get()}');

  var methodCheckPassword = userReflection.method('checkPassword')!;

  var passOk1 = methodCheckPassword.invoke(['wrong']); // false
  print('pass("wrong"): $passOk1');

  var passOk2 = methodCheckPassword.invoke(['123']); // true
  print('pass("123"): $passOk2');

  // 使用生成的 `toJson` 扩展方法：
  print('User JSON:');
  print(user.toJson());

  // 使用生成的 `toJsonEncoded` 扩展方法：
  print('User JSON encoded:');
  print(user.toJsonEncoded());
  
  // 通过类访问反射：
  var userReflection2 = User$reflection();

  // 从默认或空构造函数创建 `User` 实例：
  var user2 = userReflection2.createInstance()!;

  user2.email = 'smith@mail.com';
  user2.pass = 'abc';

  print('User 2 JSON:');
  print(user2.toJson());
}

以上是 reflection_factory 插件的基本用法和示例代码，希望对你有所帮助！