项目背景

组件后，我们通过路由打通了模块之间的跳转。

项目简介

挨个注册路由

路由的注册使用单例一个个添加，随着项目的膨胀，这种模式就不好维护了，也容易出现Activity被不同的路由重复注册的情况。

解决思路

APT(Annotation Processing Tool)即注解处理器，是一种注解处理工具，用来在编译期扫描和处理注解，通过注解来生成 Java 文件。即以注解作为桥梁，通过预先规定好的代码生成规则来自动生成 Java 文件。此类注解框架的代表有 ButterKnife、Dragger2、EventBus等
Java API 已经提供了扫描源码并解析注解的框架，开发者可以通过继承AbstractProcessor类来实现自己的注解解析逻辑。APT 的原理就是在注解了某些代码元素（如字段、函数、类等）后，在编译时编译器会检查 AbstractProcessor的子类，并且自动调用其process()方法，然后将添加了指定注解的所有代码元素作为参数传递给该方法，开发者再根据注解元素在编译期输出对应的Java 代码

那么通过注解编译，能帮我们改造到什么程度呢？下面是改造后的路由

路由表解析、注册
我们路由注册的颗粒是面向插件模块的，减少了很多业务代码

 public static void initRoute() {
        XLRouteManager.getInstance().clearRoute();
        XLRouteManager.getInstance().addClearTopClass(MainActivity.class);
        XLRouteManager.getInstance().initLocalRouteModule("app");
        XLRouteManager.getInstance().initLocalRouteModule(XLRouteConfig.LOCAL_FUNCTION_MODULE_LIST);
    }

Activity标记注解
注解不会被继承，所以我们不用担心子Activity被标记

@XLRouteAnno(XLRouteConfig.ROUTE_MAIN_INDEX_PAGE)
public class MainActivity extends Activity  {
        //。。。一些业务代码
}

编译注解，在各个插件模块自动创建路由表文件
Build成功后，文件路径为：工程名\build\ap_generated_sources\source\apt\debug或者release\包名\

/**
 * Generated by XLRouter. Do not edit it!
 */
public class AppRouteContentProvider implements IXLRouteContentProvider {
  @Override
  public void handleRoute(Map<String, Class<?>> map) {
    map.put("family/ties", MyFamilyActivity.class);
    map.put("family/invite", InviteDetailActivity.class);
    map.put("main/loginPage", LoginActivity.class);
    map.put("space/joinClass", NewClassNoAccountActivity.class);
    map.put("main/blackBoardPhoto", TeachUploadActivity.class);
    map.put("main/handWritePlan", TeachingPlanActivity.class);
    map.put("main/indexPage", MainActivity.class);
    map.put("main/selectCourse", SelectCourseStuActivity.class);
    map.put("userInfo/teacherSetting", TeachSettingActivity.class);
    map.put("main/deliverPage", RouteDeliverActivity.class);
    map.put("main/splashPage", SplashActivity.class);
  }
}

改造完成后，路由注册表的可维护性大大提高。下面图展示了注解编译是如何工作的

image.png

代码已经放到git仓库，https://gitee.com/yso/AnnoProcessor
没有复杂的业务逻辑，可能陌生的api比较多，大家对照demo多查查就熟悉了
下面是一些需要注意的点

注意事项

1 、注解库

记得库类型要选Java库

记得要选java Library

修改gradle库，引入第三方库

apply plugin: 'java-library'

dependencies {
    implementation fileTree(dir: 'libs', include: ['*.jar'])
    //javaPoet可以更方便的创建java文件
    implementation 'com.squareup:javapoet:1.11.1'
    //auto-service可以帮我们把编译注解自动注册到项目中
    implementation 'com.google.auto.service:auto-service:1.0-rc6'
    annotationProcessor 'com.google.auto.service:auto-service:1.0-rc6'
}

sourceCompatibility = JavaVersion.VERSION_1_8
targetCompatibility = JavaVersion.VERSION_1_8

2、接入

在调用方的build.gradle添加依赖关系

 annotationProcessor project(":XLAnnoProcessor")
    implementation project(":XLAnnoProcessor")

在defaultConfig里添加

javaCompileOptions {
            annotationProcessorOptions {
                arguments = [ moduleName : project.getName() ]
            }
        }

3、功能跨模块

通过上面的注解实战，我们在模块之间打通了页面的跳转；
那么功能如何跨模块调用呢？我们的做法是

在公共库定义契约接口
在能提供功能的工程实现这个契约接口
在壳app里，注册这个这个实现，key是契约，value是实现对象
XLProviderManager.getInstance().register(IPrivateChatContract.class, new PrivateChatContract());
注册后，在各个模块就能这样调用了
IPrivateChatContract chatFunc = (IPrivateChatContract) XLProviderManager.getInstance().getProvider(IPrivateChatContract.class);

致谢

在开发过程中借鉴了下述两个优秀开源库，感谢开发者
https://github.com/chenenyu/Router、https://github.com/alibaba/ARouter

组件化全局路由实践-基于注解编译APT