java - 如何从 Java 方法返回多个对象？

Question

我想从 Java 方法返回两个对象，想知道这样做的好方法是什么？

我能想到的可能方法是：返回一个HashMap（因为这两个对象是相关的）或返回一个ArrayList对象Object。

更准确地说，我要返回的两个对象是（a）List对象和（b）逗号分隔的相同名称。

我想从一种方法返回这两个对象，因为我不想遍历对象列表以获取逗号分隔的名称（我可以在此方法的同一循环中执行此操作）。

不知何故，返回 aHashMap看起来不是一种非常优雅的方式。

Answer 1

如果要返回两个对象，通常希望返回封装这两个对象的单个对象。

你可以像这样返回一个NamedObject对象列表：

public class NamedObject<T> {
  public final String name;
  public final T object;

  public NamedObject(String name, T object) {
    this.name = name;
    this.object = object;
  }
}

然后你可以轻松地返回一个List<NamedObject<WhateverTypeYouWant>>.

另外：为什么要返回以逗号分隔的名称列表而不是List<String>? 或者更好的是，返回 a Map<String,TheObjectType>，键是对象的名称和值（除非您的对象已指定顺序，在这种情况下， aNavigableMap可能是您想要的。

Answer 2

如果你知道你将返回两个对象，你也可以使用一个泛型对：

public class Pair<A,B> {
    public final A a;
    public final B b;

    public Pair(A a, B b) {
        this.a = a;
        this.b = b;
    }
};

编辑上述更完整的实现：

package util;

public class Pair<A,B> {

    public static <P, Q> Pair<P, Q> makePair(P p, Q q) {
        return new Pair<P, Q>(p, q);
    }

    public final A a;
    public final B b;

    public Pair(A a, B b) {
        this.a = a;
        this.b = b;
    }

    @Override
    public int hashCode() {
        final int prime = 31;
        int result = 1;
        result = prime * result + ((a == null) ? 0 : a.hashCode());
        result = prime * result + ((b == null) ? 0 : b.hashCode());
        return result;
    }

    @Override
    public boolean equals(Object obj) {
        if (this == obj) {
            return true;
        }
        if (obj == null) {
            return false;
        }
        if (getClass() != obj.getClass()) {
            return false;
        }
        @SuppressWarnings("rawtypes")
        Pair other = (Pair) obj;
        if (a == null) {
            if (other.a != null) {
                return false;
            }
        } else if (!a.equals(other.a)) {
            return false;
        }
        if (b == null) {
            if (other.b != null) {
                return false;
            }
        } else if (!b.equals(other.b)) {
            return false;
        }
        return true;
    }

    public boolean isInstance(Class<?> classA, Class<?> classB) {
        return classA.isInstance(a) && classB.isInstance(b);
    }

    @SuppressWarnings("unchecked")
    public static <P, Q> Pair<P, Q> cast(Pair<?, ?> pair, Class<P> pClass, Class<Q> qClass) {

        if (pair.isInstance(pClass, qClass)) {
            return (Pair<P, Q>) pair;
        }

        throw new ClassCastException();

    }

}

注释，主要是关于 Java 和泛型的生锈：

• 两者都是不可变a的b。
• makePairstatic 方法可以帮助您进行样板类型，Java 7 中的菱形运算符将减少烦人。有一些工作可以使这个非常好：泛型，但现在应该没问题。（参见 PECS）
• hashcode并由equalseclipse生成。
• 该cast方法中的编译时间转换是可以的，但似乎不太正确。
• 我不确定是否需要通配符isInstance。
• 我只是为了回应评论而写的，仅用于说明目的。

Answer 3

如果您调用的方法是私有的，或者从一个位置调用，请尝试

return new Object[]{value1, value2};

调用者看起来像：

Object[] temp=myMethod(parameters);
Type1 value1=(Type1)temp[0];  //For code clarity: temp[0] is not descriptive
Type2 value2=(Type2)temp[1];

