在Java中如何优雅地判空

2019-12-17 14:40:08

来自：李良逸
链接：http://blog.imuxuan.com/archives/86

判空灾难

作为搬砖党的一族们，我们对判空一定再熟悉不过了，不要跟我说你很少进行判空，除非你喜欢 NullPointerException。

不过 NullPointerException对于很多猿们来说，也是 Exception家族中亲近的一员了。

为了避免 NullPointerException来找我们，我们经常会进行如下操作：

if (data != null) {
 do sth.
}

如果一个类中多次使用某个对象，那你可能要一顿操作，so：

世界第九大奇迹”就这样诞生了。Maybe你会想，项目中肯定不止你一个人会这样一顿操作，然后按下 Command+Shift+F，真相就在眼前：

What，我们有接近一万行的代码都是在判空？

好了，接下来，要进入正题了。

NullObject模式

对于项目中无数次的判空，对代码质量整洁度产生了十分之恶劣的影响，对于这种现象，我们称之为“判空灾难”。

那么，这种现象如何治理呢，你可能听说过 NullObject模式，不过这不是我们今天的武器，但是还是需要介绍一下 NullObject模式。

什么是NullObject模式呢？

In object-oriented computer programming, a null object is an object with no referenced value or with defined neutral ("null") behavior. The null object design pattern describes the uses of such objects and their behavior (or lack thereof).

NullObject模式发表在“ 程序设计模式语言 ”系列丛书中。一般的，在面向对象语言中，对对象的调用前需要使用判空检查，来判断这些对象是否为空，因为在空引用上无法调用所需方法。

空对象模式的一种典型实现方式如下图所示(图片来自网络)：

示例代码如下（命名来自网络，哈哈到底是有多懒）：

Nullable是空对象的相关操作接口，用于确定对象是否为空，因为在空对象模式中，对象为空会被包装成一个 Object，成为 NullObject，该对象会对原有对象的所有方法进行空实现。

public interface Nullable {
 boolean isNull();
}

这个接口定义了业务对象的行为。

public interface DependencyBase extends Nullable {
 void Operation();
}

这是该对象的真实类，实现了业务行为接口 DependencyBase与空对象操作接口 Nullable。

public class Dependency implements DependencyBase, Nullable { @Override public void Operation() { System.out.print("Test!"); } @Override public boolean isNull() { return false; }}

这是空对象，对原有对象的行为进行了空实现。

public class NullObject implements DependencyBase{

 @Override
 public void Operation() {
 // do nothing
 }

 @Override
 public boolean isNull() {
 return true;
 }

}

在使用时，可以通过工厂调用方式来进行空对象的调用，也可以通过其他如反射的方式对对象进行调用（一般多耗时几毫秒）在此不进行详细叙述。

public class Factory {

 public static DependencyBase get(Nullable dependencyBase){
 if (dependencyBase == null){
 return new NullObject();
 }
 return new Dependency();
 }

}

这是一个使用范例，通过这种模式，我们不再需要进行对象的判空操作，而是可以直接使用对象，也不必担心 NPE（NullPointerException）的问题。

public class Client {

 public void test(DependencyBase dependencyBase){
 Factory.get(dependencyBase).Operation();
 }

}

关于空对象模式，更具体的内容大家也可以多找一找资料，上述只是对 NullObject的简单介绍，但是，今天我要推荐的是一款协助判空的插件 NRNullObject，让我们来优雅地进行判空，不再进行一顿操作来定义繁琐的空对象接口与空独享实现类。

.NR Null Object

NRNullObject是一款适用于Android Studio、IntelliJ IDEA、PhpStorm、WebStorm、PyCharm、RubyMine、AppCode、CLion、GoLand、DataGrip等 IDEA的 Intellij插件。其可以根据现有对象，便捷快速生成其空对象模式需要的组成成分，其包含功能如下：

分析所选类可声明为接口的方法；

抽象出公有接口；

创建空对象，自动实现公有接口；

对部分函数进行可为空声明；

可追加函数进行再次生成；

自动的函数命名规范

让我们来看一个使用范例：

怎么样，看起来是不是非常快速便捷，只需要在原有需要进行多次判空的对象中，邮件弹出菜单，选择 Generate，并选择 NRNullObject即可自动生成相应的空对象组件。

那么如何来获得这款插件呢？

安装方式

可以直接通过 IDEA的 Preferences中的 Plugins仓库进行安装。

选择 Preferences→Plugins→Browserepositories

搜索 “NR Null Oject” 或者 “Null Oject”进行模糊查询，点击右侧的 Install，restart IDEA 即可

Optional

还有一种方式是使用 Java8特性中的 Optional来进行优雅地判空。一个可能包含也可能不包含非null值的容器对象。如果存在值， isPresent()将返回 true， get()将返回该值。

话不多说，举个例子。

有如下代码，需要获得 Test2中的 Info信息，但是参数为 Test4，我们要一层层的申请，每一层都获得的对象都可能是空，后的代码看起来就像这样。

public String testSimple(Test4 test) {
 if (test == null) {
 return "";
 }
 if (test.getTest3() == null) {
 return "";
 }
 if (test.getTest3().getTest2() == null) {
 return "";
 }
 if (test.getTest3().getTest2().getInfo() == null) {
 return "";
 }
 return test.getTest3().getTest2().getInfo();
 }

但是使用 Optional后，整个就都不一样了

public String testOptional(Test test) {
 return Optional.ofNullable(test).flatMap(Test::getTest3)
 .flatMap(Test3::getTest2)
 .map(Test2::getInfo)
 .orElse("");
 }

Optional.ofNullable(test)，如果 test为空，则返回一个单例空 Optional对象，如果非空则返回一个 Optional包装对象， Optional将 test包装；

flatMap(Test::getTest3)判断 test是否为空，如果为空，继续返回步中的单例 Optional对象，否则调用 Test的 getTest3方法；

flatMap(Test3::getTest2)同上调用 Test3的 getTest2方法；

map(Test2::getInfo)同 flatMap类似，但是 flatMap要求 Test3::getTest2返回值为 Optional类型，而 map不需要， flatMap不会多层包装， map返回会再次包装 Optional；

orElse("");获得 map中的 value，不为空则直接返回 value，为空则返回传入的参数作为默认值。

怎么样，使用 Optional后我们的代码是不是瞬间变得非常整洁，或许看到这段代码你会有很多疑问，针对复杂的一长串判空，Optional有它的优势，但是对于简单的判空使用 Optional也会增加代码的阅读成本、编码量以及团队新成员的学习成本。毕竟 Optional在现在还并没有像 RxJava那样流行，它还拥有一定的局限性。

如果直接使用Java8中的Optional，需要保证安卓API级别在24及以上。