Java 注解实现 OnClickListener

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

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

1
2
3
4
5
6


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

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

1
2
3
4


@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文件中都存在)
运行时注解 (在运行阶段还会起作用，甚至会影响运行逻辑的注解)

自定义注解

注解语法

1
2
3
4
5
6


@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)

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

首先，定义一个注解接口

1
2
3
4
5
6


@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Inherited
public @interface OnClick {
    int value() default -1;//只有一个元素用于获取View的id，当只有一个元素时，元素名必须为value
}

然后，编写注解处理器（如果不理解反射请看上一篇文章Java反射机制）

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27


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()

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13


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是不能相提并论的，还有许多细节要处理，这是自定义注解最简单的用法，了解了注解的基本原理，我们才可以更加自信的去使用基于注解的一些开源框架。由于笔者水平有限，如有错误之处，请不吝赐教。