Java8新特性之Optional类

引言

在文章的开头，先说下NPE问题，NPE问题就是，我们在开发中经常碰到的NullPointerException，NPE是十亿美元的错误，任何编程语言70%以上的异常都是NPE，假设我们有两个类，他们的UML类图如下图所示：
目的：为了避免一系列的if判空，使代码看起来臃肿，故引入Option类来使代码看起来更加的优雅美观
常用方法：

• Optional.of(T t) : 创建一个 Optional 实例
• Optional.empty() : 创建一个空的Optional 实例
• Optional.ofNullable(T t):若 t 不为 null,创建 Optional实例,否则创建空实例
• isPresent() : 判断是否包含值
• orElse(T t) : 如果调用对象包含值，返回该值，否则返回t
• orElseGet(Supplier s) :如果调用对象包含值，返回该值，否则返回 s 获取的值
• map(Function f):如果有值对其处理，并返回处理后的Optional，否则返回Optional.empty()
• flatMap(Function mapper):与 map 类似，要求返回值必须是Optional

代码准备

@Data
@Builder
public class User {
    private String phone;
    private String name;
    private Address address;
}
@Data
@Builder
class Address {
    private String province;
    private String city;
    private String area;
}

实例代码：

User user1 = User.builder().name("a").phone("188")
                .address(Address.builder().city("上海浦东").area("康桥").province("上海").build()).build();
//当user!=null
Optional.ofNullable(user1)
        .ifPresent(u -> {
            System.out.println("user不为空");
        });
//获取user1用户下地址的省份
String province = Optional.ofNullable(user1)
        .map(u -> u.getAddress())
        .map(a -> a.getProvince())
        .orElse("取值错误");
//                    .orElseGet(()->"取值错误");
//                    .orElseThrow(()->new Exception("取指错误"));
System.out.println(province);
//获取name值等于b的数据
User user = Optional.ofNullable(user1)
        .filter(u -> "b".equals(u.getName()))
        .orElseGet(() -> User.builder().name("b").build());
System.out.println(user);

输出结果：

user不为空
上海
User(phone=null, name=b, address=null)

其实采用这种链式编程，虽然代码优雅了。但是逻辑性没那么明显，可读性有所降低，大家项目中看情况酌情使用

API介绍

先介绍一下API，采取类比的方式来讲，同时结合源码

(1)Optional(T value),empty(),of(T value),ofNullable(T value)

这四个函数之间具有相关性，因此放在一组进行记忆
Optional(T value)，即构造函数，它是private权限的，不能由外部调用的。其余三个函数是public权限，供我们所调用。那么，Optional的本质，就是内部储存了一个真实的值，在构造的时候，就直接判断其值是否为空。好吧，这么说还是比较抽象。直接上Optional(T value)构造函数的源码，如下图所示

of(T value)的源码如下

public static <T> Optional<T> of(T value) {
        return new Optional<>(value);
    }

of(T value)函数内部调用了构造函数。根据构造函数的源码我们可以得出两个结论:
(1)通过of(T value)函数所构造出的Optional对象，当Value值为空时，依然会报NullPointerException
(2)通过of(T value)函数所构造出的Optional对象，当Value值不为空时，能正常构造Optional对象
除此之外呢，Optional类内部还维护一个value为null的对象，大概就是长下面这样的

public final class Optional<T> {
    //省略....
    private static final Optional<?> EMPTY = new Optional<>();
    private Optional() {
        this.value = null;
    }
    //省略...
    public static<T> Optional<T> empty() {
        @SuppressWarnings("unchecked")
        Optional<T> t = (Optional<T>) EMPTY;
        return t;
    }
}

那么，empty()的作用就是返回EMPTY对象。
好了铺垫了这么多，可以说ofNullable(T value)的作用了，上源码

 public static <T> Optional<T> ofNullable(T value) {
        return value == null ? empty() : of(value);
}

好吧，大家应该都看得懂什么意思了。相比较of(T value)的区别就是，当value值为null时，of(T value)会报NullPointerException异常；ofNullable(T value)不会throw Exception，ofNullable(T value)直接返回一个EMPTY对象。
那是不是意味着，我们在项目中只用ofNullable函数而不用of函数呢?
不是的，一个东西存在那么自然有存在的价值。当我们在运行过程中，不想隐藏NullPointerException。而是要立即报告，这种情况下就用Of函数。但是不得不承认，这样的场景真的很少。博主也仅在写junit测试用例中用到过此函数

