注解的理解与ARouter框架的学习

动手实现一个路由框架

前言

  • 组件化或者模块化开发模式,已逐渐成为热浪的形式,使用这些模式可以让我们程序更容易的扩展、更方便的测试与维护

  • ARouter是:阿里巴巴自研路由框架,主要解决组件间、模块间的 界面跳转 问题。

  • 我们将自己简单实现一个路由

这个项目对你有什么帮助?

让我更加熟悉注解与注解编译器的过程,也让我们对以后项目也有了更大的可能延展性

构思

让我们自己先想着如何实现,本身实现并不复杂。 新建一个Arouter类

Arouter

  1. 既然在使用Arouter的时候我们的调用方式是根据Path来的,那么我们肯定需要一个Map<String,Class<? extend Activity> class> 来装载这个集合
  2. 然后我们要对外开启一个方法来把Activity Put进来。
  3. 处理跳转,根据map.get(Path) 来跳到相应的Activity 中去。

就这三步,是不是看起来很容易。 问题就只在于如何生成一个自动添加Activity的工具类,然后自动的去执行这个方法。

项目结构

项目结构.png

分为4个模块

  • annotation 模块:用来定义注解

  • compiler 模块:用来定义Annotation Processor

  • app 模块 : 主模块,也是Activity测试模块

  • Arouter模块: 路由模块

    为什么要分这么多模块?其中 app 模块是用来测试的,测试新定义的 Annotation Processor 能否成功运行。两者的目的并不一样,annotation 是专门定义注解的,而 compiler 是处理注解的。最重要的是,annotation(RetentionPolicy.CLASS,RetentionPolicy.RUNTIME)是需要被编译到 app 项目的 class 文件中的,而 compiler 没有必要进入 app 中。所以在gradle中依赖为compileOnly

  • 在annotation模块中创建一个注解文件,通过这个注解获取path
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.CLASS)
public @interface BindPath {
    String value();
}
  • 有了注解我们还需要一个compiler 替我们去生成对应的代码, 我们在创建一个AnotationCompiler类. 编写注解处理器,在编译期找到加入注解的类文件,进行处理
@AutoService(Processor.class)  //注册注解处理器
public class AnotationCompiler extends AbstractProcessor {

    private Filer mFiler;

    @Override
    public synchronized void init(ProcessingEnvironment processingEnvironment) {
        super.init(processingEnvironment);
        mFiler = processingEnvironment.getFiler();
        System.out.println("jsc");
    }

    /**
     * 声明这个注解处理器要识别处理的注解
     * @return
     */
    @Override
    public Set<String> getSupportedAnnotationTypes() {
        Set<String> types = new HashSet<>();
        types.add(BindPath.class.getCanonicalName());
        return types;
    }

    /**
     * 支持java的源版本
     * @return
     */

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

    /**
     * 核心方法
     * @param set
     * @param roundEnvironment
     * @return
     */

    @Override
    public boolean process(Set<? extends TypeElement> set, RoundEnvironment roundEnvironment) {
        System.out.println("123");
        Set<? extends Element> elementsAnnotatedWith = roundEnvironment.getElementsAnnotatedWith(BindPath.class);
        Map<String,String> map =new HashMap<>();
        for (Element element : elementsAnnotatedWith) {
            TypeElement typeElement = (TypeElement) element;
            BindPath bindPath = typeElement.getAnnotation(BindPath.class);
            //对应的key
            String value = bindPath.value();
            //获取带包名的类名
            String activityName = typeElement.getQualifiedName().toString();
            map.put(value,activityName);
        }

        if (map.size()>0) {
            Writer writer=null;
            String activityNmae = "ActivityUtil"+System.currentTimeMillis();
            try {
                JavaFileObject classFile = mFiler.createSourceFile("com.example.util." + activityNmae);
                writer = classFile.openWriter();
                writer.write("package com.example.util;\n" +
                        "\n" +
                        "import com.example.arouter2.ARouter;\n" +
                        "import com.example.arouter2.IARouter;\n" +
                        "\n" +
                        "/**\n" +
                        " * @author AlienChao\n" +
                        " * @date 2019/11/19 17:34\n" +
                        " */\n" +
                        "public class "+activityNmae+" implements IARouter {\n" +
                        "    @Override\n" +
                        "    public void putActivity() {");
                Iterator<String> iterator = map.keySet().iterator();
                while (iterator.hasNext()) {
                    String path = iterator.next();
                    String value  = map.get(path);
                    writer.write("\n ARouter.getInstance().putActivity(\""+path+"\","+value +".class);");
                }
                writer.write(" \n}\n" +
                        "}");

            } catch  (Exception e) {
                 e.printStackTrace();
            }finally {
                if (null!=writer) {
                    try {
                        writer.close();
                    } catch (IOException e) {
                        e.printStackTrace();
                    }
                }

            }
        }
        return false;
    }
}

