Java Optional使用指南

水深无声 2022-10-24 01:43 150阅读 0赞

提到`NullPointerException`（简称NPE）异常，相信每个Java开发人员都不陌生，从接触编程的第1天起，它就和我们如影随形，最近处理的线上bug中，有不少都是对象没判空导致的`NullPointerException`异常。

## 1. 简单回顾 ##

引起`NullPointerException`异常的地方有很多，比如调用String的trim()方法，比如对BigDecimal进行计算时，比如将包装类型转化为基本类型时，这里简单回顾下。

假设有个导入模版定义如下：

package com.zwwhnly.springbootaction.model;
    
    import lombok.AllArgsConstructor;
    import lombok.Data;
    
    /** * 导入模版 */
    @Data
    @AllArgsConstructor
    public class ImportTemplate { 
        /** * 模版id */
        private int templateId;
    
        /** * 模版名称 */
        private String templateName;
    
        /** * 模版下载url */
        private String url;
    
        /** * 备注 */
        private String remark;
    }

然后看下如下代码：

public static void main(String[] args) { 
        ImportTemplate importTemplate = getImportTemplateById(1);
        System.out.println(importTemplate.getUrl());
    }
    
    public static ImportTemplate getImportTemplateById(int id) { 
        return new ImportTemplate(1, "销售订单-普通商品导入模版", "o_w-140e3c1f41c94f238196539558e25bf7", null);
    }

正常情况下，这段代码肯定是没有问题的，但当getImportTemplateById方法返回null时，这段代码就会抛出`NullPointerException`异常，如下所示：

public static ImportTemplate getImportTemplateById(int id) {
        return null;
    }

![在这里插入图片描述][20210128212319784.png_pic_center]

为了程序能正常运行，就要判断importTemplate是否为null，所以代码就修改为了：

public static void main(String[] args) { 
        ImportTemplate importTemplate = getImportTemplateById(1);
        if (importTemplate != null) { 
            System.out.println(importTemplate.getUrl());
        }
    }

项目中类似的判空代码应该有很多，大家可以自行看下自己项目的代码。

## 2. 使用Optional ##

为了避免`NullPointerException`异常，JDK1.8新增了Optional类来处理空指针异常，该类位于`java.util`包下，提供了一系列方法，

并且可以配合Lambda表达式一起使用，使代码看起来更加清晰，接下来我们看下它的使用方法。

### 2.1 创建实例 ###

创建Optional实例有以下3种方式，分别为：

1.  调用empty方法
    
        Optional<ImportTemplate> optionalImportTemplate = Optional.empty();
2.  调用of方法
    
        ImportTemplate importTemplate = new ImportTemplate(1, "销售订单-普通商品导入模版",
                "o_w-140e3c1f41c94f238196539558e25bf7", null);
        Optional<ImportTemplate> optionalImportTemplate = Optional.of(importTemplate);
3.  调用ofNullable方法\*\*（推荐）\*\*
    
        ImportTemplate importTemplate = new ImportTemplate(1, "销售订单-普通商品导入模版",
                "o_w-140e3c1f41c94f238196539558e25bf7", null);
        Optional<ImportTemplate> optionalImportTemplate = Optional.ofNullable(importTemplate);

值得注意的是，当参数为null时，调用of方法会抛`NullPointerException`异常，但调用ofNullable方法不会（更符合使用场景），因此**推荐使用ofNullable方法**：

ImportTemplate importTemplate = null;
    Optional<ImportTemplate> optionalImportTemplate = Optional.of(importTemplate);

![在这里插入图片描述][20210128212348514.png_pic_center]

### 2.2 判断是否有值 ###

可以调用`isPresent`方法来判断对象是否有值（不为null），使用方法如下所示：

ImportTemplate importTemplate = null;
    Optional<ImportTemplate> optionalImportTemplate = Optional.ofNullable(importTemplate);
    
    System.out.println(optionalImportTemplate.isPresent());

