如何在 Java 中返回一个标志和一条可选消息？

Question

我想用 Java 编写一个方法，用于验证某些数据是否满足某些条件，并确认数据有效，否则会生成适当的错误消息。

问题是我们不能从一个方法返回多个内容，所以我想知道最好的解决方案是什么（在可读性和可维护性方面）。

第一个解决方案。很简单，但我们不知道到底是什么导致检查失败：

boolean verifyLimits1(Set<Integer> values, int maxValue) {
    for (Integer value : values) {
        if (value > maxValue) {
            return false; // Out of limits
        }
    }
    return true; // All values are OK
}

第二种解决方案。我们有消息，但我们以不应该的方式使用异常（此外，它可能应该是特定于域的检查异常，IMO 开销太大）：

void verifyLimits2(Set<Integer> values, int maxValue) {
    for (Integer value : values) {
        if (value > maxValue) {
            throw new IllegalArgumentException("The value " + value + " exceeds the maximum value");
        }
    }
}

第三种解决方案。我们有一个详细的消息，但契约并不干净：我们让客户端检查 String 是否为空（为此他需要阅读 javadoc）。

String verifyLimits3(Set<Integer> values, int maxValue) {
    StringBuilder builder = new StringBuilder();
    for (Integer value : values) {
        if (value > maxValue) {
            builder.append("The value " + value + " exceeds the maximum value/n");
        }
    }
    return builder.toString();
}

您会推荐哪种解决方案？或者有更好的吗（希望如此！）？

（注意：我编了这个小例子，我的实际用例涉及异构数据的复杂条件，因此不要关注这个具体示例并提出Collections.max(values) > maxValue ?“超出范围。 " : "一切都好。" :-).)

Answer 1

如果您需要多个值，您应该返回一个简单的类实例。下面是我们在某些情况下使用的示例：

public class Validation {
    private String          text    = null;
    private ValidationType  type    = ValidationType.OK;

    public Validation(String text, ValidationType type) {
        super();
        this.text = text;
        this.type = type;
    }
    public String getText() {
        return text;
    }
    public ValidationType getType() {
        return type;
    }
}

这对类型使用了简单的枚举：

public enum ValidationType {
    OK, HINT, ERROR;
}

验证器方法可能如下所示：

public Validation validateSomething() {
    if (condition) {
        return new Validation("msg.key", ValidationType.ERROR);
    }
    return new Validation(null, ValidationType.OK);
}

就是这样。

Answer 2

解决方案很简单：创建一个自定义 VerificationResult 类。它可以有一个布尔状态标志和一个字符串消息字段，以及您可能想要添加的其他内容。返回 VerificationResult，而不是返回 String 或 boolean。

此外，根据上下文，抛出异常实际上可能是正确的做法。不过，这必须根据具体情况进行具体情况考虑。

---

替代解决方案：最后一个错误查询

您可以使用的另一个选项是让验证返回一个 boolean，并有一个单独的方法，例如用户可以查询的 String whatWentWrongLastTime()如果返回 false。您必须非常小心任何可能覆盖“最后”验证错误的并发问题等。

这是例如 java. util.Scanner，它不会抛出任何IOException（构造函数除外）。要查询是否出现“错误”，您可以查询其 ioException() 方法，返回最后一个 IOException，如果没有则返回 null任何。

Answer 3

IllegalArgumentException 是正确的方法，如果它确实意味着：您向方法的调用者（契约）提出一些要求，但它们被忽略。在这种情况下，IAE 是合适的。

如果这不能反映您的用例，我会使用其他解决方案之一。

Answer 4

另一种方法 - 使用 Status 对象：

 public class Status {
   public final static Status OK = new Status("OK");
   private String message;
   public Status(String message) { this.message = message; }
   public String getMessage() { return message; }
 }

