Java 中任何對象都有可能為空，當我們調用空對象的方法時就會拋出 NullPointerException 空指針異常，這是一種非常常見的錯誤類型。我們可以使用若干種方法來避免產生這類異常，使得我們的代碼更為健壯。
運行時檢測
最顯而易見的方法就是使用 if (obj == null) 來對所有需要用到的對象來進行檢測，包括函數參數、返回值、以及類實例的成員變量。當你檢測到 null 值時，可以選擇拋出更具針對性的異常類型，如 IllegalArgumentException，並添加消息內容。我們可以使用一些庫函數來簡化代碼，如 Java 7 開始提供的 Objects#requireNonNull 方法：
public void testObjects(Object arg) {
Object checked = Objects.requireNonNull(arg, "arg must not be null");
checked.toString();
}
Guava 的 Preconditions 類中也提供了一系列用於檢測參數合法性的工具函數，其中就包含空值檢測：
public void testGuava(Object arg) {
Object checked = Preconditions.checkNotNull(arg, "%s must not be null", "arg");
checked.toString();
}
我們還可以使用 Lombok 來生成空值檢測代碼，並拋出帶有提示信息的空指針異常：
public void testLombok(@NonNull Object arg) {
arg.toString();
}
生成的代碼如下：
public void testLombokGenerated(Object arg) {
if (arg == null) {
throw new NullPointerException("arg is marked @NonNull but is null");
}
arg.toString();
}
這個注解還可以用在類實例的成員變量上，所有的賦值操作會自動進行空值檢測。
編程規范
通過遵守某些編程規范，也可以從一定程度上減少空指針異常的發生。
使用那些已經對 null 值做過判斷的方法，如 String#equals、String#valueOf、以及三方庫中用來判斷字符串和集合是否為空的函數：
if (str != null && str.equals("text")) {}
if ("text".equals(str)) {}
if (obj != null) { obj.toString(); }
String.valueOf(obj); // "null"
// from spring-core
StringUtils.isEmpty(str);
CollectionUtils.isEmpty(col);
// from guava
Strings.isNullOrEmpty(str);
// from commons-collections4
CollectionUtils.isEmpty(col);
如果函數的某個參數可以接收 null 值，考慮改寫成兩個函數，使用不同的函數簽名，這樣就可以強制要求每個參數都不為空了：
public void methodA(Object arg1) {
methodB(arg1, new Object[0]);
}
public void methodB(Object arg1, Object[] arg2) {
for (Object obj : arg2) {} // no null check
}
如果函數的返回值是集合類型，當結果為空時，不要返回 null 值，而是返回一個空的集合；如果返回值類型是對象，則可以選擇拋出異常。Spring JdbcTemplate 正是使用了這種處理方式：
// 當查詢結果為空時，返回 new ArrayList<>()
jdbcTemplate.queryForList("SELECT * FROM person");
// 若找不到該條記錄，則拋出 EmptyResultDataAccessException
jdbcTemplate.queryForObject("SELECT age FROM person WHERE id = 1", Integer.class);
// 支持泛型集合
public <T> List<T> testReturnCollection() {
return Collections.emptyList();
}
靜態代碼分析
Java 語言有許多靜態代碼分析工具，如 Eclipse IDE、SpotBugs、Checker Framework 等，它們可以幫助程序員檢測出編譯期的錯誤。結合 @Nullable 和 @Nonnull 等注解，我們就可以在程序運行之前發現可能拋出空指針異常的代碼。
但是，空值檢測注解還沒有得到標准化。雖然 2006 年 9 月社區提出了 JSR 305 規范，但它長期處於擱置狀態。很多第三方庫提供了類似的注解，且得到了不同工具的支持，其中使用較多的有：
javax.annotation.Nonnull：由 JSR 305 提出，其參考實現為 com.google.code.findbugs.jsr305；
org.eclipse.jdt.annotation.NonNull：Eclipse IDE 原生支持的空值檢測注解；
edu.umd.cs.findbugs.annotations.NonNull：SpotBugs 使用的注解，基於 findbugs.jsr305；
org.springframework.lang.NonNull：Spring Framework 5.0 開始提供；
org.checkerframework.checker.nullness.qual.NonNull：Checker Framework 使用；
android.support.annotation.NonNull：集成在安卓開發工具中；
我建議使用一種跨 IDE 的解決方案，如 SpotBugs 或 Checker Framework，它們都能和 Maven 結合得很好。
SpotBugs 與 @NonNull、@CheckForNull
SpotBugs 是 FindBugs 的后繼者。通過在方法的參數和返回值上添加 @NonNull 和 @CheckForNull 注解，SpotBugs 可以幫助我們進行編譯期的空值檢測。需要注意的是，SpotBugs 不支持 @Nullable 注解，必須用 @CheckForNull 代替。如官方文檔中所說，僅當需要覆蓋 @ParametersAreNonnullByDefault 時才會用到 @Nullable。
官方文檔 中說明了如何將 SpotBugs 應用到 Maven 和 Eclipse 中去。我們還需要將 spotbugs-annotations 加入到項目依賴中，以便使用對應的注解。
<dependency>
<groupId>com.github.spotbugs</groupId>
<artifactId>spotbugs-annotations</artifactId>
<version>3.1.7</version>
</dependency>
以下是對不同使用場景的說明：
@NonNull
private Object returnNonNull() {
// 錯誤：returnNonNull() 可能返回空值，但其已聲明為 @Nonnull
return null;
}
@CheckForNull
private Object returnNullable() {
return null;
}
public void testReturnNullable() {
Object obj = returnNullable();
// 錯誤：方法的返回值可能為空
System.out.println(obj.toString());
}
private void argumentNonNull(@NonNull Object arg) {
System.out.println(arg.toString());
}
public void testArgumentNonNull() {
// 錯誤：不能將 null 傳遞給非空參數
argumentNonNull(null);
}
public void testNullableArgument(@CheckForNull Object arg) {
// 錯誤：參數可能為空
System.out.println(arg.toString());
}
對於 Eclipse 用戶，還可以使用 IDE 內置的空值檢測工具，只需將默認的注解 org.eclipse.jdt.annotation.Nullable 替換為 SpotBugs 的注解即可：
Eclipse null analysis
Checker Framework 與 @NonNull、@Nullable
Checker Framework 能夠作為 javac 編譯器的插件運行，對代碼中的數據類型進行檢測，預防各類問題。我們可以參照 官方文檔，將 Checker Framework 與 maven-compiler-plugin 結合，之后每次執行 mvn compile 時就會進行檢查。Checker Framework 的空值檢測程序支持幾乎所有的注解，包括 JSR 305、Eclipse、甚至 lombok.NonNull。
import org.checkerframework.checker.nullness.qual.Nullable;
@Nullable
private Object returnNullable() {
return null;
}
public void testReturnNullable() {
Object obj = returnNullable();
// 錯誤：obj 可能為空
System.out.println(obj.toString());
}
Checker Framework 默認會將 @NonNull 應用到所有的函數參數和返回值上，因此，即使不添加這個注解，以下程序也是無法編譯通過的：
private Object returnNonNull() {
// 錯誤：方法聲明為 @NonNull，但返回的是 null。
return null;
}
private void argumentNonNull(Object arg) {
System.out.println(arg.toString());
}
public void testArgumentNonNull() {
// 錯誤：參數聲明為 @NonNull，但傳入的是 null。
argumentNonNull(null);
}
Checker Framework 對使用 Spring Framework 5.0 以上的用戶非常有用，因為 Spring 提供了內置的空值檢測注解，且能夠被 Checker Framework 支持。一方面我們無需再引入額外的 Jar 包，更重要的是 Spring Framework 代碼本身就使用了這些注解，這樣我們在調用它的 API 時就能有效地處理空值了。舉例來說，StringUtils 類里可以傳入空值的函數、以及會返回空值的函數都添加了 @Nullable 注解，而未添加的方法則繼承了整個框架的 @NonNull 注解，因此，下列代碼中的空指針異常就可以被 Checker Framework 檢測到了：
// 這是 spring-core 中定義的類和方法
public abstract class StringUtils {
// str 參數繼承了全局的 @NonNull 注解
public static String capitalize(String str) {}
@Nullable
public static String getFilename(@Nullable String path) {}
}
// 錯誤：參數聲明為 @NonNull，但傳入的是 null。
StringUtils.capitalize(null);
String filename = StringUtils.getFilename("/path/to/file");
// 錯誤：filename 可能為空。
System.out.println(filename.length());
Optional 類型
Java 8 引入了 Optional<T> 類型，我們可以用它來對函數的返回值進行包裝。這種方式的優點是可以明確定義該方法是有可能返回空值的，因此調用方必須做好相應處理，這樣也就不會引發空指針異常。但是，也不可避免地需要編寫更多代碼，而且會產生很多垃圾對象，增加 GC 的壓力，因此在使用時需要酌情考慮。
Optional<String> opt;
// 創建
opt = Optional.empty();
opt = Optional.of("text");
opt = Optional.ofNullable(null);
// 判斷並讀取
if (opt.isPresent()) {
opt.get();
}
// 默認值
opt.orElse("default");
opt.orElseGet(() -> "default");
opt.orElseThrow(() -> new NullPointerException());
// 相關操作
opt.ifPresent(value -> {
System.out.println(value);
});
opt.filter(value -> value.length() > 5);
opt.map(value -> value.trim());
opt.flatMap(value -> {
String trimmed = value.trim();
return trimmed.isEmpty() ? Optional.empty() : Optional.of(trimmed);
});
方法的鏈式調用很容易引發空指針異常，但如果返回值都用 Optional 包裝起來，就可以用 flatMap 方法來實現安全的鏈式調用了：
String zipCode = getUser()
.flatMap(User::getAddress)
.flatMap(Address::getZipCode)
.orElse("");
Java 8 Stream API 同樣使用了 Optional 作為返回類型：
stringList.stream().findFirst().orElse("default");
stringList.stream()
.max(Comparator.naturalOrder())
.ifPresent(System.out::println);
此外，Java 8 還針對基礎類型提供了單獨的 Optional 類，如 OptionalInt、OptionalDouble 等，在性能要求比較高的場景下很適用。
其它 JVM 語言中的空指針異常
Scala 語言中的 Option 類可以對標 Java 8 的 Optional。它有兩個子類型，Some 表示有值，None 表示空。
val opt: Option[String] = Some("text")
opt.getOrElse("default")
除了使用 Option#isEmpty 判斷，還可以使用 Scala 的模式匹配：
opt match {
case Some(text) => println(text)
case None => println("default")
}
Scala 的集合處理函數庫非常強大，Option 則可直接作為集合進行操作，如 filer、map、以及列表解析（for-comprehension）：
opt.map(_.trim).filter(_.length > 0).map(_.toUpperCase).getOrElse("DEFAULT")
val upper = for {
text <- opt
trimmed <- Some(text.trim())
upper <- Some(trimmed) if trimmed.length > 0
} yield upper
upper.getOrElse("DEFAULT")
Kotlin 使用了另一種方式，用戶在定義變量時就需要明確區分 可空和不可空類型。當可空類型被使用時，就必須進行空值檢測。
var a: String = "text"
a = null // 錯誤：無法將 null 賦值給非空 String 類型。
val b: String? = "text"
// 錯誤：操作可空類型時必須使用安全操作符（?.）或強制忽略（!!.）。
println(b.length)
val l: Int? = b?.length // 安全操作
b!!.length // 強制忽略，可能引發空值異常
Kotlin 的特性之一是與 Java 的可互操作性，但 Kotlin 編譯器無法知曉 Java 類型是否為空，這就需要在 Java 代碼中使用注解了，而 Kotlin 支持的 注解 也非常廣泛。Spring Framework 5.0 起原生支持 Kotlin，其空值檢測也是通過注解進行的，使得 Kotlin 可以安全地調用 Spring Framework 的所有 API。
結論
在以上這些方案中，我比較推薦使用注解來預防空指針異常，因為這種方式十分有效，對代碼的侵入性也較小。所有的公共 API 都應該使用 @Nullable 和 @NonNull 進行注解，這樣就能強制調用方對空指針異常進行預防，讓我們的程序更為健壯。
參考資料
https://howtodoinjava.com/java/exception-handling/how-to-effectively-handle-nullpointerexception-in-java/
http://jmri.sourceforge.net/help/en/html/doc/Technical/SpotBugs.shtml
https://dzone.com/articles/features-to-avoid-null-reference-exceptions-java-a
https://medium.com/@fatihcoskun/kotlin-nullable-types-vs-java-optional-988c50853692
————————————————