善用Optional，告别NPE

作者：京东物流 王亚宁

1、NPE是什么？

NPE:NullPointerException（空指针异常）。可以说自Null的诞生以来它就让无数的程序员为之哀嚎，也是无数系统Bug的来源。托尼·霍尔（Tony Hoare），Null的发明者也表示过这是他十亿美元的错误。当程序试图在空引用（null）上调用方法或访问属性时，JVM会抛出NPE。例如：

String str = null;
int length = str.length(); // 这里会抛出NPE

1.1、NPE的常见原因

未初始化的对象：变量声明后未赋值，即默认为null。

方法返回null：方法可能返回一个对象或null，但调用者未进行null检查。

集合中的null元素：集合操作中插入了null，后续操作未处理。

多线程环境中的竞态条件：一个线程修改对象状态为null，另一个线程未及时检查。

1.2、NPE的影响

程序崩溃：未处理的NPE会导致程序终止，影响用户体验。

调试困难：NPE的堆栈信息可能不直观，定位问题源头耗时。

代码质量下降：频繁的NPE表明代码缺乏健壮的null处理机制。

2、Optional库介绍

为了应对NPE问题，Java 8引入了Optional类，它是一个容器对象，可以包含或不包含非null的值。通过Optional，开发者可以显式地表示一个值是可选的，从而强制进行null检查，减少NPE的发生。

2.1、Optional的基本用法

创建Optional对象
Optional<String> optional = Optional.of("Hello"); // 创建包含值的Optional
Optional<String> emptyOptional = Optional.empty(); // 创建空的Optional
Optional<String> nullableOptional = Optional.ofNullable(null); // 可以接受null

获取值
// 使用get()获取值，如果为空则抛出NoSuchElementException
optional.get();

// 使用orElse()提供默认值
String value = optional.orElse("Default");

// 使用orElseGet()提供默认值的Supplier
String value = optional.orElseGet(() -> "Default");

// 使用orElseThrow()在值为空时抛出异常
String value = optional.orElseThrow(() -> new IllegalArgumentException("Value is null"));

处理值
// 使用ifPresent()在值存在时执行操作
optional.ifPresent(val -> System.out.println(val));

// 使用map()转换值
Optional<Integer> lengthOptional = optional.map(String::length);

// 使用flatMap()处理嵌套的Optional
Optional<Optional<String>> nestedOptional = Optional.of(Optional.of("Nested"));
Optional<String> flatOptional = nestedOptional.flatMap(opt -> opt);

2.2、Optional的优势

明确的意图：方法返回Optional表明返回值可能为空，增强代码的可读性。

强制null检查：通过Optional的方法链，开发者必须处理可能的空值，减少遗漏。

函数式编程支持：与Lambda表达式和Stream API无缝结合，简化代码逻辑。

3、最佳实例示例

示例背景

假设有一个用户类User，包含一个地址类Address，而地址类中又包含城市信息City。在获取用户的城市名称时，存在多级空指针的风险。

public class User {
    private Address address;

    public Address getAddress() {
        return address;
    }
}

public class Address {
    private City city;

    public City getCity() {
        return city;
    }
}

public class City {
    private String name;

    public String getName() {
        return name;
    }
}

使用传统方式处理NPE

在没有使用Optional的情况下，获取城市名称可能需要多级null检查：

public String getUserCityName(User user) {
    if (user != null) {
        Address address = user.getAddress();
        if (address != null) {
            City city = address.getCity();
            if (city != null) {
                return city.getName();
            }
        }
    }
    return "Unknown";
}

上述代码层层嵌套，逻辑复杂，且易于遗漏某一级的null检查。并且代码也不容易阅读

使用Optional简化代码

利用Optional，可以将多级null检查转化为链式调用，代码更加简洁明了：

public String getUserCityName(Optional<User> userOptional) {
    return userOptional
            .map(User::getAddress)
            .map(Address::getCity)
            .map(City::getName)
            .orElse("Unknown");
}

另一个实例：处理方法返回值

假设有一个方法findUserById，可能返回一个User对象或null。使用Optional可以优雅地处理返回值。

public Optional<User> findUserById(String userId) {
    User user = userRepository.findById(userId); // 可能返回null
    return Optional.ofNullable(user);
}

调用方可以这样使用：

findUserById("12345")
    .map(User::getAddress)
    .map(Address::getCity)
    .map(City::getName)
    .ifPresent(cityName -> System.out.println("User city: " + cityName));

如果User不存在或其地址、城市信息为null，上述代码不会执行ifPresent中的打印操作，避免了NPE的风险。

总结

通过合理使用Java 8的Optional类，我们开发者可以有效减少NullPointerException的发生，提高代码的健壮性和可维护性。然而，Optional并非万能，需结合具体场景合理使用。掌握Optional的使用技巧和最佳实践，将有助于编写更安全、优雅的Java代码，真正做到“善用Optional，告别NPE”。