• Java8新特性之Optional

    一、前言

    曾经在学习SpringSecurity时，视频中的老师在写项目时使用了Optional，当时他说这个用的好的话可以很好的规避NPE空指针问题，也可以减少大量的判空代码。当时觉得老帅了，代码也更加高级整洁，如同Stream流出现的效果其实差不多。但是我对Stream的使用频率远大于Optional,可以说几乎没用过，仍然还是以模仿别人代码为主，使用判空，而且经常会因为忘记写判空处理导致NPE。
    其实要我说还是一种意识问题，就像不熟练使用Stream的时候仍然习惯增强for循环里面使用，熟悉了后就爱上了Stream，那么NPE其实总是出现在忘记写判空处理，谁不会写一个判空呢（滑稽）。那么希望能够通过学习Optional并且将它纳入使用的意识当中去，争取实现规避NPE。

    二、Optional介绍

    以前，为了解决空指针异常，Google公司著名的Guava项目引入了Optional类，Guava通过使用检查空值的方式来防止代码污染，它鼓励程序员写更干净的代码。受到Google Guava的启发，Optional类已经成为Java 8类库的一部分。Optional实际上是个容器：它可以保存类型T的值，或者仅仅保存null。Optional提供很多有用的方法，这样我们就不用显式进行空值检测。
    假设我们有两个类，他们的UML类图如下图所示
    在这里插入图片描述
    在这种情况下，有如下代码

    user.getAddress().getProvince();

    • 1

    这种写法，在user为null时或者get的Address为null时，是有可能报NullPointerException异常的。为了解决这个问题，于是采用下面的写法

    if(user!=null){
    Address address = user.getAddress();
    if(address!=null){
        String province = address.getProvince();
    }
}

    • 1
    • 2
    • 3
    • 4
    • 5
    • 6

    这种写法是比较丑陋的，为了避免上述丑陋的写法，让丑陋的设计变得优雅。JAVA8提供了Optional类来优化这种写法，接下来的正文部分进行详细说明

    2.1、API分组讲解

    先介绍一下API，与其他文章不同的是，本文采取类比的方式来讲，同时结合源码。而不像其他文章一样，一个个API罗列出来，让人找不到重点。

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

    这四个函数之间具有相关性，因此放在一组进行记忆。

    • 先说明一下，Optional(T value)，即构造函数，它是private权限的，不能由外部调用的。
    
    /**
     * If non-null, the value; if null, indicates no value is present
     */
    private final T value;
    /**
     * Constructs an empty instance.
     *
     * @implNote Generally only one empty instance, {@link Optional#EMPTY},
     * should exist per VM.
     */
    private Optional() {
        this.value = null;
    }
    
    /**
     * Constructs an instance with the value present.
     *
     * @param value the non-null value to be present
     * @throws NullPointerException if value is null
     */
    private Optional(T value) {
        this.value = Objects.requireNonNull(value);
    }

    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8
    • 9
    • 10
    • 11
    • 12
    • 13
    • 14
    • 15
    • 16
    • 17
    • 18
    • 19
    • 20
    • 21
    • 22
    • 23
    • 24

    其余三个函数是public权限，供我们所调用。
    那么，Optional的本质，就是内部储存了一个真实的值，在构造的时候，就直接判断其值是否为空。好吧，这么说还是比较抽象。直接上Optional(T value)构造函数的源码，如下图所示
    也就是要不直接存储为null的值，要不就存储一个对象，当对象为空，仍然会抛出NPE。
    在这里插入图片描述

    • 那么，of(T value)的源码如下
    public static <T> Optional<T> of(T value) {
    return new Optional<>(value);
}

    • 1
    • 2
    • 3

    也就是说of(T value)函数内部调用了构造函数。根据构造函数的源码我们可以得出两个结论:

    • 通过of(T value)函数所构造出的Optional对象，当Value值为空时，依然会报NullPointerException。
    • 通过of(T value)函数所构造出的Optional对象，当Value值不为空时，能正常构造Optional对象。

    在这里插入图片描述
    除此之外呢，Optional类内部还维护一个value为null的对象，大概就是长下面这样的,那么这个对象就是EMPTY

    private static final Optional<?> EMPTY = new Optional<>();