如代码中所示,要想在编译期对注解做处理,就需要AnnotationCompiler继承自AbstractProcessor并通过@AutoService注解进行注册,然后实现process()方法。process()方法里的set集合就是编译期扫描代码得到的加入了BindPath注解的文件集合
这里需要注意的是谷歌的 auto service, 在As 3.4- 之前是用1.0-rc3 在As3.4.1+ gradle5.1.1 之后用1.0-rc4。

image-20191120173851791.png
  • compileOnly 所需的只是 @AutoService 这个注解。表示只参与编译过程并不打包到最终产物 jar 文件中,而注解 @AutoService 的 RetentionPolicy 就是 SOURCE,不会编译生成到 class 文件中。即便使用 implementation依赖,最终生成的 jar 包中只会多了 auto service 提供的注解,其他 class 文件部分不受影响,因此可以使用 compileOnly 只参与编译过程。
  • annotationProcessor 这个是新版 gradle 提供的 java plugin 内置的配置项,代替了早期第三方提供的 android-apt 插件。而且,敲重点,在 gradle 5.+ 中将 Annotation Processor 从编译期 classpath 中去除了,javac 也就无法发现 Annotation Processor。此处如果按照 gradle 4.+ 的写法,只写一个 compileOnly 是无法使用 auto service 的 Annotation Processor 的。必须要使用 annotationProcessor 来配置 Annotation Processor 使其生效。

生成完了,那怎么去执行这个代码呢??

这里就比较粗暴一点, 直接 根据完整路径获取dex,遍历dex获取所有带包名的类名, 有了类名我们就好办了,可以根据类名 判断是否是IARouter 的实现类,去调用 putActivity() 方法

private List<String> getClassName(String packageName) {
        //创建一个class对象的集合
    List<String> classList = new ArrayList<>();
    String path = null;
    try {
       //通过包管理器   获取到应用信息类然后获取到APK的完整路径
       path = context.getPackageManager().getApplicationInfo(
               context.getPackageName(), 0).sourceDir;
       //根据APK的完整路径获取到编译后的dex文件目录
       DexFile dexfile = new DexFile(path);
       // 获得编译后的dex文件中的所有class
       Enumeration entries = dexfile.entries();
       //然后进行遍历
       int index = 0;

       while (entries.hasMoreElements()) {
           index ++;
           //通过遍历所有的class的包名
           String name = (String) entries.nextElement();

           // 判断类的包名是否符合 com.dongnao.util
           if(name.contains(packageName)){
               //如果符合 就添加到集合中
               classList.add(name);
           }
        }
    } catch (Exception e) {
       e.printStackTrace();
    }
    return classList;
}

public void init(Application application){
    context = application;
    List<String> className = getClassName("com.example.util");
    //遍历
    for (String s : className) {
        try {
            Class<?> aClass = Class.forName(s);
            //判断这个类是不是IRouter这个接口的子类
            if(IARouter.class.isAssignableFrom(aClass)){
                //通过接口的引用 指向子类的实例
                IARouter iRouter = (IARouter) aClass.newInstance();
                iRouter.putActivity();
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

参考资料:

https://blog.csdn.net/ajey2005/article/details/100652260

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