通过自定义Annotation简单实现ButterKnife注解功能

最新推荐文章于 2024-07-25 07:21:48 发布

D_SJ

最新推荐文章于 2024-07-25 07:21:48 发布

阅读量118

点赞数

文章标签： runtime java python

原文链接：https://my.oschina.net/u/3389024/blog/1358533

版权

2019独角兽企业重金招聘Python工程师标准>>>

前言

通过对《Java Annotation简介》的简单介绍，我们应该了解到了Java 中自定义注解的使用方式。实际上现有市场上已经出现了很多利用注解来完成依赖注入工作的库，例如ButterKnife。

ButterKnife 简单来讲就是通过注解的方式，简化代码中View变量与XML资源绑定的流程的工具。
前面提到过，元注解@Retention有三种取值：

RetentionPoicy.SOURCE：在源文件中有效，在class文件中失效（即只在源文件保留）；
RetentionPoicy.CLASS：在class文件中有效（即class保留);
RetentionPoicy.RUNTIME：在运行时有效（即运行时保留）。

ButterKnife使用的是RetentionPoicy.CLASS级别的注解，为了简单直观，我们这里使用RUNTIME注解来模仿，当然因为需要通过反射获得元素对象，会损失运行时性能。

过程

首先我们来看一个简单的使用场景：

...

@BindView(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");

}
...

在onCreate方法中使用以下方法后，我们已经获得了该控件的引用，可以实现控件方法的各种调用，前提只需要在声明控件变量时添加BindView注解，并设置对应的资源变量。

ButterKnife.inject(this)

我们模仿这样一个流程，首先定义一个名为BindView的注解：

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
@Documented
public @interface BindView {
    // 唯一的value是要指定的R.id变量
    int value();
}

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

下面我们就能在Activity中使用这个注解了（暂时不起作用）：

public class MainActivity extends AppCompatActivity {

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

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

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

public class PoorKnife {
    public static void inject(Activity activity) {
        try {
         // 获取类变量
        Class contextClass = Class.forName(activity.getClass().getCanonicalName());
        // 遍历类中所有Field
        for (Field field : contextClass.getDeclaredFields()) {
            // 如果包含注解
            if (field.isAnnotationPresent(BindView.class)) {
                Log.d(TAG, field.getName() + " has annotation");

                // 得到注解值
                int rId = field.getAnnotation(BindView.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();
        }
     }
}

inject方法中的操作主要用到反射机制：

通过参数activity获得类变量
遍历类中所有FIELD(成员变量)，并检查是否被标注BindView注解
若有注解，则获取注解给定的int值，并通过反射将findViewById得到的view赋值给这个变量

接下来我们再次重写onCreate方法，此时才完成了控件对象的初始化工作：

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

    PoorKnife.inject(this);

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

由于是运行时通过反射调用，因此效率相对较低，同理注解 onClick 按照这个流程也可以很方便的实现。

下一步我们讲讲《注解处理器Annotation Processor 的概念及使用》

转载于:https://my.oschina.net/u/3389024/blog/1358533