Flutter自动化生成等式插件autoequal_gen的使用

Flutter自动化生成等式插件autoequal_gen的使用

使用说明

autoequal_gen 是一个用于自动生成 List<Object?> _$props 私有扩展的 Dart 构建系统构建器，适用于带有 [@autoequal](/user/autoequal) 注解的类。

在你的 pubspec.yaml 文件中

1. 将 autoequal 添加到 dependencies
2. 将 autoequal_gen 添加到 dev_dependencies
3. 将 build_runner 添加到 dev_dependencies

示例配置如下：

dependencies:
  autoequal: ^最新版本号
  equatable: ^最新版本号

dev_dependencies:
  autoequal_gen: ^最新版本号
  build_runner: ^最新版本号

使用 [@autoequal](/user/autoequal) 注解标注你的类

以下是一个完整的示例 demo：

import 'package:autoequal/autoequal.dart';
import 'package:equatable/equatable.dart';

// 自动生成的文件需要声明在这里
part 'some_class.g.dart';

// 使用 [@autoequal](/user/autoequal) 注解
[@autoequal](/user/autoequal)
class SomeClass extends Equatable {
  const SomeClass({this.id, this.random});

  final String id;
  final String? random; // 可以被忽略的字段

  // 使用生成的 _$props
  [@override](/user/override)
  List<Object?> get props => _$props;
}

确保在文件顶部包含 part 'your_file_name.g.dart'; 声明。

启动代码生成

在终端中运行以下命令来生成代码：

flutter pub run build_runner build

生成的扩展代码

生成的代码将会如下所示：

// GENERATED CODE - DO NOT MODIFY BY HAND

part of 'some_class.dart';

// **************************************************************************
// AutoequalGenerator
// **************************************************************************

extension _$SomeClassAutoequal on SomeClass {
  List<Object> get _$props => [id]; // 自动生成的属性列表
}

自动包含注解

[@autoequal](/user/autoequal) 注解足够智能，可以为使用 Equatable 的类自动生成 props getter，而无需显式注解。

更新你的 build.yaml 文件：

targets:
  $default:
    builders:
      autoequal_gen:
        enabled: true
        options:
          auto_include: true
          exclude:
            - SomeClass # 类名的正则表达式模式

或者添加正则表达式模式到 include 选项：

targets:
  $default:
    builders:
      autoequal_gen:
        enabled: true
        options:
          include:
            - SomeClass # 类名的正则表达式模式

然后正常使用 Equatable 并创建 props getter：

class SomeClass with EquatableMixin { // 或者 `extends Equatable`
  const SomeClass({this.id});

  final String id;

  [@override](/user/override)
  List<Object?> get props => _$props;
}

注意：如果未定义 props getter，则 autoequal 不会生成 _$props 变量。

继承

如果你的类继承了另一个使用 Equatable 的类，你可以使用 [@autoequal](/user/autoequal) 注解，autoequal 会自动处理：

[@autoequal](/user/autoequal)
class SubClass extends BaseClass { // BaseClass extends Equatable
  const SubClass({required this.name, required super.id});

  final String name;

  [@override](/user/override)
  List<Object?> get props => _$props;
}

// 生成的代码
extension _$SubClassAutoequal on SubClass {
  List<Object?> get _$props => [name, id];
}

字段/Getter 注解

忽略字段或 Getter 方法

可以通过使用 [@ignore](/user/ignore) 注解来忽略字段或 Getter 方法：

[@ignore](/user/ignore)
final int random;

包含字段或 Getter 方法

可以通过使用 @include 注解来包含字段或 Getter 方法：

@include
String get id => _id;

build.yaml 配置选项

默认情况下，构建器会忽略所有 props 中的 Getter 方法，但你可以在 build.yaml 文件中更改此行为：

targets:
  $default:
    builders:
      autoequal_gen:
        enabled: true
        options:
          ... # 查看下面的选项

查看源代码获取完整的选项列表。所有选项都是可选的，所有选项键均采用 snake_case 格式。

完整示例 Demo

import 'package:autoequal/autoequal.dart';
import 'package:equatable/equatable.dart';

part 'main.g.dart';

[@autoequal](/user/autoequal)
class Example1Class extends Equatable {
  Example1Class({
    required this.value,
    this.ignored,
    this.optional,
  });

  final String value;
  final String? optional;

  [@ignore](/user/ignore)
  final String? ignored;

  [@override](/user/override)
  List<Object?> get props => _$props;
}

[@autoequal](/user/autoequal)
class Example2Class with EquatableMixin {
  const Example2Class({
    required this.value,
    this.ignored,
    this.optional,
  });

  final String value;
  final String? optional;

  [@ignore](/user/ignore)
  final String? ignored;

  [@override](/user/override)
  List<Object?> get props => _$props;
}