Java中null相關註解的實現

Posted on by

在 Java 中，null 是一個表示“空值”的特殊值。相信大傢都很瞭解 null 在 Java 中的作用，但是在開發過程中我們通常會遇到 null 相關的錯誤。為瞭避免這些錯誤，Java 引入瞭一系列和 null 相關的註解，讓我們更好地解決和預防 null 相關的錯誤。

1. @Nullable

@Nullable 註解，它位於 javax.annotation 包中。該註解用於標註變量、參數、函數返回值等可以為 null 的情況。通常，這個註解被用於“可空”的情況下，以聲明我們需要避免 null 指針錯誤，同時也為 IDE 和靜態分析器提供更豐富的信息。通過使用 @Nullable，我們可以更加準確地描述代碼的含義，提高代碼的可讀性和可維護性。同時，它也能夠幫助開發者在編譯期間發現潛在的問題，從而提高代碼的質量和穩定性。

@Nullable 使用示例：

public static void doSomething(@Nullable String s) {
    if (s != null) {
        System.out.println(s);
    }
}

註意：@Nullable 註解不能保護可能發生 NullPointerException 的代碼，它隻提供瞭有關代碼的信息並幫助表明它們的用途。因此，在使用時，僅僅使用 @Nullable 註解是不夠的，我們還需要編寫代碼來判斷變量是否為 null，並在需要時進行處理。

2. @NonNull

@NonNull 是定義在 javax.annotation 包下的註解，它用於標註：

  • 當方法調用完成後，被註釋的返回值不能為空，如果為空將拋出 NullPointerException。
  • 參數或字段即使你寫瞭 null，它也不能為 null。如果為 null 就會拋出 NullPointerException。

使用 @NonNull 可以幫助我們編寫更安全和更可靠的代碼，強制約束對應的變量、參數和返回類型，防止空指針異常，並提供更有利的代碼提示。@NonNull 有點像編寫編譯時代碼時的斷言，因此這對於保證代碼正確性非常重要。

@NonNull 使用示例：

public static int add(@NonNull Integer a, @NonNull Integer b) {
    return a + b;
}

註意：如果使用瞭 @NonNull 註解，則程序在有參數為 null 時會報 NullPointerException 異常。

3. @NotNull

@NotNull 是定義在 org.jetbrains.annotations 包下的註解，它主要用於增加安全性和可讀性。與 @Nullable 和 @NonNull 類似，@NotNull 也是一種用於檢查 null 的註解，提醒我們必須將這個參數設置為非 null。

@NotNull 使用示例：

public static boolean contains(@NotNull String[] strArr, @NotNull String str) {
    for (String s : strArr) {
        if (s.equals(str)) {
            return true;
        }
    }
    return false;
}

註意：與 @NonNull 不同的是，使用 @NotNull 註解在參數或返回值為 null 時，拋出的是 IllegalArgumentException 異常。

4. @NullableDecl

@NullableDecl 是定義在 com.google.errorprone.annotations 包下的註解，它表示標註的類型可以為 null，或者為空。它通常用於返回值或字段，並且可以與 @NonNullApi 註解配合使用。

@NullableDecl 使用示例：

public @NullableDecl Object getObject() {
    return null;
}

註意：當返回類型為 null 時，可以使用 @NullableDecl 註解進行標註，然後可以通過 IDE 和靜態分析器進行分析。

5. @NonNullApi

@NonNullApi 註解，它定義在 org.eclipse.jdt.annotation 包下。該註解可以用於註解包、類、構造函數、方法和屬性。它的主要作用是指示被註解的元素是一個不允許參數、成員或返回值為 null 的 API。這意味著使用該 API 的代碼必須確保在運行時不會出現 null 值，從而提高代碼的健壯性和可靠性。

@NonNullApi 使用示例：

@NonNullApi
package com.example.demo;

//類中屬性前加上@NonNull註解
class User {
    @NonNull
    private Integer id;
    @NonNull
    private String name;
    
    public User(Integer id, String name) {
        this.id = Objects.requireNonNull(id);
        this.name = Objects.requireNonNull(name);
    }
    
    public Integer getId() {
        return id;
    }
    
    public String getName() {
        return name;
    }
}

註意：註意 @NonNullApi 註解應該添加在每個支持此 Api 的類上，如果省略瞭 @NonNullApi 註解，意味著這個 API 不支持強制使用 @NonNull 註解。

6. @NullableApi

@NullableApi 是定義在 org.eclipse.jdt.annotation 包下的註解，與 @NonNullApi 類似，它主要用於註解一個包、類、構造函數、方法、屬性，它表示該元素是支持為 null 的 API。

@NullableApi 使用示例：

@NullableApi
​​​​​​​package com.example.demo;

//類中屬性聲明可以為null
class User {
    @Nullable
    private String address;
    @Nullable
    private String phone;
    
    public User(String address, String phone) {
        this.address = address;
        this.phone = phone;
    }
    
    public void setAddress(@Nullable String address) {
        this.address = address;
    }
    
    public void setPhone(@Nullable String phone) {
        this.phone = phone;
    }
    
    public @Nullable String getAddress() {
        return address;
    }
    
    public @Nullable String getPhone() {
        return phone;
    }
}

註意：@NullableApi 註解意味著參數、返回類型、字段可以為 null，並且 API 支持使用 @Nullable 註解進行標註。

7. @SuppressWarnings(“nullness”)

@SuppressWarnings(“nullness”) 註解可用於禁用 nullness 檢查器，從而允許我們忽略在特定位置的 null 檢查。這種註解可以提高代碼的靈活性，允許我們在需要時繞過 null 檢查，同時仍然保持代碼的可讀性和可維護性。此外，使用該註解還可以幫助我們更好地理解代碼中的 null 值的處理方式，從而更好地優化代碼的性能和可靠性。

@SuppressWarnings(“nullness”) 使用示例：

@SuppressWarnings("nullness")
public boolean isEmpty(String str) {
    return str.length() == 0;
}

註意：@SuppressWarnings(“nullness”) 註解應謹慎使用，我們不應該盲目地使用它，應該僅在必要時使用。

到此這篇關於Java中null相關註解的實現的文章就介紹到這瞭,更多相關Java中null註解內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

推薦閱讀：