Android依赖注入浅析

2019-08-09 本文已影响0人 Heweii

前言

谈到依赖注入首先就会想到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.注解分类

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

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

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

JDK内置系统注解
元注解
自定义注解

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的相关内容