【Android】阿里路由框架ARouter原理分析总结

1、单向依赖的module之间

组件化中两个单向依赖的module之间需要互相启动对方的Activity时，因为没有相互引用，startActivity()是实现不了的，必须需要一个协定的通信方式，此时类似ARouter的路由框架就派上用场了。

2、互不依赖的module之间

两个module之间没有依赖，便不能通过startActivity()的显示启动进行通信，那么如何进行通信呢？

（1）隐式跳转：这是一种解决方法，但是一个项目中不可能所有的跳转都是隐式的，这样Manifest文件会有很多过滤配置，而且非常不利于后期维护。

（2）反射：当然你用反射拿到Activity的class文件也可以实现跳转，但是大量的使用反射跳转对性能会有影响。

（3）路由框架。

3、ARouter原理

（1）在每个需要对其他module提供调用的Activity中，都会声明类似下面@Route注解，我们称之为路由地址。

@Route(path = "/main/main")
public class MainActivity extends AppCompatActivity {}
@Route(path = "/module1/module1main")
public class Module1MainActivity extends AppCompatActivity {}

（2）编译期时生成路由映射

路由框架会在项目的编译期通过注解处理器apt扫描所有添加@Route注解的Activity类，然后将Route注解中的path地址和Activity.class文件映射关系保存到它自己生成的java文件中，只要拿到了映射关系便能拿到Activity.class。

route.put("/main/main", MainActivity.class);
route.put("/module1/module1main", Module1MainActivity.class);
route.put("/login/login", LoginActivity.class);

（3）不同module之间启动Activity

public void login(String name, String password) {
    LoginActivity.class classBean = route.get("/login/login");
    Intent intent = new Intent(this, classBean);
    intent.putExtra("name", name);
    intent.putExtra("password", password);
    startActivity(intent);
}

（4）ARouter使用

ARouter.getInstance().build("/test/login")
            .withString("password", 666666)
            .withString("name", "小三")
            .navigation();

ARouter背后的实现原理其实跟上面讲解是一样的。

4、apt & javapoet

apt是在编译期对代码中指定的注解进行解析，然后做一些其他处理（如通过javapoet生成新的Java文件）。我们常用的ButterKnife，其原理就是通过注解处理器在编译期扫描代码中加入的@BindView、@OnClick等注解进行扫描处理，然后生成XXX_ViewBinding类，实现了view的绑定。javapoet是用来生成java文件的一个library，它提供了简便的api供你去生成一个java文件。

5、路由映射文件生成原理

（1）定义注解

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.CLASS)
public @interface Route {
    //Path of route
    String path();

    //Used to merger routes
    String group() default "";
}

ARouter中会要求路由地址至少需要两级，如"/xx/xx"，其中第一级是group。因为当项目变得越来越庞大的时候，为了便于管理和减小首次加载路由表过于耗时的问题，我们对所有的路由进行分组。

（2）在Activity上使用注解

@Route(path = "/main/main")
public class MainActivity extends AppCompatActivity {}
@Route(path = "/main/main2")
public class Main2Activity extends AppCompatActivity {}

（3）编写注解处理器

@AutoService(Processor.class)
@SupportedOptions({"AROUTER_MODULE_NAME", "AROUTER_GENERATE_DOC" })
@SupportedSourceVersion(SourceVersion.RELEASE_7)
@SupportedAnnotationTypes({ANNOTATION_TYPE_ROUTE, ANNOTATION_TYPE_AUTOWIRED})
public class RouteProcessor extends AbstractProcessor {
// ModuleName and routeMeta.
//分组 key:组名 value:对应组的路由信息
    private Map> groupMap = new HashMap<>();
    // Map of root metas, used for generate class file in order.
    private Map rootMap = new TreeMap<>();  

    @Override
    public synchronized void init(ProcessingEnvironment processingEnv) {
        super.init(processingEnv);
        //
        // Attempt to get user configuration [moduleName]
        Map options = processingEnv.getOptions();
        if (MapUtils.isNotEmpty(options)) {
            moduleName = options.get("AROUTER_MODULE_NAME");  
        }
    }

    @Override
    public boolean process(Set annotations, RoundEnvironment roundEnv) {
        //
    }
}

说明：

（a）@AutoService(Processor.class)

AutoService会自动在META-INF文件夹下生成Processor配置信息文件，该文件里就是实现Processor接口的具体实现类。而当外部程序装配这个模块的时候，就能通过该jar包META-INF/services/里的配置文件找到具体的实现类名，并装载实例化，完成模块的注入。

基于这样一个约定就能很好的找到服务接口的实现类，而不需要再代码里制定，方便快捷。应用依赖如下：

implementation 'com.google.auto.service:auto-service:1.0-rc3'

文件结构如下：

（b）@SupportedOptions({KEY_MODULE_NAME, KEY_GENERATE_DOC_NAME})

SupportedOptions指定支持的选项（即处理器接收的参数），AbstractProcessor的getSupportedOptions()会得到它支持的选项。

public Set getSupportedOptions() {
    SupportedOptions var1 = (SupportedOptions)this.getClass().getAnnotation(SupportedOptions.class);
    return var1 == null ? Collections.emptySet() : arrayToSet(var1.value());
}

（c）@SupportedSourceVersion(SourceVersion.RELEASE_7)

指定使用的Java版本。

（d）@SupportedAnnotationTypes({ANNOTATION_TYPE_ROUTE, ANNOTATION_TYPE_AUTOWIRED})

指定注解处理器是注册给哪一个注解的，它是一个字符串的集合，意味着可以支持多个类型的注解，并且字符串是合法全名。

（e）

