[譯]使用Android Support Annotations優化你的代碼

@author ASCE1885的 Github 簡書 微博 CSDN
原文鏈接

如果你還沒有聽說過Android Support Annotations 函數庫,你將錯過一個整潔的新軟件包,它有助于你捕獲程序中的bugs。該函數庫包含了許多的Java注解,用于幫助Android Studio檢測代碼中可能存在的錯誤,并報告給開發者。注解類型有很多種,本文將只介紹其中幾種,請一定要自己閱讀文檔以了解本文未介紹的其他注解類型。

@NONNULL / @NULLABLE

@NonNull和@Nullable可能是support annotations最基礎的也是最有用的注解之一了。使用這兩個注解修飾的函數參數或者函數,表示參數或者函數返回值是否可以為空,之后Android Studio在代碼可能出現不安全的情況下會給出智能提示。

使用注解前后對比如下:

未使用注解:

使用@NonNull注解:

更進一步,我們可以使用@CheckResult注解來讓使用者知道該函數的返回值是需要使用的,沒有使用函數的返回值則Android Studio會給出警告提示:

@STRINGRES / @DRAWABLERES等

你是否遇到過嘗試調用TextView的setText函數,結果出現如下異常:

android.content.res.Resources$NotFoundException: String resource ID #0x3039

當你給setText函數傳入一個整型值,TextView將它作為一個String資源id對待,并會進行查找以便設置這個字符串。如果存在一個可以標識整型值是非法ids的注解就好了,@StringRes正是用來實現這個功能的!

public void setText(@StringRes int id) {
  // Do something like getString(id), etc.
}

現在如果你試圖傳遞一個非字符串的資源id給這個函數,你將得到如下提示:

所有的資源類型都存在類似的注解,例如@DrawableRes, @ColorRes, @InterpolatorRes等等。

@KEEP

最近我發現一個新的support annotation注解@Keep。根據support annotations文檔說明,這個注解還沒有被關聯到Gradle插件中,被這個注解修飾的函數或者類,在代碼混淆進行壓縮時會被保持住。

如果你曾經在使用Proguard時使用過

-keep class com.foo.bar { public static <methods> }

你會知道當嘗試把某個特定的函數或者類從優化操作中排除掉是多么痛苦的事情。使用這個注解將會告訴Proguard不要對指定的函數或者類進行優化操作:

public class Example {
  @Keep
  public void doSomething() {
      // hopefully this method does something
  }
  ...
}

好消息是,如果你已經使用了appcompat-v7,那么support-annotations已經被包含在里面了,可以立刻開始使用它了。

歡迎關注我的微信公眾號

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 228,333評論 6 531
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 98,491評論 3 416
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 176,263評論 0 374
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 62,946評論 1 309
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 71,708評論 6 410
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 55,186評論 1 324
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,255評論 3 441
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,409評論 0 288
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 48,939評論 1 335
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 40,774評論 3 354
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 42,976評論 1 369
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,518評論 5 359
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,209評論 3 347
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,641評論 0 26
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,872評論 1 286
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 51,650評論 3 391
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 47,958評論 2 373

推薦閱讀更多精彩內容