0%

简单实现ButterKnife的注解功能

发表于 更新于

今天简单实现一个类似ButterKnife注解的功能——通过注解的方式，简化代码中View变量与XML资源绑定的流程。
ButterKnife使用的是CLASS级别的注解，在这里短平快，使用RUNTIME注解来模仿，会损失运行时性能。

首先，我们来看一下ButterKnife典型的使用场景：

1
2
3
4
5
6
7
8
9
10
11
12
@InjectView(R.id.title_text)
TextView mTitleTextView;

@Override
protected void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    setContentView(R.layout.main_activity);

    ButterKnife.inject(this);
    mTitleTextView.setText("test");

}

在使用ButterKnife.inject(this)
这一句代码后，就可以直接调用控件的方法了，前提只需要在声明控件变量时添加InjectView注解，并给定相应的R.id变量。

我们完全仿照这一流程：
首先定义一个注解InjectView

1
2
3
4
5
6
7
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
@Documented
public @interface InjectView {
    // 唯一的value是要指定的R.id变量
    int value();
}

在这里我们定义注解保留在运行时环境中，并且这个注解是应用在类中的FIELD上。

下面我们就能在Activity中使用这个注解了（虽然没有任何作用）：

1
2
3
4
5
6
7
8
9
10
11
public class MainActivity extends AppCompatActivity {

    @InjectView(R.id.textview_a)
    TextView textViewA;

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

现在我们来实现注解的功能。起一个名为PoorKnife的类，声明一个static方法inject，并且接收一个Activity类型参数：

1
2
3
public class PoorKnife {
    public static void inject(Activity activity) { }
}

接下来实现inject方法，主要用到反射机制：

  1. 通过参数activity获得类变量
  2. 遍历类中所有FIELD，并检查是否被标注InjectView注解
  3. 若有注解，则获取注解给定的int值，并通过反射将findViewById得到的view赋值给这个field
    代码如下：
    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
    public static void inject(Activity activity) {
        try {
            // 获取类变量
            Class contextClass = Class.forName(activity.getClass().getCanonicalName());
            // 遍历类中所有Field
            for (Field field : contextClass.getDeclaredFields()) {
                // 如果包含注解
                if (field.isAnnotationPresent(InjectView.class)) {
                    Log.d(TAG, field.getName() + " has annotation");

                    // 得到注解值
                    int rId = field.getAnnotation(InjectView.class).value();
                    String type = field.getType().toString();
                    if (type.endsWith("TextView")) {
                        // 设置field可访问，并将通过set方法赋值view
                        field.setAccessible(true);
                        field.set(activity, activity.findViewById(rId));
                    }
                }
            }
        } catch (ClassNotFoundException e) {
            e.printStackTrace();
        } catch (IllegalAccessException e) {
            e.printStackTrace();
        }
    }

接下来我们可以在Activity中使用这个方法初始化View了：

1
2
3
4
5
6
7
8
9
@Override
protected void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    setContentView(R.layout.activity_main);

    PoorKnife.inject(this);

    textViewA.setText("PoorKnife succeed!!!");
}

由于是运行时通过反射调用，因此效率相对较低，但使用上简化了view初始化的流程。绑定onClick按照这个流程也可以很方便的实现。