煩人的Null,你能夠走開點了

1. Null 的問題

假設如今有一個須要三個參數的方法。其中第一個參數是必須的,後兩個參數是無關緊要的。java

第一種狀況,在咱們調用這個方法的時候,咱們只能傳入兩個參數,對第三個參數,咱們在上下文裏是沒有的,那麼咱們調用方法的時候,就須要用一個特殊值去告知這個方法:
第三個參數咱們拿不到,參數是不存在或者不明確的。
這個特殊的值應該用什麼呢?在 Java 中,咱們會選擇用 null 去表示這種狀況。git

第二種狀況,若是在調用方法的時候,咱們有三個參數,只是第三個參數沒有值,咱們也須要傳入一個特殊的值去表示:
參數存在,可是沒有值。
這個特殊的值是什麼呢?沒錯,在 Java 中,又是 null。程序員

你看到了,如今 null 值的含義自己出現了兩個意思:github

  1. 參數不存在
  2. 參數沒有值

二義性在計算機科學裏是能避免就儘可能避免的。因此,null 值的二義性是一個 Java 中的設計缺陷。不過,也不光是在 Java 語言中,null 的二義性在編程語言裏是普遍存在的一個問題。這個問題被稱爲 Null 引用問題。算法

Null 引用是計算機科學中一個歷史悠久又臭名昭著的問題。在 1964 年,由快排算法的創造者東尼·霍爾發明。他自稱這是個十億美圓的錯誤。apache

在 Java 中,當咱們去調用一個對象值爲 null 的方法或者屬性時,就會報 java.lang.NullPointerException,簡稱爲 NPE。編程

傳統上,這些 NPE 問題,必須徹底依賴程序員自己細緻周密的檢查,對於 null 的檢查充斥在了 Java 代碼的字裏行間,讓代碼變得臃腫醜陋,很是噁心。maven

同時,因爲 NPE 的二義性問題,開發人員每每沒法徹底防禦住 NPE,這使得 NPE 成爲了開發人員的噩夢。明明邏輯上,一個對象是存在的,只是不知道其明確含義,可是隻要引用了這個沒有明確含義值的對象的方法,就會被告知NPE,簡直讓人防不勝防。編程語言

而且,更可惡的是,在 Java 中,NPE 是運行期異常,這就意味着 NPE 沒法早期發現,只有上線運行了,纔可能出現問題。工具

討厭的 null,成本巨大的 NPE,讓 Java 開發人員在不斷地實踐中,採用了各類方法去對付 null,讓咱們看看這些方法。

NPE 是運行期異常,只會在系統運行期間形成,因此致使代碼檢查沒法提早發現它。若是咱們能想辦法把在運行期出現的 NPE,提早在編譯代碼時探測到,那麼咱們就會大大減輕 NPE 對系統形成的損害。

因而,@NonNull 這個註解橫空出世了。

2. 橫空出世的註解

@NonNull 這個註解就是一個標記,這個標記能夠和 IDE 聯動:當可能出現 NPE 時,IDE 會標出警告。

咱們先看一段代碼:

上面的代碼沒有加入 @NonNull,能夠看到 IDE 並無給出什麼警告。

讓咱們加上 @NonNull 註解看看:

能夠看到,Idea 和 @NonNull 註解造成了聯動,並給出了可能出現 NPE 的警告。

有了這個警告,其實對一個複雜的項目來講還不夠,由於這些警告很容易就會被忽略過去了,即便忽略了,項目依然能夠編譯運行起來。

那麼,咱們是否是能夠再增長一步檢查?當檢查到了可疑的 NPE,根本不容許編譯經過。是時候給你們介紹一下 findbugs 了!

3. findbugs 出場了

