手写ButterKnife框架

前言

由华为裁员传闻引发的思考,据说华为裁员34岁以上员工,虽是传闻,但华为明确规定45岁以后必须退休却是真的、大到BAT、小到创业型公司,现在的企业比较喜欢招聘年轻人也是真的,人到中年以后学习能力身体素质比不上年轻人更是真的。
  所以我同大部分的你们一样也在思考,当我干到35岁的时候,我处于一种什么状态,我能达到一种什么样的高度?我会失业吗?我有核心竞争力吗?
  加入如果不换行业的话,那么目前摆在我面前的就只有两条路可走:管理或者架构。
  
  当然扯远了,现在就是打算多赚钱...** PS:女朋友想做家庭主妇,我一定要实现她的这个愿望**

进入正题

手写Butterknife框架,相信大部分同学在项目中都用到过 JakeWharton大神的这个框架,就算没用过也听说过。


  
这套框架的优缺点如下:

优点

  • 提高开发效率
  • 减少代码量
  • 性能不影响

缺点

  • 代码可读性差
  • 增加新人学习成本
  • 加速触及65535方法数问

嗯嗯,为什么会有上面的这些优缺点呢? 它是怎么得出来的这个结论呢?
废话不多说了,老司机开车啦

老司机开车

流程设计分析

我们平常调用ButterKnife的方式 如下图:


就以上两行代码 让我们省略了 findViewByID 这些动作。

仅仅两行代码,它都做了那些事情呢? 大概分为以下三步:

  • 给元素打注解;
  • 收集元素生成Java类(编译器执行);

    在编译时 通过处理注解元素 生成新的 Java 代码类,该Java代码 里面包含了我们的 findViewById(R.id.xxx)、view.setonclickListener(new lis... )的这些动作;

  • 动态注入;

    InjectView.bind(this); 将activity传进去,内部调用了第二步生成的 Java 。

下图表示了 第二步以及第三步做的事情。


核心原理

核心技术在于:编译时生成我们的 Java文件。

通过APT(AnnotionProcessing Tools)实现:在某些代码元素上(类型、函数、字段等)添加我们指定的注解,在编译时编译器会检查并拿到指定的元素,然后解析元素进行处理(这边是根据元素以及元素上的注解信息生成新的java类)。

以上的原理导致 最终的结果如下图,可以看到多出来一个MainActivity$$ViewBinder.class这个文件,在我们的代码中没有写MainActivity$$ViewBinder.java文件却编译出了MainActivity$$ViewBinder.class.

同学们,有木有很神奇!!!
我们接下来就可以解释上面所总结的优缺点了。

从使用上,不需要初始化View(使用findViewByID)了,动态注入事件(setOnclickListener)了等等...这极大的提高了我们开发的效率,减少了代码量。 再而该方式相当于我们手动写了一个类,没有影响性能。
当然 缺点就是:我们不知道 该类是怎么实现的,可读性很差,在一个增加了方法数量。

必备知识

核心技术就这些。

其中 JavaPoet是用来构造生成 Java 类文件,你也可以用Java原生的JavaFileObject来实现,这边只是JavaPoet比较好使用而已。
AbstractProcessor 在编译时用来处理注解元素。

拿起键盘一把梭

由于精力有限,就实现一下 bindView 功能,其他事件 onclick、 textChange啥么的 都是套路而已,只是麻烦一点。。。

工程目录

其中: intject-annotion 和 inject-compiler 是 java library并不是 android library;
    在intject-annotion中引入 'com.google.android:android:xxxcom.android.support:support-annotations:xxx包,就能 java项目中使用 android注解和一些onclicklistener事件了。

这边主要讲下如何 生成Java类
ButterKnifeProcessor.java


@AutoService(Processor.class)
public class ButterKnifeProcessor extends AbstractProcessor {
    /** 元素实用工具  */
    private Elements elementUtils;
    /** 用来创建新源、类或辅助文件的 Filer。 */
    private Filer filer;
    
    @Override
    public synchronized void init(ProcessingEnvironment env) {
        super.init(env);
        elementUtils = env.getElementUtils();
        filer = env.getFiler();
    }


    /**
     * 规定指定注解
     * @return
     */
    @Override
    public Set<String> getSupportedAnnotationTypes() {
        Set<String> types = new LinkedHashSet<>();
        for (Class<? extends Annotation> annotation : getSupportedAnnotations()) {
            types.add(annotation.getCanonicalName());
        }
        return types;
    }

