Android依赖注入浅析

前言

谈到依赖注入首先就会想到ButterKnife,这个View的依赖注入框架在开发中的优势很明显,可以极其的简化代码,避免过多的编写findViewById,setOnClickListener,让代码更有条理性。本篇以及后续文章将会剖析其原理和实现过程,有时间还会写下dagger2(适用于大型项目)。
依赖注入本身的原理并没有太难,主要的知识点有注解以及反射。本篇主要详细讲解注解的相关知识,以及ButterKnife的简单样例。

一.注解简介

1.注解概念

Annotation(注解)就是Java提供了一种源程序中的元素关联任何信息或者任何元数据(metadata)的途径和方法。
注解的概念咋看起来有点难理解呢,以下是一个自定义注解的栗子,@interface表明这是一个注解,概念中提到的元素关联就是上面4个注解(元注解),元数据的途径和方法就是里面的"name-value"形式的定义

@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.FIELD})
@Documented
@Inherited
public @interface BindView {
    int value() default 1;
    boolean canBeNull() default false;
}

2.注解分类

根据注解的参数个数分类:

  1. 标记注解,一个没有成员的Annotation类型被称为标记注解,这种类型仅仅使用自身的存在与否来为我们提供信息,比如常见的@Override
  2. 单值注解
  3. 完整注解

根据注解使用的方法和用途分类:

  1. JDK内置系统注解
  2. 元注解
  3. 自定义注解

3.元注解

上面的栗子中已经全部罗列出来了
@Target:
@Target指定Annotation用于修饰哪些程序元素。
@Target也包含一个名为”value“的成员变量,该value成员变量类型为ElementType[ ],ElementType为枚举类型,值有如下几个:
ElementType.TYPE:能修饰类、接口或枚举类型
ElementType.FIELD:能修饰成员变量
ElementType.METHOD:能修饰方法
ElementType.PARAMETER:能修饰参数
ElementType.CONSTRUCTOR:能修饰构造器
ElementType.LOCAL_VARIABLE:能修饰局部变量
ElementType.ANNOTATION_TYPE:能修饰注解
ElementType.PACKAGE:能修饰包

@Rentention:
@Rentention用来标记自定义注解的有效范围,他的取值有以下三种:
RetentionPolicy.SOURCE: 只在源代码中保留 一般都是用来增加代码的理解性或者帮助代码检查之类的,比如我们的Override;
RetentionPolicy.CLASS: 默认的选择,能把注解保留到编译后的字节码class文件中,仅仅到字节码文件中,运行时是无法得到的;
RetentionPolicy.RUNTIME: ,注解不仅 能保留到class字节码文件中,还能在运行通过反射获取到,这也是我们最常用的。

@Document:
用于描述其它类型的 annotation 应该被作为被标注的程序成员的公共API。Documented 是一个标记注解,没有成员。
作用:表示需要在什么级别保存该注释信息,用于描述注解的生命周期。

@Inhrited:
是一个标记注解,@Inherited 阐述了某个被标注的类型是被继承的。如果一个使用了@Inherited 修饰的 annotation类型 被用于一个 class,则这个 annotation 将被用于该class的子类。
当 @Inherited annotation类型 标注的 annotation 的 Retention 是RetentionPolicy.RUNTIME,则反射API增强了这种继承性。如果我们使用java.lang.reflect 去查询一个 @Inherited annotation类型 的 annotation 时,反射代码检查将展开工作:检查class和其父类,直到发现指定的 annotation 类型被发现,或者到达类继承结构的顶层。

4.自定义注解

自己编写ButterKnife简单样例,当然ButterKnife底层实现更仔细,大致原理类似。
@interface 用来声明一个注解,其中的每一个方法实际上是声明了一个配置参数。方法的名称就是参数的名称,返回值类型就是参数的类型(返回值类型只能是 基本类型、Class、String、enum)。可以通过 default 来声明参数的默认值。

//先定义一个BindView注解
@Target(ElementType.FIELD)//作用域是成员变量
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface BindView {
    int value() default 0;
}
@Target(ElementType.METHOD)//作用域为方法
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface OnClick {
    int[] value() default {0};
}

上面的注解就可以这么使用

@BindView(R.id.button)
    Button button;
@OnClick(R.id.button)
    public void click(){
    }

这样就结束了吗,很明显注解的逻辑还没有写,这里先贴出利用反射实现注解逻辑的方法,后续会更新反射的相关知识

public class LoadUtils {

    public static void bindView(final Activity activity){
        Class<Activity> activityClass = (Class<Activity>) activity.getClass();
        Field[] fields = activityClass.getDeclaredFields();
        for (Field field : fields) {
            if (field.isAnnotationPresent(BindView.class)){
                int id = field.getAnnotation(BindView.class).value();
                View view = activity.findViewById(id);
                field.setAccessible(true);
                try {
                    field.set(activity , view);
                } catch (IllegalAccessException e) {
                    e.printStackTrace();
                }
            }
        }

        Method[] methods = activityClass.getDeclaredMethods();
        for (final Method method : methods) {
            OnClick onClick = method.getAnnotation(OnClick.class);
            if (onClick != null) {
                int[] ids = onClick.value();
                for (int id : ids) {
                    activity.findViewById(id).setOnClickListener(new View.OnClickListener() {
                        @Override
                        public void onClick(View v) {
                            method.setAccessible(true);
                            try {
                                method.invoke(activity);
                            } catch (IllegalAccessException e) {
                                e.printStackTrace();
                            } catch (InvocationTargetException e) {
                                e.printStackTrace();
                            }
                        }
                    });
                }
            }
        }
    }

}

使用如下

@BindView(R.id.button)
    Button button;

    @OnClick(R.id.button)
    public void click(){
    }

@Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        LoadUtils.bindView(this);
}

结语

后面将会写一些关于反射和dagger2的相关内容

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

推荐阅读更多精彩内容

  • 什么是注解(Annotation):Annotation(注解)就是Java提供了一种元程序中的元素关联任何信息和...
    九尾喵的薛定谔阅读 3,141评论 0 2
  • 从JDK5开始,Java增加了Annotation(注解),Annotation是代码里的特殊标记,这些标记可以在...
    lay_wn阅读 826评论 0 1
  • 从JDK5开始,Java增加了Annotation(注解),Annotation是代码里的特殊标记,这些标记可以在...
    CarlosLynn阅读 548评论 0 2
  • 关于注解首先引入官方文档的一句话:Java 注解用于为 Java 代码提供元数据。作为元数据,注解不直接影响你的代...
    编程小世界阅读 455评论 0 0
  • 苦难并不是人生的低谷。对于人的成长而言,苦难就像一位严师,既不要害怕他,也不要故作姿态的嘲弄她,要学会尊重它,理解...
    老马奔腾阅读 229评论 0 0