private Optional() {
        this.value = null;
    }

    • 1
    • 2
    • 3
    • 4
    • 那么，empty（）的作用就是返回EMPTY对象。
    
    /**
     * Returns an empty {@code Optional} instance.  No value is present for this
     * Optional.
     *
     * @apiNote Though it may be tempting to do so, avoid testing if an object
     * is empty by comparing with {@code ==} against instances returned by
     * {@code Option.empty()}. There is no guarantee that it is a singleton.
     * Instead, use {@link #isPresent()}.
     *
     * @param  Type of the non-existent value
     * @return an empty {@code Optional}
     */
    public static<T> Optional<T> empty() {
        @SuppressWarnings("unchecked")
        Optional<T> t = (Optional<T>) EMPTY;
        return t;
    }

    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8
    • 9
    • 10
    • 11
    • 12
    • 13
    • 14
    • 15
    • 16
    • 17
    • 18

    好了铺垫了这么多，可以说ofNullable(T value)的作用了，上源码

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

    • 1
    • 2
    • 3

    好吧，大家应该都看得懂什么意思了。相比较of(T value)的区别就是，当value值为null时，of(T value)会报NullPointerException异常；ofNullable(T value)不会throw Exception，ofNullable(T value)直接返回一个EMPTY对象。

    那是不是意味着，我们在项目中只用ofNullable函数而不用of函数呢?

    不是的，一个东西存在那么自然有存在的价值。当我们在运行过程中，不想隐藏NullPointerException。而是要立即报告，这种情况下就用Of函数。但是不得不承认，这样的场景真的很少。博主也仅在写junit测试用例中用到过此函数。

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

    这三个函数放一组进行记忆，都是在构造函数传入的value值为null时，进行调用的。orElse和orElseGet的用法如下所示，相当于value值为null时，给予一个默认值:
    但是给予的默认值仍然可以为空，这样如果使用orElse或者orElseGet获取的对象仍然可能造成NPE问题。

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

    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8
    • 9
    • 10
    • 11
    • 12

    这两个函数的区别：

    • 当value值不为null时，orElse函数依然会执行createUser()方法，而orElseGet函数并不会执行createUser()方法。

    例如，此时user不为Null，debug可以看到不管是orElse还是orElseGet都会进到对应的方法里面的，但是对于orelse里面的参数方法调用了，但是orElseGet并没有调用：
    在这里插入图片描述
    我们看下源码：

      public T orElse(T other) {
         return value != null ? value : other;
     }

    • 1
    • 2
    • 3

    那就好理解了：

    • 在要执行orElse之前，那参数的值我总要知道吧，所以肯定先要执行传入的方法才行。
    • orElseGet方法不会执行，因为他使用的Supplier函数接口

    所以当值是函数或者需要计算时建议使用orElseGet，当值是基础类型值时就用orElse。
    至于orElseThrow，就是value值为null时,直接抛一个异常出去，用法如下所示

    User user = null;
