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 {
}
  1. 创建一个注解,用来标明哪些字段需要调用findViewById
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface FIND_THIS_VIEW {

    /*字段的id*/
    int value() default 0;
}
  1. 接下来,来写处理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;
    }
}
  1. 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,还有很大的优化空间。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 217,826评论 6 506
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,968评论 3 395
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 164,234评论 0 354
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,562评论 1 293
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,611评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,482评论 1 302
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,271评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,166评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,608评论 1 314
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,814评论 3 336
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,926评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,644评论 5 346
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,249评论 3 329
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,866评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,991评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,063评论 3 370
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,871评论 2 354

推荐阅读更多精彩内容

  • 训练时间是从2017年12月12号开始,2018年1月1号结束,总计21天。 下面是我的实践成果总结报告,包含每一...
    杨颖__指数成长阅读 4,893评论 0 15
  • 1剪剪春风料峭寒纤纤春雨润物轻娇娇春花含苞艳徐徐春暖芳菲竞 2一剪寒梅镜湖映悄然绽放翠竹间斜风细雨英姿曳姹紫嫣红总...
    春天的麦琪阅读 619评论 8 5
  • 这一刻,我似乎看到了我成功的样子。很开心。 所以下一刻看见旁边的单词的时候,我就已经觉得我都记住了。 我的未来很美...
    千浮生阅读 152评论 0 0
  • 最近极客人在使用React Native制作的自己的博客客户端,客户端在调用Wordpress Rest API时...
    极客人阅读 6,185评论 2 1
  • 对于必然的解读思绪万千,其实典型的实例就是计算机在社会生存中的应用,注意是计算机而不是kk说的网络。 计算机的国内...
    秦家炎阅读 104评论 0 2