init()和process()是接口Processor的方法。

public abstract class AbstractProcessor implements Processor{}

抽象类AbstractProcessor实现了Processor接口。

process()方法里的set集合就是编译期扫描代码得到的加入了Route注解的文件集合。

（f）moduleName = options.get("AROUTER_MODULE_NAME");

以上代码会得到一个moduleName，这个moduleName需要我们在要使用注解处理器生成路由映射文件的模块gradle文件里配置，而@SupportedOptions("AROUTER_MODULE_NAME")会拿到当前module的名字，用来生成唯一对应module下存放分组信息的类文件名。在这之前，我们需要在每个组件module的gradle下配置如下：

android {
    defaultConfig {
        javaCompileOptions {
            annotationProcessorOptions {
                arguments = [AROUTER_MODULE_NAME: project.getName(), AROUTER_GENERATE_DOC: "enable"]
            }
        }
    }
}

（4）使用javapoet生成java类

（参考Arouter的easyrouter实现方式）

（a）定义变量

    /**
     * key:组名   value:该组名对应的group类名
     */
    private Map rootMap = new TreeMap<>();

    /**
     * key:组名   value:该组下的路由信息
     */
    private Map> groupMap = new HashMap<>();

（b）定义接口IRouteGroup

public interface IRouteGroup {
    void loadInto(Map atlas);
}

（c）定义接口IRouteRoot

public interface IRouteRoot {
    void loadInto(Map> routes);
}

（d）生成group类

private void generatedGroup(TypeElement iRouteGroup) {
        //创建参数类型 Map
        ParameterizedTypeName parameterizedTypeName = ParameterizedTypeName.get(
                ClassName.get(Map.class),
                ClassName.get(String.class),
                ClassName.get(RouteMeta.class));
        ParameterSpec altas = ParameterSpec.builder(parameterizedTypeName, "atlas").build();

        for (Map.Entry> entry : groupMap.entrySet()) {
            MethodSpec.Builder methodBuilder = MethodSpec.methodBuilder(Constant.METHOD_LOAD_INTO)
                    .addModifiers(Modifier.PUBLIC)
                    .addAnnotation(Override.class)
                    .addParameter(altas);

            String groupName = entry.getKey();
            List groupData = entry.getValue();
            for (RouteMeta routeMeta : groupData) {
                //函数体的添加
                methodBuilder.addStatement("atlas.put($S,$T.build($T.$L,$T.class,$S,$S))",
                        routeMeta.getPath(),
                        ClassName.get(RouteMeta.class),
                        ClassName.get(RouteMeta.Type.class),
                        routeMeta.getType(),
                        ClassName.get(((TypeElement) routeMeta.getElement())),
                        routeMeta.getPath(),
                        routeMeta.getGroup());
            }
            String groupClassName = Constant.NAME_OF_GROUP + groupName;
            TypeSpec typeSpec = TypeSpec.classBuilder(groupClassName)
                    .addSuperinterface(ClassName.get(iRouteGroup))
                    .addModifiers(Modifier.PUBLIC)
                    .addMethod(methodBuilder.build())
                    .build();
            JavaFile javaFile = JavaFile.builder(Constant.PACKAGE_OF_GENERATE_FILE, typeSpec).build();
            try {
                javaFile.writeTo(filerUtils);
            } catch (IOException e) {
                e.printStackTrace();
            }
            rootMap.put(groupName, groupClassName);

        }
    }

说明：

1）根据groupMap分组信息，每一组生成一个group类，每一个group类里包含该组所有信息。

2）rootMap.put(groupName, groupClassName); //存放组名和该组的group类名的映射关系。

（e）生成Root类

private void generatedRoot(TypeElement iRouteRoot, TypeElement iRouteGroup) {
        //创建参数类型 Map> routes>
        //Wildcard 通配符
        ParameterizedTypeName parameterizedTypeName = ParameterizedTypeName.get(
                ClassName.get(Map.class),
                ClassName.get(String.class),
                ParameterizedTypeName.get(
                        ClassName.get(Class.class),
                        WildcardTypeName.subtypeOf(ClassName.get(iRouteGroup))
                ));
        //参数 Map> routes> routes
        ParameterSpec parameter = ParameterSpec.builder(parameterizedTypeName, "routes").build();
        //函数 public void loadInfo(Map> routes> routes)
        MethodSpec.Builder methodBuilder = MethodSpec.methodBuilder(Constant.METHOD_LOAD_INTO)
                .addModifiers(Modifier.PUBLIC)
                .addAnnotation(Override.class)
                .addParameter(parameter);
        //函数体
        for (Map.Entry entry : rootMap.entrySet()) {
            methodBuilder.addStatement("routes.put($S, $T.class)", entry.getKey(), ClassName.get(Constant.PACKAGE_OF_GENERATE_FILE, entry.getValue()));
        }
        //生成$Root$类
        String className = Constant.NAME_OF_ROOT + moduleName;
        TypeSpec typeSpec = TypeSpec.classBuilder(className)
                .addSuperinterface(ClassName.get(iRouteRoot))
                .addModifiers(Modifier.PUBLIC)
                .addMethod(methodBuilder.build())
                .build();
        try {
            JavaFile.builder(Constant.PACKAGE_OF_GENERATE_FILE, typeSpec).build().writeTo(filerUtils);
            log.i("Generated RouteRoot：" + Constant.PACKAGE_OF_GENERATE_FILE + "." + className);
        } catch (IOException e) {
            e.printStackTrace();
        }
    }

说明：

1）根据rootMap信息，生成一个root类，该root类以moduleName命名。

2）root类里包含信息（即组名与组对应的group类的映射关系）。