Router解析

Android的路由框架一般都是基于注解做处理的,但是由于反射造成一定运行效率的损耗,所以我们会更青睐于编译时注解的框架,也就是程序在编译的时候通过处理注解生成Java代码。那我们就先讲一讲注解,网上关于注解的讲解有很多,我是看了这篇文档 Java注解(Annotation),里面的讲解很详细,这里我就说说我们用到的东西。

@Retention(RetentionPolicy.CLASS)
@Target({ElementType.TYPE, ElementType.METHOD})
public @interface Router {
    String[] value();
    String[] stringParams() default "";
    ...
}
  • @Retention
    表示该注解类型的注解保留的时长。当注解类型声明中没有@Retention元注解,则默认保留策略为RetentionPolicy.CLASS。关于保留策略(RetentionPolicy)是枚举类型,共定义3种保留策略,如下表:
RetentionPolicy 含义
SOURCE 仅存在Java源文件,经过编译器后便丢弃相应的注解
CLASS 存在Java源文件,以及经编译器后生成的Class字节码文件,但在运行时VM不再保留注解
RUNTIME 存在源文件、编译生成的Class字节码文件,以及保留在运行时VM中,可通过反射性地读取注解

由于在编译生成.class文件后我们没有再使用注解,在这里使用@Retention(RetentionPolicy.SOURCE)也是可以的。验证SOURCECLASS可以去./build/intermediates/classes/包名/*.class查看注解是否存在。

  • @Target
    表示该注解类型的所使用的程序元素类型。当注解类型声明中没有@Target元注解,则默认为可适用所有的程序元素。如果存在指定的@Target元注解,则编译器强制实施相应的使用限制。关于程序元素(ElementType)是枚举类型,共定义8种程序元素,如下表:
ElementType 含义
ANNOTATION_TYPE 注解类型声明
CONSTRUCTOR 构造方法声明
FIELD 字段声明(包括枚举常量)
LOCAL_VARIABLE 局部变量声明
METHOD 方法声明
PACKAGE 包声明
PARAMETER 参数声明
TYPE 类、接口(包括注解类型)或枚举声明
  • @interface 声明注解
  • String[] value(); 表示这个注解里可以存放什么类型值
  • default "" 表示默认值

到这里关于Router要使用的注解基本语法已将讲完啦[撒花]。

Router框架结构

  • annotation 用于存放注解,Java模块
apply plugin: 'java'
compileJava {
    sourceCompatibility = '1.7'
    targetCompatibility = '1.7'
}
  • compiler 用于编写注解处理器,Java模块
apply plugin: 'java' //由于要使用javax包AndroidSdk是没有的

compileJava {
    sourceCompatibility = '1.7'
    targetCompatibility = '1.7'
}

dependencies {
    compile project(':annotation') //因为编写注解处理器需要依赖相关注解,所以要依赖annotation模块

    compile 'com.google.auto.service:auto-service:1.0-rc2' //主要的作用是注解 Processor 类,并对其生成 META-INF 的配置信息
    compile 'com.squareup:javapoet:1.7.0' //JavaPoet is a Java API for generating .java source files.
}
  • router 用于给用户提供使用的API, library模块,依赖annotation模块

  • app

compile project(':router')
annotationProcessor project(':compiler')

在项目根目录添加apt(注解处理工具):

dependencies {
        ...
        classpath 'com.neenbedankt.gradle.plugins:android-apt:1.8'
        ...
}

Router实现

注解最重要的就是注解处理器了,RouterProcessor会在编译时期生成Java代码。

@AutoService(Processor.class)
public class RouterProcessor extends AbstractProcessor {
    private Filer filer;//用于创建Java文件

    //初始化操作
    @Override
    public synchronized void init(ProcessingEnvironment processingEnv){
        filer = processingEnv.getFiler();
    }

    //返回一个支持注解的set集合,也就是说想要处理的注解都要放到这个集合里面
    @Override
    public Set getSupportedAnnotationTypes() {}

    //返回处理器支持的最新版本
    @Override
    public SourceVersion getSupportedSourceVersion() {}

    //处理注解,生成java文件就是在这个方法里
    @Override
    public boolean process(Set annotations, RoundEnvironment roundEnv) {}
}

项目在组件化的时候会有很多模块,通过Router是如何实现页面跳转的呢?于是有这么一个注解:

@Router("MainActivity")
public class MainActivity extends AppCompatActivity{}

你可能感兴趣的:(Router解析)