以上代码的输出结果为：

![在这里插入图片描述][20210128212415387.png_pic_center]

ImportTemplate importTemplate = new ImportTemplate(1, "销售订单-普通商品导入模版",
            "o_w-140e3c1f41c94f238196539558e25bf7", null);
    Optional<ImportTemplate> optionalImportTemplate = Optional.ofNullable(importTemplate);
    
    System.out.println(optionalImportTemplate.isPresent());

以上代码的输出结果为：

![在这里插入图片描述][20210128212442885.png_pic_center]

看下`isPresent`的源码，逻辑非常简单，就是判断了我们传入的对象是否有值，即不为null：

/** * Return {@code true} if there is a value present, otherwise {@code false}. * * @return {@code true} if there is a value present, otherwise {@code false} */
    public boolean isPresent() { 
        return value != null;
    }

### 2.3 获取值 ###

可以调用`get`方法来获取对象的有值，使用方法如下所示：

以上代码的输出结果为：

![在这里插入图片描述][20210128212503821.png_pic_center]

**值得注意的是**，当我们传入的对象为null时，调用get方法会抛出`java.util.NoSuchElementException`异常，而不是返回null。

ImportTemplate importTemplate = null;
    Optional<ImportTemplate> optionalImportTemplate = Optional.ofNullable(importTemplate);
    System.out.println(optionalImportTemplate.get());

以上代码的输出结果为：

![在这里插入图片描述][20210128212524515.png_pic_center]

看下`get`方法的源码，就可以知道原因：

public T get() { 
        if (value == null) { 
            throw new NoSuchElementException("No value present");
        }
        return value;
    }

### 2.4 先用isPresent，再用get（不推荐） ###

然后我们回顾下文初的代码：

ImportTemplate importTemplate = getImportTemplateById(1);
    if (importTemplate != null) { 
        System.out.println(importTemplate.getUrl());
    }

可能很多同学会把代码优化为下面这样的写法：

Optional<ImportTemplate> optionalImportTemplate = Optional.ofNullable(getImportTemplateById(1));
    if (optionalImportTemplate.isPresent()) { 
        System.out.println(optionalImportTemplate.get().getUrl());
    }

不推荐这么使用，因为判断的地方没减少，而且还不如原来看起来清晰。

### 2.5 ifPresent（推荐） ###

那该怎么优化呢？答案就是使用`ifPresent`方法，该方法接收一个Consumer类型的参数，当值不为null时，就执行，当值为null时，就不执行，源码如下所示：

public void ifPresent(Consumer<? super T> consumer) { 
        if (value != null)
            consumer.accept(value);
    }

优化之后的代码如下所示：

Optional<ImportTemplate> optionalImportTemplate = Optional.ofNullable(getImportTemplateById(1));
    optionalImportTemplate.ifPresent(importTemplate -> System.out.println(importTemplate.getUrl()));

当然，也可以写更多的逻辑：

Optional<ImportTemplate> optionalImportTemplate = Optional.ofNullable(getImportTemplateById(1));
    optionalImportTemplate.ifPresent(importTemplate -> { 
        System.out.println(importTemplate.getTemplateId());
        System.out.println(importTemplate.getTemplateName());
        System.out.println(importTemplate.getUrl());
        System.out.println(importTemplate.getRemark());
    });

### 2.6 自定义默认值 ###

Optional类提供了以下2个方法来自定义默认值，用于当对象为null时，返回自定义的对象：

1.  orElse
2.  orElseGet

先来看下orElse方法的使用：

