java8 Optional 用法解析

java8 Optional 用法解析

全局实例： 

//调用工厂方法创建Optional实例
Optional<String> name = Optional.of("Sanaulla"); // name = Sanaulla

Optional empty = Optional.ofNullable(null);      // empty = null

【1】empty() ：返回一个空的 Optional对象 ；

---

 【2】of(T)： T必须是非null值，返回一个Optional对象； 唯一的区别是可以接受参数为null的情况

【3】ofNullable(T)：如果T为null，它会调用empty方法，如果不为null则调用of方法；

Optional empty = Optional.ofNullable(null);

---

【4】isPresent()：如果这个对象的值不为null返回true,否则返回false；

【5】get：如果这个值存在，则返回这个值，如果这个值为null，则抛出异常；

---

【6】ifPresent()：方法接收一个consumer函数式接口，将自己的非空的逻辑写进去。Optioanal该方法更加简洁；

strValue.ifPresent(s -> System.out.println(s));

【规则】：如果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());
return “adf”;//此处不可以有返回值
});

---

【7】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!"));

---

 

【8】orElseGet()：接收一个Supplier，如果存在，返回这个值本身，否则返回Supplier对象。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"));

【9】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());
}


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";
  }
}

【10】map()：接收一个Function, 如果Optioanal为null则抛出异常（所以这里创建Optional对象时建议用Optional.ofNullable()），如果为空值则返回空，如果不为空则返回Function的返回值。

如果有值，则对其执行调用mapping函数得到返回值。如果返回值不为null，则创建包含mapping返回值的Optional作为map方法返回值，否则返回空Optional。

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

【11】flatMap ：

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

【注意】：flatMap方法与map方法类似，区别在于mapping函数的返回值不同。map方法的mapping函数返回值可以是任何类型T，而flatMap方法的mapping函数必须是Optional。 

//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

【12】filter： 

该方法通过传入限定条件对Optional实例的值进行过滤。如果有值并且满足断言条件返回包含该值的Optional，否则返回空Optional。（对于filter函数我们应该传入实现了Predicate接口的lambda表达式）

//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"));

  【13】Optioanal 通常作为方法的返回值来使用，它可以有效的规避返回null的结果，如果一个类需要序列化，当Optional作为参数类型或是成员变量类型是有问题的。因为Optional没有实现序列化，所以Optioanl通常不被建议作为参数或常量使用。

 【14】举例：

（1）非空校验：

public static String getName(User u) {
    return Optional.ofNullable(u)
                    .map(user->user.name)
                    .orElse("Unknown");
}

（2）参数校验： 

public static String getChampionName(Competition comp) throws IllegalArgumentException {
    return Optional.ofNullable(comp)
            .map(c->c.getResult())
            .map(r->r.getChampion())
            .map(u->u.getName())
            .orElseThrow(()->new IllegalArgumentException("The value of param comp isn't available."));
}

public void setName(String name) throws IllegalArgumentException {
    this.name = Optional.ofNullable(name).filter(User::isNameValid)
                        .orElseThrow(()->new IllegalArgumentException("Invalid username."));
}

（3）Optional转为List或者Set

import static java.util.stream.Collectors.*;
//转为List
List<String> list = collect(opt, toList());
//转为Set
Set<String>  set  = collect(opt, toSet());

 public static <R, A, T> R collect(Optional<T> option, Collector<? super T, A, R> collector) {
        final A container = collector.supplier().get();
        option.ifPresent(v -> collector.accumulator().accept(container, v));
        return collector.finisher().apply(container);
    }

【参考文献】：Java 8 Optional类深度解析