新手Java開發(fā)總是經(jīng)?？罩羔槞z查，甚至某些老手也會犯這樣的問題。我們來看看如何系統(tǒng)地避免空指針問題。

首先需指出的是，Java語言層面就支持引用為空，再怎么優(yōu)秀的方法也無法繞過語言底層的設(shè)定。

好消息是：空指針問題并沒特別難解決。根據(jù)谷歌的內(nèi)部調(diào)查，代碼中使用空指針的概率約為95%，筆者在工作中的實際體驗也和這個數(shù)據(jù)相差不大，甚至更低。只有少量的代碼需要注意空指針問題，比如我們很少見集合對象中存在null，很多方法的調(diào)用也是空指針安全的。

防止空指針的基本思路

• 靜態(tài)代碼分析工具
• 快速失?。╢ail-fast), 代碼空指針檢查
• 兼容 null
• 減少使用 null

使用靜態(tài)代碼分析工具

Java中靜態(tài)代碼分析工具有很多，F(xiàn)indBugs、SpotBugs、ErrorProne 等等，筆者使用的IDEA自帶的代碼分析器。

打開方法：Settings -> Inspections -> 搜索nullability，勾選相關(guān)選項。 對于新項目，建議盡量都勾選上，同時提示類型為warning及以上。以后遇到相關(guān)空指針報警時，可以快速定位問題。

以下列舉一些優(yōu)秀的代碼規(guī)范：

1.如果方法返回對象可能為空，使用Optional封裝。

對應(yīng)了IDEA代碼中Probable Bugs => Nullability problems => Return of 'null' 稍差一點的方法是使用注解（NonNull）標(biāo)注。這種方式的優(yōu)點是強制方法調(diào)用者檢查。如果調(diào)用者確認對象存在，可以強制獲取對象opt.orElseThrow(),如果不確定返回結(jié)果是否存在，可以使用Optonal提供的方法進行鏈?zhǔn)教幚?，不能進行鏈?zhǔn)教幚淼?，可以調(diào)用orElse(null)，進行空校驗。

值得一提的是，如var userOpt = repo.getUser(userId);獲取user后，再調(diào)用orElse(null),看似多此一舉，實則已經(jīng)提示開發(fā)需要進行判空。雖然其與方法直接返回null,再進行空判斷的邏輯一致。

Optional難以進行鏈?zhǔn)教幚淼那闆r大多為兩種：一是多種變量進行運算，二是需要提前返回結(jié)果（衛(wèi)模式）。

2.實際代碼開發(fā)中，對于常用獲取操作，還可以封裝成新方法。

getCheckedUser(userId) -> @NonNull User

當(dāng)user不存在時，會拋出業(yè)務(wù)異常BusinessException("用戶不存在") 存在則返回非空對象

3.不要在方法參數(shù)中允許傳空

可以為空的參數(shù)可以通過枚舉、拆分出多個方法、使用方法參數(shù)對象實現(xiàn)。

方法參數(shù)中傳空指針會讓代碼難以理解。 比如repo.getUser(null);

這里傳空可以返回空，或者返回所有用戶。如果方法沒有在注釋或文檔中標(biāo)明，調(diào)用者需要閱讀方法的具體實現(xiàn)，違背了封裝的原則。

這里最簡單的改造方法是新增方法getAllUsers(), 同時原方法禁止傳空。

4.使用Nullability相關(guān)注解

目前空指針相關(guān)注解并沒有統(tǒng)一的標(biāo)準(zhǔn)，各家都有各自的實現(xiàn)，不過很多實際上大同小異，幾乎所有的注解IDEA都可以分析（一般就@Nullable和@NonNull兩種）。

使用方法非常簡單，對于方法返回值、參數(shù)、字段，如果可為空，就標(biāo)注@Nullable。

我推薦使用JSpecify,當(dāng)前該項目試圖提供統(tǒng)一的空指針注解方案，雖然目前還沒有定論，不過其提供的注解足夠滿足當(dāng)前的代碼需要。

其支持一些邊界條件，比如其注解支持泛型參數(shù)標(biāo)注，提供默認非空范圍標(biāo)注@NullMarked（Guava中使用@ElementTypesAreNonnullByDefault）。

對于復(fù)雜的情況可以參考其規(guī)范：jspecify.dev/docs/spec

這里不想討論過多的邊界情況，僅舉一例：

對象的某個屬性在初始化前為空，初始化后不為空，如何標(biāo)注？這個屬性可以標(biāo)注為@Nullable，不過更好的解決方法是標(biāo)注非空+注釋，同時在報警的位置@SuppressWarning。

public class Demo {

    @SuppressWarnings("NotNullFieldNotInitialized")
    @NonNull
    @Getter
    private String serviceName;

    public void init() {
        serviceName = "demoService";
    }
}

快速失?。╢ail-fast）

快速失敗在這里指的是：如果對象需要不為空，就提前在代碼中明確；而不是在用到的時候才發(fā)現(xiàn)原來不能為空的對象是空指針。

大多數(shù)NPE都是上面這種場景，發(fā)生NPE后，排查代碼時，從堆棧一步一步地往后找，最終可以找到問題的源頭可能就是原本被認為不能為空的對象實際是空指針。

對外暴露的代碼如果不進行快速失敗處理，調(diào)用者就會覺得可能是原方法的問題，比如：

遠程調(diào)用userService#getUser(userId)，傳入?yún)?shù)為null, 這時被調(diào)用方報空指針異常,這個問題的源頭應(yīng)該由被調(diào)用方負責(zé)；正確的返回結(jié)果應(yīng)該是報錯'傳入userId不能為空'或者返回null。