public static void main(String[] args) { 
        ImportTemplate importTemplate = null;
        ImportTemplate firstImportTemplate = Optional.ofNullable(importTemplate)
                .orElse(getDefaultTemplate());
        System.out.println(firstImportTemplate);
    
        importTemplate = new ImportTemplate(2, "销售订单-不定规格商品导入模版", "o_w-a7109db89f8d4508b4c6202889a1a2c1", null);
    
        ImportTemplate secondImportTemplate = Optional.ofNullable(importTemplate)
                .orElse(getDefaultTemplate());
        System.out.println(secondImportTemplate);
    }
    
    public static ImportTemplate getDefaultTemplate() { 
        System.out.println("getDefaultTemplate");
        return new ImportTemplate(1, "销售订单-普通商品导入模版", "o_w-140e3c1f41c94f238196539558e25bf7", null);
    }

输出结果：

![在这里插入图片描述][20210128212701536.png_pic_center]

再来看下orElseGet方法的使用：

public static void main(String[] args) { 
        ImportTemplate importTemplate = null;
        ImportTemplate firstImportTemplate = Optional.ofNullable(importTemplate)
                .orElseGet(() -> getDefaultTemplate());
        System.out.println(firstImportTemplate);
    
        importTemplate = new ImportTemplate(2, "销售订单-不定规格商品导入模版", "o_w-a7109db89f8d4508b4c6202889a1a2c1", null);
    
        ImportTemplate secondImportTemplate = Optional.ofNullable(importTemplate)
                .orElseGet(() -> getDefaultTemplate());
        System.out.println(secondImportTemplate);
    }
    
    public static ImportTemplate getDefaultTemplate() { 
        System.out.println("getDefaultTemplate");
        return new ImportTemplate(1, "销售订单-普通商品导入模版", "o_w-140e3c1f41c94f238196539558e25bf7", null);
    }

输出结果：

![在这里插入图片描述][20210128212724554.png_pic_center]

从输出结果看，2个方法好像差不多，第1次调用都返回了默认模版，第2次调用都返回了传入的模版，但其实仔细观察，你会发现当使用

orElse方法时，getDefaultTemplate方法执行了2次，但调用orElseGet方法时，getDefaultTemplate方法只执行了2次（只在第1次传入模版为null时执行了）。

为什么会这样呢？带着这个疑问，我们看下这2个方法的源码，其中orElse方法的源码如下所示：

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

可以看到，参数other是个对象，这个参数肯定是要传的，但只有value为空时，才会用到（返回）这个对象。

orElseGet方法的源码如下所示：

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

可以看到，参数other并不是直接传入对象，如果value为null，才会执行传入的参数获取对象，如果不为null，直接返回value。

### 2.7 自定义异常 ###

Optional类提供了orElseThrow方法，用于当传入的对象为null时，抛出自定义的异常，使用方法如下所示：

public static void main(String[] args) { 
        ImportTemplate importTemplate = new ImportTemplate(2, "销售订单-不定规格商品导入模版", "o_w-a7109db89f8d4508b4c6202889a1a2c1", null);
        ImportTemplate firstImportTemplate = Optional.ofNullable(importTemplate)
                .orElseThrow(() -> new IndexOutOfBoundsException());
        System.out.println(firstImportTemplate);
    
        importTemplate = null;
    
        ImportTemplate secondImportTemplate = Optional.ofNullable(importTemplate)
                .orElseThrow(() -> new IndexOutOfBoundsException());
        System.out.println(secondImportTemplate);
    }

输出结果：

![在这里插入图片描述][20210128212743689.png_pic_center]

### 2.8 过滤数据 ###

Optional类提供了filter方法来过滤数据，该方法接收一个Predicate参数，返回匹配条件的数据，如果不匹配条件，返回一个空的Optional，使用方法如下所示：

public static void main(String[] args) { 
        ImportTemplate importTemplate = getImportTemplateById(1);
        Optional<ImportTemplate> filterById = Optional.ofNullable(importTemplate)
                .filter(f -> f.getTemplateId() == 1);
        System.out.println(filterById.isPresent());
    
        Optional<ImportTemplate> filterByName = Optional.ofNullable(importTemplate)
                .filter(f -> f.getTemplateName().contains("发货单"));
        System.out.println(filterByName.isPresent());
    }
    
    public static ImportTemplate getImportTemplateById(int id) { 
        return new ImportTemplate(1, "销售订单-普通商品导入模版", "o_w-140e3c1f41c94f238196539558e25bf7", null);
    }

