第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阅读 206,013评论 6 481
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,205评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 152,370评论 0 342
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,168评论 1 278
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,153评论 5 371
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,954评论 1 283
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,271评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,916评论 0 259
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,382评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,877评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,989评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,624评论 4 322
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,209评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,199评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,418评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,401评论 2 352
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,700评论 2 345

推荐阅读更多精彩内容