這篇文章主要介紹了我賭你不清楚Spring中關於Null的這些事,文中通過示例代碼介紹的非常詳細,對大家的學習或者工作具有一定的參考學習價值,需要的朋友們下面隨着小編來一起學習學習吧
之前一直在某些代碼中看到過使用@Nullable 標註過的註釋,當時也沒有在意到底是什麼意思,之後忍不住去調查一番,這篇文章來談談Spring中關於Null的那些事。
在Java中不允許你使用類型表示其null的安全性,但Spring Framework 現在在org.sprinngframework.lang包提供以下注釋,以便聲明API和字段的可空性:
- @Nullable: 用於指定參數、返回值或者字段可以作爲null的註釋。
- @NonNull: 與上述註釋相反,表明指定參數、返回值或者字段不允許爲null。(不需要@NonNullApi和@NonNullFields適用的參數/返回值和字段)
- @NonNullApi: 包級別的註釋聲明非null作爲參數和返回值。
- @NonNullFields:包級別的註釋聲明字段默認非空
Spring Framework 本身利用了上面這幾個註釋,但它們也可以運用在任何基於Spring的Java 項目中,以聲明空安全api 和 空安全字段。尚未支持泛型和數組元素的可空性,但應該也會在後期版本中支持這倆。
Spring Null-Safety出現在Spring5中,讓我們更方便的編寫空安全的代碼,這叫做null-safety,null-safety不是讓我們逃脫不安全的代碼,而是在編譯時產生警告。 此類警告可以在運行時防止災難性空指針異常(NPE)。
@NonNull
@NonNull註釋是null-safety的所有註釋中最重要的一個,我們可以使用此註釋在期望對象引用的任何地方聲明非空約束:字段、方法參數或者方法返回值。
先來看一個例子
public class Student { private String name; public String getName() { return name; } public void setName(String name) { if(null != null && name.isEmpty()){ name = null; } this.name = name; } }
上述代碼對name的校驗是有效的,但是存在一個缺陷,如果name被設置爲null的話,那麼當我們使用name的時候,就會以NullPointerException來結尾。
使用@NonNull
Spring 的null-safety特性能夠允許idea或者eclipse報告這個潛在的威脅,例如,如果我們用IDEA對屬性加上@NonNull會出現如下的效果。
奇怪,並沒有什麼變化啊,沒看見有潛在的安全提示啊,那是因爲你沒有在idea進行設置。
設置安全檢查
如果你也沒有提示的話,可以通過如下的方式設置安全檢查:
如果還不好使的話,那就在右側 configuration annotations 添加一下 @NonNull和 @Nullable 所在的jar包,如下:
添加上,打上 ✅ 即可看到如下效果。
現在fullName 已經被@NonNull 註釋添加編譯器檢查null值的功能了!
測試一下,可以把@NonNull 註釋去掉,你的鼠標再放在fullName 上,就沒有這句提示了。
@NonNullFields
@NonNull 註解能夠幫助你確保null-safety。然而,如果此註釋直接裝飾所有的字段的話,就會污染整個代碼庫。
Spring提供了另外一個不允許爲null的註解 — @NonNullFields。這個註解適合用在包級別上,通知我們的開發工具註釋包中所有的字段,默認的,不允許爲null
新建一個Parent類,並在該類所屬包下創建一個名爲package-info.java的類,創建的不是Java類,而是創建的file,名爲package-info.java,如下
package-info.java
@NonNullFields package com.nullsafety.demo.pojo; import org.springframework.lang.NonNullFields;
新建一個Parent.java 類
public class Parent { private String son; private String age; private String name; public void setSon(String son) { if(son != null && son.isEmpty()){ son = null; } this.son = son; } public void setAge(String age) { if(age != null && age.isEmpty()){ age = null; } this.age = age; } public void setName(String name) { if(name != null && name.isEmpty()){ name = null; } this.name = name; } }
package-info.java 中的@NonNullFields能夠對Parent類中所有的屬性起作用,把鼠標放在任意一個屬性上,會出現編譯期檢查的提示
@Nullable
@NonNullFields註釋通常比@NonNull更好,因爲它有助於減少樣板。 但是,有時我們想要從包級別指定的非null約束中免除某些字段,這時候就會使用到@Nullable註解
改造一下Person.java,Person.java 與pack-info.java 處於同一包下
public class Person { @NonNull private String fullName; @Nullable private String nickName; public String getNickName() { return nickName; } public void setNickName(String nickName) { if(nickName != null && nickName.isEmpty()){ nickName = null; } this.nickName = nickName; } public String getFullName() { return fullName; } public void setFullName(String fullName) { if(fullName != null && fullName.isEmpty()){ fullName = null; } this.fullName = fullName; } }
在這種情況下,我們使用@Nullable註釋來覆蓋字段上@NonNullFields的語義。
@NonNullApi
@NonNullFields註釋僅適用於其名稱所示的字段。 如果我們想對方法的參數和返回值產生相同的影響,我們需要@NonNullApi。
添加 @NonNullApi和 @NonNullFields 在 configure annotations 中,並選用NonNullApi
與@NonNullFields一樣,我們需要在package-info.java 中定義@NonNullApi
package-info.java
@NonNullApi @NonNullFields package com.nullsafety.demo.pojo; import org.springframework.lang.NonNullApi; import org.springframework.lang.NonNullFields;
加上如下注釋後的效果如下: 可以在返回值的時候接受到編譯期的提示。
結語
看完文章,你至少應該瞭解@NonNull, @Nullable, @NonNullFields, @NonNullApi四個註解和各自的作用範圍以及如何設置編譯期的Null-safety檢查。
以上就是本文的全部內容,希望對大家的學習有所幫助,也希望大家多多支持神馬文庫。