咱們先在 maven 中配置好 findbugs:

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>com.github</groupId>
    <artifactId>leetcodeMaster</artifactId>
    <version>1.0-SNAPSHOT</version>
    <build>
        <resources>
            <resource>
                <directory>src/main/resources</directory> <!--掃描resources包下的配置文件-->
                <filtering>true</filtering>
                <includes>
                    <include>**/*.xml</include>
                    <include>**/*.properties</include>
                </includes>
            </resource>
            <resource>
                <directory>src/main/java</directory><!--掃描java包下的配置文件-->
                <includes>
                    <include>**/*.xml</include>
                    <include>**/*.properties</include>
                </includes>
            </resource>
        </resources>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <configuration>
                    <source>8</source>
                    <target>8</target>
                </configuration>
            </plugin>
            <plugin>
                <groupId>org.codehaus.mojo</groupId>
                <artifactId>findbugs-maven-plugin</artifactId>
                <version>3.0.5</version>
                <configuration>
                    <!-- 設置分析工做的等級,能夠爲Min、Default和Max -->
                    <effort>Low</effort>
                    <!-- Low、Medium和High (Low最嚴格) High只掃描嚴重錯誤。建議用Medium-->
                    <threshold>Medium</threshold>
                    <failOnError>true</failOnError>
                    <includeTests>true</includeTests>
                    <!--findbugs須要忽略的錯誤的配置文件-->
<!--                    <excludeFilterFile>conf/findbugs-exclude-filter.xml</excludeFilterFile>-->
                    <!--findbugs須要忽略的錯誤的配置文件-->
                    <includeFilterFile>conf/findbugs-include-filter.xml</includeFilterFile>
                </configuration>
                <executions>
                    <execution>
                        <id>run-findbugs</id>
                        <!-- 在package(也可設爲compile) 階段觸發執行findbugs檢查,好比執行 mvn clean package -->
                        <phase>compile</phase>
                        <goals>
                            <goal>check</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>
    <dependencies>
        <!-- https://mvnrepository.com/artifact/com.google.guava/guava -->
        <dependency>
            <groupId>com.google.guava</groupId>
            <artifactId>guava</artifactId>
            <version>19.0</version>
        </dependency>
        <!-- https://mvnrepository.com/artifact/org.apache.commons/commons-lang3 -->
        <dependency>
            <groupId>org.apache.commons</groupId>
            <artifactId>commons-lang3</artifactId>
            <version>3.3.2</version>
        </dependency>
        <!-- https://mvnrepository.com/artifact/com.google.code.findbugs/jsr305 -->
        <dependency>
            <groupId>com.google.code.findbugs</groupId>
            <artifactId>jsr305</artifactId>
            <version>3.0.2</version>
        </dependency>
    </dependencies>
</project>

緊接着運行maven,對項目進行編譯。
mvn clean compile findbugs:findbugs 

能夠看到,findbugs 發現可能會在運行期間出現 NPE 後,中斷了項目構建過程。

咱們再打開 findbugs 的界面看看具體的報錯位置:

你瞧,findbugs 準確的找到了可能出現 NPE 的根源。

經過以上這些手段,咱們儘量的將 NPE 提早到編譯期發現。

可是啊可是,對一個規模龐大且複雜的項目來講,光使用靜態代碼檢查仍是不夠的。由於相似 findbugs 這種的靜態代碼檢查工具,不可能對每一個 NPE 的檢查點都檢查到位。而且,探測的問題有時候由於業務緣由,也會放鬆檢查要求。

別慌,咱們可讓靜態代碼檢查再加上一些別的方法,來聯手堵住 NPE 問題,這就是咱們下面要說的 Optional。

4. 用 Optional 去除二義性

因爲鋪天蓋地的 null 檢查,使得 Java 程序員叫苦不堪。因而官方自 Java8 起,參考了 google 的 guava,引入了 Optional 類型用來避免每次繁瑣醜陋的 null 檢查。

Optional 本質上就是一個容器,這個容器持有了一個變量類型爲 T 的值。因此,Optional 這個容器中的值只會有兩種狀況,要麼爲類型 T 的變量值,要麼爲null。

