android注入View

作为学习笔记，自己写，肯定能学到更多的东西

上代码

public class MainActivity extends AppCompatActivity {

  Button btn;

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

      btn = findViewById(R.id.btn);

      btn.setOnClickListener(view -> Toast.makeText(MainActivity.this,  "myInject", Toast.LENGTH_SHORT).show());
    }
  }

最简单的代码,通过findViewById获取R.id.btn 赋值给 btn对象，这是初学者的第一行代码，假设有10个按钮那需要findViewById 10次，写到你绝望，直接放弃安卓。。。
我看到鸿洋大神写的是通过反射，invoke的方式给 btn 赋值的，既然都是findViewById，那就换一种方式findViewById。

第一步建个类

class MyInjectViewBuilder {

  public MyInjectViewBuilder(MainActivity mainActivity) {
    mainActivity.btn = mainActivity.findViewById(R.id.btn);
  }
}

!!! 这··只是把activity对象传给另一个类去解决了还是要findviewById 10次，怎么让代码帮我们生成呢？
在java中有一个注解处理器，可以在编译阶段，获取注解，生成代码。

AbstractProcessor

先新建一个java-library工程这个工程专门用来compiler编译的，gradle依赖

implementation 'com.squareup:javapoet:1.7.0'
implementation 'com.google.auto.service:auto-service:1.0-rc2'

第一个是squareup公司让你方便的生成java文件的
第二个是关键，java中有个SPI机制，全称Service Provider Interface，提供的一套用来被第三方实现或者扩展的API，它可以用来启用框架扩展和替换组件。比较麻烦，谷歌给我们封装了一下。我们就不需要关注在build/classes目录下在生成什么什么文件了

1、AutoService和AbstractProcessor

随便建个类继承 AbstractProcessor，在类名上增加AutoService注解，并完成重载方法

@SupportedSourceVersion(SourceVersion.RELEASE_8)
@AutoService(Processor.class)
public class MyCompilerProcessor extends AbstractProcessor {
  @Override
  public boolean process(Set<? extends TypeElement> set,    RoundEnvironment roundEnvironment) {
    //这里
  }
}

现在在编译阶段，编译器就会执行这里的代码。
那我们只需要在这里，获取注解和内容生成一个MyInjectViewBuilder类(名字无所谓)就好了
这是解析注解的
我们再建立一个注解类，我放在了另一个模块里，当然主要是在这里能引用到这个注解，我新建了一个模块增加了一个注解类，并在这个工程添加了对注解模块的依赖，这是compiler模块

apply plugin: 'java-library'

dependencies {
  implementation fileTree(dir: 'libs', include: ['*.jar'])

  // 用于生成Java文件的库
  implementation 'com.squareup:javapoet:1.7.0'
  implementation 'com.google.auto.service:auto-service:1.0-rc2'
  implementation project(':myInject')//这是注解模块
}

sourceCompatibility=JavaVersion.VERSION_1_8
targetCompatibility=JavaVersion.VERSION_1_8

注解类

增加一个注解类InjectView

@Retention(RUNTIME)           //保留在运行时
@Target(FIELD)                //目标在字段上 也就是变量上
public @interface InjectView {

  @IdRes int value();         //可以给注解设置内容，设置一个int
}

MyCompilerProcessor类

这时候我们就要在process方法中编写代码了
process有两个参数set、roundEnvironment
set：MyCompilerProcessor 继承 AbstractProcessor后可以重载一个方法getSupportedAnnotationTypes()这个方法需要返回一个Set，看名字就知道是获取支持的注解类型。process的第一个参数set就是返回使用过的注解。这个目前用不到
roundEnvironment：这个对象返回了注解标注的所有内容。比如当前注解下面的类名、变量名、所在的包等等都能获取到。

