在 Dart 中覆盖哈希码的好方法是什么？

Question

我发现自己想为一个对象覆盖哈希码和 ==，我想知道是否有最佳实践来实现依赖于多个属性的哈希码，而且似乎有一些特定于 Dart 的注意事项.

最简单的答案是对所有属性的哈希值进行异或运算，这可能还不错。 Dart Up and Running 中还有一个示例https://www.dartlang.org/docs/dart-up-and-running/contents/ch03.html

  // Override hashCode using strategy from Effective Java, Chapter 11.
 int get hashCode {
   int result = 17;
   result = 37 * result + firstName.hashCode;
   result = 37 * result + lastName.hashCode;
   return result;
 }

但这似乎需要截断整数语义，并且在 Dart 中溢出 JS 整数范围似乎不利于散列。

我们也可以这样做，并在每次操作后截断为 32 位。

对于我的应用程序，集合的预期大小非常小，几乎任何事情都可以，但我很惊讶没有看到针对一般情况的标准配方。有没有人有这方面的经验或经验丰富？

Answer 1

从 2.14 版开始，Dart 语言增加了对 Object.hash() 以及 Object.hashAll() 和 Object.hashAllUnordered() 的支持

hash()文档：

为多个对象创建组合哈希码。

例子：

class SomeObject {
  final Object a, b, c;
  SomeObject(this.a, this.b, this.c);

  bool operator==(Object other) =>
      other is SomeObject && a == other.a && b == other.b && c == other.c;

  int get hashCode => Object.hash(a, b, c); // <----- here
}

文档中关于实施的说明：

此函数生成的哈希值不能保证在同一程序的不同运行期间或在同一程序的不同隔离区中运行的代码之间保持稳定。不同平台或平台库的不同版本之间使用的确切算法可能有所不同，并且可能取决于每次程序执行时更改的值。

Answer 2

为了最小化依赖关系，如果你已经依赖 Flutter，但不依赖于 quiver 之类的东西，dart:ui 库包含用于创建和组合哈希值的实用程序、hashValues 和 hashList。如果组合列表值，必须小心确保相等运算符和哈希码匹配行为。如果哈希码计算它的哈希值很深，则使用深度相等，否则，使用浅相等。

class Example {
    final String value1;
    final Object value2;
    final List<Object> deep;
    final List<Object> shallow;

    Example({this.value1, this.value2, this.deep, this.shallow});

    @override
    operator ==(o) =>
        o is Example &&
        o.value1 == value1 &&
        o.value2 == value2 &&
        listEquals(o.deep, deep) &&
        o.shallow == shallow;

    @override
    int get hashCode => hashValues(value1, value2, hashList(deep), shallow);
}

Flutter API docs for hashValues

Flutter API docs for hashList

Answer 3

quiver package 提供了帮助函数hash2、hash3 等，它们简化了实现hashCode 的任务，并确保它在 Dart VM 下正常工作和编译成 JavaScript 时。

import 'package:quiver/core.dart';

class Person {
  String name;
  int age;

  Person(this.name, this.age);

  bool operator ==(o) => o is Person && name == o.name && age == o.age;
  int get hashCode => hash2(name.hashCode, age.hashCode);
}

另请参阅this post 以获得稍长的讨论。

Answer 4

equatable 包可以提供帮助

import 'package:equatable/equatable.dart';

class Person extends Equatable {
  final String name;
  final int age;

  Person(this.name, this.age);

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

现在 Person 将使用来自 Equatable 的 == 和 hashCode，这将采用您提供的 props 列表

Answer 5

我推荐“equatable”插件

https://pub.dev/packages/equatable

例子：

原始模式：

class Person {
  final String name;

  const Person(this.name);

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

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

与等价：

import 'package:equatable/equatable.dart';

class Person extends Equatable {
  final String name;

  Person(this.name);

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

Answer 6

由于 Dart 与 Java 非常相似，您肯定可以在适用于 Dart 的 Java 的 hashCodes 上找到很好的参考。

我在谷歌上搜索了一下Wikipedia page on Java's Object.hashCode()。有一个简单对象的哈希码的非常基本的示例。一种流行的方法是执行与素数（不同的）相乘，并为对象的每个属性添加一些值。

This question f.e.解释了为什么选择数字 31 用于 String.hashCode() 方法的乘法。

使用 Google 可以轻松找到更详细的哈希码实现示例。