Optional类包含的方法介绍及其示例

Optional类的介绍

javadoc中的介绍

这是一个能够为null的容器对象。若是值存在则isPresent()方法会返回true，调用get()方法会返回> 该对象。

使用场景

用于避免处理空指针异常（NullPointerException)。将可能为空值的变量放入Optional容器中，经过Optional容器访问对象.

Optional类包含的方法介绍及其示例

of

为非null的值建立一个Optional。

of方法经过工厂方法建立Optional类。须要注意的是，建立对象时传入的参数不能为null。若是传入参数为null，则抛出NullPointerException 。

//调用工厂方法建立Optional实例
Optional<String> name = Optional.of("Sanaulla");
//传入参数为null，抛出NullPointerException.
Optional<String> someNull = Optional.of(null);

ofNullable

为指定的值建立一个Optional，若是指定的值为null，则返回一个空的Optional。

ofNullable与of方法类似，惟一的区别是能够接受参数为null的状况。示例以下：

//下面建立了一个不包含任何值的Optional实例
//例如，值为'null'
Optional empty = Optional.ofNullable(null);

isPresent

很是容易理解

若是值存在返回true，不然返回false。

相似下面的代码：

//isPresent方法用来检查Optional实例中是否包含值
if (name.isPresent()) {
  //在Optional实例内调用get()返回已存在的值
  System.out.println(name.get());//输出Sanaulla
}

get

若是Optional有值则将其返回，不然抛出NoSuchElementException。

上面的示例中，get方法用来获得Optional实例中的值。下面咱们看一个抛出NoSuchElementException的例子：

//执行下面的代码会输出：No value present 
try {
  //在空的Optional实例上调用get()，抛出NoSuchElementException
  System.out.println(empty.get());
} catch (NoSuchElementException ex) {
  System.out.println(ex.getMessage());
}

ifPresent

若是Optional实例有值则为其调用consumer，不然不作处理

要理解ifPresent方法，首先须要了解Consumer类。简答地说，Consumer类包含一个抽象方法。该抽象方法对传入的值进行处理，但没有返回值。Java8支持不用接口直接经过lambda表达式传入参数。

若是Optional实例有值，调用ifPresent()能够接受接口段或lambda表达式。相似下面的代码：

//ifPresent方法接受lambda表达式做为参数。
//lambda表达式对Optional的值调用consumer进行处理。
name.ifPresent((value) -> {
  System.out.println("The length of the value is: " + value.length());
});

orElse

若是有值则将其返回，不然返回指定的其它值。

若是Optional实例有值则将其返回，不然返回orElse方法传入的参数。示例以下：

//若是值不为null，orElse方法返回Optional实例的值。
//若是为null，返回传入的消息。
//输出：There is no value present!
System.out.println(empty.orElse("There is no value present!"));
//输出：Sanaulla
System.out.println(name.orElse("There is some value!"));

orElseGet

orElseGet与orElse方法相似，区别在于获得的默认值。orElse方法将传入的字符串做为默认值，orElseGet方法能够接受Supplier接口的实现用来生成默认值。示例以下：

//orElseGet与orElse方法相似，区别在于orElse传入的是默认值，
//orElseGet能够接受一个lambda表达式生成默认值。
//输出：Default Value
System.out.println(empty.orElseGet(() -> "Default Value")); //输出：Sanaulla System.out.println(name.orElseGet(() -> "Default Value"));

orElseThrow

若是有值则将其返回，不然抛出supplier接口建立的异常。

在orElseGet方法中，咱们传入一个Supplier接口。然而，在orElseThrow中咱们能够传入一个lambda表达式或方法，若是值不存在来抛出异常。示例以下：

try {
  //orElseThrow与orElse方法相似。与返回默认值不一样，
  //orElseThrow会抛出lambda表达式或方法生成的异常 

  empty.orElseThrow(ValueAbsentException::new);
} catch (Throwable ex) {
  //输出: No value present in the Optional instance
  System.out.println(ex.getMessage());
}

ValueAbsentException定义以下：

class ValueAbsentException extends Throwable {

  public ValueAbsentException() {
    super();
  }

  public ValueAbsentException(String msg) {
    super(msg);
  }

  @Override
  public String getMessage() {
    return "No value present in the Optional instance";
  }
}

map

map方法文档说明以下：

若是有值，则对其执行调用mapping函数获得返回值。若是返回值不为null，则建立包含mapping返回值的Optional做为map方法返回值，不然返回空Optional。

map方法用来对Optional实例的值执行一系列操做。经过一组实现了Function接口的lambda表达式传入操做。map方法示例以下：

//map方法执行传入的lambda表达式参数对Optional实例的值进行修改。
//为lambda表达式的返回值建立新的Optional实例做为map方法的返回值。
Optional<String> upperName = name.map((value) -> value.toUpperCase()); System.out.println(upperName.orElse("No value found"));

flatMap

若是有值，为其执行mapping函数返回Optional类型返回值，不然返回空Optional。flatMap与map（Funtion）方法相似，区别在于flatMap中的mapper返回值必须是Optional。调用结束时，flatMap不会对结果用Optional封装。

