本文將介紹java 8的第二個特性:類型註解。
註解大家都知道,從java5開始加入這一特性,發展到現在已然是遍地開花,在很多框架中得到了廣泛的使用,用來簡化程序中的配置。那充滿爭議的類型註解究竟是什麼?複雜還是便捷?
什麼是類型註解
在java 8之前,註解只能是在聲明的地方所使用,比如類,方法,屬性;java 8裏面,註解可以應用在任何地方,比如:
- 創建類實例
new @Interned MyObject();
- 類型映射
myString = (@NonNull String) str;
- implements 語句中
class UnmodifiableList<T> implements @Readonly List<@Readonly T> { ... };
- throw exception聲明
void monitorTemperature() throws @Critical TemperatureException { ... };
需要注意的是,類型註解只是語法而不是語義,並不會影響java的編譯時間,加載時間,以及運行時間,也就是說,編譯成class文件的時候並不包含類型註解。
類型註解的作用
先看看下面代碼:
Collections.emptyList().add("One");
int i=Integer.parseInt("hello");
System.console().readLine();
上面的代碼編譯是通過的,但運行是會分別報UnsupportedOperationException; NumberFormatException;NullPointerException異常,這些都是runtime error;
類型註解被用來支持在Java的程序中做強類型檢查。配合插件式的check framework,可以在編譯的時候檢測出runtime error,以提高代碼質量。這就是類型註解的作用了。
check framework
check framework是第三方工具,配合Java的類型註解效果就是1+1>2。它可以嵌入到javac編譯器裏面,可以配合ant和maven使用,也可以作爲eclipse插件。地址是http://types.cs.washington.edu/checker-framework/。
check framework可以找到類型註解出現的地方並檢查,舉個簡單的例子:
import checkers.nullness.quals.*;
public class GetStarted {
void sample() {
@NonNull Object ref = new Object();
}
}
使用javac編譯上面的類 :
javac -processor checkers.nullness.NullnessChecker GetStarted.java
編譯是通過,但如果修改成:
@NonNull Object ref = null;
再次編譯,則出現:
GetStarted.java:5: incompatible types.
found : @Nullable <nulltype>
required: @NonNull Object
@NonNull Object ref = null;
^
1 error
如果你不想使用類型註解檢測出來錯誤,則不需要processor,直接javac GetStarted.java是可以編譯通過的,這是在java 8 with Type Annotation Support版本里面可以,但java 5,6,7版本都不行,因爲javac編譯器不知道@NonNull是什麼東西,但check framework 有個向下兼容的解決方案,就是將類型註解nonnull用/**/註釋起來,比如上面例子修改爲:
import checkers.nullness.quals.*;
public class GetStarted {
void sample() {
/*@NonNull*/ Object ref = null;
}
}
這樣javac編譯器就會忽略掉註釋塊,但用check framework裏面的javac編譯器同樣能夠檢測出nonnull錯誤。
通過類型註解+check framework我們可以看到,現在runtime error可以在編譯時候就能找到。
關於JSR 308
JSR 308想要解決在Java 1.5註解中出現的兩個問題:
- 在句法上對註解的限制:只能把註解寫在聲明的地方。
- 類型系統在語義上的限制:類型系統還做不到預防所有的bug。
JSR 308 通過如下方法解決上述兩個問題:
- 對Java語言的句法進行擴充,允許註解出現在更多的位置上。包括:方法接收器(method receivers,譯註:例public in size() @Readonly { … }),泛型參數,數組,類型轉換,類型測試,對象創建,類型參數綁定,類繼承和throws子句。其實就是類型註解,現在是java 8的一個特性。
- 通過引入可插拔的類型系統(pluggable type systems)能夠創建功能更強大的註解處理器。類型檢查器對帶有類型限定註解的源碼進行分析,一旦發現不匹配等錯誤之處就會產生警告信息。其實就是check framework。
對JSR308,有人反對,覺得更復雜更靜態了,比如:
@NotEmpty List<@NonNull String> strings = new ArrayList<@NonNull String>()>;
換成動態語言爲:
var strings = ["one", "two"];
有人贊成,說到底,代碼纔是“最根本”的文檔。代碼中包含的註解清楚表明了代碼編寫者的意圖。當沒有及時更新或者有遺漏的時候,恰恰是註解中包含的意圖信息,最容易在其他文檔中被丟失。而且將運行時的錯誤轉到編譯階段,不但可以加速開發進程,還可以節省測試時檢查bug的時間。
總結
並不是人人都喜歡這個特性,特別是動態語言比較流行的今天,所幸,java 8並不強求大家使用這個特性,反對的人可以不使用這一特性,而對代碼質量有些要求比較高的人或公司可以採用JSR 308,畢竟代碼纔是“最基本”的文檔,這句話我是贊同的。雖然代碼會增多,但可以使你的代碼更具有表達意義。