AnnotationProcessor 就是注解编译，通过它，我们可以在编译阶段拿到注解对象（类、属性、方法等）的属性、注解值。我们常用的做法是把拿到的元素包装下，写成一个Java类。然后在业务代码里使用反射、实例化得对该java类进行操作。

项目背景

我们通过路由打通了插件层内部、插件层与应用层之间的跳转。

项目简介 挨个注册路由

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

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

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

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

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

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

3. 编译注解，在各个插件模块自动创建路由表文件
   Build成功后，文件路径为：工程名\build\generated\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'])
    //下面两个库版本是jdk 1.7最后一个版本，再没改成1.8之前，不要升级
    //javaPoet可以更方便的创建java文件
    implementation 'com.squareup:javapoet:1.9.0'
    //auto-service可以帮我们把编译注解自动注册到项目中
    implementation 'com.google.auto.service:auto-service:1.0-rc3'
}

sourceCompatibility = JavaVersion.VERSION_1_7
targetCompatibility = JavaVersion.VERSION_1_7

2、接入

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

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

在defaultConfig里添加

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

致谢

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