一、简述
当一个方法需要返回有重要意义的两个值时,一般会用 Map 的 key 和 value 来表达,但是这样的话就需要两组键值对。用 Map 映射去做处理时,key 相当于 value 的一个描述或者引用,而具体的信息都保存在 value 中,可以通过 key 去获取对应的 value。但是当 key 和 value 都保存具体信息时,配对(Pair) 是个不错的选择,其提供了一种方便方式来处理简单的键值关联,当想从方法返回两个值时特别有用。
二、具体的实现
在核心 Java 库中可以使用配对(Pair)的实现。除此之外,某些第三方库,比如 Apache Commons 和 Vavr,已经在各自的 API 中公开了这个功能。
1️⃣核心 Java 库配对(Pair)实现
在javafx.util包中,类构造函数有两个参数,键及对应值:
Pair<Integer, String> pair = new Pair<>(1, "one");
Integer key = pair.getKey();
String value = pair.getValue();
示例使用 Pair 类实现简单 Integer 到 String 的映射。getKey 方法返回 key 对象,getValue 方法返回对应值对象。
2️⃣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();
其键和值可以通过标准的 setter/getter 方法获得。
另外 AbstractMap 类还包含一个嵌套类,表示不可变配对:SimpleImmutableEntry 类。
AbstractMap.SimpleImmutableEntry<Integer, String> entry
= new AbstractMap.SimpleImmutableEntry<>(1, "one");
应用方式与可变的配对一样,除了配置的值不能修改,尝试修改会抛出UnsupportedOperationException。
3️⃣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();//底层pair.getLeft();
String value = pair.getValue();//底层pair.getRight();
在 ImmutablePair 执行 setValue 方法,会抛出UnsupportedOperationException。但在可变配对上执行完全正常:
Pair<Integer, String> pair = new MutablePair<>(3, "three");
pair.setValue("New Three");
4️⃣Vavr库
Vavr库中不可变的 Tuple2 类提供配对功能:
Tuple2<Integer, String> pair = new Tuple2<>(4, "four");
Integer key = pair._1();
String value = pair._2();
在这个实现中,创建对象后不能修改,所以更新方法返回改变后的新实例:
tuplePair = pair.update2("New Four");
网友评论