Java Optional

1、前言

相信不少同学已经被java的NPE(Null Pointer Exception)所谓的空指针异常搞的头昏脑涨, 有大佬说过“防止 NPE，是程序员的基本修养。”但是修养归修养，也是程序员最头疼的问题之一，利用Java8的新特性 Optional来尽量简化代码同时高效处理NPE（Null Pointer Exception 空指针异常）

2、认识Optional并使用

简单来说，Opitonal类就是Java提供的为了解决用 null!=obj 这样的方式存在的判断对象是否为空，从而令人头疼导致NPE（Null Pointer Exception 空指针异常），同时Optional的存在可以让代码更加简单，可读性跟高，代码写起来更高效.
常规判断：

  1. //对象 人
  2. //属性有 name，age
  3. Person person=new Person();
  4. if (null==person){
  5.     return "person为null";
  6. }
  7. return person;

使用**Optional**：

  2. //对象 人
  3. //属性有 name，age
  4. Person person=new Person();
  5. return Optional.ofNullable(person).orElse("person为null");

Person类代码：

  1. public class Person {
  2.     private String name;
  3.     private Integer age;
  4.     public Person(String name, Integer age) {
  5.         this.name = name;
  6.         this.age = age;
  7.     }
  8.     public Person() {
  9.     }
  10.     public String getName() {
  11.         return name;
  12.     }
  13.     public void setName(String name) {
  14.         this.name = name;
  15.     }
  16.     public Integer getAge() {
  17.         return age;
  18.     }
  19.     public void setAge(Integer age) {
  20.         this.age = age;
  21.     }
  22. }

2.1 Optional对象创建

创建Optional对象的方法

  1. public final class Optional<T> {
  2.     private static final Optional<?> EMPTY = new Optional<>();
  3.     private final T value;
  4.     //可以看到两个构造方格都是private 私有的
  5.     //说明 没办法在外面new出来Optional对象
  6.     private Optional() {
  7.         this.value = null;
  8.     }
  9.     private Optional(T value) {
  10.         this.value = Objects.requireNonNull(value);
  11.     }
  12.     //这个静态方法大致 是创建出一个包装值为空的一个对象因为没有任何参数赋值
  13.     public static<T> Optional<T> empty() {
  14.         @SuppressWarnings("unchecked")
  15.         Optional<T> t = (Optional<T>) EMPTY;
  16.         return t;
  17.     }
  18.     //这个静态方法大致 是创建出一个包装值非空的一个对象 因为做了赋值
  19.     public static <T> Optional<T> of(T value) {
  20.         return new Optional<>(value);
  21.     }
  22.     //这个静态方法大致是 如果参数value为空，则创建空对象，如果不为空，则创建有参对象
  23.     public static <T> Optional<T> ofNullable(T value) {
  24.         return value == null ? empty() : of(value);
  25.     }
  26. }

一个简单的示例，与上面对应

  1. // 1、创建一个包装对象值为空的Optional对象
  2. Optional<String> optEmpty = Optional.empty();
  3. // 2、创建包装对象值非空的Optional对象
  4. Optional<String> optOf = Optional.of("optional");
  5. // 3、创建包装对象值允许为空也可以不为空的Optional对象
  6. Optional<String> optOfNullable1 = Optional.ofNullable(null);
  7. Optional<String> optOfNullable2 = Optional.ofNullable("optional");

2.2 Optional.get()方法(返回对象的值)

get()方法是返回一个optional的实例值
源码：

  1. public T get() {
  2.     if (value == null) {
  3.         throw new NoSuchElementException("No value present");
  4.     }
  5.     return value;
  6. }

如果value不为空则做返回，如果为空则抛出异常 “No value present”
简单实例展示

  1. Person person=new Person();
  2. person.setAge(2);
  3. Optional.ofNullable(person).get();

2.3 Optional.isPresent()方法(判断是否为空)

isPresent()方法就是会返回一个boolean类型值，如果对象不为空则为真，如果为空则false
源码:

  1. public boolean isPresent() {
  2.     return value != null;
  3. }

简单的实例展示:

  1. Person person=new Person();
  2. person.setAge(2);
  3. if (Optional.ofNullable(person).isPresent()){
  4.     //写不为空的逻辑
  5.     System.out.println("不为空");
  6. }else{
  7.     //写为空的逻辑
  8.     System.out.println("为空");
  9. }

