注解的運用

舉一個例子,日常開發(fā)中常有這樣的需求:
后臺接口自定義返回碼,通常有code=200,201,202等等..
一般情況有這么幾種做法:
1.定義常量
public static final int SUCCESS = 200;
public static final int FAIL = 201;
根據不用的情形,指定錯誤類型,比如200代表成功,201代表失敗等..
是最常見方法

    private int test1() {
        switch ("value") {
            case "成功":
                return SUCCESS;
            case "失敗":
                return FAIL;
        }
    }

但是int型的常量也是int,假如這樣寫:

    private int test1() {
        switch ("value") {
            case "成功":
                return SUCCESS;
            case "失敗":
                return FAIL;
            case "空指針":
                return 500;
        }
    }

直接寫500,依然可以正常編譯運行。但是在某些具體的情形,這樣的代碼并不好維護,容易出現類型安全的問題。
2.使用枚舉

    private State test2() {
        switch ("value") {
            case "成功":
                return State.SUCCESS;
            case "失敗":
                return State.FAIL;
            default:
                return State.FAIL;
        }
    }

看是很完美,但是枚舉類型是很占用內存的,每個枚舉類型相當于一個單例對象
3.使用注解
Android源碼中帶有很多常見的注解的使用,support-annotations 是通過靜態(tài)編譯檢測來提高代碼質量的
一個注解工具
eg:@LayoutRes資源注解

@Documented
@Retention(CLASS)
@Target({METHOD, PARAMETER, FIELD, LOCAL_VARIABLE})
public @interface LayoutRes {
}

限定被注解的屬性必須是layout布局資源,可以作用于方法、變量等,該資源以int的形式存儲在Android系統之中,
使用方法如下:

    public BottomDialog setLayoutRes(@LayoutRes int layoutRes) {
       mLayoutRes = layoutRes;
       return this;
    }

setLayoutRes方法必須使用int類型的資源文件,如果傳“1”,“2”,“23224234”或者任何一個int類型的參數,則會提出異常警告。

了解一下注解
注解(也稱元數據),為我們在代碼中添加信息提供一種形式化的方法,使我們可以在稍后的某個時刻
非常方便的使用這些數據。就像注釋是給人看的,注解是給機器“看的”。
1.注解的作用
注解可以作用于類、方法、變量、等
a,更加干凈易讀的代碼
b.編譯期類型檢查
2.基本語法

@Target
@Retention
public @interface 注解名稱{
    屬性列表;
}

3.用法
定義-使用-執(zhí)行
eg:

public class Demo1 {

    @Test1(getName = "cat")
    private void get1() {
    }
    
    @Target(ElementType.METHOD)
    @Retention(RetentionPolicy.CLASS)
    @interface Test1 {
        String getName();
    }
}

Target限定所能作用的位置,可以作用于類、方法、成員變量等等..
Retention:
SOURCE: 源碼注解,編譯成.class文件后注解就不存在,用來提示開發(fā)者
CLASS: CLASS匯編注解,編譯成.class文件后注解也還存在,但是JVM在加載類的時候不需要將其加載為
運行時可見的(反射可見)的注解,用于自動生成代碼
RUNTIME: 運行時動態(tài)注解,在編譯過程中保留,會寫入Class文件,并且JVM加載類的時候也會將其加載為
反射可見的注解,生命周期一直程序運行時都存在,常用于自動注入

回到上面的例子
根據注解的機制和上面的例子,可以使用support-annotations包編寫自己的注解:

    @IntDef({ReturnCode.SUCCESS, ReturnCode.FAIL})
    @Target({ElementType.METHOD, ElementType.PARAMETER})
    @Retention(RetentionPolicy.SOURCE)
    @interface ReturnCode {
        int SUCCESS = 200;
        int FAIL = 201;
    }

    private void test() {
        InnerDemo innerDemo = new InnerDemo();
        innerDemo.t(200);//lint異常提醒
        innerDemo.t(ReturnCode.SUCCESS);
    }

    class InnerDemo {
        private void t(@ReturnCode int da) {

        }
    }
最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
【社區(qū)內容提示】社區(qū)部分內容疑似由AI輔助生成,瀏覽時請結合常識與多方信息審慎甄別。
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發(fā)布,文章內容僅代表作者本人觀點,簡書系信息發(fā)布平臺,僅提供信息存儲服務。

友情鏈接更多精彩內容