前言

在工作中我們經(jīng)常需要將功能模塊封裝成庫(kù)供合作廠商調(diào)用， 如何寫(xiě)好一個(gè)健壯的Android Library有很多講究，使用注解可以對(duì)SDK暴露給開(kāi)發(fā)者的接口做出一些限制，從而盡可能地避免開(kāi)發(fā)者錯(cuò)誤地使用API。 下面我們介紹幾種封裝SDK時(shí)常用到的注解，需要的朋友們可以參考學(xué)習(xí)。

一、IntDef與StringDef

我們有時(shí)候會(huì)使用int常量或者String常量來(lái)代替枚舉， 特別在你編寫(xiě)SDK的時(shí)候，你可以通過(guò)IntDef或者StringDef來(lái)限制接口可接受的參數(shù)。

比如，有一個(gè) disableChannel的接口，用來(lái)關(guān)閉指定的channel 。 我們可以先定義自己的注解@RequirePayChannel

public static final int CHANNEL_UNIONPAY = 0x11000;
public static final int CHANNEL_ALIPAY = 0x12000;
public static final int CHANNEL_WECHAT = 0x13000;
@Retention(RetentionPolicy.SOURCE)
@IntDef({CHANNEL_UNIONPAY,CHANNEL_ALIPAY,CHANNEL_WECHAT})
public @interface RequirePayChannel {}

這樣，你便可以通過(guò)@RequirePayChannel來(lái)指定disableChannel()的可接受參數(shù)

public void enableChannel(@RequirePayChannel int channel) {
 // do something
}

這樣，一些IDE還會(huì)自動(dòng)提供給你建議參數(shù)。如果填入指點(diǎn)范圍之外的參數(shù)，將會(huì)出現(xiàn)錯(cuò)誤提示并無(wú)法編譯通過(guò)。

值得一說(shuō)的是， 在這里，我們使用到了@Retention(RetentionPolicy.SOURCE) 。 它指定了編譯器在處理Animation時(shí)候的處理方法。 默認(rèn)編譯器會(huì)將常量替換成對(duì)應(yīng)的數(shù)值，如果沒(méi)指定該注解，你編譯完成后將得到這樣的class文件:

這樣會(huì)導(dǎo)致IDE不能提示到有意義的信息。并且一定要指定為特定的int數(shù)值，否則也無(wú)法編譯通過(guò)。

所以，應(yīng)該指定Retention讓編譯器不對(duì)該注解做額外的優(yōu)化處理。

二、DrawableRes, StringRes 與 DimenRes

當(dāng)我們?cè)诰帉?xiě)指定資源文件的接口時(shí)，可以通過(guò)資源注解來(lái)指定該方法接受的資源類型。 指定錯(cuò)誤的資源將不能編譯通過(guò)。 下面代碼中，我們使用@DrawableRes來(lái)表明setLogo方法只支持Drawable資源的ID。

public void setLogo(@DrawableRes int resurceId) {
 // do something
}

當(dāng)我們提供錯(cuò)誤的資源，IDE將會(huì)報(bào)錯(cuò)。

@StringRes 與 @DimenRes 的使用方法也類似。

三、NonNull 與 Nullable

將一個(gè)空值傳入一個(gè)方法中可能引發(fā)潛在的Crash。 我們應(yīng)該極力避免這種情況， @NonNull 可以指定參數(shù)是否接受空值，當(dāng)我們傳入一個(gè)空值的時(shí)候，IDE會(huì)給出響應(yīng)的警告。 我們可以這樣使用它：

public void setContext(@NonNull Context context) {
 // do something
}

當(dāng)我們對(duì)其傳入一個(gè)空值的時(shí)候，將會(huì)顯示警告（但代碼仍然能通過(guò)編譯）

@Nullable 用于修飾參數(shù)或者方法的返回值可能為空，提醒開(kāi)發(fā)者主要空值檢查。

@Nullable
public Context getContext() {return null;}

總結(jié)

以上就是這篇文章的全部?jī)?nèi)容了，希望本文的內(nèi)容對(duì)大家的學(xué)習(xí)或者工作能帶來(lái)一定的幫助，如果有疑問(wèn)大家可以留言交流，謝謝大家對(duì)腳本之家的支持。

最新評(píng)論