Optional.ofNullable(user).orElseThrow(()->new Exception("user为NULL"));

    • 1
    • 2

    在这里插入图片描述

    map(Function mapper)，flatMap(Function> mapper)

    熟悉Stream的都知道这两个函数做的是转换值的操作

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

    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8
    • 9
    • 10
    • 11
    • 12
    • 13
    • 14
    • 15
    • 16
    • 17
    • 18
    • 19
    • 20
    • map方法接受一个映射函数参数，返回一个被Optional包装的结果。若结果为空，则返回空Optional。
    • flatMap方法接受一个返回值为Optional的映射函数参数，该返回值亦是flatMap方法的返回值。若结果为空，则返回
      空Optional      。

    这两个函数，在函数体上没什么区别。两者返回结果都是Optional.唯一区别的就是入参，map函数所接受的入参类型为Function，而flapMap的入参类型为Function>。
    在具体用法上，对于map而言：

    如果User结构是下面这样的

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

    • 1
    • 2
    • 3
    • 4
    • 5
    • 6

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

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

    • 1

    对于flatMap而言:

    如果User结构是下面这样的：

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

    • 1
    • 2
    • 3
    • 4
    • 5
    • 6

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

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

    • 1

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

    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8
    • 9
    • 10
    • 11

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

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

    • 1

    给写成:

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

    • 1

    因为这样写，代码结构依然丑陋。博主会在后面给出正确写法

    至于ifPresent(Consumer consumer)，用法也很简单，如下所示

    public static void main(String[] args) {
        User user = createUser();
       Optional.ofNullable(user).ifPresent(u->{
           u.setPhone("1789387933");
       });
        System.out.println(user);
    }

    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7

    在这里插入图片描述

    filter(Predicate predicate)

    不多说，直接上源码：

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

    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7

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

     public static void main(String[] args) throws Exception {
        User user = createUser();
        try {
            String phone = Optional.ofNullable(user)
                    .map(u -> u.getPhone())
                    .filter(p -> p.length() == 11)
                    .orElseThrow(() -> new Exception("手机号长度需为11"));
            System.out.println(phone);
        } catch (Exception e) {
            System.out.println(e.getMessage());
        }

    }

    private static User createUser(){
        User user = new User();
        user.setName("孟博文");
        user.setPhone("1789387933");
        return user;
    }

    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8
    • 9
    • 10
    • 11
    • 12
    • 13
    • 14
    • 15
    • 16
    • 17
    • 18
    • 19
    • 20

    如上面所示，如果phone长度等于11，则返回phone,反之，抛出异常。
    在这里插入图片描述

    2.2、实战使用

    例一

    在函数方法中

    以前写法：

    public String getCity(User user)  throws Exception{
        if(user!=null){
            if(user.getAddress()!=null){
                Address address = user.getAddress();
                if(address.getCity()!=null){
                    return address.getCity();
                }
            }
        }
        throw new Excpetion("取值错误");
    }

    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8
    • 9
    • 10
    • 11

    JAVA8写法

    public String getCity(User user) throws Exception{
    return Optional.ofNullable(user)
                   .map(u-> u.getAddress())
                   .map(a->a.getCity())
                   .orElseThrow(()->new Exception("取值错误"));
}

    • 1
    • 2
    • 3
    • 4
    • 5
    • 6

    例二

    比如，在主程序中

    以前写法

    if(user!=null){
    dosomething(user);
}

    • 1
    • 2
    • 3

    JAVA8写法

    Optional.ofNullable(user)
    .ifPresent(u->{
        dosomething(u);
});

    • 1
    • 2
    • 3
    • 4

    例三

    以前写法:

    public User getUser(User user) throws Exception{
    if(user!=null){
        String name = user.getName();
        if("zhangsan".equals(name)){
            return user;
        }
    }else{
        user = new User();
        user.setName("zhangsan");
        return user;
    }
}

    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8
    • 9
    • 10
    • 11
    • 12

    java8写法:

    public User getUser(User user) {
    return Optional.ofNullable(user)
                   .filter(u->"zhangsan".equals(u.getName()))
                   .orElseGet(()-> {
                        User user1 = new User();
                        user1.setName("zhangsan");
                        return user1;
                   });
}

    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8
    • 9

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

    三、参考链接

    https://blog.csdn.net/qq_37217713/article/details/119708573

  • 相关阅读:
    [C/C++]数据结构 深入挖掘环形链表问题
    MongoDB3.x创建用户与用户角色
    JAVA毕业设计好物网站计算机源码+lw文档+系统+调试部署+数据库
    Python3 OS 文件/目录方法
    加固三防平板如何提高轨道交通系统的运营效率？
    你找到适合自己的赚钱门路了吗
    [云原生] Kubernetes（k8s）健康检查详解与实战演示（就绪性探针 和 存活性探针）
    超级浏览器对跨境亚马逊防关联有用吗？
    FASTAPI的简单理解
    长春大学计算机考研资料汇总
  • 原文地址：https://blog.csdn.net/qq_44754515/article/details/126040000