optionals
我们中任何使用允许空引用的语言进行编程的人,都将在尝试取消引用一个引用时经历过。 无论是导致segfault还是NullPointerException,它始终是一个错误。 托尼·霍尔将其描述为他十亿美元的错误 。 当函数向客户端的开发人员未预料到的客户端返回空引用时,通常会发生此问题。 用这样的代码说:
User user = userRepository.find("Alice");
精明的程序员会立即询问没有找到匹配“ Alice”的用户,但是find()
方法的签名中没有任何内容告诉您期望什么。 过去,典型的Java解决方案是使该方法引发一个已检查的异常,也许是UserNotFoundException
。 这肯定会告知客户程序员可能会发生这种情况,但是它无助于增强其代码的表达能力。 捕获异常会导致妨碍理解的代码。 无论如何,受检查的异常都不受欢迎,人们不再倾向于编写引发异常的代码。
许多程序员将改为抛出未经检查的异常或返回空引用。 两者彼此一样坏,并且出于相同的原因:它们都不通知程序员期望这种可能性,并且如果处理不当,它们都将导致运行时失败。 Java 8引入了Optional
类型来处理此问题。 每当编写可能返回或可能不返回值的方法时,都应使该方法返回希望返回的任何类型的Optional。 因此,在上面的示例中,find将返回Optional<User>
类型的值。 客户端代码现在需要执行其他步骤来测试的存在,然后获取值:
Optional<User> userOpt = userRepository.find("Alice");
if (userOpt.isPresent()) {User user = userOpt.get();
}
此外,如果代码不加保护地调用get()
则其IDE可能会警告他们。
Lambdas使事情变得更好
这个解决方案已经好很多了,但是Optional
远不止于此:如果您坚持以这种方式处理可选内容,那么您将失去一些使代码更具表现力的机会。
上面的代码段改编自我自己对Codurance用于测试求职者的“社交网络”练习的实现。 我的实际代码更像是:
Optional<User> userOpt = userRepository.find(subject);
if (userOpt.isPresent()) {User user = userOpt.get();printAllMessagesPostedToUser(user);
}
Optional有一个ifPresent()
方法,该方法允许我们提供一个Consumer
,如果存在Optional,它将被调用。 消费者的参数将是由可选参数包装的对象。 这使我们可以像这样重写代码:
userRepository.find(subject).ifPresent(user -> printAllMessagesPostedToUser(user));
实际上,我们可以更进一步,并用方法引用代替lambda:
userRepository.find(subject).ifPresent(this::printAllMessagesPostedToUser);
我认为这比if语句更清楚地传达了程序员的意图(在本例中为我的意图)。
令人疯狂的是,没有ifNotPresent()
对应项,即使存在,也没有ifPresent是一个void方法,因此它们无论如何都无法链接。 Java 9通过其ifPresentOrElse(Consumer<T>, Runnable)
方法来解决此问题,但是它仍然不是理想的选择。
替换默认值
关于不存在可选值的问题,我们该怎么办? 如果忘记了缺少功能的抱怨, ifPresent()
仅适用于具有副作用的命令。 如果要实现查询,则可能需要用默认值替换为空的可选值,例如:
if (optionalValue.isPresent()) {return optionalValue.get();
}
return defaultValue;
使用Optional.orElse()
可以很容易地做到这一点:
return optionalValue.orElse(defaultValue);
当您必须调用可能返回null且不受您控制的方法时,这也提供了一种方便的方法,可以将值清零。 之前,我们都有所有与此类似的书面代码:
value = methodThatMayReturnNull();
if (value == null) {value = defaultValue;
}
您可以使用Optional.ofNullable()
重构该代码,因为如果该值为null,它将返回Optional.empty()
:
value = Optional.ofNullable(methodThatMayReturnNull()).orElse(defaultValue);
我认为这比使用ObjectUtils.defaultIfNull
做同样的事情要好一些。 但是,有一个警告。 您不得使用Optional.orElse()
来调用具有副作用的方法。 例如,在我的社交网络练习的其他地方,我有代码来搜索用户,并在找到用户后将其返回,否则它将创建一个新用户:
Optional<User> userOpt = userRepository.find(recipient);
if (userOpt.isPresent()) {return userOpt.get();
}
return createUser();
您可能会假设您可以像下面这样重写此代码:
return userRepository.find(recipient).orElse(createUser());
您不必这样做,因为无论是否存在可选参数,都会始终调用createUser()
! 几乎可以肯定这不是您想要的:充其量您将进行不必要的方法调用,并且,如果该方法有副作用,则可能会引入错误。 相反,您应该调用Optional.orElseGet()
并为它提供一个提供默认值的Supplier
:
return userRepository.find(recipient).orElseGet(() -> createUser());
现在,仅当不存在可选参数时才调用createUser()
,这是我想要的行为。 再一次,我们可以将lambda替换为方法参考:
return userRepository.find(recipient).orElseGet(this::createUser);
抛出异常
对于您来说,当可选项不存在并且您想引发异常时,可能是错误情况。 您可以通过调用Optional.orElseThrow()并将其传递给创建异常的Supplier来实现:
return userRepository.find(recipient).orElseThrow(() -> new RuntimeException("User " + recipient + " not found"));
映射可选值
Optional
还有一些方法,使您可以执行类似于流上的操作。 例如,在另一个练习中,我有一些结构类似于此的代码:
Optional<Amount> creditAmountOpt = transaction.getCreditAmount();
Optional<Amount> debitAmountOpt = transaction.getDebitAmount();String formattedDepositAmount = creditAmountOpt.isPresent() ?formatAmount(creditAmountOpt.get()) : " ";String formattedWithdrawalAmount = debitAmountOpt.isPresent() ?formatAmount(debitAmountOpt.get()) : " ";return String.format(" %s| %s|", formattedDepositAmount, formattedWithdrawalAmount);
该代码的上下文是一个打印银行对帐单行的类:我的Transaction
类知道这是存款还是取款,但我不希望对帐单行打印机知道。 因此,我让Transaction接口返回了借方和贷方金额的可选值:语句行打印机将对每个值(如果存在)进行格式化,如果不存在则替换为空格。
为了避免条件运算符,我们可以使用Optional.map()
方法。 这与Stream
API上的map
方法非常相似。 它接受一个Function
并在存在可选选项时调用它。 它将包装的值作为函数参数传递,并将返回值包装在另一个Optional中。 因此,在这种情况下,它将Optional<Amount>
映射到Optional<String>
。 这使我们可以像这样重写代码:
return String.format(" %s| %s|",transaction.getDepositAmount().map(this::formatAmount).orElse(" "),transaction.getWithdrawalAmount().map(this::formatAmount).orElse(" "));
您可能想知道,如果映射一个返回另一个可选参数的函数,即Function<T, Optional<U>>
,在这种情况下,您最终得到的是Optional<Optional<U>>
类型的结果,这可能不是你要。 同样,类似于流,您可以改用flatMap()
返回一个Optional<U>
值。
与流的相似性扩展到Optional.filter()
,它评估提供的谓词(如果存在可选值),并且当谓词评估为false时,它将返回一个空的可选。 明智的是,避免变得过于可爱,如果不加注意,您可能会得到难以理解的代码。 可选选项最适合用于重构简单明了的代码,但是将其简化为简单明了的代码。
但小心点
最后,任何有用的工具都可能被滥用,因此Optional
也是如此。 它们仅用于表示返回值。 如果您声明类型为Optional的实例变量,IntelliJ将向您发出警告。 这构成了一个临时字段的显式声明,该字段被视为代码气味 。 另外,不要将Optionals用作方法参数:本质上,这是伪装的布尔型参数,也被认为很臭。 如果发现自己想这样做,最好将方法分为两个方法:一个带有参数,另一个不带参数,然后将条件放在客户端代码中。
翻译自: https://www.javacodegeeks.com/2017/11/java-optionals-expressive-code.html
optionals