移动架构学习笔记十三：仿照ButterKnife手写View注入框架

• 前言

上一篇博客中仿照XUtils手写了一个View注入框架，这个框架的核心原理是用到了反射，不停反射，全程反射。说实话，实际项目中我是不会选择XUtils这样的框架的，毕竟大量的反射还是有损性能的。今天我们将使用另外一种思路来实现View的注入，避免使用大量的反射，从而提升性能。今天的注入框架是参考ButterKnife来实现的，ButterKnife现在是最流行的注入框架，很多小伙伴都在使用，但是不知道大家清不清楚ButterKnife是用什么原理实现的，今天我们就抽丝剥茧来聊一聊ButterKnife的原理并实现自己的View注入框架。

• findViewById

首先我们来看看，如果不适用注入框架，View是怎么绑定的：

public class OriginalMainActivity extends AppCompatActivity {
    TextView mTextView;

    @Override
    protected void onCreate(@Nullable Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);

        mTextView = findViewById(R.id.text_view);
    }
}

 只要是稍微了解过Android开发的朋友，应该都明白上面一段代码，为了将java代码中的控件和xml视图中的控件绑定起来，需要使用findViewById来找到xml的控件并使用变量保存。一个控件就写一次，一百个控件就写一百次，代码很简单，但是非常的没有技术含量还写得很累，基本上可以称之为搬砖代码，跟工地上搬砖的工作一样，重复切无意义。我们有没有什么办法，让程序员少些这种搬砖的代码呢？

首先我们对上面的代码做一个改造：

public class OriginalMainActivity extends AppCompatActivity {
    TextView mTextView;

    @Override
    protected void onCreate(@Nullable Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);

//        mTextView = findViewById(R.id.text_view);
        new ViewBinder().bind(this);
    }
    
    class ViewBinder{
        public void bind(final OriginalMainActivity target) {
            target.mTextView = target.findViewById(R.id.text_view);
        }
    }
}

上面的代码中，新增了一个内部类ViewBinder，在内部类中对Acitivity的控件进行绑定，这样Acitivity中就不用去写大量的findViewById代码了。这时候可能会有人质疑我是不是在掩耳盗铃，Acitivity不写，ViewBinder也要写啊，代码量不降反升了。别急，我们目标是ViewBinder不由程序员来写，而是编译器自动生成。

• annotationProcessor

让编译器帮我们自动生成代码？这个能实现吗？答案是能！实现这个愿望的关键字就是annotationProcessor，这个关键字翻译过来叫做注解处理器（完全直译的），annotation（注解）中有一个类型叫做编译时注解，通过annotationProcessor之后能让我们截获编译时注解标注的地方，这时候就是我们发挥生成代码这一技能的时候，既然现在还处在编译阶段，我们就可以生成一个ViewBinder的内部类，再和原来的类一起编译。大概的过程如图所示：

•  创建项目

创建Android Module命名为app，用于测试

创建Java library Module命名为 injector-annotation，用于自定义注解，存放@BindView

创建Java library Module命名为 injector-processor，注解处理器，根据apt-annotation中的注解，在编译期生成xxxActivity_ViewBinding.java代码

创建Android library Module 命名为injector-library，工具类，调用xxxActivity_ViewBinding.java中的方法，实现View的绑定。

• injector-annotation

在这个Module中，我们创建一个自定义注解，代码如下：

@Target(ElementType.FIELD)
@Retention(RetentionPolicy.CLASS)
public @interface BindView {
    int value();
}

•  injector-processor

在这个Module中，首先修改Module中的build.gradle文件，增加如下配置：

    implementation project(':injector-annotation')
    implementation 'com.google.auto:auto-common:0.8'
    implementation 'com.google.auto.service:auto-service:1.0-rc3'
    annotationProcessor 'com.google.auto.service:auto-service:1.0-rc3'
    implementation 'com.squareup:javapoet:1.10.0'

在这里，对于auto-service模块，我同时使用了implementation关键字和annotationProcessor关键字来引入它，网上很多文章只用了implementation，但是我实际操作中发现编译会报错，经过反复试验，两者中单独使用一个都会报错，两个一起使用则没问题。这个不知道为什么别人可以只用一个，可能是环境问题吧。如果你也遇到同样的问题，可以两个都加上试试。

auto-service模块，可以指定那个类为我们自定义注解的处理类，比如我们新建一个类，命名可以随便命名：

@AutoService(Processor.class)
public class BindViewProcessor extends AbstractProcessor {}

通过Autoervice的注解就指定了这个类是注解处理器，但是现在这类还不知道具体要处理哪些自定义注解，因为自定义注解非常多，比如我们常用的Override也是自定义注解，但是我们肯定不需要处理它，我们只需要处理我们自己的注解BindView即可，这个怎么呢？代码如下：

    @Override
    public Set<String> getSupportedAnnotationTypes() {
        Set<String> types = new LinkedHashSet<>();
        types.add(BindView.class.getCanonicalName());
        return types;
    }

另外我们还需要指定java的编译版本，一般选择支持的最新版本即可：

    @Override
    public SourceVersion getSupportedSourceVersion() {
        return SourceVersion.latestSupported();
    }

有了以上操作，我们就可以拦截到BindView注解并处理它了，另外javapoet可以帮助我生成java代码，其实不用javapoet也可以，使用java的Stream包下面的工具也可以生成，但是相对比较麻烦，所以使用javapoet可以帮助我们更快速的生成java代码。生成代码的方法是重写process方法：

    @Override
    public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) {}

这里面的代码就比较多，但是不难理解，不过就是拦截到BindView所指的字段，并生成ViewBinder内部类，再写入到指定文件中即可。文章最后会贴出完整代码的链接，感兴趣的话下载下来看吧。我们这里只把框架的架构思路理解即可。

• injector-library

在这个Module中，我们需要暴露一个供用户调用的工具类：

public class ButterInjector {
    public static void bind(Activity activity) {
        String className = activity.getClass().getName();
        try {
            Class<?> viewBinderClass = Class.forName(className + "$$ViewBinder");
            ViewBinder viewBinder = (ViewBinder) viewBinderClass.newInstance();
            viewBinder.bind(activity);
        } catch (ClassNotFoundException e) {
            e.printStackTrace();
        } catch (IllegalAccessException e) {
            e.printStackTrace();
        } catch (InstantiationException e) {
            e.printStackTrace();
        }
    }
}

上面的类用到了ViewBinder的接口，代码如下：

public interface ViewBinder<T> {
    void bind(T target);
}

同时这个Module需要依赖injector-annotation，修改Module中的build.gradle文件，增加如下配置：

implementation project(':injector-annotation')

• app应用层

修改app Module中的build.gradle文件，增加如下配置：

    implementation project(':injector-annotation')
    implementation project(':injector-library')
    annotationProcessor project(':injector-processor')

同时修改Activity的代码：

public class MainActivity extends AppCompatActivity {
    @BindView(R.id.text_view)
    TextView mTextView;

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

        Toast.makeText(this, "mTextView----->" + mTextView, Toast.LENGTH_SHORT).show();
    }
}

这时，就不用再写搬砖代码findViewById了，是不是很开心？

• 总结

今天实现的View注入框架，仅仅用到了一次反射。其他的代码效率和原生代码一样。总的来说，使用这种方式的注入，效率无限接近于原生代码，但是大大提升了程序员的开发效率，是值的在实际的项目中使用的。

 

完整代码