Guava中提供了Preconditions類，包含以下3個非常有用的方法： checkNotNull, checkState, checkArgument。

標(biāo)準(zhǔn)庫也緊隨其后，在Objects類中，常用的方法為：

requireNonNull（IDEA中快捷鍵var.req）, requireNonNullElse, requireNonNullElseGet.

后兩個方法可以用來賦初值或默認值。

Validator規(guī)范常常用于對象字段校驗，@NotNull 可以用于空指針校驗，這里不贅述。

從Spring中隨便拉取一個構(gòu)造器方法，其便使用了快速失敗方法：

public PropertyValue(PropertyValue original, @Nullable Object newValue) {
    Assert.notNull(original, "Original must not be null");
    this.name = original.getName();
    this.value = newValue;
    this.optional = original.isOptional();
    this.conversionNecessary = original.conversionNecessary;
    this.resolvedTokens = original.resolvedTokens;
    setSource(original);
    copyAttributesFrom(original);
}

再舉一例，代碼中常常需要手動實現(xiàn)類似數(shù)據(jù)庫的join操作，此時需要創(chuàng)建索引map, map.get方法返回值可能為空，我們確定不為空,就可以代碼確認。這樣在測試時，出現(xiàn)問題時可以快速定位。

修改后代碼如下

class JoinDemo {
    public static List<UserRoleDTO> toDTOs(List<User> users, List<Role> roles, List<UserRoleRelation> relations) {
        var roleIdsByUserId = relations.stream().collect(
                toImmutableSetMultimap(r -> r.userId(), r -> r.roleId()));
        var roleMap = Maps.uniqueIndex(roles, Role::id);
        return users.stream()
                .map(u -> {
                    var roleNames = roleIdsByUserId.get(u.id()).stream()
                            .map(roleMap::get)
                            .map(r -> Objects.requireNonNull(r).name())
                            .toList();
                    return UserRoleDTO.builder()
                            .userId(u.id())
                            .userName(u.name())
                            .roles(roleNames)
                            .build();
                })
                .toList();
    }
}

@Builder
record UserRoleDTO(Long userId, String userName, List<String> roles) {}

record User(Long id, String name) {}

record UserRoleRelation(Long userId, Long roleId) {}

record Role(Long id, String name) {}

兼容null

一般來說null表示沒有或者空對象，我們可以在代碼中兼容null, 從而避免程序的崩潰，提升健壯性。 常見的null安全方法如：
CollectionUtils.isEmpty, StringUtils.isBlank, ListUtils.emptyIfNull, Strings.nullToEmpty... 對于不受信任的代碼，安全起見，可以使用兼容方法（防御性編程）。

代碼中最常見的POJO對象，方法如果返回集合對象，可以返回空集合，這樣調(diào)用者可以直接在返回對象上調(diào)用方法，形成鏈?zhǔn)秸{(diào)用提高可讀性。

類似地可以推廣到空對象模式，字符串的空對象為'',基本類型的空對象可以用Optional封裝，這樣自由組合成任意的空對象?？諏ο罂梢圆粸閱卫侠械挠脩艚巧珜ο?，空對象可以為（userId: 1, userName: '樺說', roles: []）,表示用戶沒有任何角色。

此處的對象不僅僅指的是具體的對象，還可以是比較抽象的責(zé)任鏈、服務(wù)注冊模式中的兜底對象，單元測試中的空實現(xiàn)對象（Mock對象）等。

減少使用 null

很多情況下null可以不存在。

如果沒有IDE的支持，我們甚至不知道null的名字，是的，大多數(shù)時候我們不會給不變的null變量（如val user）起名字。

比如當(dāng)新建一個數(shù)據(jù)庫對象，然后插入數(shù)據(jù)庫，方法調(diào)用如下：

var newUser = new UserPO(null, userName, null, null, 'admin');
userRepo.insert(newUser);

這是第一個null表示id, 第二個表示用戶類型（可以為空，表示普通用戶），第三個表示創(chuàng)建時間，空表示使用數(shù)據(jù)插入時間。
這個例子恰好說明了null降低了代碼的可讀性，甚至可維護性。

可以使用builder模式解決這個問題，

var newUser = UserPO.builder()
    .userName(userName)
    .operator('admin')
    .build();
userRepo.insert(newUser);  

同理，方法的調(diào)用除了拆解方法功能，還可以提取方法參數(shù)（ParameterObject）對象實現(xiàn)排除null的使用。

黑魔法：使用lombok.NonNull

lombok中@NonNull注解提供了以上所述的靜態(tài)代碼檢查、運行時快速失敗功能，可以標(biāo)注在方法參數(shù)、對象字段上。如果對于lombok的具體實現(xiàn)不清楚，可以直接查看 build 的代碼或者使用IDEA的delombok功能。

標(biāo)注在對象字段上時，生成的代碼可以作用在setter方法、構(gòu)造器上：

@Data
class NonNullDemo{
    @lombok.NonNull
    private String name;
}

生成的代碼：

class NonNullDemo {
    private @NonNull String name;

    public NonNullDemo(final @NonNull String name) {
        if (name == null) {
            throw new NullPointerException("name is marked non-null but is null");
        } else {
            this.name = name;
        }
    }

    public @NonNull String getName() {
        return this.name;
    }

    public void setName(final @NonNull String name) {
        if (name == null) {
            throw new NullPointerException("name is marked non-null but is null");
        } else {
            this.name = name;
        }
    }
}

總之，通過以上方法可以極大地降低空指針發(fā)生的概率。

到此這篇關(guān)于一文詳解Java如何系統(tǒng)地避免空指針問題的文章就介紹到這了,更多相關(guān)Java空指針內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

最新評論