2.4 Optional.ifPresent()方法(判读是否为空并返回函数)

如果对象非空，则运行函数体
源码:

  1. public void ifPresent(Consumer<? super T> consumer) {
  2.     //如果value不为空，则运行accept方法体
  3.     if (value != null)
  4.         consumer.accept(value);
  5. }

看实例：

  1. Person person=new Person();
  2. person.setAge(2);
  3. Optional.ofNullable(person).ifPresent(p -> System.out.println("年龄"+p.getAge()));

如果对象不为空，则会打印这个年龄，因为内部已经做了NPE（非空判断），所以就不用担心空指针异常了

2.5 Optional.filter()方法(过滤对象)

filter()方法大致意思是，接受一个对象，然后对他进行条件过滤，如果条件符合则返回Optional对象本身，如果不符合则返回空Optional
源码：

  1. public Optional<T> filter(Predicate<? super T> predicate) {
  2.     Objects.requireNonNull(predicate);
  3.     //如果为空直接返回this
  4.     if (!isPresent())
  5.         return this;
  6.     else
  7.         //判断返回本身还是空Optional
  8.         return predicate.test(value) ? this : empty();
  9. }

简单实例：

  1. Person person=new Person();
  2. person.setAge(2);
  3. Optional.ofNullable(person).filter(p -> p.getAge()>50);

2.6 Optional.map()方法(对象进行二次包装)

map()方法将对应Funcation函数式接口中的对象，进行二次运算，封装成新的对象然后返回在Optional中
源码：

  1. public<U> Optional<U> map(Function<? super T, ? extends U> mapper) {
  2.     Objects.requireNonNull(mapper);
  3.     //如果为空返回自己
  4.     if (!isPresent())
  5.         return empty();
  6.     else {
  7.         //否则返回用方法修饰过的Optional
  8.         return Optional.ofNullable(mapper.apply(value));
  9.     }
  10. }

实例展示：

  1. Person person1=new Person();
  2. person.setAge(2);
  3. String optName = Optional.ofNullable(person).map(p -> person.getName()).orElse("name为空");

2.7 Optional.flatMap()方法(Optional对象进行二次包装)

map()方法将对应Optional< Funcation >函数式接口中的对象，进行二次运算，封装成新的对象然后返回在Optional中
源码:

  1. public<U> Optional<U> flatMap(Function<? super T, Optional<U>> mapper) {
  2.     Objects.requireNonNull(mapper);
  3.     if (!isPresent())
  4.         return empty();
  5.     else {
  6.         return Objects.requireNonNull(mapper.apply(value));
  7.     }
  8. }

实例：

  1. Person person=new Person();
  2. person.setAge(2);
  3. Optional<Object> optName = Optional.ofNullable(person).map(p -> Optional.ofNullable(p.getName()).orElse("name为空"));

2.8 Optional.orElse()方法(为空返回对象)

常用方法之一，这个方法是如果包装对象为空的话，就执行orElse方法里的value，如果非空，则返回写入对象
源码:

  1. public T orElse(T other) {
  2.     //如果非空，返回value，如果为空，返回other
  3.     return value != null ? value : other;
  4. }

实例：

  1. Person person1=new Person();
  2. person.setAge(2);
  3. Optional.ofNullable(person).orElse(new Person("小明", 2));

2.9 Optional.orElseGet()方法(为空返回Supplier对象)

这个与orElse很相似，入参不一样，入参为Supplier对象，为空返回传入对象的.get()方法，如果非空则返回当前对象
源码:

  1. public T orElseGet(Supplier<? extends T> other) {
  2.     return value != null ? value : other.get();
  3. }

实例：

  1. Optional<Supplier<Person>> sup=Optional.ofNullable(Person::new);
  2. //调用get()方法，此时才会调用对象的构造方法，即获得到真正对象
  3. Optional.ofNullable(person).orElseGet(sup.get());

Suppiler是一个接口，是类似Spring的懒加载，声明之后并不会占用内存，只有执行了get()方法之后，才会调用构造方法创建出对象 创建对象的语法的话就是Supplier<Person> supPerson= Person::new; 需要使用时supPerson.get()即可

2.10 Optional.orElseThrow()方法(为空返回异常)

Optional.orElseThrow()方法作用的话就是如果为空，就抛出定义的异常，如果不为空返回当前对象，在实战中所有异常肯定是要处理好的，为了代码的可读性
源码：

  1. public <X extends Throwable> T orElseThrow(Supplier<? extends X> exceptionSupplier) throws X {
  2.     if (value != null) {
  3.         return value;
  4.     } else {
  5.         throw exceptionSupplier.get();
  6.     }
  7. }