要验证，如果输入有效，则返回 Status.OK 或创建新的状态消息。

 public Status validate(Integer input, int maxValue){
   if (input > maxValue) {
     return new Status(
         String.format("%s value out of limits (maxValue=%s)", input, maxValue);
   }

   return Status.OK;
 }

使用验证器很简单：

 Status status = validate(i, 512);
 if (status != Status.OK) {
   // handle the error
 }

Answer 5

我认为最好的解决方案是创建您自己的异常，其中包含您想要的尽可能多的错误描述信息。它不应该是 RuntimeException 子类；您希望调用者必须处理验证失败的情况，因为太多程序员未能进行错误处理。通过将失败设置为已检查的异常，您可以强迫他们（您？）至少放入一些内容，并且如果他们对此愚蠢的话，代码审查可以相对轻松地发现。我知道这很官僚，但从长远来看它提高了代码质量。

完成此操作后，请考虑是否需要在成功验证时返回一个值。仅当该值包含“哦，我现在到了这里”（这从程序流程中显而易见）以外的信息时才返回该值。如果您确实需要返回结果，并且它需要是一个复杂的结果，请务必使用自定义类实例来保存它！不这样做就等于拒绝使用该语言为您提供的设施。

Answer 6

在这种情况下，返回“false”的方法看起来像是业务逻辑结果，而不是真正的异常。因此 verifyLimits 无论如何都应该返回结果，而不是在“false”时抛出异常。

 class VerifyLimitsResult{
       //Ignore get, set methods
        Integer maxValue;
        Integer value;

        public VerifyLimitsResult(Integer maxValue, Integer value) {
           this.maxValue = maxValue;
           this.value = value;
        }

        public boolean isOK(){
           return value==null;
        }

        public String getValidationInfo(){
           if(isOK()){
              return "Fine";
           }else{
              return "The value " + value + " exceeds the maximum value/n"
           }
        }
 }
....
VerifyLimitsResult verifyLimits4(Set<Integer> values, int maxValue) {

         for (Integer value : values) {
             if (value > maxValue) {
                   return new VerifyLimitsResult(maxValue, value);  
            }
        }
         return new VerifyLimitsResult(maxValue, null);  
}

Answer 7

如果您检查合理数量的项目并关心您创建的用于返回结果的对象的数量，则可以使用带有接口的替代方案。

首先，您创建一个在违反限制时调用的接口：

// A simple listener to be implemented by the calling method.
public interface OutOfLimitListener {
    // Called whenever a limit is violated.
    public void outOfLimit(int value, int maxValue);

    // ... Add additional results as parameters
    // ... Add additional states as methods
}

您可以添加参数和/或方法。例如，违规值的实际位置可以是一个参数。作为另一个示例，添加一个在每次测试结束时调用的方法，其中包含检查次数和违规次数的参数。

该接口的实现作为参数传递给您的检查方法。每当违反其中一个限制时，它都会调用侦听器：

private boolean verifyLimits(Set<Integer> values, int maxValue, OutOfLimitListener listener) {
    boolean result = true; // Assume all values are OK
    for (Integer value : values) {
        if (value > maxValue) {
            listener.outOfLimit(value, maxValue);
            result = false; // At least one was out of limits
        }
    }
    return result;
}

最后，您只需通过实现接口即可使用此方法：

@Test
public final void test() throws IOException, InterruptedException {
    // Make up a test set of random numbers
    Set<Integer> testSet = new HashSet<Integer>();
    for(int i=0; i<10; i++) testSet.add((int) (Math.random() * 100));

    // Implement the interface once with appropriate reaction to an out-of-limit condition      
    OutOfLimitListener listener = new OutOfLimitListener() {
        @Override
        public void outOfLimit(int value, int maxValue) {
            System.out.printf("The value %d exceeds the maximum value %d\n", value, maxValue);
        }
    };

    // Call verification
    verifyLimits(testSet, 50, listener);
}

Android 和其他 GUI 接口大量使用此模式。对我来说，当结果包含多个值时，它得到了首选方法。

Answer 8

创建您自己的从 RuntimeException 扩展的自定义未检查异常。

Answer 9

您可以使用简单的键值对，通过使用 HashMap，当然还有预定义的键。
返回 HashMap 以进行进一步处理。

Answer 10

我会投票支持第二种解决方案（使用 IllegalArgumentException 或定义特定的解决方案）。

一般来说，好的做法是确保可以安全地忽略方法的任何返回值（因为有一天有人会忘记检查它），并且在忽略返回值不安全的情况下，最好抛出/捕获异常。

Answer 11

您可以将标志作为布尔值返回，并记录未验证的测试结果，无论如何您都想记录它们......

假设您将检查数百万个值。