Flutter数据类生成插件mek_data_class_generator的使用

Flutter数据类生成插件mek_data_class_generator的使用

插件简介

mek_data_class_generator 是一个用于生成Flutter数据类的插件，它能够自动生成常用的方法，如 hashCode、==、toString、copyWith 等，从而减少样板代码的编写。该插件支持继承、泛型类，并且可以根据需要启用或禁用特定的功能。

功能特性

• 继承和泛型类支持：可以生成继承类和泛型类。
• 自动生成 hashCode 和 == 方法：确保对象的比较和哈希值计算正确。
• 自动生成 toString 方法：生成格式良好的字符串表示。
• 自动生成 copyWith 方法：方便地复制对象并修改部分字段。
• 生成 *Changes 类和 change、toChanges 方法：支持可空性处理。
• 生成 *Builder 类：用于构建复杂对象。
• 生成字段类：包含数据类的字段名称，便于反射使用。

安装步骤

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

   # pubspec.yaml
   dependencies:
     mek_data_class:
   
   dev_dependencies:
     build_runner:
     mek_data_class_generator:
   

2. 运行代码生成器： 使用以下命令运行代码生成器：

   dart pub run build_runner build
   

3. 在 Dart 文件中导入生成的代码：

   import 'package:mek_data_class/mek_data_class.dart';
   
   part 'my_file.g.dart';
   

使用示例

1. 基本用法

import 'package:mek_data_class/mek_data_class.dart';

part 'basic_example.g.dart';

@DataClass()
class Product with _$Product {
  final String title;
  @DataField(equality: DefaultEquality())
  final double price;

  const Product({
    required this.title,
    required this.price,
  });

  // 自定义 getter
  String get titlePrice => '$title $price';
}

• 说明：@DataClass() 注解会自动为 Product 类生成 hashCode、==、toString 和 copyWith 方法。@DataField 注解用于自定义字段的相等性和哈希值计算规则。

2. 继承

import 'package:mek_data_class/mek_data_class.dart';

part 'inheritance_example.g.dart';

@DataClass()
class Product with _$Product {
  final String title;
  @DataField(equality: DefaultEquality())
  final double price;

  const Product({
    required this.title,
    required this.price,
  });
}

@DataClass()
class PrettyProduct extends Product with _$PrettyProduct {
  final String color;

  const PrettyProduct({
    required String title,
    required double price,
    required this.color,
  }) : super(title: title, price: price);

  // 自定义 getter
  String get titlePriceColor => '$titlePrice $color';
}

• 说明：PrettyProduct 继承了 Product 类，并且自动生成了所有父类的方法。

3. 泛型类

import 'package:mek_data_class/mek_data_class.dart';

part 'generics_example.g.dart';

@DataClass()
class Value<T> with _$Value<T> {
  final T value;

  const Value({
    required this.value,
  });
}

• 说明：Value 类是一个泛型类，mek_data_class_generator 会为泛型类生成相应的代码。

4. 格式化的 toString 方法

final product = Product(title: 'Overlord', price: 12);
print(product);
// 输出:
// Product(
//   title=Overlord,
//   price=12,
// )

• 说明：toString 方法会自动生成格式良好的字符串表示。

5. copyWith 方法

final product = Product(title: 'Overlord', price: 12);
final updatedProduct = product.copyWith(title: 'Raisekamika');
print(updatedProduct);
// 输出:
// Product(
//   title=Raisekamika,
//   price=12,
// )

• 说明：copyWith 方法允许你复制对象并修改部分字段。

6. *Changes 类

final product = Product(title: 'Overlord', price: 12);
final updatedProduct = product.change((changes) => changes..title = 'Raisekamika');

// 或者
final changes = product.toChanges();
changes.title = 'Raisekamika';
final updatedProduct = changes.build();

• 说明：*Changes 类允许你安全地更新对象的字段，支持可空性处理。

7. *Builder 类

@DataClass(buildable: true)
class Product with _$Product {
  final int id;

  const Product({required this.id});

  factory Product.build(void Function(ProductBuilder b) updates) =>
      (ProductBuilder().update(updates)).build();
}

final builder = ProductBuilder();
builder.id = 12;
final product = builder.build();

• 说明：*Builder 类允许你逐步构建对象，适用于复杂的对象构造。

8. 生成字段类

@DataClass(createFieldsClass: true)
class Product with _$Product {
  final int id;

  const Product({required this.id});
}

// 生成的字段类
class ProductFields {
  final String _path;
  const ProductFields([this._path = '']);
  String get id => '${_path}id';
}

• 说明：createFieldsClass 选项会生成一个包含字段名称的类，便于反射使用。

全局配置

你可以在 build.yaml 文件中配置全局选项，以控制生成的行为。例如：

targets:
  $default:
    builders:
      mek_data_class_generator:
        enabled: true
        options:
          comparable: true
          stringify: true
          changeable: true