在 Java 中，null 是一個(gè)表示“空值”的特殊值。相信大家都很了解 null 在 Java 中的作用，但是在開發(fā)過(guò)程中我們通常會(huì)遇到 null 相關(guān)的錯(cuò)誤。為了避免這些錯(cuò)誤，Java 引入了一系列和 null 相關(guān)的注解，讓我們更好地解決和預(yù)防 null 相關(guān)的錯(cuò)誤。

1. @Nullable

@Nullable 注解，它位于 javax.annotation 包中。該注解用于標(biāo)注變量、參數(shù)、函數(shù)返回值等可以為 null 的情況。通常，這個(gè)注解被用于“可空”的情況下，以聲明我們需要避免 null 指針錯(cuò)誤，同時(shí)也為 IDE 和靜態(tài)分析器提供更豐富的信息。通過(guò)使用 @Nullable，我們可以更加準(zhǔn)確地描述代碼的含義，提高代碼的可讀性和可維護(hù)性。同時(shí)，它也能夠幫助開發(fā)者在編譯期間發(fā)現(xiàn)潛在的問(wèn)題，從而提高代碼的質(zhì)量和穩(wěn)定性。

@Nullable 使用示例：

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

注意：@Nullable 注解不能保護(hù)可能發(fā)生 NullPointerException 的代碼，它只提供了有關(guān)代碼的信息并幫助表明它們的用途。因此，在使用時(shí)，僅僅使用 @Nullable 注解是不夠的，我們還需要編寫代碼來(lái)判斷變量是否為 null，并在需要時(shí)進(jìn)行處理。

2. @NonNull

@NonNull 是定義在 javax.annotation 包下的注解，它用于標(biāo)注：

• 當(dāng)方法調(diào)用完成后，被注釋的返回值不能為空，如果為空將拋出 NullPointerException。
• 參數(shù)或字段即使你寫了 null，它也不能為 null。如果為 null 就會(huì)拋出 NullPointerException。

使用 @NonNull 可以幫助我們編寫更安全和更可靠的代碼，強(qiáng)制約束對(duì)應(yīng)的變量、參數(shù)和返回類型，防止空指針異常，并提供更有利的代碼提示。@NonNull 有點(diǎn)像編寫編譯時(shí)代碼時(shí)的斷言，因此這對(duì)于保證代碼正確性非常重要。

@NonNull 使用示例：

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

注意：如果使用了 @NonNull 注解，則程序在有參數(shù)為 null 時(shí)會(huì)報(bào) NullPointerException 異常。

3. @NotNull

@NotNull 是定義在 org.jetbrains.annotations 包下的注解，它主要用于增加安全性和可讀性。與 @Nullable 和 @NonNull 類似，@NotNull 也是一種用于檢查 null 的注解，提醒我們必須將這個(gè)參數(shù)設(shè)置為非 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 注解在參數(shù)或返回值為 null 時(shí)，拋出的是 IllegalArgumentException 異常。

4. @NullableDecl

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

@NullableDecl 使用示例：

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

注意：當(dāng)返回類型為 null 時(shí)，可以使用 @NullableDecl 注解進(jìn)行標(biāo)注，然后可以通過(guò) IDE 和靜態(tài)分析器進(jìn)行分析。

5. @NonNullApi

@NonNullApi 注解，它定義在 org.eclipse.jdt.annotation 包下。該注解可以用于注解包、類、構(gòu)造函數(shù)、方法和屬性。它的主要作用是指示被注解的元素是一個(gè)不允許參數(shù)、成員或返回值為 null 的 API。這意味著使用該 API 的代碼必須確保在運(yùn)行時(shí)不會(huì)出現(xiàn) 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 注解應(yīng)該添加在每個(gè)支持此 Api 的類上，如果省略了 @NonNullApi 注解，意味著這個(gè) API 不支持強(qiáng)制使用 @NonNull 注解。

6. @NullableApi

@NullableApi 是定義在 org.eclipse.jdt.annotation 包下的注解，與 @NonNullApi 類似，它主要用于注解一個(gè)包、類、構(gòu)造函數(shù)、方法、屬性，它表示該元素是支持為 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 注解意味著參數(shù)、返回類型、字段可以為 null，并且 API 支持使用 @Nullable 注解進(jìn)行標(biāo)注。

7. @SuppressWarnings(“nullness”)

@SuppressWarnings(“nullness”) 注解可用于禁用 nullness 檢查器，從而允許我們忽略在特定位置的 null 檢查。這種注解可以提高代碼的靈活性，允許我們?cè)谛枰獣r(shí)繞過(guò) null 檢查，同時(shí)仍然保持代碼的可讀性和可維護(hù)性。此外，使用該注解還可以幫助我們更好地理解代碼中的 null 值的處理方式，從而更好地優(yōu)化代碼的性能和可靠性。

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

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

注意：@SuppressWarnings(“nullness”) 注解應(yīng)謹(jǐn)慎使用，我們不應(yīng)該盲目地使用它，應(yīng)該僅在必要時(shí)使用。

到此這篇關(guān)于Java中null相關(guān)注解的實(shí)現(xiàn)的文章就介紹到這了,更多相關(guān)Java中null注解內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

最新評(píng)論