對於可能出現的爲 null 的狀況,Optional 自己從建立、檢查,到抽取、使用,都提供了對應的方法供使用者調用。並採用了意義很明確的方法去排除了null的二義性。

咱們看示例代碼:

class Player{
    private int id;
    private String name;

    public int getId() {
        return id;
    }

    public void setId(int id) {
        this.id = id;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }
}

public class Optional4NPE {
    public static void main(String[] args) {
        Optional<Player> optionalPlayer = Optional.ofNullable(null);
        optionalPlayer.ifPresent(u -> System.out.println(u.getName()));
    }
}

以上代碼咱們使用了一個 Optional 中的 ofNullable,去建立了一個包含了類型爲 Player、值爲 null 的 Optional 容器。

運行結果:
'Process finished with exit code 0'

運行後,代碼沒有任何輸出,也沒有出現 NPE 異常。沒有輸出的緣由是咱們傳入了一個 null 值,這個 null 表示值不存在。此時,咱們調用 Optional 的 ifPresent 方法作了判斷,只有存在值時,纔會執行打印輸出。

接下來,咱們把 null 替換成有意義的值看看。

import java.util.Optional;

class Player{
    private int id;
    private String name;

    public int getId() {
        return id;
    }

    public void setId(int id) {
        this.id = id;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }
}

public class Optional4NPE {
    public static void main(String[] args) {
        Player player = new Player();
        player.setId(1);
        player.setName("demoUser");
        Optional<Player> optionalPlayer = Optional.ofNullable(player);
        optionalPlayer.ifPresent(u -> System.out.println(u.getName()));
    }
}

輸出結果:

demoUser

Process finished with exit code

能夠看到,當傳入一個咱們建立的 player 時,執行了打印輸出方法。

上面咱們已經發現,經過 Optional 的 ifPresent 方法,咱們明確了 null 的含義,明確認定只要值爲 null,就表示不存在。那若是一個變量存在,可是沒有值或者沒有有意義的值呢?

咱們把代碼改改:

import java.util.Optional;

class Player{
    private int id;
    private String name;

    public int getId() {
        return id;
    }

    public void setId(int id) {
        this.id = id;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }
}

public class Optional4NPE {
    public static void main(String[] args) {
        Player player = null;
        Player defaultPlayer = new Player();
        defaultPlayer.setId(1);
        defaultPlayer.setName("————undefinedNAME-----");
        Player player1 = Optional.ofNullable(player).orElse(defaultPlayer);
        System.out.println(player1.getName());
    }
}

運行結果以下:

————undefinedNAME-----

Process finished with exit code 0

這裏能夠看到,咱們使用 orElse 方法,當一個變量值爲 null 時,返回一個默認值。經過返回默認值,咱們明確了 null 的另一個含義,對象存在,可是可能沒有實際意義。

Optional 的出現,大大改善了咱們的 Java 代碼質量,減小了 NPE 的可能性,並使得代碼的可讀性大大加強。

經過使用 Optional,開發人員還能很是天然輕鬆的使用 Null Object Pattern 模式去處理 Null 問題。Optional 是很是值得在項目中大範圍使用的。

5. 總結

最後總結一下。

咱們在項目中綜合利用 @NonNull 註解,findbugs 靜態代碼檢查,還有引入 Optional 等方式,大大減小了 NPE 出現的場合。

不過,有一說一,這些方法也會加大項目開發複雜度,增大了編譯測試時間。

同時,使用好 findbugs 也是有一些門檻的,其自己檢測代碼有時候嚴格程度也很難把握。Optional自己也提供了 of 方法,這個方法不當心也會引入新的 NPE 問題。

可是,我認爲這些相對於 NPE 可能對線上系統形成的損失而言,都是值得的。咱們如今能夠說:
NPE,你能夠走開點了。

相關文章
相關標籤/搜索