David Hanak 的 Pair 示例没有语法优势，并且仅限于两个值。

return new Pair<Type1,Type2>(value1, value2);

调用者看起来像：

Pair<Type1, Type2> temp=myMethod(parameters);
Type1 value1=temp.a;  //For code clarity: temp.a is not descriptive
Type2 value2=temp.b;

Answer 4

您可以使用以下任何一种方式：

private static final int RETURN_COUNT = 2;
private static final int VALUE_A = 0;
private static final int VALUE_B = 1;
private static final String A = "a";
private static final String B = "b";

1) 使用数组

private static String[] methodWithArrayResult() {
    //...
    return new String[]{"valueA", "valueB"};
}

private static void usingArrayResultTest() {
    String[] result = methodWithArrayResult();
    System.out.println();
    System.out.println("A = " + result[VALUE_A]);
    System.out.println("B = " + result[VALUE_B]);
}

2) 使用数组列表

private static List<String> methodWithListResult() {
    //...
    return Arrays.asList("valueA", "valueB");
}

private static void usingListResultTest() {
    List<String> result = methodWithListResult();
    System.out.println();
    System.out.println("A = " + result.get(VALUE_A));
    System.out.println("B = " + result.get(VALUE_B));
}

3) 使用哈希映射

private static Map<String, String> methodWithMapResult() {
    Map<String, String> result = new HashMap<>(RETURN_COUNT);
    result.put(A, "valueA");
    result.put(B, "valueB");
    //...
    return result;
}

private static void usingMapResultTest() {
    Map<String, String> result = methodWithMapResult();
    System.out.println();
    System.out.println("A = " + result.get(A));
    System.out.println("B = " + result.get(B));
}

4）使用您的自定义容器类

private static class MyContainer<M,N> {
    private final M first;
    private final N second;

    public MyContainer(M first, N second) {
        this.first = first;
        this.second = second;
    }

    public M getFirst() {
        return first;
    }

    public N getSecond() {
        return second;
    }

    // + hashcode, equals, toString if need
}

private static MyContainer<String, String> methodWithContainerResult() {
    //...
    return new MyContainer("valueA", "valueB");
}

private static void usingContainerResultTest() {
    MyContainer<String, String> result = methodWithContainerResult();
    System.out.println();
    System.out.println("A = " + result.getFirst());
    System.out.println("B = " + result.getSecond());
}

5) 使用AbstractMap.simpleEntry

private static AbstractMap.SimpleEntry<String, String> methodWithAbstractMapSimpleEntryResult() {
    //...
    return new AbstractMap.SimpleEntry<>("valueA", "valueB");
}

private static void usingAbstractMapSimpleResultTest() {
    AbstractMap.SimpleEntry<String, String> result = methodWithAbstractMapSimpleEntryResult();
    System.out.println();
    System.out.println("A = " + result.getKey());
    System.out.println("B = " + result.getValue());
}

6) 使用一对Apache Commons

private static Pair<String, String> methodWithPairResult() {
    //...
    return new ImmutablePair<>("valueA", "valueB");
}

private static void usingPairResultTest() {
    Pair<String, String> result = methodWithPairResult();
    System.out.println();
    System.out.println("A = " + result.getKey());
    System.out.println("B = " + result.getValue());
}

Answer 5

当我用 Java 编码时，我几乎总是最终定义 n-Tuple 类。例如：

public class Tuple2<T1,T2> {
  private T1 f1;
  private T2 f2;
  public Tuple2(T1 f1, T2 f2) {
    this.f1 = f1; this.f2 = f2;
  }
  public T1 getF1() {return f1;}
  public T2 getF2() {return f2;}
}

我知道这有点难看，但它可以工作，你只需要定义一次元组类型。元组是 Java 真正缺乏的东西。

编辑：David Hanak 的例子更优雅，因为它避免定义 getter 并且仍然保持对象不可变。

Answer 6