flatMap方法与map方法相似，区别在于mapping函数的返回值不一样。map方法的mapping函数返回值能够是任何类型T，而flatMap方法的mapping函数必须是Optional。

参照map函数，使用flatMap重写的示例以下：

//flatMap与map（Function）很是相似，区别在于传入方法的lambda表达式的返回类型。
//map方法中的lambda表达式返回值能够是任意类型，在map函数返回以前会包装为Optional。 
//但flatMap方法中的lambda表达式返回值必须是Optionl实例。 
upperName = name.flatMap((value) -> Optional.of(value.toUpperCase())); System.out.println(upperName.orElse("No value found"));//输出SANAULLA

filter

filter个方法经过传入限定条件对Optional实例的值进行过滤。文档描述以下：

若是有值而且知足断言条件返回包含该值的Optional，不然返回空Optional。

读到这里，可能你已经知道如何为filter方法传入一段代码。是的，这里能够传入一个lambda表达式。对于filter函数咱们应该传入实现了Predicate接口的lambda表达式。若是你不熟悉Predicate接口，能够参考这篇文章。

如今我来看看filter的各类用法，下面的示例介绍了知足限定条件和不知足两种状况：

//filter方法检查给定的Option值是否知足某些条件。
//若是知足则返回同一个Option实例，不然返回空Optional。
Optional<String> longName = name.filter((value) -> value.length() > 6); System.out.println(longName.orElse("The name is less than 6 characters"));//输出Sanaulla //另外一个例子是Optional值不知足filter指定的条件。 Optional<String> anotherName = Optional.of("Sana"); Optional<String> shortName = anotherName.filter((value) -> value.length() > 6); //输出：name长度不足6字符 System.out.println(shortName.orElse("The name is less than 6 characters"));

一个完整的示例对用法集中展现：

public class OptionalDemo {

  public static void main(String[] args) {
    //建立Optional实例，也能够经过方法返回值获得。
    Optional<String> name = Optional.of("Sanaulla");

    //建立没有值的Optional实例，例如值为'null'
    Optional empty = Optional.ofNullable(null);

    //isPresent方法用来检查Optional实例是否有值。
    if (name.isPresent()) {
      //调用get()返回Optional值。
      System.out.println(name.get());
    }

    try {
      //在Optional实例上调用get()抛出NoSuchElementException。
      System.out.println(empty.get());
    } catch (NoSuchElementException ex) {
      System.out.println(ex.getMessage());
    }

    //ifPresent方法接受lambda表达式参数。
    //若是Optional值不为空，lambda表达式会处理并在其上执行操做。
    name.ifPresent((value) -> { System.out.println("The length of the value is: " + value.length()); }); //若是有值orElse方法会返回Optional实例，不然返回传入的错误信息。 System.out.println(empty.orElse("There is no value present!")); System.out.println(name.orElse("There is some value!")); //orElseGet与orElse相似，区别在于传入的默认值。 //orElseGet接受lambda表达式生成默认值。 System.out.println(empty.orElseGet(() -> "Default Value")); System.out.println(name.orElseGet(() -> "Default Value")); try { //orElseThrow与orElse方法相似，区别在于返回值。 //orElseThrow抛出由传入的lambda表达式/方法生成异常。 empty.orElseThrow(ValueAbsentException::new); } catch (Throwable ex) { System.out.println(ex.getMessage()); } //map方法经过传入的lambda表达式修改Optonal实例默认值。 //lambda表达式返回值会包装为Optional实例。 Optional<String> upperName = name.map((value) -> value.toUpperCase()); System.out.println(upperName.orElse("No value found")); //flatMap与map（Funtion）很是类似，区别在于lambda表达式的返回值。 //map方法的lambda表达式返回值能够是任何类型，可是返回值会包装成Optional实例。 //可是flatMap方法的lambda返回值老是Optional类型。 upperName = name.flatMap((value) -> Optional.of(value.toUpperCase())); System.out.println(upperName.orElse("No value found")); //filter方法检查Optiona值是否知足给定条件。 //若是知足返回Optional实例值，不然返回空Optional。 Optional<String> longName = name.filter((value) -> value.length() > 6); System.out.println(longName.orElse("The name is less than 6 characters")); //另外一个示例，Optional值不知足给定条件。 Optional<String> anotherName = Optional.of("Sana"); Optional<String> shortName = anotherName.filter((value) -> value.length() > 6); System.out.println(shortName.orElse("The name is less than 6 characters")); } }

上述代码输出以下：

Sanaulla
 No value present
 The length of the value is: 8
 There is no value present!
 Sanaulla
 Default Value
 Sanaulla
 No value present in the Optional instance
 SANAULLA
 SANAULLA
 Sanaulla
 The name is less than 6 characters

原文连接： javacodegeeks

翻译： ImportNew.com - 高俊阳

译文连接： http://www.importnew.com/6675.html [ 转载请保留原文出处、译者和译文连接。]