(2)orElse(T other)，orElseGet(Supplier other)和orElseThrow(Supplier exceptionSupplier)

这三个函数放一组进行记忆，都是在构造函数传入的value值为null时，进行调用的。orElse和orElseGet的用法如下所示，相当于value值为null时，给予一个默认值:

@Test
public void test() {
    User user = null;
    user = Optional.ofNullable(user).orElse(createUser());
    user = Optional.ofNullable(user).orElseGet(() -> createUser());
    
}

public User createUser(){
    User user = new User();
    user.setName("zhangsan");
    return user;
}

这两个函数的区别：当user值不为null时，orElse函数依然会执行createUser()方法，而orElseGet函数并不会执行createUser()方法，大家可自行测试。
至于orElseThrow，就是value值为null时,直接抛一个异常出去，用法如下所示

User user = null;
Optional.ofNullable(user).orElseThrow(()->new Exception("用户不存在"));

(3) map(Function mapper)和flatMap(Function> mapper)

这两个函数放在一组记忆，这两个函数做的是转换值的操作。
直接上源码

 public final class Optional<T> {
    //省略....
     public<U> Optional<U> map(Function<? super T, ? extends U> mapper) {
        Objects.requireNonNull(mapper);
        if (!isPresent())
            return empty();
        else {
            return Optional.ofNullable(mapper.apply(value));
        }
    }
    //省略...
     public<U> Optional<U> flatMap(Function<? super T, Optional<U>> mapper) {
        Objects.requireNonNull(mapper);
        if (!isPresent())
            return empty();
        else {
            return Objects.requireNonNull(mapper.apply(value));
        }
    }
} 

这两个函数，在函数体上没什么区别。唯一区别的就是入参，map函数所接受的入参类型为Function，而flapMap的入参类型为Function>。
在具体用法上，对于map而言:
如果User结构是下面这样的

public class User {
    private String name;
    public String getName() {
        return name;
    }
}

这时候取name的写法如下所示

String city = Optional.ofNullable(user).map(u-> u.getName()).get();

对于flatMap而言:
如果User结构是下面这样的

public class User {
    private String name;
    public Optional<String> getName() {
        return Optional.ofNullable(name);
    }
}

这时候取name的写法如下所示

String city = Optional.ofNullable(user).flatMap(u-> u.getName()).get();

(4) isPresent()和ifPresent(Consumer consumer)

这两个函数放在一起记忆，isPresent即判断value值是否为空，而ifPresent就是在value值不为空时，做一些操作。这两个函数的源码如下

public final class Optional<T> {
    //省略....
    public boolean isPresent() {
        return value != null;
    }
    //省略...
    public void ifPresent(Consumer<? super T> consumer) {
        if (value != null)
            consumer.accept(value);
    }
}

需要额外说明的是，大家千万不要把

if (user != null){
   // TODO: do something
}

给写成

User user = Optional.ofNullable(user);
if (Optional.isPresent()){
   // TODO: do something
}

因为这样写，代码结构依然丑陋。博主会在后面给出正确写法
至于ifPresent(Consumer consumer)，用法也很简单，如下所示

Optional.ofNullable(user).ifPresent(u->{
            // TODO: do something
});

(5) filter(Predicate predicate)

不多说，直接上源码

public final class Optional<T> {
    //省略....
  public Optional<T> filter(Predicate<? super T> predicate) {
        Objects.requireNonNull(predicate);
        if (!isPresent())
            return this;
        else
            return predicate.test(value) ? this : empty();
    }
}

filter 方法接受一个 Predicate 来对 Optional 中包含的值进行过滤，如果包含的值满足条件，那么还是返回这个 Optional；否则返回 Optional.empty。
用法如下

Optional<User> user1 = Optional.ofNullable(user).filter(u -> u.getName().length()<6);

如上所示，如果user的name的长度是小于6的，则返回。如果是大于6的，则返回一个EMPTY对象