Java中Pair 配对的使用以及和Map的区别

前记

不知道有的铁子在敲代码时有没有想过，为什么一个方法不能同时返回两个结果？今天我很负责任的告诉你：这是可以的！不过需要它的帮助

Pair

Pair(配对)，当涉及到key-value场景时，想必大家都知道用Map去处理映射的关系，此时的key只是代表着一种引用关系，具体的信息都保存在value中，我们可以通过key去获取value访问存储的信息。当key和value都需要保存信息时，此时就需要我们的Pair上场了！

Pair存储的是一对信息对，key / value之间并没有关系

具体实现：
1、Java中提供的Pair很简单，在javafx.util包下

package javafx.util;

import java.io.Serializable;
import javafx.beans.NamedArg;

public class Pair<K,V> implements Serializable{

    private K key;
    
    public K getKey() { return key; }

    private V value;

    public V getValue() { return value; }
	//构造方法
    public Pair(@NamedArg("key") K key, @NamedArg("value") V value) {
        this.key = key;
        this.value = value;
    }

2、另外在Apache Commons库中也有提供Pair抽象类，并拓展了两个子类：ImmutablePair 和 MutablePair，分别代表了可变配对和不可变配对

package org.apache.commons.lang3.tuple;

import java.io.Serializable;
import java.util.Map;
import java.util.Objects;

import org.apache.commons.lang3.builder.CompareToBuilder;

public abstract class Pair<L, R> implements Map.Entry<L, R>, Comparable<Pair<L, R>>, Serializable {

    private static final class PairAdapter<L, R> extends Pair<L, R> {

        private static final long serialVersionUID = 1L;

        @Override
        public L getLeft() {
            return null;
        }

        @Override
        public R getRight() {
            return null;
        }

        @Override
        public R setValue(final R value) {
            return null;
        }

    }

   
    private static final long serialVersionUID = 4954918890077093841L;

    public static final Pair<?, ?>[] EMPTY_ARRAY = new PairAdapter[0];

    @SuppressWarnings("unchecked")
    public static <L, R> Pair<L, R>[] emptyArray() {
        return (Pair<L, R>[]) EMPTY_ARRAY;
    }

    public static <L, R> Pair<L, R> of(final L left, final R right) {
        return ImmutablePair.of(left, right);
    }

    public static <L, R> Pair<L, R> of(final Map.Entry<L, R> pair) {
        return ImmutablePair.of(pair);
    }

    @Override
    public int compareTo(final Pair<L, R> other) {
      return new CompareToBuilder().append(getLeft(), other.getLeft())
              .append(getRight(), other.getRight()).toComparison();
    }
    
    @Override
    public final L getKey() {
        return getLeft();
    }

    public abstract L getLeft();

    public abstract R getRight();

    @Override
    public R getValue() {
        return getRight();
    }

    public String toString(final String format) {
        return String.format(format, getLeft(), getRight());
    }

}

实践

1、javafx.util下的Pair

Pair<String, String> pair = new Pair<>("2", "二号");
String key = pair.getKey();
String value = pair.getValue();

这里的key就对应 “2”，value对应 “二号”

2、org.apache.commons.lang3.tuple下的Pair

Pair<String, String> pair = Pair.of("3", "三号");
String key = pair.getKey();
String value = pair.getValue();

这里的Pair提供了4种获取值得方式，只是底层调用没有变化

public abstract L getLeft();

@Override
public final L getKey() {
    return getLeft();
}    
    
    
public abstract R getRight();
    
@Override
public R getValue() {
    return getRight();
}

总结

看到这里，大家也基本会Pair 的使用了，可能大家感觉这个Pair还挺方便的，终于可以在方法中返回两个结果了，不需要多写一个方法了。

不过，个人建议还是少用为好，现在公司中的项目都是多人协同开发，免不了我需要调你写的方法，可是给我返回我不需要的另一个数据是什么意思？

所以说还是一个方法返回一个值，尽量做到一个方法只干一件事，不怕代码写的多，就怕写的不专业