相關閱讀:
[乾貨]2017已來,最全面試總結——這些Android面試題你一定需要
關注回覆:Android,iOS,PHP,js,HTML5,Python,機器學習 ,AI,大數據,Hadoop,c++,J2EE等關鍵字就能免費獲取學習資料視頻
前言:使用Support Annotations註解優化代碼
本片文章講解怎麼使用Support Annotations註解優化代碼,比如使用 android特有的魔術變量註解替代Enum等功能。不要看見使用註解就想到反射會影響性能之類,今天我們就來學習一下Android Support Annotations註解來優化我們的代碼,增加可讀性的同時,也讓讓更多的錯誤消滅在萌芽之中。
Support Annotations 簡介:
Android support library 不斷地引入新的註解庫,它包含很多有用的元註解,你能用它們修飾你的代碼,幫助你發現bug。Support library 自己本身也用到了這些註解,所以作爲 support library 的用戶,Android Studio已經基於這些註解校驗了你的代碼並且標註其中潛在的問題。
Support Annotations 如何引入:
註解默認是沒有包含的;它被包裝成一個獨立的庫,如果使用了appcompat庫,那麼 Support Annotations 就會自動引入進來,因爲 appcompat 使用了 Support Annotations,如果沒有則需要在 build.gradle 中添加如下配置:
dependencies {
compile 'com.android.support:support-annotations:23.4.0'
}
如果你已經引入了 appcompat v7 則可能就沒有必要再次引用 support-annotations ,因爲 appcompat 默認包含了對其引用。
Support Annotations分類:
Typedef 註解:IntDef / StringDef (Android特有的魔術變量註解替代Enum)
Enum in Android 枚舉Enum在java中是一個完整的類. 而枚舉中的每一個值在枚舉類中都是一個對象. 所以在我們使用時枚舉的值將比整數常量消耗更多的內存. 當我們使用枚舉在安卓應用中, 如果我們的程序本身內存消耗就比較大,或者是一個遊戲的應用程序. 那麼我們最好使用常量來替代枚舉。可是使用了常量代替後又不能限制取值了。那有什麼好的辦法呢?
當然, Android 支持註解庫中有一些好用的annotation helper 我們可以使用它們來解決我們之前的問題(在編譯代碼時期).
IntDef和StringDef 是兩個魔術變量註解. 使用這個兩個來替代之前使用的Enum. 它將幫助我們在編譯代碼時期像Enum那樣選擇變量的功能。 @IntDef和”typedef”作用非常類似,你可以創建另外一個註解,然後用@IntDef指定一個你期望的整型常量值列表,最後你就可以用這個定義好的註解修飾你的API了。接下來我們來使用IntDef來替換Enum看一下.
public class MainActivity extends Activity {
public static final int SUNDAY = 0;
public static final int MONDAY = 1;
{...省略部分}
@IntDef({SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY})
@Retention(RetentionPolicy.SOURCE)
public @interface WeekDays {
}
@WeekDays
int currentDay = SUNDAY;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
setCurrentDay(WEDNESDAY);
@WeekDays int today = getCurrentDay();
switch (today) {
case SUNDAY:
break;
case MONDAY:
break;
{...省略部分}
default:
break;
}
}
/**
* 參數只能傳入在聲明範圍內的整型,不然編譯通不過
* @param currentDay
*/
public void setCurrentDay(@WeekDays int currentDay) {
this.currentDay = currentDay;
}
@WeekDays
public int getCurrentDay() {
return currentDay;
}
}
說明:
聲明一些必要的 int 常量
聲明一個註解爲 WeekDays
使用 @IntDef 修飾 WeekDays,參數設置爲待枚舉的集合
使用 @Retention(RetentionPolicy.SOURCE) 指定註解僅存在與源碼中,不加入到 class 文件中
需要在調用時只能傳入指定類型,如果傳入類型不對,編譯不通過。
我們也可以指定整型值作爲標誌位,也就是說這些整型值可以使用 ’|’ 或者 ’&’ 進行與或等操作。如果我們把@Flavour定義爲如下標誌位:
@IntDef(flag = true, value = {SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY})
public @interface Flavour {
}
那麼可以如下調用:
setCurrentDay(SUNDAY & WEDNESDAY);
@StringDef用法和@IntDef基本差不多,只不過是針對String類型而已。
怎麼樣?使用起來還是很簡單的吧。如果你只是衝做標題 尋求一種替代Enum的方式 進來的話,看到這你就可以直接跳到文章結尾 點個喜歡 離開了。如果你還想知道更多關於註解的強大功能,那麼就接着看下面的內容吧!
Nullness註解
@Nullable註解可以用來標識特定的參數或者返回值可以爲null。
@NonNull註解可以用來標識參數不能爲null。
Resource Type 註解
資源在Android中作爲整型值來傳遞。這意味着希望獲取一個drawable作爲參數的代碼很容易被傳遞了一個string類型的資源,因爲他們資源id都是整型的,編譯器很難區分。Resource Type註解在這種條件下可以提供類型檢查,例如:
如果類型指定錯誤,編譯不會通過。
常見的Resource Type註解,使用方式都是指定一個integer的參數、成員變量、或者方法,檢查對應的資源類型。
-
AnimatorRes :animator資源類型
-
AnimRes:anim資源類型
-
AnyRes:任意資源類型
-
ArrayRes:array資源類型
-
AttrRes:attr資源類型
-
BoolRes:boolean資源類型
-
ColorRes:color資源類型
-
DimenRes:dimen資源類型。
-
DrawableRes:drawable資源類型。
-
FractionRes:fraction資源類型
-
IdRes:id資源類型
-
IntegerRes:integer資源類型
-
InterpolatorRes:interpolator資源類型
-
LayoutRes:layout資源類型
-
MenuRes:menu資源類型
-
PluralsRes:plurals資源類型
-
RawRes:raw資源類型
-
StringRes:string資源類型
-
StyleableRes:styleable資源類型
-
StyleRes:style資源類型
-
TransitionRes:transition資源類型
-
XmlRes:xml資源類型
以上基本上包括了所有的資源類型,但是有時需要通過RGB顏色整型來設置顏色值,在這種情況下,你可以使用 @ColorInt 註解,表示你期望的是一個代表顏色的整數值,如果使用不對同樣也是編譯不通過
Threading 註解
比如我們在項目中處理比較耗時的操作,需要制定在工作子線程中執行,可以使用Threading 註解,如果沒有在制定的線程中執行也是編譯不過的
幾種Threading註解
-
@UiThread UI線程
-
@MainThread 主線程
-
@WorkerThread 子線程
-
@BinderThread 綁定線程
Value Constraints 註解:@Size, @IntRange, @FloatRange
在實際開發過程中,我們有時可能需要設置一個取值範圍,這時我們可以使用取值範圍註解來約束。
比如我們設置一個百分比,取值範圍爲0-100,
對於數據、集合以及字符串,你可以用@Size註解參數來限定集合的大小(當參數是字符串的時候,可以限定字符串的長度)。
舉幾個例子
-
集合不能爲空: @Size(min=1)
-
字符串最大只能有23個字符: @Size(max=23)
-
數組只能有2個元素: @Size(2)
-
數組的大小必須是2的倍數 (例如圖形API中獲取位置的x/y座標數組: @Size(multiple=2)
Permissions 註解: @RequiresPermission
有時我們的方法調用需要調用者擁有指定的權限,這時我們可以使用
@RequiresPermission註解,
@RequiresPermission(Manifest.permission.SET_WALLPAPER)
public abstract void setWallpaper(Bitmap bitmap) throws IOException;
除了上面的單一使用方式,官方同時也給出瞭如下幾種使用場景
(1)如果你至少需要權限集合中的一個,你可以使用anyOf屬性
@RequiresPermission(anyOf = {
Manifest.permission.ACCESS_COARSE_LOCATION,
Manifest.permission.ACCESS_FINE_LOCATION})
public abstract Location getLastKnownLocation(String provider);
(2)如果你同時需要多個權限,你可以用allOf屬性
@RequiresPermission(allOf = {
Manifest.permission.READ_HISTORY_BOOKMARKS,
Manifest.permission.WRITE_HISTORY_BOOKMARKS})
public static final void updateVisitedHistory(ContentResolver cr, String url, boolean real) ;
(3)對於intents的權限,可以直接在定義的intent常量字符串字段上標註權限需求(他們通常都已經被@SdkConstant註解標註過了)
@RequiresPermission(android.Manifest.permission.BLUETOOTH)
public static final String ACTION_REQUEST_DISCOVERABLE =
"android.bluetooth.adapter.action.REQUEST_DISCOVERABLE";
(4)對於content providers的權限,你可能需要單獨的標註讀和寫的權限訪問,所以可以用@Read或者@Write標註每一個權限需求
@RequiresPermission.Read(@RequiresPermission(READ_HISTORY_BOOKMARKS))
@RequiresPermission.Write(@RequiresPermission(WRITE_HISTORY_BOOKMARKS))
public static final Uri BOOKMARKS_URI = Uri.parse("content://browser/bookmarks");
Overriding Methods 註解: @CallSuper
如果你的API允許使用者重寫你的方法,但是呢,你又需要你自己的方法(父方法)在重寫的時候也被調用,這時候你可以使用@CallSuper標註
例如:Activity的onCreate函數
@CallSuper
protected void onCreate(@Nullable Bundle savedInstanceState)
用了這個後,當重寫的方法沒有調用父方法時,工具就會給予標記提示
Return Values註解: @CheckResult
如果你的方法返回一個值,你期望調用者用這個值做些事情,那麼你可以使用 @CheckResult 註解標註這個方法。
這個在具體使用中用的比較少,除非特殊情況,比如在項目中對一個數據進行處理,這個處理比較耗時,我們希望調用該函數的調用者在不需要處理結果的時候,提示沒有使用,酌情刪除調用。
Keep 註解
Keep:指出一個方法在被混淆的時候應該被保留。
在Android編譯生成APK的環節,我們通常需要設置minifyEnabled爲true實現下面的兩個效果:
-
混淆代碼
-
刪除沒有用的代碼
但是出於某一些目的,我們需要不混淆某部分代碼或者不刪除某處代碼,除了配置複雜的Proguard文件之外,我們還可以使用@Keep註解.
@Keep
public static int getBitmapWidth(Bitmap bitmap) {
return bitmap.getWidth();
}
其他註解
VisibleForTesting:可註解一個類,方法,或變量,表示有更寬鬆的可見性,這樣它能夠有更寬泛的可見性,使代碼可以被測試。
IntelliJ註解
IntelliJ ,Android Studio 就是基於它開發的, IntelliJ 有一套它自己的註解; IntDef 分析其實重用的是 MagicConstant 分析的代碼,IntelliJ null 分析其實用的是一組配置好的 null 註解。如果你執行 Analyze > Infer Nullity…,它會試圖找出所有的 null 約束並添加他們。這個檢查有時會插入 IntelliJ 註解。你可以通過搜索,替換爲 Android 註解庫的註解,或者你也可以直接用 IntelliJ 註解。在 build.gradle 裏或者通過 Project Structure 對話框的 Dependencies 面板都可以添加如下依賴:
dependencies {
compile 'com.intellij:annotations:12.0'
}
結尾
經過查閱資料和博客,系統了學習和總結了關於Support Annotations註解的內容,在編碼中通過使用Support Annotations可以提高代碼可讀性,同時可以在類加載時就可以檢查一些錯誤,同時不會對性能有任何影響,因爲Support Annotations中的註解的生命週期全部是RetentionPolicy.class。在以後的編碼中大家可以嘗試用用。
Java和Android大牛頻道
歡迎關注我們,一起討論技術,掃描和長按下方的二維碼可快速關注我們。或搜索微信公衆號:JANiubility。
公衆號:JANiubility