淺析Java如何優(yōu)雅的避免那無處不在的空指針異常

更新時間：2024年03月01日 10:56:43 作者：碼農(nóng)Academy

在Java編程語言中,NullPointerException（簡稱NPE）是一種常見的運行時異常,本文主要來和大家講講如何優(yōu)雅的避免這些空指針異常,需要的可以參考下

在Java編程語言中，NullPointerException（簡稱NPE）是一種常見的運行時異常，當程序試圖訪問或操作一個還未初始化（即值為null）的對象引用時，Java虛擬機就會拋出NullPointerException。如果我們在日常開發(fā)中，不能很好的去規(guī)避NPE，那么可能因為數(shù)據(jù)或者其他問題就會導致線上問題。。。很煩。。。。

阿里巴巴開發(fā)手冊規(guī)約中也說明防止NPE，是程序員的基本素養(yǎng)。。。

接下來我們先談談幾種可能會出現(xiàn)空指針異常的方式。

出現(xiàn)空指針異常的情況

訪問空對象的屬性或調(diào)用空對象的方法當一個對象是null時，試圖訪問一個對象的屬性或調(diào)用其方法，就會觸發(fā)空指針異常。

String text = null;
int length = text.length();

User user = null;
String userName = user.getUserName();

數(shù)組為null或者數(shù)組元素為null當嘗試訪問數(shù)組中的某個索引處的元素，而該元素為null時，同樣會導致空指針異常。

String[] strs = null;
int length = strs.length;

String[] strs = new String[3];  
int length = strs[2].length();

集合中null元素訪問當集合中存在null元素，當我們遍歷集合，訪問到這個元素的屬性或者方法時也會拋出NPE，這種情況也會出現(xiàn)在我們的日常開發(fā)中，有時候就會因為數(shù)據(jù)問題導致這種情況發(fā)生，常常也莫名其妙。。。。

List<String> list = Lists.newArrayList();  
list.add(null);  
System.out.println(list.get(0).length());

調(diào)用的方法返回null調(diào)用某個方法，期望其返回一個非null的對象，但實際返回了null。當然這種情況等同于訪問空對象的屬性或者方法。這在實際開發(fā)過程中極易出現(xiàn)的一種情況。比如我們使用Mybatis從數(shù)據(jù)庫中查詢一條記錄時，數(shù)據(jù)不存在，就會返回null。這種情況尤為注意。

private User getUserInfo(){  
    return null;  
}

User user = getUserInfo();
String userName = user.getUserName();

使用基本數(shù)據(jù)類型的包裝類在使用基本數(shù)據(jù)類型的包裝類時，如果未正確初始化，再轉(zhuǎn)成int時，可能導致空指針異常。

Integer i = null;  
int num = i;

以上大概是我想到或者常遇到的一些可能會發(fā)生NPE的情況，如果還有其他情況，可以貼出來討論。

那么我們該如何避免NPE呢？

避免NPE的幾種方式

訪問對象前要謹慎在使用對象之前，始終檢查它是否為null。這包括方法參數(shù)、返回值以及對象的屬性。在訪問對象的方法或?qū)傩灾?，使用條件語句判斷對象是否為null。比如我們在訪問User對象前，一定要判null

User user = new User();  
if (user != null){  
    String userName = user.getUserName();  
    Address address = user.getAddress();  
    if (address != null){  
        String coutry = address.getCountry();  
    }  
}

或者我們的user是從一個方法中獲取的，例如數(shù)據(jù)庫中查詢，那么我們在訪問這個對象前，一定要判null，如果為null要拋出對應的業(yè)務異常，然后我們就可以在接口響應中對應返回錯誤的信息即可，此時就算是一個正常的流程了。這點尤為重要，一定要注意。

User user = userManager.getUserById(Long userId);
if (user == null){
	throw new ServiceException(""當前查詢的對象不存在);
}

關(guān)于SpringBoot項目中捕獲自定義業(yè)務異常，統(tǒng)一異常管理，統(tǒng)一結(jié)果返回，可以參考這篇文章：SpringBoot統(tǒng)一結(jié)果返回，統(tǒng)一異常處理，大牛都這么玩

當然如果使我們在寫User getUserById(Long id)返回對象或者List<User> listUserByIds(List<Long> idList)時我們可以不返回null，可以返回一個對象默認信息或者一個空集合，這樣調(diào)用方就不會出現(xiàn)NPE風險，當然我們不強制返回一個對象或者空集合，但是必須添加注釋充分說明什么情況下會返回null值。這也是阿里巴巴開發(fā)手冊規(guī)約的建議。

