在Java中如何优雅地判空

《移动开发架构设计实战》

判空灾难

NullPointerException

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

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

Wowo

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

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

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

1

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

2

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

3

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

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).

以上解析来自Wikipedia。

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

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

4

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

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

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的简单介绍，但是，今天我要推荐的是一款协助判空的插件NR Null Object，让我们来优雅地进行判空，不再进行一顿操作来定义繁琐的空对象接口与空独享实现类。

.NR Null Object

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

  • 分析所选类可声明为接口的方法；
  • 抽象出公有接口；
  • 创建空对象，自动实现公有接口；
  • 对部分函数进行可为空声明；
  • 可追加函数进行再次生成；
  • 自动的函数命名规范

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

5

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

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

安装方式

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

选择 Preferences → Plugins → Browse repositories

6

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

7

Optional

还有一种方式是使用Java8特性中的Optional来进行优雅地判空，Optional来自官方的介绍如下：

A container object which may or may not contain a non-null value. If a value is present, isPresent() will return true and get() will return the value.

一个可能包含也可能不包含非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("");
    }

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

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

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

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

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

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

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

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

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

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

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

image-20181124085913887.png

你也可以直接引入Google的Guava。（啥是Guava？来自官方的提示）

Guava is a set of core libraries that includes new collection types (such as multimap and multiset), immutable collections, a graph library, functional types, an in-memory cache, and APIs/utilities for concurrency, I/O, hashing, primitives, reflection, string processing, and much more!

引用方式，就像这样：

    dependencies {
      compile 'com.google.guava:guava:27.0-jre'
      // or, for Android:
      api 'com.google.guava:guava:27.0-android'
    }

不过IDEA默认会显示黄色，提示让你将Guava表达式迁移到Java Api上。

image-3.png

当然，你也可以通过在Preferences搜索"Guava"来Kill掉这个Yellow的提示。

image-4.png

关于Optional使用还有很多技巧，感兴趣可以查阅Guava和Java8相关书籍和文档。

使用Optional具有如下优点：

  1. 将防御式编程代码完美包装
  2. 链式调用
  3. 有效避免程序代码中的空指针

但是也同样具有一些缺点：

  1. 流行性不是非常理想，团队新成员需要学习成本
  2. 安卓中需要引入Guava，需要团队每个人处理IDEA默认提示，或者忍受黄色提示
  3. 有时候代码阅读看起来可能会如下图所示：
Duang

Kotlin

当然，Kotlin以具有优秀的空安全性为一大特色，并可以与Java很好的混合使用，like this:

    test1?.test2?.test3?.test4

如果你已经开始使用了Kotlin，可以不用再写缭乱的防御判空语句。如果你还没有使用Kotlin，并不推荐为了判空优雅而直接转向Kotlin。

最后编辑于 ：
©著作权归作者所有,转载或内容合作请联系作者
  • 人面猴
    序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
    沈念sama阅读 204,530评论 6赞 478
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 86,403评论 2赞 381
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 151,120评论 0赞 337
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 54,770评论 1赞 277
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 63,758评论 5赞 367
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 48,649评论 1赞 281
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 38,021评论 3赞 398
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 36,675评论 0赞 258
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 40,931评论 1赞 299
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,659评论 2赞 321
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,751评论 1赞 330
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 33,410评论 4赞 321
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 39,004评论 3赞 307
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,969评论 0赞 19
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,203评论 1赞 260
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 45,042评论 2赞 350
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 42,493评论 2赞 343