項(xiàng)目背景

組件后怕午，我們通過路由打通了模塊之間的跳轉(zhuǎn)。

項(xiàng)目簡介

挨個(gè)注冊路由

路由的注冊使用單例一個(gè)個(gè)添加震贵，隨著項(xiàng)目的膨脹利赋，這種模式就不好維護(hù)了，也容易出現(xiàn)Activity被不同的路由重復(fù)注冊的情況猩系。

解決思路

APT(Annotation Processing Tool)即注解處理器媚送，是一種注解處理工具，用來在編譯期掃描和處理注解寇甸，通過注解來生成 Java 文件塘偎。即以注解作為橋梁，通過預(yù)先規(guī)定好的代碼生成規(guī)則來自動生成 Java 文件拿霉。此類注解框架的代表有 ButterKnife吟秩、Dragger2、EventBus等
Java API 已經(jīng)提供了掃描源碼并解析注解的框架绽淘，開發(fā)者可以通過繼承AbstractProcessor類來實(shí)現(xiàn)自己的注解解析邏輯涵防。APT 的原理就是在注解了某些代碼元素（如字段、函數(shù)沪铭、類等）后壮池，在編譯時(shí)編譯器會檢查 AbstractProcessor的子類，并且自動調(diào)用其process()方法杀怠，然后將添加了指定注解的所有代碼元素作為參數(shù)傳遞給該方法椰憋，開發(fā)者再根據(jù)注解元素在編譯期輸出對應(yīng)的Java 代碼

那么通過注解編譯，能幫我們改造到什么程度呢赔退？下面是改造后的路由

路由表解析橙依、注冊
我們路由注冊的顆粒是面向插件模塊的，減少了很多業(yè)務(wù)代碼

 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標(biāo)記注解
注解不會被繼承，所以我們不用擔(dān)心子Activity被標(biāo)記

@XLRouteAnno(XLRouteConfig.ROUTE_MAIN_INDEX_PAGE)
public class MainActivity extends Activity  {
        //票编。褪储。。一些業(yè)務(wù)代碼
}

編譯注解慧域，在各個(gè)插件模塊自動創(chuàng)建路由表文件
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);
  }
}

改造完成后，路由注冊表的可維護(hù)性大大提高昔榴。下面圖展示了注解編譯是如何工作的

image.png

代碼已經(jīng)放到git倉庫辛藻，https://gitee.com/yso/AnnoProcessor
沒有復(fù)雜的業(yè)務(wù)邏輯，可能陌生的api比較多互订，大家對照demo多查查就熟悉了
下面是一些需要注意的點(diǎn)

注意事項(xiàng)

1 吱肌、注解庫

記得庫類型要選Java庫

記得要選java Library

修改gradle庫，引入第三方庫

apply plugin: 'java-library'

dependencies {
    implementation fileTree(dir: 'libs', include: ['*.jar'])
    //javaPoet可以更方便的創(chuàng)建java文件
    implementation 'com.squareup:javapoet:1.11.1'
    //auto-service可以幫我們把編譯注解自動注冊到項(xiàng)目中
    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仰禽、接入

在調(diào)用方的build.gradle添加依賴關(guān)系

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

在defaultConfig里添加

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

3氮墨、功能跨模塊

通過上面的注解實(shí)戰(zhàn)，我們在模塊之間打通了頁面的跳轉(zhuǎn)吐葵；
那么功能如何跨模塊調(diào)用呢规揪？我們的做法是

在公共庫定義契約接口
在能提供功能的工程實(shí)現(xiàn)這個(gè)契約接口
在殼app里，注冊這個(gè)這個(gè)實(shí)現(xiàn)温峭，key是契約猛铅，value是實(shí)現(xiàn)對象
XLProviderManager.getInstance().register(IPrivateChatContract.class, new PrivateChatContract());
注冊后，在各個(gè)模塊就能這樣調(diào)用了
IPrivateChatContract chatFunc = (IPrivateChatContract) XLProviderManager.getInstance().getProvider(IPrivateChatContract.class);

致謝

在開發(fā)過程中借鑒了下述兩個(gè)優(yōu)秀開源庫凤藏，感謝開發(fā)者
https://github.com/chenenyu/Router奸忽、https://github.com/alibaba/ARouter

組件化全局路由實(shí)踐-基于注解編譯APT