输出结果：

![在这里插入图片描述][20210128212800736.png_pic_center]

### 2.9 转换值 ###

Optional类提供了以下2个方法来转换值：

1.  map
2.  flatMap

map方法的使用方法如下所示：

public static void main(String[] args) { 
        ImportTemplate importTemplate = getImportTemplateById(1);
        Optional<String> optionalUrl = Optional.ofNullable(importTemplate)
                .map(f -> "url:" + f.getUrl());
        System.out.println(optionalUrl.isPresent());
        System.out.println(optionalUrl.get());
    }
    
    public static ImportTemplate getImportTemplateById(int id) { 
        return new ImportTemplate(1, "销售订单-普通商品导入模版", "o_w-140e3c1f41c94f238196539558e25bf7", null);
    }

输出结果：

![在这里插入图片描述][20210128212828122.png_pic_center]

flatMap方法和map方法类似，不过它支持传入Optional，使用方法如下所示：

public static void main(String[] args) { 
        ImportTemplate importTemplate = getImportTemplateById(1);
        Optional<String> optionalUrl = Optional.ofNullable(importTemplate)
                .flatMap(f -> Optional.ofNullable(f.getUrl()));
        System.out.println(optionalUrl.isPresent());
        System.out.println(optionalUrl.get());
    }
    
    public static ImportTemplate getImportTemplateById(int id) { 
        return new ImportTemplate(1, "销售订单-普通商品导入模版", "o_w-140e3c1f41c94f238196539558e25bf7", null);
    }

输出结果：

![在这里插入图片描述][20210128212847336.png_pic_center]

## 3. 总结 ##

对于程序员来说，一不注意就会出现`NullPointerException`异常，避免它的方式也很简单，比如使用前判断不能为空：

比如为空时，直接返回（或者返回默认值）：

public static void main(String[] args) { 
        ImportTemplate importTemplate = getImportTemplateById(1);
        if (importTemplate == null) { 
            return;
        }
        System.out.println(importTemplate.getUrl());
    }

比如，使用本文中的Optional。

使用哪种方式不重要，尽可能地避免`NullPointerException`异常才重要。

## 4. 参考 ##

[理解、学习与使用 Java 中的 Optional][Java _ Optional]

[20210128212319784.png_pic_center]: /images/20221024/9b5961c8f4bf4e01bd765ec1f63114ad.png
[20210128212348514.png_pic_center]: /images/20221024/2c416dfd798a4af7b04f33da58a376dd.png
[20210128212415387.png_pic_center]: /images/20221024/78478a551b9f42e2ac1d07bdf954d917.png
[20210128212442885.png_pic_center]: /images/20221024/9d2e2048545b4870b0bc5f6c8c5996f2.png
[20210128212503821.png_pic_center]: /images/20221024/e4df951fe7534003803e93b0d09b3c3e.png
[20210128212524515.png_pic_center]: /images/20221024/220063da59c64a1ea4cbdb1d74c17817.png
[20210128212701536.png_pic_center]: /images/20221024/e5dde88bb3944dfc8aa5f5749775ddf2.png
[20210128212724554.png_pic_center]: /images/20221024/eac58e1fc28e4d8b83326d3d6dbe3b95.png
[20210128212743689.png_pic_center]: /images/20221024/c58f8f97c58443789c0a5e0329c05f03.png
[20210128212800736.png_pic_center]: /images/20221024/778353e010bb4c528e38d66108f55465.png
[20210128212828122.png_pic_center]: /images/20221024/5c720339c7474dcc8555b0e25255f7ad.png
[20210128212847336.png_pic_center]: /images/20221024/a5913c3a6ad946eeaae2529c7c72ec2d.png
[Java _ Optional]: https://www.cnblogs.com/zhangboyu/p/7580262.html