    //process annotion
    @Override
    public boolean process(Set<? extends TypeElement> set, RoundEnvironment env) {
        print("process:");
        print("env"+env.getRootElements());
        Map<TypeElement, List<FieldBinding>> map = new HashMap<>();

        //拿到元素
        for (Element element : env.getElementsAnnotatedWith(BindView.class)) {
            //get the Activity
            TypeElement activityElement = (TypeElement) element.getEnclosingElement();
            print(" activityElement:"+ activityElement.toString());
            List<FieldBinding> list = map.get(activityElement);
            if (list == null) {
                list = new ArrayList<>();
                map.put(activityElement, list);
            }
            //get  id
            int id = element.getAnnotation(BindView.class).value();
            //get fieldName
            String fieldName = element.getSimpleName().toString();
            //get mirror
            TypeMirror typeMirror = element.asType();

            FieldBinding fieldBinding = new FieldBinding(fieldName, typeMirror, id);
            list.add(fieldBinding);
        }

        //遍历
        for (Map.Entry<TypeElement, List<FieldBinding>> item :
                map.entrySet()) {
            TypeElement activityElement = item.getKey();

            //get packageName  
            String packageName = elementUtils.getPackageOf(activityElement).getQualifiedName().toString();
            //get  activityName
            String activityName = activityElement.getSimpleName().toString();

            //转换成 javaPoet 认识的 类名
            ClassName activityClassName = ClassName.bestGuess(activityName);
            ClassName viewBuild = ClassName.get(ViewBinder.class.getPackage().getName(), ViewBinder.class.getSimpleName());    //

            //创建类   public class MainActivity$$ViewBinder<T extends MainActivity> implements ViewBinder<MainActivity>
            TypeSpec.Builder result = TypeSpec.classBuilder(activityClassName + "$$ViewBinder")            // 类名   MainActivity$$ViewBinder
                    .addModifiers(Modifier.PUBLIC)                                                         //修饰符
                    .addTypeVariable(TypeVariableName.get("T", activityClassName))                         //泛型   <T extends MainActivity>
                    .addSuperinterface(ParameterizedTypeName.get(viewBuild,activityClassName));             // 添加接口  接口内有泛型   implements ViewBinder<MainActivity> 

            //创建方法      public void bind(MainActivity target)  
            MethodSpec.Builder method = methodBuilder("bind")      //methodName           bind
                    .addModifiers(Modifier.PUBLIC)                          // modifier
                    .returns(TypeName.VOID)
                    .addAnnotation(Override.class)                          
                    .addParameter(activityClassName, "target", Modifier.FINAL);       //MainActivity target  
//              
            //   target.tv = (TextView)target.findViewById(2131427415);
            //      target.btn = (Button)target.findViewById(213142741s5);
            List<FieldBinding> list = item.getValue();
            for (FieldBinding fieldBinding : list) {
                //
                String pacageName = fieldBinding.getType().toString();
                ClassName viewClass = ClassName.bestGuess(pacageName);
                // 添加 target.tv = (TextView)target.findViewById(2131427415); 到方法内
                method.addStatement("target.$L=($T)target.findViewById($L)", fieldBinding.getName(), viewClass, fieldBinding.getResId());
            }
//          添加方法
            result.addMethod(method.build());

            try {
                //生成java文件
                JavaFile.builder(packageName, result.build()).build().writeTo(filer);
            } catch (IOException e) {
                e.printStackTrace();
            }

        }
        return true;
    }

}

允许我偷个懒,该类的方法说明如下:

生成Java 文件的代码我都有一行一行给注释,在上面自己看下就懂了。

生成java文件的代码

butterKnife 巧妙设计 分享

这是作者个人的一些观点,如果有不对你来打死我呀。
开玩笑的,请告诉我!!!

apt的使用那就不用说了,本身就是一种优雅地设计。

注解上面使用注解。(好处自己体会)


还有一些问题想请教广大网友:

很奇葩的问题:引入annotions包 一直失败。(anrdoid studio版本 2.3。)


项目地址:戳我!!!


路漫漫其修远兮

01. 手写EventBus框架——源码分析1
02. 手写EventBus框架——源码分析2
03. 手写EventBus框架——动手_整体架构设计
04. 手写EventBus框架——动手_终结


希望我的文章不会误导在观看的你,如果有异议的地方欢迎讨论和指正。
如果能给观看的你带来收获,那就是最好不过了。

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

推荐阅读更多精彩内容