Java注解实现OnClickListener

在学习Android开发的过程中用到了许多的开源框架,很多框架都大量的用到了注解这个概念,虽然会用别人的框架,但是总觉得自己眼前有一片雾霾,所以决定去认识注解背后的原理,拨开这层迷雾。

刚开始开发Android的过程中经常写出下面的代码:

view.setOnClickListener(new View.OnClickListener() {
    @Override
    public void onClick(View v) {
        //do something...      
    }
});

直到后来用了ButterKnife变成了这样:

@OnClick(R.id.view)
public void viewClick(){
    //do something...     
}

遇到了这样的神器,心中激动不已,这是怎样神奇的技术啊,简化了劳资很多代码,现在我就要探寻这神秘背后的真实面目:注解

Java注解是在Java 1.5中出现的
概念:
Java 提供了一种原程序中的元素关联任何信息和任何元数据的途径和方法。(反正我是没看懂)
直观一点就是那些插入到源代码中使用其他工具可以对其进行处理的标签。(如:@Override)

Java中的常见注解
  • JDK自带注解
    1.@Override (被该标签修饰的方法是重写父类的方法)
    2.@Deprecated (表示该方法已经过时,不建议使用)
    3.@Suppvisewarnings (忽略一些特定的警告)

  • ButterKnife(Android常用的view注解框架)的注解
    1.@Bind (获得一个view的实例)
    2.@OnClick (添加点击事件)
    3.@OnItemSelected (添加Listview的点击事件)

注解不止这一些,还有很多,我只列举了常见的一些,大家看起来应该非常的熟悉

注解的分类(按运行机制分类)
  • 源码注解 (注解只在源代码中存在,编译成.class文件就不存在了)
  • 编译时注解 (注解在源码和.class文件中都存在)
  • 运行时注解 (在运行阶段还会起作用,甚至会影响运行逻辑的注解)
自定义注解
  • 注解语法
@Target()      //用来标注该注解使用的范围如类,方法等
@Retention()   //指定一条注解应该保留多长时间,源码级别,编译级别,运行时级别
modifiers @interface AnnotationName{
    type elementName1();//不带默认值
    type elementName2() default value;//带默认值
  }
  • 注解的注意事项
    1.一个注解接口的方法不能有任何参数和任何的throws语句,并且他们也不能是泛型的

2.注解的元素类型必须为以下几种

  • 基本数据类型 (int,short,long,byte,char,double,float,boolean)
  • String
  • Class (具有一个可选的类型参数,例如Class<? extends MyClass>)
  • enum类型
  • 注解类型
  • 由前面类型组成的数组 (由数组组成的数组不是合法的元素类型)

3.元注解

  • @Target({ElementType.TYPE,ElementType.METHOD})
  • ANNOTATION_TYPE 适用于注解类型声明
  • PACKAGE 适用于包
  • TYPE 适用于类以及接口(包括枚举及注解类型)
  • CONSTRUCTOR 适用于构造器
  • FIELD 成员属性(域)
  • PARAMETER 方法或构造器的参数
  • LOCAL_VARIABLE 局部变量
  • @Retention(RetentionPolicy.RUNTIME)
  • SOURCE 源码级别的注解,编译之后就不存在了
  • CLASS 编译时注解,但是需要载入虚拟机
  • RUNTIME 运行时注解,可通过反射API改变运行状态
  • @Inherited 表示该注解可被子类继承(一定是类,枚举和接口无效)
注解实现OnClickListener(Android)

上面介绍了一些基本概念,接下来就开始动手来实现这一监听效果吧!

  • 首先,定义一个注解接口
@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Inherited
public @interface OnClick {
    int value() default -1;//只有一个元素用于获取View的id,当只有一个元素时,元素名必须为value
}
  • 然后,编写注解处理器(如果不理解反射请看上一篇文章Java反射机制
public class PanViewInjector {
    public static void process(final Object o) {
        Class c = o.getClass();
        Method[] methods = c.getDeclaredMethods();
        for (final Method m : methods) {
            OnClick click = m.getAnnotation(OnClick.class);//通过反射api获取方法上面的注解
            if (click != null) {
                if (o instanceof Activity) {
                    if (click.value() == -1) return;
                    View view = ((Activity) o).findViewById(click.value());//通过注解的值获取View控件
                    if (view == null) return;
                    view.setOnClickListener(new View.OnClickListener() {
                        @Override
                        public void onClick(View v) {
                            try {
                                m.invoke(o);//通过反射来调用被注解修饰的方法
                            } catch (Exception e) {
                                e.printStackTrace();
                            }
                        }
                    });
                }
            }
        }

    }
}
  • 最后在Activity里面使用注解,并在Oncreate里面调用PanViewInjector.process()
public class MainActivity extends AppCompatActivity {

    @OnClick(R.id.centerButton)//使用注解
    public void toCenter(){
        Toast.makeText(this,"注解起作用啦",Toast.LENGTH_SHORT).show();
    }
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        PanViewInjector.process(this);//调用注解处理器
    }
}

到了这里,这个注解写的就差不多了,显然这几行代码跟ButterKnife是不能相提并论的,还有许多细节要处理,这是自定义注解最简单的用法,了解了注解的基本原理,我们才可以更加自信的去使用基于注解的一些开源框架。由于笔者水平有限,如有错误之处,请不吝赐教。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 195,898评论 5 462
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 82,401评论 2 373
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 143,058评论 0 325
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,539评论 1 267
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 61,382评论 5 358
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,319评论 1 273
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,706评论 3 386
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,370评论 0 254
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,664评论 1 294
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,715评论 2 312
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,476评论 1 326
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,326评论 3 313
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,730评论 3 299
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,003评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,275评论 1 251
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,683评论 2 342
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 40,877评论 2 335

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,510评论 18 139
  • 本文章涉及代码已放到github上annotation-study 1.Annotation为何而来 What:A...
    zlcook阅读 29,086评论 15 116
  • 什么是注解(Annotation):Annotation(注解)就是Java提供了一种元程序中的元素关联任何信息和...
    九尾喵的薛定谔阅读 3,125评论 0 2
  • 在经过一次没有准备的面试后,发现自己虽然写了两年的android代码,基础知识却忘的差不多了。这是程序员的大忌,没...
    猿来如痴阅读 2,794评论 3 10
  • 1. Java基础部分 基础部分的顺序:基本语法,类相关的语法,内部类的语法,继承相关的语法,异常的语法,线程的语...
    子非鱼_t_阅读 31,513评论 18 399