在 Java 5 之前，我有点同意 Map 解决方案并不理想。它不会为您提供编译时类型检查，因此可能会在运行时导致问题。但是，在 Java 5 中，我们有了泛型类型。

因此，您的方法可能如下所示：

public Map<String, MyType> doStuff();

MyType 当然是您要返回的对象的类型。

基本上我认为在这种情况下返回 Map 是正确的解决方案，因为这正是您想要返回的 - 字符串到对象的映射。

Answer 7

Apache Commons 为此提供了元组和三元组：

• ImmutablePair<L,R> 由两个 Object 元素组成的不可变对。
• ImmutableTriple<L,M,R> 由三个 Object 元素组成的不可变三元组。
• MutablePair<L,R> 由两个 Object 元素组成的可变对。
• MutableTriple<L,M,R> 由三个 Object 元素组成的可变三元组。
• Pair<L,R> 由两个元素组成的一对。
• Triple<L,M,R> 由三个元素组成的三元组。

来源：https ://commons.apache.org/proper/commons-lang/apidocs/org/apache/commons/lang3/tuple/package-summary.html

Answer 8

或者，在我想从一个方法返回许多东西的情况下，我有时会使用回调机制而不是容器。这在我无法提前指定将生成多少对象的情况下非常有效。

对于您的特定问题，它看起来像这样：

public class ResultsConsumer implements ResultsGenerator.ResultsCallback
{
    public void handleResult( String name, Object value )
    {
        ... 
    }
}

public class ResultsGenerator
{
    public interface ResultsCallback
    {
        void handleResult( String aName, Object aValue );
    }

    public void generateResults( ResultsGenerator.ResultsCallback aCallback )
    {
        Object value = null;
        String name = null;

        ...

        aCallback.handleResult( name, value );
    }
}

Answer 9

虽然在您的情况下，评论可能是一个不错的选择，但在 Android 中，您可以使用Pair . 简单地

return new Pair<>(yourList, yourCommaSeparatedValues);

Answer 10

使用以下条目对象示例：

public Entry<A,B> methodname(arg)
{
.......

return new AbstractMap.simpleEntry<A,B>(instanceOfA,instanceOfB);
}

Answer 11

关于一般的多个返回值的问题，我通常使用一个小的帮助类来包装单个返回值并作为参数传递给方法：

public class ReturnParameter<T> {
    private T value;

    public ReturnParameter() { this.value = null; }
    public ReturnParameter(T initialValue) { this.value = initialValue; }

    public void set(T value) { this.value = value; }
    public T get() { return this.value; }
}

（对于原始数据类型，我使用较小的变化来直接存储值）

一个想要返回多个值的方法将被声明如下：

public void methodThatReturnsTwoValues(ReturnParameter<ClassA> nameForFirstValueToReturn, ReturnParameter<ClassB> nameForSecondValueToReturn) {
    //...
    nameForFirstValueToReturn.set("...");
    nameForSecondValueToReturn.set("...");
    //...
}

也许主要的缺点是调用者必须提前准备返回对象以防他想使用它们（并且该方法应该检查空指针）

ReturnParameter<ClassA> nameForFirstValue = new ReturnParameter<ClassA>();
ReturnParameter<ClassB> nameForSecondValue = new ReturnParameter<ClassB>();
methodThatReturnsTwoValues(nameForFirstValue, nameForSecondValue);

优点（与提出的其他解决方案相比）：

• 您不必为各个方法及其返回类型创建特殊的类声明
• 参数有一个名称，因此在查看方法签名时更容易区分
• 每个参数的类型安全

Answer 12

所有可能的解决方案都将是一个杂项（如容器对象、您的 HashMap 想法、通过数组实现的“多个返回值”）。我建议从返回的列表中重新生成逗号分隔的列表。代码最终会变得更干净。

Answer 13

保持简单并为多个结果情况创建一个类。此示例接受一个 ArrayList 和来自 databasehelper getInfo 的消息文本。

