【Android】Android自定义注解——利用Java的Annotation

Github地址:Github

其实Android开发的时候,每次都要写什么findViewById之类的挺烦的,所以如果可以直接用注解的方式最好。
先直接上效果:

@ContentView(value = R.layout.activity_main)
public class MainActivity extends BaseActivity {
    super.onCreate(savedInstanceState);
    Injection.inject(this);

    @BindView(value = R.id.button1)
    Button button1;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
    }

    @OnClick(value = R.id.button1)
    public void button1Click(View view) {
        Toast.makeText(MainActivity.this, "button1 clicked", Toast.LENGTH_LONG).show();
    }
}

可以看见非常的简洁,本文用Java的Annontation会用到反射,影响效率,显然不是最好的解决方法,只是起到一个学习的作用而已。

Annontation是Java5引入的,即注解。
用处主要在于:
1、生成文档,比如@param @return
2、起到检查的作用,比如@Override
3、依赖配置。

定义注解的时候使用关键字@interface,这个不是interface,而是定义注解类的关键字。注解本质是一个继承了Annotation的特殊接口,其具体实现类是Java运行时生成的动态代理类。

一、元注解

java.lang.annotation提供了四种元注解,专门注解其他的注解(在自定义注解的时候,需要使用到元注解):
1、@Documented –注解是否将包含在JavaDoc中。
2、@Retention –什么时候使用该注解。
值以及含义如下:

含义
RetentionPolicy.SOURCE 在编译阶段丢弃。这些注解在编译结束之后就不再有任何意义,所以它们不会写入字节码。
RetentionPolicy.CLASS 在类加载的时候丢弃。在字节码文件的处理中有用。
RetentionPolicy.RUNTIME 始终不会丢弃,运行期也保留该注解,因此可以使用反射机制读取该注解的信息。我们自定义的注解通常使用这种方式。

3、@Target – 表示该注解用于什么地方。默认值为任何元素。
值以及含义如下:

含义
ElementType.CONSTRUCTOR 用于描述构造器。
ElementType.FIELD 成员变量、对象、属性(包括enum实例)。
ElementType.LOCAL_VARIABLE 用于描述局部变量。
ElementType.METHOD 用于描述方法。
ElementType.PACKAGE 用于描述包。
ElementType.PARAMETER 用于描述参数。
ElementType.TYPE 用于描述类、接口(包括注解类型) 或enum声明。

4、@Inherited - 定义该注释和子类的关系
@Inherited 元注解是一个标记注解,@Inherited阐述了某个被标注的类型是被继承的。如果一个使用了@Inherited修饰的annotation类型被用于一个class,则这个annotation将被用于该class的子类。

二、常见的注解

1、Override
java.lang.Override是一个标记类型注解,它被用作标注方法。能起到检查的作用,编译器会检查是否覆盖了父类的方法,如果没有覆盖的话会报错。
2、Deprecated
过时的方法或者成员。
3、SuppressWarnings
抑制警告。它有一个类型为String[]的成员,这个成员的值为被禁止的警告名。

三、自定义注解

介绍了Java的Annontation的一些知识之后,开始自定义我们的注解。首先先说下总体思路:
自定义注解类, 具体的注解解析类里面实现注解解释,通过反射拿到对应的类,然后通过getFields和getMethods遍历方法进行动态注入。

有个比较重要的方法getAnnotation,这个是尝试获得对应的注释。

1、findViewById 注解BindView实现

使用如下,需要能解析成 Button button1 = (Button)findViewById(R.id.button1);

@BindView(value = R.id.button1)
Button button1;

首先,定义注解。新建BindView类,实现如下:

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
public @interface BindView {
    int value () default 0;
}

解释一下含义:
(1)Retention指定运行时使用注解。
(2)Target指定注解对象是成员。
(3)value指定注解参数,默认值为0。

注解的具体实现。新建一个Injection类,然后添加一个inject方法用以解析注解。

public class Injection {
    public static void inject(Object object) {
        bindView(object);
    }
}

bindView方法即用来解释BindView,实现思路为先通过object.getClass()拿到类,然后getFields()拿到类的所有成员,进行遍历,getAnnotation可以拿到注解,如果有BindView注解,则将value值拿出来并将((Activity)object).findViewById(id))赋值给现在的成员。具体代码如下:

private static void bindView(Object object) {
    Class cls = object.getClass();
    Field[] fields = cls.getFields(); //得到所有成员
    for(Field field : fields) {
        BindView bindView = field.getAnnotation(BindView.class);
        if(bindView != null && bindView.value() != 0) {
            int id = bindView.value();
            try {
                field.setAccessible(true);
                if(object instanceof Activity) {
                    field.set(object, ((Activity)object).findViewById(id));
                }
            } catch (IllegalAccessException e) {
                e.printStackTrace();
            }
        }
    }
}

同时需要在MainActivity加载的时候调用inject函数并将this传入。

Injection.inject(this);

2、setOnClickListener注解OnClick实现。

效果如下:

@OnClick(value = R.id.button1)
public void button1Click(View view) {
    Toast.makeText(MainActivity.this, "button1 clicked", Toast.LENGTH_LONG).show();
}

首先,还是自定义注解类。

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface OnClick {
    int value() default 0;
}

和上面不同的是这个注解是作用在方法上的,所以Target的值是ElementType.METHOD。

同时,在方法inject中加入。

public class Injection {
    public static void inject(Object object) {
        bindView(object);
        onClick(object);
    }
}

onClick方法的实现即要将注解的方法添加到对应的控件上,因此思路上首先需要先找到所有有这个注解的方法。通过object.getClass().getMethods()获得所有方法,然后进行遍历如果发现有OnClick注解的,将注解的value拿出来,然后通过findViewById(id)拿到View,然后调用view.setOnClickListener,在重写onClick由于需要运行现在的方法,因此用调用method.invoke(object, view),第一个是类,第二个是参数。

具体代码如下:

private static void onClick(final Object object) {
    Class cls = object.getClass();

    Method[] methods = cls.getMethods();
    for(final Method method : methods) {
        OnClick onClick = method.getAnnotation(OnClick.class);
        if (onClick != null && onClick.value() != 0) {
            int id = onClick.value();
            View view = null;
            if (object instanceof Activity) {
                view = ((Activity)object).findViewById(id);
                if (view != null) {
                    view.setOnClickListener(new View.OnClickListener() {
                        @Override
                        public void onClick(View view) {
                            try {
                                method.invoke(object, view);
                            } catch (IllegalAccessException e) {
                                e.printStackTrace();
                            } catch (InvocationTargetException e) {
                                e.printStackTrace();
                            }

                        }
                    });
                }
            }
        }
    }
}

3、setContentView的注解ContentView的实现。

效果如下:

@ContentView(value = R.layout.activity_main)
public class MainActivity extends BaseActivity {
    super.onCreate(savedInstanceState);
    Injection.inject(this);
}

首先,还是定义一个注解类。

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
public @interface ContentView {
    int value() default 0;
}

作用在类上,因此Target值为ElementType.TYPE。
同样的,加入inject中,注意,这个需要是最先被执行的,因为后面有findViewById,所以页面必选先加载,所以最先执行解释处理。

public class Injection {
    public static void inject(Object object) {
        contentView(object);
        bindView(object);
        onClick(object);
    }
}

contentView实现其实就是执行了一下setContentView。实现如下:

private static void contentView(Object object) {
    Class cls = object.getClass();
    ContentView contentView = (ContentView)cls.getAnnotation(ContentView.class);
    if (object instanceof Activity) {
        int id = contentView.value();
        if (id != 0) {
            ((Activity)object).setContentView(id);
        }
    }
}

4、再稍微进一步

每次新建个Activity都要写一句Injection.inject(this)其实挺麻烦的,所以,我们自己新建一个BaseActivity,在里面执行这个,然后以后的Activity都继承自这个,也便于管理。

public class BaseActivity extends AppCompatActivity {
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        Injection.inject(this);
    }
}

总的来说,这种通过Java反射机制的方法自定义注解虽然实现起来简单,但是在Android中反射效率低,对性能影响比较大,所以只是适合学习一种思路,不适合在Android中用来自定义注解。

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

推荐阅读更多精彩内容