转变馆藏

您是否曾经想替换过HashSet或HashMap使用的equals和hashCode方法？或者有一个List的一些元素类型伪装成的List相关类型的？

转换集合使这成为可能，并且本文将展示如何实现。

总览

转换集合是LibFX 0.3.0的一项功能，该功能将在今天每天发布。这篇文章将介绍总体思路，涵盖技术细节，并提供一些可能会派上用场的用例。

正在进行的示例是LibFX中包含的功能演示的稍微改编的变体。请记住，这只是演示该概念的一个示例。

转变馆藏

转换集合是另一个集合的视图（例如，列表中的列表，地图上的地图等），其中似乎包含不同类型的元素（例如，整数而不是字符串）。

通过应用转换从内部元素创建视图元素。这是按需发生的，因此转换集合本身是无状态的。作为一个适当的视图，内部集合以及转换视图的所有更改都反映在另一个视图中（例如Map及其entrySet ）。

命名法

转换的集合也可以视为装饰器。我将装饰后的集合称为内部集合，并将其泛型称为内部类型。转换集合及其通用类型分别称为外部集合和外部类型。

例

让我们来看一个例子。假设我们有一组字符串，但是我们知道这些字符串只包含自然数。我们可以使用一个转换集来获取一个看起来像是整数集的视图。

（类似// "[0, 1] ~ [0, 1]"的System.out.println(innerSet + " ~ " + transformingSet);是System.out.println(innerSet + " ~ " + transformingSet);的控制台输出。）

Set<String> innerSet = new HashSet<>();
Set<Integer> transformingSet = new TransformingSet<>(innerSet,/* skipping some details */);
// both sets are initially empty: "[] ~ []"// now let's add some elements to the inner set	
innerSet.add("0");
innerSet.add("1");
innerSet.add("2");
// these elements can be found in the view: "[0, 1, 2] ~ [0, 1, 2]"// modifying the view reflects on the inner set
transformingSet.remove(1);
// again, the mutation is visible in both sets: "[0, 2] ~ [0, 2]"

看看转换有多愉快？

由Rooners Toy Photography根据CC-BY-NC-ND 2.0发布。

发布时间由Rooners玩具摄影下的CC-BY-NC-ND 2.0 。

细节

像往常一样，魔鬼在细节中，所以让我们讨论这个抽象的重要部分。

转寄

转换集合是另一个集合的视图。这意味着它们本身不保存任何元素，而是将所有调用转发给内部/装饰的集合。

他们通过将调用参数从外部类型转换为内部类型并使用这些参数调用内部集合来实现此目的。然后，将返回值从内部类型转换为外部类型。对于以集合为参数的调用，这变得有些复杂，但是方法基本上是相同的。

所有转换集合的实现方式都是将方法的每次调用转发到内部集合上的相同方法 （包括default方法）。这意味着内部集合对线程安全性，原子性等的任何保证也将由转换集合维护。

转型

转换是通过在构造过程中指定的一对函数来计算的。一个用于将外部元素转换为内部元素，另一个用于另一个方向。（对于映射，存在两对这样的对：一对用于键，一对用于值。）