您在哪里调用返回您编码的多个值的例程：

multResult res = mydb.getInfo(); 

在例程 getInfo 中，您编写代码：

ArrayList<String> list= new ArrayList<String>();
add values to the list...
return new multResult("the message", list);

并定义一个类 multResult ：

public class multResult {
    public String message; // or create a getter if you don't like public
    public ArrayList<String> list;
    multResult(String m, ArrayList<String> l){
        message = m;
        list= l;
}

}

Answer 14

正如我所看到的，这里实际上有三个选择，解决方案取决于上下文。您可以选择在生成列表的方法中实现名称的构造。这是您选择的选择，但我认为这不是最好的选择。您正在生产者方法中创建与不需要存在的消费方法的耦合。其他呼叫者可能不需要额外信息，您将为这些呼叫者计算额外信息。

或者，您可以让调用方法计算名称。如果只有一个呼叫者需要此信息，您可以停止。您没有额外的依赖关系，虽然涉及一些额外的计算，但您避免了使您的构造方法过于具体。这是一个很好的权衡。

最后，您可以让列表本身负责创建名称。如果计算需要由多个调用者完成，这是我会走的路线。我认为这将负责创建与对象本身最密切相关的类的名称。

在后一种情况下，我的解决方案是创建一个专门的 List 类，该类返回它包含的对象名称的逗号分隔字符串。使类足够聪明，以便在添加和删除对象时动态构造名称字符串。然后返回这个列表的一个实例，并根据需要调用名称生成方法。尽管将名称的计算简单地延迟到第一次调用该方法并随后存储它（延迟加载）可能几乎同样有效（并且更简单）。如果您添加/删除一个对象，您只需要删除计算值并在下一次调用时重新计算它。

Answer 15

可以做一些像动态语言（Python）中的元组之类的事情

public class Tuple {
private Object[] multiReturns;

private Tuple(Object... multiReturns) {
    this.multiReturns = multiReturns;
}

public static Tuple _t(Object... multiReturns){
    return new Tuple(multiReturns);
}

public <T> T at(int index, Class<T> someClass) {
    return someClass.cast(multiReturns[index]);
}
}

并像这样使用

public Tuple returnMultiValues(){
   return Tuple._t(new ArrayList(),new HashMap())
}


Tuple t = returnMultiValues();
ArrayList list = t.at(0,ArrayList.class);

Answer 16

我采用了与其他答案中描述的方法类似的方法，并根据我的要求进行了一些调整，基本上我创建了以下类（以防万一，一切都是 Java）：

public class Pair<L, R> {
    final L left;
    final R right;

    public Pair(L left, R right) {
        this.left = left;
        this.right = right;
    }

    public <T> T get(Class<T> param) {
        return (T) (param == this.left.getClass() ? this.left : this.right);
    }

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

然后，我的要求很简单，在到达数据库的存储库类中，对于获取方法而不是从数据库中检索数据，我需要检查它是失败还是成功，然后，如果成功，我需要使用返回列表，如果失败，停止执行并通知错误。

因此，例如，我的方法是这样的：

public Pair<ResultMessage, List<Customer>> getCustomers() {
    List<Customer> list = new ArrayList<Customer>();
    try {
    /*
    * Do some work to get the list of Customers from the DB
    * */
    } catch (SQLException e) {
        return Pair.of(
                       new ResultMessage(e.getErrorCode(), e.getMessage()), // Left 
                       null);  // Right
    }
    return Pair.of(
                   new ResultMessage(0, "SUCCESS"), // Left 
                   list); // Right
}

其中 ResultMessage 只是一个具有两个字段（代码/消息）的类，而 Customer 是具有来自数据库的一堆字段的任何类。

然后，要检查结果，我只是这样做：

void doSomething(){
    Pair<ResultMessage, List<Customer>> customerResult = _repository.getCustomers();
    if (customerResult.get(ResultMessage.class).getCode() == 0) {
        List<Customer> listOfCustomers = customerResult.get(List.class);
        System.out.println("do SOMETHING with the list ;) ");
    }else {
        System.out.println("Raised Error... do nothing!");
    }
}

Answer 17

public class MultipleReturnValues {