实例：

  1. //简单的一个查询
  2. Member member = memberService.selectByPhone(request.getPhone());
  3. Optional.ofNullable(member).orElseThrow(() -> new ServiceException("没有查询的相关数据"));

2.11 相似方法进行对比分析

orElse() 和 orElseGet() 还有 orElseThrow() 很相似，map() 和 flatMap() 很相似，总结一下不同方法的异同点

orElse() 和 orElseGet() 和 orElseThrow() 的异同点

方法效果类似，如果对象不为空，则返回对象，如果为空，则返回方法体中的对应参数，所以可以看出这三个方法体中参数是不一样的 orElse（T 对象）、 orElseGet（Supplier < T >对象）、 orElseThrow（异常）

map()和orElseGet的异同点

方法效果类似，对方法参数进行二次包装，并返回,入参不同 map（function函数） 、flatmap（Optional< function >函数）

具体要怎么用，要根据业务场景以及代码规范来定义。

3、实战场景再现

场景1：在service层中 查询一个对象，返回之后判断是否为空并做处理

  1. //查询一个对象
  2. Member member = memberService.selectByIdNo(request.getCertificateNo());
  3. //使用ofNullable加orElseThrow做判断和操作
  4. Optional.ofNullable(member).orElseThrow(() -> new ServiceException("没有查询的相关数据"));

场景2：可以在dao接口层中定义返回值时就加上Optional 例如：使用的是jpa，其他也同理

  1. public interface LocationRepository extends JpaRepository<Location, String> {
  2.     Optional<Location> findLocationById(String id);
  3. }

然在是Service中

  1. public TerminalVO findById(String id) {
  2.     //这个方法在dao层也是用了Optional包装了
  3.     Optional<Terminal> terminalOptional = terminalRepository.findById(id);
  4.     //直接使用isPresent()判断是否为空
  5.     if (terminalOptional.isPresent()) {
  6.         //使用get()方法获取对象值
  7.         Terminal terminal = terminalOptional.get();
  8.         //在实战中，我们已经免去了用set去赋值的繁琐，直接用BeanCopy去赋值
  9.         TerminalVO terminalVO = BeanCopyUtils.copyBean(terminal, TerminalVO.class);
  10.         //调用dao层方法返回包装后的对象
  11.         Optional<Location> location = locationRepository.findLocationById(terminal.getLocationId());
  12.         if (location.isPresent()) {
  13.             terminalVO.setFullName(location.get().getFullName());
  14.         }
  15.         return terminalVO;
  16.     }
  17.     //不要忘记抛出异常
  18.     throw new ServiceException("该终端不存在");
  19. }

实战场景还有很多，包括**return**时可以判断是否返回当前值还是跳转到另一个方法体中。

4、Optional使用注意事项

**Optional**真么好用，真的可以完全替代if判断吗？ 这肯定是大家使用完之后Optional之后可能会产生的想法，答案是否定的
举一个最简单的栗子：例子1：如果只想判断对象的某一个变量是否为空并且做出判断呢？

  1. Person person=new Person();
  2. person.setName("");
  3. persion.setAge(2);
  4. //普通判断
  5. if(StringUtils.isNotBlank(person.getName())){
  6.   //名称不为空执行代码块
  7. }
  9. //使用Optional做判断
  10. Optional.ofNullable(person).map(p -> p.getName()).orElse("name为空");

这个例子就能很好的说明这个问题，只是一个很简单判断，如果用了**Optional**还需要考虑包装值，考虑代码书写，考虑方法调用，虽然只有一行，但是可读性并不好，如果别的程序员去读，肯定没有**if**看的明显

5、jdk1.9对Optional优化

首先增加了三个方法: **or()**、**ifPresentOrElse()** 和 **stream()**。 **or()** 与orElse() 等方法相似，如果对象不为空返回对象，如果为空则返回or()方法中预设的值。**ifPresentOrElse()** 方法有两个参数：一个 Consumer 和一个 Runnable。如果对象不为空，会执行 Consumer 的动作，否则运行 Runnable。相比 ifPresent() 多了OrElse判断。stream() 将Optional转换成stream，如果有值就返回包含值的stream，如果没值，就返回空的stream。