第11章 注解

Annotation其實就是代碼里的特殊標記,可以在編譯,類加載,運行的時候被讀取,并執行相應的處理。在不改變原有邏輯的情況下,在源文件嵌入一些補充信息。一條重要原則:僅僅使用注解來標識程序元素,對程序不會造成任何影響,要讓注解起作用,必須為這些注解提供注解處理工具。

一、基本Annotation

  • @Override 只能修飾方法,強制子類必須覆蓋父類的方法
  • @Deprecated 表示某個程序元素(類、方法、接口等)已經過時,若其他程序使用該元素,將會給出警告
  • @SuppressWarnings 被修飾的程序元素取消顯示指定的警告,會同時作用于該程序元素下的所有的子元素

二、自定義Annotation

1、定義Annotation

定義新的Annotation,使用@interface關鍵字,與定義一個接口非常相似。所有的注解都繼承了Annotation接口。

public @interface Testable{
    
}

使用Annotation的語法,非常類似于public,final等修飾符(一般單獨放一行),通常用于修飾程序中的類 、接口、變量、方法等

public class MyClass {
    @Testable
    public void info() {

    }
}

Annotation中還可以帶成員變量,用無參數的方法來聲明。方法名定義了成員變量的名字,返回值定義了成員變量的類型。語法與定義接口的語法非常相似。若沒有定義默認值,則必須賦值。

public @interface Testable {
    String name();
    int age() default 19;//已經設置默認值,使用時可以不賦值
}
//使用
public class MyClass {
    @Testable(name="xiangyaohui")
    public void info() {

    }
}

標記Annotation:沒有成員變量,僅使用自身的存在與否,來為我們提供信息。
元數據Annotation:包含成員變量的Annotation,因為他們可以接受更多的元數據。

2、提取Annotation信息

AnnotatedElement接口中的三個方法

- <T extends Annotation> T getAnnotation(Class<T> aClass) //返回該類程序元素上,指定類型的注解,若該類型的注解不存在,返回null
- Annotation[] getAnnotations()   //返回程序元素存在的所有注解
- boolean isAnnotationPresent(Class<? extends Annotation> aClass)   //判定該程序元素上是否包含指定類型的注解

AnnotatedElement接口的實現類:
Class
Contrustor
Field
Method
Package

2.1、例子一

僅僅是一個標記Annotation,沒有成員變量

public @interface Testable {
}

public class MyClass {
    @Testable
    public void m1() {

    }
    public void m2() {

    }
}

public class TestProcessor {
    public static void process(String clazz) throws ClassNotFoundException {
        for (Method m : Class.forName(clazz).getMethods()) {
            //如果包含Testable標記注解
            if (m.isAnnotationPresent(Testable.class)) {
                try {
                    //調用m方法
                    m.invoke(null);
                }catch (Exception e){
                    e.printStackTrace();
                }
            }
        }
    }
}

其實注解很簡單,就是為源碼添加一些特殊的標記,這些標記可以通過反射獲取,獲取到之后做出相應的處理。

2.2、例子二

public @interface ClickListenerFor {
    //用于保存監聽器實現類
    String listener();
}
public class ClickListenerProcessor {
    public static void process(Object obj) {
        try {
            Class clazz = obj.getClass();
            for (Field field : clazz.getFields()) {
                field.setAccessible(true);
                ClickListenerFor c = field.getAnnotation(ClickListenerFor.class);
                if (c !=null){
                    //獲取元數據
                    Class listenerClazz = Class.forName(c.listener());
                    //
                    View.OnClickListener click = (View.OnClickListener) listenerClazz.newInstance();
                    //獲取field 實際對應的對象
                    Button button = (Button) field.get(obj);
                    //添加事件
                    button.setOnClickListener(click);
                }
            }
        } catch (Exception ex) {
            ex.printStackTrace();
        }
    }
}
public class MainActivity extends Activity {
    @ClickListenerFor(listener = "OkClickListener")
    private Button okButton;
    @ClickListenerFor(listener = "CancelClickListener")
    private Button cancelButton;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        Button button1 = findViewById(R.id.button1);
        Button button2 = findViewById(R.id.button2);
        ClickListenerProcessor.process(this);
    }

    class OkClickListener implements View.OnClickListener {
        @Override
        public void onClick(View view) {
            //點擊了確定按鈕
        }
    }

    class CancelClickListener implements View.OnClickListener {
        @Override
        public void onClick(View view) {
            //點擊了取消按鈕
        }
    }
}

三、元注解

@Retention

@Test

@Documented

@Inherited

四、使用APT來處理Annotation

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

推薦閱讀更多精彩內容