Flutter类生成器插件class_generator的使用

Flutter类生成器插件class_generator的使用

简介

class_generator 是一个用于生成 Dart 代码的工具包，它提供了一种基于构建器的库，可以轻松生成类、构造函数、方法、属性等。你可以使用这个插件快速生成包含 copyWith、序列化（toMap 和 fromMap）以及 Equatable 的类。

功能特点

• 轻松生成类、构造函数、方法和属性。
• 提供预生成的 copyWith、序列化（toMap 和 fromMap）和 Equatable。
• 生成的代码以字符串形式输出，你可以根据需要将其写入文件。

注意：此插件不与 Dart 的 build 包兼容。它是一个独立的 Dart 库，用于生成 Dart 代码。

入门指南

1. 添加依赖 在你的 pubspec.yaml 文件中添加 class_generator 依赖：

   dependencies:
     class_generator: ^1.0.0
   

2. 导入依赖 在你的 Dart 文件中导入 class_generator：

   import 'package:class_generator/class_generator.dart';
   

使用示例

示例 1：生成一个简单的类

下面是一个生成简单 Human 类的示例，包含构造函数和字段：

import 'package:class_generator/class_generator.dart';

void main() {
  // 定义字段
  final name = Field('String', 'name', prefix: 'final');
  final age = Field('int', 'age', prefix: 'final');
  
  // 创建类构建器
  final builder = ClassBuilder('Human');
  builder
    ..buildConstructor()  // 生成构造函数
    ..buildCopyWith()     // 生成 copyWith 方法
    ..addFields([name, age]);  // 添加字段

  // 打印生成的类代码
  print(builder.build());
}

示例 2：生成带有更多功能的类

下面是一个更复杂的示例，生成一个 Human 类，包含构造函数、copyWith、toMap、fromMap、空构造函数和 Equatable：

import 'package:class_generator/class_generator.dart';

void main(List<String> args) {
  // 定义字段
  var fields = [
    Field('String', 'firstName'),
    Field('int', 'age'),
    Field('List<String>', 'address')
  ];

  // 创建类构建器
  final model = ClassBuilder('Human')
    ..constructor = true  // 生成构造函数
    ..copyWith = true     // 生成 copyWith 方法
    ..toMap = true        // 生成 toMap 方法
    ..fromMap = true      // 生成 fromMap 方法
    ..empty = true        // 生成空构造函数
    ..equatable = true    // 生成 Equatable 支持
    ..fields.addAll(fields.map((e) => e..modifier = 'final'));  // 添加字段并设置为 final

  // 打印生成的类代码
  print(model.build());
}

输出结果

运行上述代码后，model.build() 将生成如下类代码：

class Human {
  final String firstName;
  final int age;
  final List<String> address;

  const Human({
    required this.firstName,
    required this.age,
    required this.address,
  });

  factory Human.empty() {
    return Human(
      firstName: '',
      age: 0,
      address: <String>[],
    );
  }

  Human copyWith({
    String? firstName,
    int? age,
    List<String>? address,
  }) {
    return Human(
      firstName: firstName ?? this.firstName,
      age: age ?? this.age,
      address: address ?? this.address,
    );
  }

  Map<String, dynamic> toMap() {
    return {
      'firstName': firstName,
      'age': age,
      'address': address,
    };
  }

  factory Human.fromMap(Map<String, dynamic> map) {
    return Human(
      firstName: map['firstName'] as String,
      age: map['age'] as int,
      address: List<String>.from(map['address']),
    );
  }

  [@override](/user/override)
  bool operator ==(Object other) {
    if (identical(this, other)) return true;

    return other is Human &&
        other.firstName == firstName &&
        other.age == age &&
        listEquals(other.address, address);
  }

  [@override](/user/override)
  int get hashCode {
    return firstName.hashCode ^ age.hashCode ^ address.hashCode;
  }
}