    public MultipleReturnValues() {
    }

    public static void functionWithSeveralReturnValues(final String[] returnValues) {
        returnValues[0] = "return value 1";
        returnValues[1] = "return value 2";
    }

    public static void main(String[] args) {
        String[] returnValues = new String[2];
        functionWithSeveralReturnValues(returnValues);
        System.out.println("returnValues[0] = " + returnValues[0]);
        System.out.println("returnValues[1] = " + returnValues[1]);
    }

}

Answer 18

为什么不创建一个WhateverFunctionResult包含您的结果的对象，以及解析这些结果所需的逻辑，然后迭代等等。在我看来，要么：

1. 这些结果对象紧密联系在一起/相关并且属于一起，或者：
2. 它们是不相关的，在这种情况下，您的功能没有很好地定义它试图做什么（即做两件不同的事情）

我看到这种问题一次又一次地出现。不要害怕创建自己的容器/结果类，其中包含数据和相关的功能来处理它。如果您只是简单地以 aHashMap或类似的方式传递这些东西，那么您的客户每次想要使用结果时都必须拆开这张地图并摸索内容。

Answer 19

在 C++ (STL) 中，有一个用于捆绑两个对象的 pair 类。在 Java 泛型中，pair 类不可用，尽管有一些需求。你可以很容易地自己实现它。

但是，我同意其他一些答案，即如果您需要从一个方法返回两个或更多对象，最好将它们封装在一个类中。

Answer 20

这并不能完全回答这个问题，但由于这里给出的每个解决方案都有一些缺点，我建议尝试稍微重构你的代码，这样你只需要返回一个值。

案例一。

你需要在你的方法内外都有一些东西。为什么不在外面计算并传递给方法呢？

代替：

[thingA, thingB] = createThings(...);  // just a conceptual syntax of method returning two values, not valid in Java

尝试：

thingA = createThingA(...);
thingB = createThingB(thingA, ...);

这应该可以满足您的大部分需求，因为在大多数情况下，一个值是在另一个值之前创建的，您可以通过两种方法拆分创建它们。缺点是该方法createThingsB与 相比有一个额外的参数createThings，并且可能您将完全相同的参数列表两次传递给不同的方法。

---

案例二。

有史以来最明显的解决方案和案例一的简化版本。这并不总是可能的，但也许这两个值都可以相互独立地创建？

代替：

[thingA, thingB] = createThings(...);  // see above

尝试：

thingA = createThingA(...);
thingB = createThingB(...);

为了让它更有用，这两种方法可以共享一些共同的逻辑：

public ThingA createThingA(...) {
    doCommonThings(); // common logic
    // create thing A
}
public ThingB createThingB(...) {
    doCommonThings(); // common logic
    // create thing B
}

Answer 21

将列表传递给您的方法并填充它，然后返回带有名称的字符串，如下所示：

public String buildList(List<?> list) {
    list.add(1);
    list.add(2);
    list.add(3);
    return "something,something,something,dark side";
}

然后像这样调用它：

List<?> values = new ArrayList<?>();
String names = buildList(values);

Answer 22

您可以使用HashMap<String, Object>如下

public HashMap<String, Object> yourMethod()
{

   .... different logic here 

  HashMap<String, Object> returnHashMap = new HashMap<String, Object>();
  returnHashMap.put("objectA", objectAValue);
  returnHashMap.put("myString", myStringValue);
  returnHashMap.put("myBoolean", myBooleanValue);

  return returnHashMap;
}

然后在不同范围内调用该方法时，您可以将每个对象转换回其初始类型：

// call the method
HashMap<String, Object> resultMap = yourMethod();
                
// fetch the results and cast them
ObjectA objectA = (ObjectA) resultMap.get("objectA");
String myString = (String) resultMap.get("myString");
Boolean myBoolean = (Boolean) resultMap.get("myBoolean");

Answer 23

我注意到还没有返回多个值的无自定义类、n 长度、无强制转换、类型安全的答案。

这是我的尝试：

import java.util.Objects;

public final class NTuple<V, T extends  NTuple<?, ?>> {
    private final V value;
    private final T next;