@Override
public boolean process(Set<? extends TypeElement> set, RoundEnvironment roundEnvironment) {
    //获取InjectView标记的所有变量
    Set<? extends Element> myModuleElement = roundEnvironment.getElementsAnnotatedWith(InjectView.class);
    //key：可以理解为类名，不是正真的类名，value则是这个类下标记InjectView的对象
    Map<TypeElement, List<Element>> viewByClassName = new HashMap<>();

    //遍历所有带有InjectView注解
     for(Element element: myModuleElement){
        TypeElement enclosingElement = (TypeElement) element.getEnclosingElement();

        if(viewByClassName.containsKey(enclosingElement)){
            //如果map中有存在就直接放入key
            viewByClassName.get(enclosingElement).add(element);
        }else{
            //如果不存在 new一个List 放入，再添加到map中
            List<Element> listTemp = new ArrayList<>();
            listTemp.add(element);
            viewByClassName.put(enclosingElement,listTemp);
        }
    }

    //遍历这个map，根据多少个Activity生成多少个类，毕竟不可能就一个界面
    Set<TypeElement> keySet = viewByClassName.keySet();
    Iterator it = keySet.iterator();
     while(it.hasNext()){

         TypeElement key = (TypeElement) it.next();
         //这里是个代码模板，是最开始我们想要生成这样的类的 模板
         String codeTemplate = "package "+ "com.demo" +";"+
                 "\n"+
                 "public class MyInjectViewBuilder {\n" +
                 "\n" +
                 fieldStr(viewByClassName.get(key))+        //这里是返回变量
                 "\n" +
                 "    public MyInjectViewBuilder(MainActivity mainActivity) {\n" +
                 findViewByIdStr(viewByClassName.get(key))+     //这里是 所有的findViewById
                 "    }\n" +
                 "\n" +
                 "}";

         try {
              //使用javapoet 直接生成类文件
             JavaFileObject source = processingEnv.getFiler().createSourceFile("com.demo.MyInjectViewBuilder");
             Writer writer = source.openWriter();
             writer.write(codeTemplate);
             writer.flush();
             writer.close();
         } catch (IOException e) {
             e.printStackTrace();
         }

     }

    return true;
}
//返回 这样的代码    TextView tv;
private String fieldStr(List<Element> elementList){
  String field = "";
  for (Element element : elementList) {
    field += "    "+element.asType().toString()+" "+"view_"+element.toString()+";"+"\n";
  }
  return field;
}
//返回 这样的代码   tv = findViewById(R.id.tv);
private String findViewByIdStr(List<Element> elementList){
  String field = "";
  for (Element element : elementList) {
    field += "        "+"mainActivity."+element.toString()+" =  mainActivity.findViewById("+element.getAnnotation(InjectView.class).value()+");\n";
  }
  return field;
}

process():在roundEnvironment.getElementsAnnotatedWith(InjectView.class);查找自定义的InjectView注解的时候，一股脑的全返回了，没办法只遍历所有，按"类名"分类。
在根据"类名"生成文件模板，再根据后面的List循环生成我们需要的findViewById,这样就不用我们写10遍了。
最后：

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

    new MyInjectViewBuilder(this);

    btn.setOnClickListener(view -> Toast.makeText(MainActivity.this, "myInject", Toast.LENGTH_SHORT).show());
}

在onCreate中 new一下方法就好了
坑：如果要用注解开发，建议gradle 是gradle-4.10.1-bin ， build.gradle 是3.3.2 ，更高的版本好像编译不出。
如何编译时调试请看这里，端口号可以更换。

总结

这里仅仅演示了如何使用AbstractProcessor在编译时生成类文件，如何注入Activity中控件对象。当然代码还可以进行优化。
1、比如把new MyInjectViewBuilder换掉，使用静态方法加载，当然也不可能每个类注入的名字都不一样，可以用ClassLoader加载一个同名的文件进行统一注入。
2、比如process()方法中代码也可以优化，根据包名进行分类，使结构更信息，或者增加注解对其他内容继续弄绑定

学艺不精，如果内容有错误请及时联系我，我及时改正