介绍java中Pair

Posted 2022-12-13 忧伤的可乐鸡

https://blog.csdn.net/neweastsun/article/details/80294811

项目中用到了Pair，之前没接触过，百度了一下，资料比较少，先记个笔记，日后完善

介绍java中Pair

在这篇文章中，我们讨论了一个非常有用的编程概念，配对(Pair)。配对提供了一种方便方式来处理简单的键值关联，当我们想从方法返回两个值时特别有用。

在核心Java库中可以使用配对(Pair)的实现。除此之外，某些第三方库，比如Apache Commons和Vavr，已经在各自的api中公开了这个功能。

核心java配对实现

Pair类

Pair类在javafx.util 包中，类构造函数有两个参数，键及对应值：

    Pair<Integer, String> pair = new Pair<>(1, "One");
    Integer key = pair.getKey();
    String value = pair.getValue();

• 1
• 2
• 3

示例描述使用Pair类实现简单Integer到String的映射。示例中getKey方法返回key对象，getValue方法返回对应值对象。

AbstractMap.SimpleEntry 和 AbstractMap.SimpleImmutableEntry

SimpleEntry定义在抽象类AbstractMap里面，其构造方法与Pair类似：

    AbstractMap.SimpleEntry<Integer, String> entry 
      = new AbstractMap.SimpleEntry<>(1, "one");
    Integer key = entry.getKey();
    String value = entry.getValue();

• 1
• 2
• 3
• 4

其键和值可以通过标准的getter和setter方法获得。

另外AbstractMap 类还包含一个嵌套类，表示不可变配对：SimpleImmutableEntry 类。

    AbstractMap.SimpleImmutableEntry<Integer, String> entry
      = new AbstractMap.SimpleImmutableEntry<>(1, "one");

• 1
• 2

应用方式与可变的配对一样，除了配置的值不能修改，尝试修改会抛出UnsupportedOperationException异常。

Apache Commons

在Apache Commons库中，org.apache.commons.lang3.tuple 包中提供Pair抽象类，不能被直接实例化。 
其有两个子类，分别代表可变与不可变配对：ImmutablePair 和 MutablePair。两者都实现了访问key/value以及setter和getter方法：

    ImmutablePair<Integer, String> pair = new ImmutablePair<>(2, "Two");
    Integer key = pair.getKey();
    String value = pair.getValue();

• 1
• 2
• 3

尝试在ImmutablePair 执行setValue方法，会抛出UnsupportedOperationException异常。但在可变配对上执行完全正常：

    Pair<Integer, String> pair = new MutablePair<>(3, "Three");
    pair.setValue("New Three");

• 1
• 2

Vavr库

Vavr库中不可变的Tuple2类提供配对功能：

    Tuple2<Integer, String> pair = new Tuple2<>(4, "Four");
    Integer key = pair._1();
    String value = pair._2();

• 1
• 2
• 3

在这个实现中，创建对象后不能修改，所以更新方法返回改变后的新实例：

    tuplePair = pair.update2("New Four");

• 1

总结

本文讨论java配对概念，并通过实例展示了其不同的实现，核心java及第三方提供实现。