Butterknife 的简单模拟

「爱情、让人受尽委屈。」 2022-09-24 14:16 113阅读 0赞

Butterknife 是一款优秀的Android 开发框架。  
主要用于 控件的初始化，监听事件绑定等，再不用写烦人的 findViewById().

新的版本 还加入了 Resource 资源的绑定。  
Butterknife 的官网，你可以了解更多。  
[http://jakewharton.github.io/butterknife/][http_jakewharton.github.io_butterknife]

Butterknife 的原理 并不是通过反射 ，而是 APT  
(Java Annotation Processing)  
这是一个用于编译时扫描和解析 注解的工具，通过它我们可以自己定义注解，并定义解析器来处理它们。它的原理是读入 Java 源代码，解析注解，然后生成新的 Java 代码，新生成的代码最后被编译成 Java 字节码。  
生成的是子类，所以Butterknife 不能绑定私有对象。  
使用APT要比使用 反射实现注解要效率高。

这里有个列子是 APT 的使用  
[http://alighters.com/blog/2016/05/10/apt-code-generate/][http_alighters.com_blog_2016_05_10_apt-code-generate]

今天我们先用 注解来模拟 一下 Butterknife 的实现。  
思路步骤:

绑定View  
1. 注册扫描 自定义的注解  
2. 根据 注解内容 初始化得到实例  
3. 将实例通过反射赋值到相应对象上面

绑定监听事件：  
1.注册扫描 ，自定义注解  
2. 根据 注解内容 得到实例对象，和绑定函数  
3. 设置 监听事件，在监听事件里面 通过反射 调用函数。  
4. 其实就是绑定实例 多了一步，绑定监听事件

一 自定义注解：  
初始化View 的注解  
@Target(ElementType.FIELD)  
@Retention(RetentionPolicy.RUNTIME)  
public @interface BindView \{  
public int id() default 0;  
\}

绑定监听事件  
@Target(ElementType.METHOD)  
@Retention(RetentionPolicy.RUNTIME)  
public @interface OnClick \{  
public int id() default 0;  
\}

二 扫描注解

/\*\*  
\* @param obj  
\* @param clazz  
\*/  
private static void bindView(Object obj, Class clazz) \{  
Field\[\] files = clazz.getDeclaredFields();  
for (Field field : files) \{  
if (field.isAnnotationPresent(BindView.class)) \{  
BindView bindView = field.getAnnotation(BindView.class);  
if (obj instanceof Activity) \{  
Activity activity = (Activity) obj;  
int id = bindView.id();  
Object view = activity.findViewById(id);  
field.setAccessible(true);  
try \{  
field.set(obj, view);  
\} catch (IllegalAccessException e) \{  
e.printStackTrace();  
\}  
\}  
\}  
\}  
\}

扫描监听事件：

/\*\*  
\* @param obj  
\* @param clazz  
\*/  
private static void bindListener(final Object obj, Class clazz) \{  
Method\[\] methods = clazz.getDeclaredMethods();  
for (final Method method : methods) \{  
if (method.isAnnotationPresent(OnClick.class)) \{  
OnClick onClick = method.getAnnotation(OnClick.class);  
if (obj instanceof Activity)\{  
Activity activity = (Activity) obj;  
int id = onClick.id();  
View view = activity.findViewById(id);  
method.setAccessible(true);  
view.setOnClickListener(new View.OnClickListener() \{  
@Override  
public void onClick(View v) \{  
try \{  
method.invoke(obj);  
\} catch (IllegalAccessException e) \{  
e.printStackTrace();  
\} catch (InvocationTargetException e) \{  
e.printStackTrace();  
\}  
\}  
\});  
\}  
\}  
\}  
\}

三 使用

public class MainActivity extends AppCompatActivity \{

@BindView(id = R.id.tv_name)
    private TextView tv_name;
    
    long startTime, endTime;
    
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        startTime = System.currentTimeMillis();
        Butterknife.bind(this);
        endTime = System.currentTimeMillis();
        tv_name.setText(" Time =  "  +(endTime - startTime));
    }
    
    @OnClick(id = R.id.tv_name)
    private void onClick() {
        tv_name.setText(" onClick ");
    }

四 到此结束：

代码地址：  
[https://github.com/linving/MyButterknife][https_github.com_linving_MyButterknife]

写写大家

下次用 APT 模拟实现 Butterknife 。

[http_jakewharton.github.io_butterknife]: http://jakewharton.github.io/butterknife/
[http_alighters.com_blog_2016_05_10_apt-code-generate]: http://alighters.com/blog/2016/05/10/apt-code-generate/
[https_github.com_linving_MyButterknife]: https://github.com/linving/MyButterknife