    private NTuple(V value, T next) {
        this.value = value;
        this.next = next;
    }

    public static <V> NTuple<V, ?> of(V value) {
        return new NTuple<>(value, null);
    }

    public static <V,  T extends  NTuple<?, ?>> NTuple<V, T> of(V value, T next) {
        return new NTuple<>(value, next);
    }

    public V value() {
        return value;
    }

    public T next() {
        return next;
    }

    public static <V> V unpack0(NTuple<V, ?> tuple) {
        return Objects.requireNonNull(tuple, "0").value();
    }

    public static <V, T extends NTuple<V, ?>> V unpack1(NTuple<?, T> tuple) {
        NTuple<?, T> tuple0 = Objects.requireNonNull(tuple, "0");
        NTuple<V, ?> tuple1 = Objects.requireNonNull(tuple0.next(), "1");
        return tuple1.value();
    }

    public static <V, T extends NTuple<?, NTuple<V, ?>>> V unpack2(NTuple<?, T> tuple) {
        NTuple<?, T> tuple0 = Objects.requireNonNull(tuple, "0");
        NTuple<?, NTuple<V, ?>> tuple1 = Objects.requireNonNull(tuple0.next(), "1");
        NTuple<V, ?> tuple2 = Objects.requireNonNull(tuple1.next(), "2");
        return tuple2.value();
    }
}

样品用途：

public static void main(String[] args) {
    // pre-java 10 without lombok - use lombok's var or java 10's var if you can
    NTuple<String, NTuple<Integer, NTuple<Integer, ?>>> multiple = wordCount("hello world");
    String original = NTuple.unpack0(multiple);
    Integer wordCount = NTuple.unpack1(multiple);
    Integer characterCount  = NTuple.unpack2(multiple);

    System.out.println(original + ": " + wordCount + " words " + characterCount + " chars");
}

private static NTuple<String, NTuple<Integer, NTuple<Integer, ?>>> wordCount(String s) {
    int nWords = s.split(" ").length;
    int nChars = s.length();
    return NTuple.of(s, NTuple.of(nWords, NTuple.of(nChars)));
}

优点：

• 无自定义容器类 - 无需仅为返回类型编写类
• n-length - 可以处理任意数量的返回值
• no-cast - 无需从 Object 进行投射
• 类型安全 - 通过 Java 的泛型检查类型

缺点：

• 对于大量返回值效率低下
  • 根据我对 python 的多个返回值的经验，这在实践中不应该发生
• 重类型声明
  • 可以通过 lombok/Java 10 缓解var

Answer 24

在 C 中，您可以通过将指向占位符的指针作为参数传递给结果：

void getShoeAndWaistSizes(int *shoeSize, int *waistSize) {
    *shoeSize = 36;
    *waistSize = 45;
}
...
int shoeSize, waistSize;
getShoeAndWaistSize(&shoeSize, &waistSize);
int i = shoeSize + waistSize;

让我们在 Java 中尝试类似的东西。

void getShoeAndWaistSizes(List<Integer> shoeSize, List<Integer> waistSize) {
    shoeSize.add(36);
    waistSize.add(45);
}
...
List<Integer> shoeSize = new List<>();
List<Integer> waistSize = new List<>();
getShoeAndWaistSizes(shoeSize, waistSize);
int i = shoeSize.get(0) + waistSize.get(0);

Answer 25

将哈希传递给方法并填充它......

公共无效构建响应（字符串数据，地图响应）；