使用Optional類JDK8以上版本提供了Optional類，它是一個容器對象，可用于包裝可能為null的值。我們可以使用它判斷null問題，同時也解決了多層級訪問問題，配合使用orElse時，會先執(zhí)行orElse方法，然后執(zhí)行邏輯代碼，不管是否出現(xiàn)了空指針。

String country = Optional.ofNullable(user)  
        .map(User::getAddress)  
        .map(Address::getCountry)  
        .orElse("");

String country = Optional.ofNullable(user)  
        .map(User::getAddress)  
        .map(Address::getCountry)  
        .orElseGet(() -> defaultContry());

private String defaultContry(){
	return "CN";
}

我們還可以使用orElseThrow()方法，當Optional中的對象是一個null時我們直接拋出異常：

String userName = Optional.ofNullable(user).map(User::getUserName).orElseThrow(() -> new ServiceException("當前用戶信息不存在"));

使用斷言避免空指針使用Java斷言（assert）來檢查變量是否為null。但要注意，斷言通常在開發(fā)和測試階段啟用，而在生產(chǎn)環(huán)境中可能被禁用（在生產(chǎn)環(huán)境中，通常不會啟用斷言以避免不必要的性能開銷以及防止?jié)撛诘腻e誤信息泄漏）。

User user = new User();
assert user != null : "user should not be null";
Address address = user.getAddress();  
assert address != null : "address should not be null";  
String coutry = address.getCountry();

使用@Nullable注解使用javax.annotation.Nullable注解，@Nullable注解通常用于標記一個方法的參數(shù)、返回值或者字段可能為null。這個注解并非Java標準庫的一部分，但在一些第三方庫（如JSR 305庫中的javax.annotation.Nullable，以及Google Guava和JetBrains的Kotlin標準庫等）中廣泛使用，并且被許多IDE和靜態(tài)分析工具支持。以便在編譯期或開發(fā)工具中提示可能的NPE風險。

@Nullable  
private static User getUserById(Long userId){  
    return null;  
}  
  
private static void handlerUser(@Nullable User user){  
    System.out.println(user.getUserName());  
}

public static void main(String[] args) {  
  Long userId = 0L;  
  User user = getUserById(userId);  
  String userName = user.getUserName();  
  handlerUser(user);  
}

此時IDEA就會警告會出現(xiàn)NPE風險

借助工具掃描代碼在Java開發(fā)中，我們還可以使用以下工具掃描代碼以發(fā)現(xiàn)潛在的空指針異常風險。

IntelliJ IDEA：內(nèi)置了強大的靜態(tài)代碼分析器，能夠檢測出可能的NPE和其他代碼問題。

SonarQube / SonarLint：提供持續(xù)集成和本地IDE插件形式的靜態(tài)代碼分析，能找出潛在的空指針以及其他質(zhì)量或安全問題。Sonar可以定時掃描倉庫中的代碼，可以發(fā)現(xiàn)代碼中的一些潛在風險，可以通過一些通知例如郵件等告知代碼提交者這段代碼的風險。

FindBugs（現(xiàn)更名為SpotBugs）：另一個開源的靜態(tài)分析工具，能夠發(fā)現(xiàn)潛在的bug，包括可能導致NPE的情況。

阿里巴巴Java開發(fā)規(guī)約插件：對于Eclipse和IntelliJ IDEA都有相應的插件版本，基于阿里巴巴內(nèi)部Java編碼規(guī)范，包含了對可能出現(xiàn)NPE情況的檢測。

補充一點

在JDK 17中引入的Helpful NullPointerExceptions特性確實增強了空指針異常信息的準確性與可用性。當發(fā)生NullPointerException時，JVM現(xiàn)在能夠提供更精確的位置信息，特別是在鏈式調(diào)用場景下，它會指出導致空指針異常的具體對象引用。這有助于開發(fā)者更快地定位到代碼中的問題所在，無需通過堆棧跟蹤逐層分析來判斷哪個對象引用為null。

假如我們訪問user.getAddress().getCountry().length()時，在JDK17以前，如果發(fā)生了空指針異常，他只會打印出來發(fā)生了空指針異常，但是并沒有告知到底是user對象還是address對象還是coutnry發(fā)生了異常：

Exception in thread "main" java.lang.NullPointerException
at com.study.base.core.base.NpeTest.main(NpeTest.java:23)

但是在JDK17以后，借助Helpful NullPointerExceptions特性，異常信息將更加精確，可能會類似打印這樣的信息，精確到那個值發(fā)生了空指針異常：

Exception in thread "main" java.lang.NullPointerException: Cannot invoke "Address.getCountry()" because "user.address" is null
at com.study.base.core.base.NpeTest.main(NpeTest.java:23)

這又多了一個升級JDK到17以上的理由。