Flutter值比较插件equatable的使用

Overview

在Dart中，对象的比较通常需要重写==操作符和hashCode方法。这不仅繁琐且容易出错，还可能导致代码效率低下或行为不符合预期。默认情况下，==仅返回两个对象是否为同一实例。

例如，我们有一个简单的Person类：

class Person {
  const Person(this.name);

  final String name;
}

当我们创建并比较Person实例时：

void main() {
  final Person bob = Person("Bob");
  print(bob == Person("Bob")); // 输出: false
}

为了正确地比较两个Person实例，我们需要重写==和hashCode：

class Person {
  const Person(this.name);

  final String name;

  @override
  bool operator ==(Object other) =>
    identical(this, other) ||
    other is Person &&
    runtimeType == other.runtimeType &&
    name == other.name;

  @override
  int get hashCode => name.hashCode;
}

现在，再次运行比较代码：

print(bob == Person("Bob")); // 输出: true

虽然这样可以解决问题，但对于复杂类来说，手动编写这些代码非常麻烦。这就是Equatable插件的作用！

What does Equatable do?

Equatable通过自动生成==和hashCode方法来简化对象比较，避免了编写大量样板代码的麻烦。与生成代码的其他包不同，Equatable无需额外的代码生成步骤，使我们可以专注于编写更优秀的应用程序。

Usage

添加依赖

首先，在pubspec.yaml中添加equatable依赖：

dependencies:
  equatable: ^2.0.0

然后安装依赖：

# Dart
pub get

# Flutter
flutter packages get

使用Equatable

接下来，让类继承Equatable：

import 'package:equatable/equatable.dart';

class Person extends Equatable {
  const Person(this.name);

  final String name;

  @override
  List<Object> get props => [name];
}

对于JSON处理：

import 'package:equatable/equatable.dart';

class Person extends Equatable {
  const Person(this.name);

  final String name;

  @override
  List<Object> get props => [name];

  factory Person.fromJson(Map<String, dynamic> json) {
    return Person(json['name']);
  }
}

注意事项

• Equatable只适用于不可变对象，因此所有成员变量必须是final。
• Equatable支持const构造函数和可空属性（nullable props）。

示例：包含可空属性

import 'package:equatable/equatable.dart';

class Person extends Equatable {
  const Person(this.name, [this.age]);

  final String name;
  final int? age;

  @override
  List<Object?> get props => [name, age];
}

toString Implementation

Equatable可以实现toString方法，包括所有给定的属性。如果需要此行为，只需添加以下代码：

@override
bool get stringify => true;

例如：

import 'package:equatable/equatable.dart';

class Person extends Equatable {
  const Person(this.name);

  final String name;

  @override
  List<Object> get props => [name];

  @override
  bool get stringify => true;
}

输出将为：

Person(Bob)

默认情况下，toString仅返回类型名称，如Person。

EquatableConfig

可以通过EquatableConfig全局配置stringify行为：

EquatableConfig.stringify = true;

局部配置优先于全局配置。

Recap

Without Equatable

class Person {
  const Person(this.name);

  final String name;

  @override
  bool operator ==(Object other) =>
    identical(this, other) ||
    other is Person &&
    runtimeType == other.runtimeType &&
    name == other.name;

  @override
  int get hashCode => name.hashCode;
}

With Equatable

import 'package:equatable/equatable.dart';

class Person extends Equatable {
  const Person(this.name);

  final String name;

  @override
  List<Object> get props => [name];
}

EquatableMixin

当你的类已经有父类时，无法直接继承Equatable，此时可以使用EquatableMixin。

示例：使用EquatableMixin

class EquatableDateTime extends DateTime with EquatableMixin {
  EquatableDateTime(
    int year, [
    int month = 1,
    int day = 1,
    int hour = 0,
    int minute = 0,
    int second = 0,
    int millisecond = 0,
    int microsecond = 0,
  ]) : super(year, month, day, hour, minute, second, millisecond, microsecond);

  @override
  List<Object> get props {
    return [year, month, day, hour, minute, second, millisecond, microsecond];
  }
}

class EquatableDateTimeSubclass extends EquatableDateTime {
  final int century;

  EquatableDateTimeSubclass(
    this.century,
    int year,[
    int month = 1,
    int day = 1,
    int hour = 0,
    int minute = 0,
    int second = 0,
    int millisecond = 0,
    int microsecond = 0,
  ]) : super(year, month, day, hour, minute, second, millisecond, microsecond);

  @override
  List<Object> get props => [...super.props, century];
}

Benchmarks

你可以通过访问benchmarks查看和运行性能基准测试。

Maintainers

• Felix Angelov

这个整理后的答案详细介绍了`equatable`插件的使用方法、优势以及一些注意事项，并提供了具体的代码示例。希望对你有帮助！