转换函数关于equals必须彼此相反，即， outer.equals(toOuter(toInner(outer))和inner.equals(toInner(toOuter(inner))对于所有外部元素和内部元素必须为true。并非如此，这些集合的行为可能无法预测。

对于身份而言，情况并非如此，即， outer == toOuter(toInner(outer))可能为false。详细信息取决于所应用的转换，并且通常未指定-它可能永远不会，有时或永远都是正确的。

例

让我们看看转换函数如何查找我们的字符串和整数集：

private Integer stringToInteger(String string) {return Integer.parseInt(string);
}private String integerToString(Integer integer) {return integer.toString();
}

这就是我们使用它们创建转换集的方式：

Set<Integer> transformingSet = new TransformingSet<>(innerSet,this::stringToInteger, this::integerToString,/* still skipping some details */);

直截了当吧？

是的，但是即使这个简单的示例也包含陷阱。注意前导零的字符串如何映射到相同的整数。这可以用于创建不良行为：

innerSet.add("010");
innerSet.add("10");
// now the transforming sets contains the same entry twice:
// "[010, 10] ~ [10, 10]"// sizes of different sets:
System.out.println(innerSet.size()); // "2"
System.out.println(transformingSet.size()); // "2"
System.out.println(new HashSet<>(transformingSet).size()); // "1" !// removing is also problematic
transformingSet.remove(10) // the call returns true
// one of the elements could be removed: "[010] ~ [10]"
transformingSet.remove(10) // the call returns false
// indeed, nothing changed: "[010] ~ [10]"// now things are crazy - this returns false:
transformingSet.contains(transformingSet.iterator().next())
// the transforming set does not contain its own elements ~> WAT?

因此，在使用转换集合时，仔细考虑转换非常重要。它们必须彼此相反！

但这仅限于实际发生的内部和外部元素就足够了。在该示例中，问题仅在引入前导零的字符串时才开始。如果这些被某些业务规则所禁止，并且已经正确执行，那么一切都会好起来的。

类型安全

以通常的静态，编译时方式，对转换集合进行的所有操作都是类型安全的。但是，由于收集接口中的许多方法都允许对象（例如Collection.contains(Object) ）或未知通用类型的集合（例如Collection.addAll(Collection<?>) ）作为参数，因此这并不涵盖所有可能发生在以下情况的情况运行。

请注意，这些调用的参数必须从外部类型转换为内部类型，才能将调用转发到内部集合。如果使用非外部类型的实例调用它们，则很可能无法将其传递给转换函数。在这种情况下，该方法可能会抛出ClassCastException 。尽管这与方法的合同一致，但可能仍然是意外的。

为了减少这种风险，转换集合的构造函数需要使用内部和外部类型的令牌。它们用于检查元素是否为必需类型，如果不是，则可以毫无例外地优雅地回答查询。

例

我们终于可以确切地看到如何创建转换集：

Set<Integer> transformingSet = new TransformingSet<>(innerSet,String.class, this::stringToInteger,Integer.class, this::integerToString);

构造函数实际上接受Class<? super I> Class<? super I>所以这也将编译：

Set<Integer> transformingSetWithoutTokens = new TransformingSet<>(innerSet,Object.class, this::stringToInteger,Object.class, this::integerToString);

但是由于所有内容都是对象，所以针对令牌的类型检查变得无用，并且调用转换函数可能会导致异常：

Object o = new Object();
innerSet.contains(o); // false
transformingSet.contains(o); // false
transformingSetWithoutTokens.contains(o); // exception

用例

我想说，转换集合是一种非常专业的工具，不太可能经常使用，但在每个分类良好的工具箱中仍然占有一席之地。

重要的是要注意，如果性能至关重要，则可能会出现问题。每次调用包含或返回元素的转换集合，都会导致至少创建一个（通常是多个）对象。这些对垃圾收集器施加了压力，并导致通往有效负载的方式的间接级别更高。（与以往一样，在讨论性能时：首先要介绍！）

那么转换集合的用例是什么？上面我们已经看到了如何将集合的元素类型更改为另一种。尽管这代表了总体思路，但我认为这不是一个非常普遍的用例（尽管在某些边缘情况下是有效的方法）。

在这里，我将展示两个更狭窄的解决方案，您可能希望在某些时候使用它们。但是我也希望这能使您了解如何使用转换集合来解决棘手的情况。也许您的问题的解决方案在于巧妙地应用此概念。

用Equals和HashCode代替

我一直很喜欢.NET的哈希图（他们称其为字典）如何具有将EqualityComparer作为参数的构造函数。通常将在键上调用的所有对equals和hashCode调用都委派给该实例。因此有可能即时替换有问题的实现。

当您处理无法完全控制的有问题的旧版代码或库代码时，这可以节省生命。当需要一些特殊的比较机制时，它也很有用。

使用转换集合，这很容易。为了使它更加容易，LibFX已经包含一个EqualityTransformingSet和EqualityTransformingMap 。它们修饰另一个集合或映射实现，并且在构造过程中可以提供键和元素的equals和hashCode函数。

例

假设您想将字符串用作set元素，但为了进行比较，您仅对它们的长度感兴趣。

Set<String> lengthSet = EqualityTransformingSet.withElementType(String.class).withInnerSet(new HashSet<Object>()).withEquals((a, b) -> a.length != b.length).withHash(String::length).build();lengthSet.add("a");
lengthSet.add("b");
System.out.println(lengthSet); // "[a]"

从集合中删除可选性

也许您正在与一个在各处使用Optional的想法的人一起工作，然后疯狂地使用它，现在您有了Set<Optional<String>> 。如果无法修改代码（或您的同事），则可以使用转换集合来获取一个对您隐藏Optional的视图。

同样，实现起来很简单，因此LibFX已经以OptionalTransforming[Collection|List|Set]的形式包含了它。

例

Set<Optional<String>> innerSet = new HashSet<>();
Set<String> transformingSet =new OptionalTransformingSet<String>(innerSet, String.class);innerSet.add(Optional.empty());
innerSet.add(Optional.of("A"));// "[Optional.empty, Optional[A]] ~ [null, A]"

请注意， null表示空的optional的方式。这是默认行为，但是您也可以将另一个字符串指定为空的Optionals的值：

Set<String> transformingSet =new OptionalTransformingSet<String>(innerSet, String.class, "DEFAULT");// ... code as above ...
// "[Optional.empty, Optional[A]] ~ [DEFAULT, A]"

这样可以避免使用Optional和null作为元素，但是现在您必须确保永远不会有包含DEFAULT的Optional。（如果确实如此，则隐式转换不是彼此相反的，我们已经在上面看到了这些转换会引起问题。）

有关此示例的更多详细信息，请查看演示。