APT的使用2

APT（Annotation Processing Tool） 注解编译时工具。现在越来越多的框架使用apt技术来实现或重写，如Dagger2、ButterKnight、ARouter。APT技术可以简单理解为在编译时通过处理注解来实现部分代码逻辑，动态生成java class文件，供我们使用。

注解的介绍

APT系列：
APT的使用1（apt的接入）
APT的使用2（实现findViewById功能）

---

实现findViewByID功能

1. 创建一个注解，用来指定哪个类需要添加这个方法，通常是Activity，Fragment

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.CLASS)
public @interface FIND_IN_THIS_ACT {
}

2. 创建一个注解，用来标明哪些字段需要调用findViewById

@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface FIND_THIS_VIEW {

    /*字段的id*/
    int value() default 0;
}

3. 接下来，来写处理Processor，拿到每一个添加了FIND_IN_THIS_ACT 的类，为其中添加了FIND_THIS_VIEW 的字段，生成对应的调用findViewById方法，所有的方法集中在一个工具类中

@AutoService(Processor.class)
@SupportedSourceVersion(SourceVersion.RELEASE_7)
@SupportedAnnotationTypes({"com.example.lib.FIND_IN_THIS_ACT"})
public class FindViewProcessor extends AbstractProcessor {

    private Elements elementUtils;

    private Types typeUtils;

    @Override
    public synchronized void init(ProcessingEnvironment processingEnvironment) {
        super.init(processingEnvironment);
        elementUtils = processingEnvironment.getElementUtils();
        typeUtils = processingEnvironment.getTypeUtils();
    }


    /***
     * 这里的逻辑是，在添加了注解（FIND_IN_THIS_ACT）的Activity的子类中，寻找添加了注解（FIND_THIS_VIEW）的字段，
     * 然后为其生成对应的findViewById方法，最后将这些方法集中到一个工具类中生成，如果想要这里方法被调用，需要在我们的
     * Activity类中调用这个工具类，也就是类似ButterKnife的调用View.inject(this)类似的操作
     * */
    @Override
    public boolean process(Set<? extends TypeElement> set, RoundEnvironment
            roundEnvironment) {
        if (set != null) {
            Set<? extends Element> elementsAnnotatedWith = roundEnvironment
                    .getElementsAnnotatedWith(FIND_IN_THIS_ACT.class);

            // 所有添加了FIND_IN_THIS_ACT注解的Element
            if (elementsAnnotatedWith != null) {

                // 创建Activity的类型，下文用于判断被注解的元素是否属于此类型，这里可以扩展包含Fragment、AppCompatActivity等
                TypeElement typeElement = elementUtils.getTypeElement("android.app.Activity");

                // 遍历这些注解了的Element
                for (Element element : elementsAnnotatedWith) {
                    //获取注解节点的类的信息
                    TypeMirror typeMirror = element.asType();
                    FIND_IN_THIS_ACT anno = element.getAnnotation(FIND_IN_THIS_ACT.class);//获取注解的信息

                    // 是否属于上文创建的Activity类型，如果是符合要求
                    if (typeUtils.isSubtype(typeMirror, typeElement.asType())) {
                        //获取节点的具体类型
                        TypeElement classElement = (TypeElement) element;

                        /**创建参数，如(SecondActivity activity)**/
                        ParameterSpec altlas = ParameterSpec.builder(ClassName.get(typeMirror),
                                "activity"/*参数名*/).build();

                        /**创建方法，静态、公有，返回值void**/
                        MethodSpec.Builder method = MethodSpec.methodBuilder("findViewById")
//                                .addAnnotation(Override.class)
                                .addModifiers(PUBLIC, STATIC).returns(TypeName.VOID).addParameter
                                        (altlas);

                        /**创建方法体**/

                        // 获取TypeElement的所有成员变量和成员方法
                        List<? extends Element> allMembers = elementUtils.getAllMembers
                                (classElement);//??

                        // 遍历成员变量
                        for (Element member : allMembers) {
                            // 找到被FIND_THIS_VIEW注解的成员变量
                            FIND_THIS_VIEW FINDTHISVIEW = member.getAnnotation(FIND_THIS_VIEW
                                    .class);
                            if (FINDTHISVIEW == null) {
                                continue;
                            }
                            // 构建方法体语句
                            method.addStatement(String.format("activity.%s = (%s) activity" + ""
                                            + ".findViewById(%s)", member.getSimpleName(),
                                    //注解节点变量的名称
                                    ClassName.get(member.asType()).toString(),//注解节点变量的类型
                                    FINDTHISVIEW.value()));//注解的值
                        }

                        /**创建类**/
                        TypeSpec typeSpec = TypeSpec.classBuilder("FindViewIn" + element
                                .getSimpleName()).addModifiers(PUBLIC, FINAL)//作用域
                                .addMethod(method.build())//添加方法
                                .build();

                        /**创建Java class文件到指定的目录下**/
                        JavaFile javaFile = JavaFile.builder("jason.test.findview", typeSpec)
                                .build();

                        try {
                            javaFile.writeTo(processingEnv.getFiler());
                        } catch (IOException e) {
                            e.printStackTrace();
                        }

                    } else {
                        throw new IllegalArgumentException("@FIND_IN_THIS_ACT must be an Activity");
                    }
                }

            }
            return true;
        }
        return false;
    }
}

4. rebuild项目，在对应目录下可以找到生成的工具类，如

public final class FindViewInSecondActivity {
  public static void findViewById(SecondActivity activity) {
    activity.findMe = (android.widget.TextView) activity.findViewById(2131165237);
  }
}

5.在项目中使用这个工具类

@FIND_IN_THIS_ACT
public class SecondActivity extends Activity {

    @FIND_THIS_VIEW(R.id.findme)
    public TextView findMe;

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

        setContentView(R.layout.second_layout);

        // 这里生成的工具类
        FindViewInSecondActivity.findViewById(this);
        
        findMe.setText("恭喜你，找到我了。。。");
    }
}

通过上面的步骤，我们可以实现一个简单apt工具，来简化findViewById。但是在项目中直接使用生成的工具类这种方式肯定是存在很大的弊端的，所以这只是一个简单的demo，还有很大的优化空间。