arouter編譯器註解

A. ARouter源碼分析

Annotation Processing Tool，自定義註解處理器。
搞Android的基本上都知道這個吧。許多第三方庫都使用了APT去實現自己的功能，比如butterknife，比如X2C，比如我們要講的ARouter。
其基本做法是：

一般是自定義gradle Transform + ASM，實現AOP，可以在編譯期修改project和第三方依賴庫中的class文件（比如ARouter源碼中的arouter-gradle-plugin模塊），與APT主要是生成.java文件不同，ASM操作的是.class文件。
自定義gradle Transform功能很強大，可以與ASM結合，修改.class，也可以操作資源文件(比如統一壓縮圖片，轉png大圖為webp等)。
至於ASM，基於修改.class文件，我們即可以用ASM來插樁統計方法耗時，也可以用來實現自動化埋點，甚至是修改第三方lib中的crash...

使用方法可以看 ARouter 。
帶著問題看源碼，這里主要的問題是：

ARouter的核心方法。

這個方法算是核心中的核心了。
其實也只做了兩件事情

總的來說，只幹了一件事情，掃描所有的dex文件，找到com.alibaba.android.arouter.routes包下的所有文件並返回。這里的操作都是耗時操作。
但是com.alibaba.android.arouter.routes包下都是什麼文件呢？
比如：

比如：

比如：

比如：

這些都是APT生成的輔助類。

①項目編譯期，通過APT，生成輔助類（所有的輔助類包名都是com.alibaba.android.arouter.routes）
包括

②ARouter#init初始化的時候，掃描dex文件，找到①生成的輔助類文件（也即是包com.alibaba.android.arouter.routes下的文件），放到routerMap中

注意，這里沒有實例化IRouteGroup，IRouteGroup的信息都在IRouteRoot中，這樣做的目的是為了實現分組route的載入，用到了哪個group的route的信息，才會載入這個group的信息，沒用到就不載入。這里可以仔細想想IProviderGroup/IInterceptorGroup/IRouteGroup的區別。
該方法執行完了以後，

至此，就完成了初始化路由表的操作。
我們回過頭來瞄一眼ARouter#init，裡面初始化路由表以後，執行了_ARouter#afterInit

這一句看著很熟悉。

頁面路由跳轉/IProvider/攔截器都是ARouter.getInstance().build("/test/activity").navigation()這種形式的話，我們就先從攔截器interceptorService = (InterceptorService) ARouter.getInstance().build("/arouter/service/interceptor").navigation();開始分析吧。

雖然這里我們是想看攔截器的實現，但是要明確一點：InterceptorServiceImpl是IProvider的實現類，獲取InterceptorService也就是獲取一個IProvider。有一點繞，簡單來說，ARouter使用一個IProvider來實現攔截器的初始化。
後面的邏輯就變成了獲取一個IProvider上了。

也即是ARouter.getInstance().build("/arouter/service/interceptor").navigation()方法中，ARouter.getInstance().build("/arouter/service/interceptor")做的事情就是創建一個Postcard，其path是"/arouter/service/interceptor",group是"arouter".

簡單來說，這里做的事情有

注意addRouteGroupDynamic(postcard.getGroup(), null)這個方法，通過groupName去groupIndex中查找，那"arouter"對應的是誰呢？正是ARouter$$Group$$arouter.class。
反射創建ARouter$$Group$$arouter對象，並執行ARouter$$Group$$arouter#loadInto方法

現在我們回過頭來繼續看LogisticsCenter#completion

總結一下LogisticsCenter#completion方法做了啥：

以ARouter.getInstance().build("/arouter/service/interceptor").navigation()舉例說明就是：

init方法做的事情很單一，就是一次性實例化全部的攔截器，存到 Warehouse.interceptors中。（想想為什麼要這么做？）
這樣，ARouter.getInstance().build("/arouter/service/interceptor").navigation()就分析完了，ARouter#init的時候,會創建所有的攔截器實例。ARouter.getInstance().build("/arouter/service/interceptor").navigation()方法返回的是InterceptorServiceImpl的實例。

另外，_ARouter#navigation(Context, Postcard, int, NavigationCallback)方法的最後，調用了_ARouter#_navigation

方法看著長，內容卻很簡單：

這樣， ARouter#init 就分析完了， 總結 一下：

另外使用ARouter.getInstance().build("path").navigation()方法 獲取IProvider的流程 如下：

Activity跳轉的流程如下：

至此，我們回答了問題1/問題2和問題4.
下面我們來看下剩下的問題
問題3：攔截器是如何生效的？
我們可以看看_ARouter

執行_ARouter#navigation的時候，執行了interceptorService.doInterceptions方法，前面我們已經知道，執行了interceptorService實際上是InterceptorServiceImpl。

這里一個一個調用攔截器，如果有攔截器攔截，就中斷調用，否則，調用下一個攔截器進行攔截。

所以， 攔截器 總結如下

最後，我們來看下最後一個問題。
問題5 ARouter的Gradle Plugin做了哪些優化？
該問題的關鍵是LogisticsCenter#loadRouterMap

上面的是gradle plugin修改之前的，下面的loadRouterMap是gradle plugin修改之後的。

瞄一眼register方法我們就能明白，這還是之前的那一套，跟不使用gradle plugin不同的地方在於，這里不需要掃描dex去找IRouteRoot/IInterceptorGroup/IProviderGroup，在編譯期，gradle plugin就已經找到了這些，然後生成新的loadRouterMap方法。

B. ARouter框架使用總結及思考

ARouter框架不僅提供了強大的路由跳轉功能，還有其他的能力。該框架對模塊解耦，組件化設計提供了強有力的支持。

ARouter框架提供的具體功能包括Native頁面跳轉，URL頁面跳轉，獲取Fragment，提供能力介面，攔截器等。

ARouter框架最基礎的能力就是頁面跳轉。針對模塊中支持外部模塊跳轉的頁面，可以配置ARouter的註解，便於模塊內外跳轉到該頁面。頁面跳轉的方法簡明易用，不需要知道頁面的class信息，避免模塊間的耦合性。

1、普通的頁面跳轉
build的入參可以是build(String path)、build(String path, String group)(D eprecated，不建議使用)、build(Uri url)三種。ARouter的path一般包括兩個層級"/group/pageName"。

傳入參數Uri時，ARouter可以按照Uri的解析規則，獲取Uri的path數據傳入build函數。Uri解析規則如圖

2、帶參數頁面跳轉
可以通過with(bundle)，withString(key, value)等傳遞數據。目標頁面通過getIntent獲取參數。

ARouter支持通過Autowired自動裝配參數，框架來完成欄位的賦值。

3、支持startActivityForResult的頁面跳轉
navigation的第一個參數必須時Activity，第二個參數是requestCode。在Activity中重寫onActivityResult(int requestCode, int resultCode, Intent data)即可處理返回信息

4、NavigationCallback
可以通過NavigationCallback監控頁面跳轉的情況。

ARouter支持在h5頁面中，通過URL直接跳轉到原生頁面。關於URL調起Intent的內容也可參考 為什麼可以通過URL來調起APP - URL Scheme和Intent

可以通過對Fragment添加註解，後續通過ARouter獲取Fragment實例。這對模塊劃分，APP殼工程開發，提供了便利性。

ARouter支持模塊通過聲明介面來對外提供能力，獲取數據等。首先通過定義IProvider的子介面，進而實現該子介面來提供能力。這個功能有助於實現模塊之間的解耦。

介面支持同步回調，也可以使用callback參數進行非同步回調。在考慮組件化開發中，和同事討論如何避免不同模塊之間傳遞數據結構，暫定採用json來在傳輸。後續的設想是調研跨模塊數據結構傳輸方案，參考aidl。

不過也可通過提供多個能力介面來避免復雜的數據結構傳輸。

使用方可通過依賴注入，通過路徑或介面類名來獲取介面實例，進而提供服務。

參考文檔
為什麼可以通過URL來調起APP - URL Scheme和Intent

C. 毫無關系的組件之間的通訊怎麼實現

> 組件間通信包括兩個場景：（1）UI 跳轉；（2）調用組件某個類的某個方法

ARouter組件間通信- https://github.com/alibaba/ARouter
支持依賴注入註解，可單獨作為依賴注入框架使用；支持添加多個攔截器，自定義攔截順序；

Android-Demos/LiteRouter/- https://github.com/hiphonezhu/Android-Demos/tree/master/LiteRouter
> 項目組件化

那麼什麼是組件化？概括為：組件化是基於可重用目的將項目按照具體業務需求進行拆分，並能將拆分得到的組件進行靈活重組，減小耦合(業務需求上的拆分)。

組件化項目- https://github.com/JessYanCoding/ArmsComponent

Android組件化方案- http://blog.csdn.net/guiying712/article/details/55213884
Android 組件化探索與思考- https://github.com/WuXiaolong/MolarSample
Android項目組件化AndroidMolePattern(阿里ARouter作為路由)- https://github.com/guiying712/AndroidMolePattern
Router activities and methods with url for android- https://github.com/mzule/ActivityRouter
組件化項目Router的其他方案-阿里ARouter- https://github.com/alibaba/ARouter

Android組件化方案- http://blog.csdn.net/guiying712/article/details/55213884
Android組件化之終極方案- http://blog.csdn.net/guiying712/article/details/78057120

Android組件化和插件化開發- https://www.cnblogs.com/android-blogs/p/5703355.html
組件化：隨著業務量的不斷增長，app也會不斷的膨脹，開發團隊的規模和工作量也會逐漸增大，面對所衍生的64K問題、協作開發問題等，app一般都會走向組件化。組件化就是將APP按照一定的功能和業務拆分成多個組件mole，不同的組件獨立開發，組件化不僅能夠提供團隊的工作效率，還能夠提高應用性能。而組件化的前提就是解耦，那麼我們首先要做的就是解耦頁面之間的依賴關系

Native與H5的問題：現在的APP很少是純Native的，也很少會有純H5的，一般情況下都是將兩者進行結合。這時候就需要非常便捷並且統一的跳轉方案，因為在H5中是無法使用StartActivity()跳轉到Native頁面的，而從Native跳轉到H5頁面也只能通過配置瀏覽器的方式實現

D. Android-ARouter原理解析

ARouter使用的是APT（Annotation Processing Tool）註解處理器，通過給對應的類添加註解，在編譯器動態生成對應的路由表文件。這里以分析ARouter的RouteProcessor。在ARouter的使用配置上，需要給base庫配置

然後給每個組件都配置annotationProcessor，如果使用kotlin，則使用kapt
接著給每個組件都配置上下面的內容：

這個配置主要是通過這個annotationProcessorOptions獲取到key為AROUTER_MODULE_NAME的值，這個值其實就是mole的name，這個的作用就是作為一個Root文件的命名的，因為一個mole中可能會有多個group，而多個group歸屬於一個Root，而ARouter的做法就是將一個mole作為一個Root。

Element 是一個介面，它只在編譯期存在和Type有區別，表示程序的一個元素，可以是package，class，interface，method,成員變數，函數參數，泛型類型等。

它的子類包括ExecutableElement, PackageElement, Parameterizable, QualifiedNameable, TypeElement, TypeParameterElement, VariableElement。

Element的子類介紹：

ExecutableElement:表示類或者介面中的方法，構造函數或者初始化器。

PackageElement :表示包程序元素

TypeELement:表示一個類或者介面元素

TypeParameterElement:表示類，介面，方法的泛型類型例如T。

VariableElement：表示欄位，枚舉常量，方法或者構造函數參數，局部變數，資源變數或者異常參數。

Element只在編譯期可見

asType()： 返回TypeMirror,TypeMirror是元素的類型信息，包括包名，類(或方法，或參數)名/類型。TypeMirror的子類有ArrayType, DeclaredType, DisjunctiveType, ErrorType, ExecutableType, NoType, NullType, PrimitiveType, ReferenceType, TypeVariable, WildcardType ，getKind可以獲取類型。

equals(Object obj)： 比較兩個Element利用equals方法。

getAnnotation(Class<A> annotationType)： 傳入註解可以獲取該元素上的所有註解。

getAnnotationMirrors()： 獲該元素上的註解類型。

getEnclosedElements()： 獲取該元素上的直接子元素，類似一個類中有VariableElement。

getEnclosingElement()： 獲取該元素的父元素,如果是PackageElement則返回null，如果是TypeElement則返回PackageElement，如果是TypeParameterElement則返回泛型Element

getKind()：返回值為ElementKind,通過ElementKind可以知道是那種element，具體就是Element的那些子類。

getModifiers()： 獲取修飾該元素的訪問修飾符，public，private。

getSimpleName()： 獲取元素名，不帶包名，如果是變數，獲取的就是變數名，如果是定義了int age，獲取到的name就是age。如果是TypeElement返回的就是類名。

getQualifiedName()：獲取類的全限定名，Element沒有這個方法它的子類有，例如TypeElement，得到的就是類的全類名（包名）。

具體的註解處理流程如下：

首先，看下屬性註解處理器生成的文件示例：

AutowiredProcessor這個註解處理器的目的，就是通過這個註解處理器給對應的類中的屬性進行賦值的操作。
AutowiredProcessor註解處理器流程：

E. android app開發中常用到哪些開源框架

在前面的課程中，隨著對Android體系的了解，已經可以進行正常的Android應用開發了。在Android開發中，同其他工程開發一樣，也經常使用一些提高效率的框架，本文我們做一個對比。這些框架，既包括：網路請求框架、也包括圖片載入庫框架、還包括資料庫操作等一些框架，總之，了解和熟悉這些框架，會對自己的開發效率有很大的提升和幫助。

網路請求框架

1、okHttp

在前文的學習中，我們已經了解過okHttp，是一個常用的網路載入庫。

2、Retrofit

介紹

Retrofit是一個很不錯的網路請求庫，該庫是square開源的另外一個庫，之前的okhttp也是該公司開源的。

Retrofit是基於OkHttp封裝的RESTful網路請求框架，使用註解的方式配置請求。優點是速度快，使用註解，callback函數返回結果自動包裝成Java對象。官方自己的介紹說：

A type-safe REST client for Android and Java

該網路框架在github上的地址如下：https://square.github.io/retrofit/

要求

Retrofit支持的http方式方式包括 GET/POST/PUT/DELETE/HEAD/PATCH，Retrofit要求Java的版本是1.8+，Android應用的API版本應該在21+。

依賴

使用Retrofit庫，和其他庫一樣，首先需要設置依賴，依然是在build.gradle文件中設置依賴：

//添加retrofit庫依賴

implementation 『com.squareup.retrofit2:retrofit:2.1.0』

//添加gson轉換器

implementation 『com.squareup.retrofit2:converter-gson:2.1.0』

使用

通過一個例子，我們可以來演示該框架的使用步驟：

1、定義請求介面，即程序中都需要什麼請求操作
public interface HttpServices {

/**

• 獲取頭條新聞

• @param type 新聞類型

• @param key apiKey

• @return

*/

@GET(「toutiao/index」)

Call getNewsList(@Query(「type」) String type, @Query(「key」) String key);

}

2、實例化Retrofit對象，使用的Builder的模式創建，如下代碼所示：
Retrofit retrofit = new Retrofit.Builder()

.baseUrl(Constants.BASE_API)

.addConverterFactory(GsonConverterFactory.create())

.build();

注意，這里設置結構體轉換器，是可以直接把網路請求回來的數據轉換為Java結構體，這里設置的Gson解析器，因此要引入相應的轉換器支持庫。

3、得到介面對象，自己創建的全局的介面對象，並調用相應的介面，得到一個類似於請求Call對象。如下所示：
HttpServices httpServices = retrofit.create(HttpServices.class);

Call newsListCall = httpServices.getNewsList(「top」, Constants.API_KEY);

4、加入到請求隊列中，並設置回調方法：
newsListCall.enqueue(new Callback() {

@Override

public void onResponse(Call call, Response response) {

//網路請求成功的回調方法

List list = Arrays.asList(response.body().result.data);

Log.i(「TAG」, 「請求成功:」 + String.valueOf(list.size()));

NewListAdapter adapter = new NewListAdapter(RetrofitActivity.this);

adapter.setmData(list);

mRecyclerView.setAdapter(adapter);

}

@Override

public void onFailure(Call call, Throwable throwable) {

//網路請求失敗的回調方法

Log.i(「TAG」, 「請求失敗:」 + throwable.getMessage());

}

});

其他界面操作和之前的Android中的內容一致。

3、RxJava

簡單來說，用來處理事件和非同步任務，在很多語言上都有實現，RxJava是Rx在Java上的實現。

原理

RxJava最基本的原理是基於觀察者模式來實現的。通過Obserable和Observer的機制，實現所謂響應式的編程體驗。

特點

RxJava在編程中的實現就是一種鏈式調用，做了哪些操作，誰在前誰在後非常直觀，邏輯清晰，代碼維護起來非常輕松。

RxJava也是一個在github上的庫，githubhttp://www.xingkongmj.com/news/id/62.html地址如下：https://github.com/ReactiveX/RxJava

基於此，還有一個RxAndroid，github地址如下：https://github.com/ReactiveX/RxAndroid

RxJava和RxAndroid的關系

RxAndroid是RxJava的一個針對Android平台的擴展，主要用於 Android 開發。

基本概念

RxJava 有四個基本概念：

Observable：可觀察者，即被觀察者Observer：觀察者subscribe：訂閱事件
這四個概念之間的邏輯關系是：Observable和Observer通過subscribe方法實現訂閱關系，從而Observable可以在需要的時候發出事件來通知Observer。

事件

RxJava 的事件回調方法主要包含以下幾個：

onNext：普通的事件onCompletedhttp://dachang.net/432717.html：事件隊列完結。RxJava 不僅把每個事件單獨處理，還會把它們看做一個隊列。RxJava 規定，當不會再有新的 onNext 發出時，需要觸發 onCompleted 方法作為標志。：事件隊列異常。在事件處理過程中出異常時， 會被觸發，同時隊列自動終止，不再允許再有事件發出。在一個正確運行的事件序列中, onCompleted和 有且只有一個，並且是事件序列中的最後一個。需要注意的是，onCompleted() 和 () 二者也是互斥的，即在隊列中調用了其中一個，就不應該再調用另一個。
資料庫操作框架

在開發時，本地資料庫可以起到緩存數據和存儲業務數據的作用，隨著技術的成熟，不斷推出了有很多關於資料庫的操作框架。比較常見的資料庫操作框架有諸如：GreenDao，OrmLite 和 ActiveAndroid，DBFlow等。

GreenDAO

GreenDAO是一個開源的 Android ORM(「對象/關系映射」)，通過 ORM（稱為「對象/關系映射」），在我們資料庫開發過程中節省了開發時間！

GreenDao的官方文檔地址如下：http://www.xingkongmj.com/news/id/63.html

GreenDao的作用

通過 GreenDao，我們可以更快速的操作資料庫，我們可以使用簡單的面相對象的API來存儲，更新，刪除和查詢 Java 對象。這款資料庫操作框架的特點是：

高性能，在官方的統計數據中，GreenDao在GreenDao，OrmLite 和 ActiveAndroid三個框架中，讀、寫、更新操作效率均表現第一。易於使用的強大 API，涵蓋關系和連接。內存消耗較小。安全：greenDAO 支持 sqlCipherhttp://www.xingkongmj.com/news/id/64.html，以確保用戶的數據安全;
核心概念

GreenDao 的核心類有三個：分別是：

DaoMaster：保存資料庫對象（SQLiteDatabase）並管理特定模式的 DAO 類（而不是對象）。它有靜態方法來創建表或刪除它們。它的內部類 OpenHelper 和DevOpenHelper 是 SQLiteOpenHelper 實現，它們在 SQLite 資料庫中創建模式。DaoSession：管理特定模式的所有可用 DAO 對象，您可以使用其中一個getter方法獲取該對象。DaoSession 還提供了一些通用的持久性方法，如實體的插入，載入，更新，刷新和刪除。XXXDao：數據訪問對象（DAO）持久存在並查詢實體。對於每個實體，greenDAO 生成DAO。它具有比 DaoSession 更多的持久性方法。Entities：可持久化對象。通常, 實體對象代表一個資料庫行使用標准 Java 屬性(如一個POJO 或 JavaBean )。
使用

按照官方的文檔和github上的說明可以實現green的使用。

首先進行的是依賴，對於greenDao，有兩個地方需要設置，分別是項目根目錄中的 build.gradle，還有mole中的build.gradle。
classpath 『org.greenrobot:green-gradle-plugin:3.3.0』 // add plugin

在項目根目錄中的build.gradle目錄中寫這句話的意思是添加greenDao的插件。

在項目mole中的build.gradle中也需要進行配置，有兩個地方需要設置，如下圖所示：

apply plugin: 『org.greenrobot.greenhttp://www.xingkongmj.com/news/id/66.html』 //開頭加入該代碼

dependences{

implementation 『org.greenrobot:green:3.2.0』

}

然後就可以使用了。

bean實體

可以在項目中創建自己業務需要的實體類，並通過註解來設置是實體類，欄位約束等內容。然後點擊Android Studio中的Make mole，即可自動生成XXXDao代碼，以此來方便開發者的操作。生成的XXXDao類，不可修改和編輯，是自動生成的。

ORMLite

ORMLite框架是另外一款Android開發中可以使用的資料庫操作框架。該框架的文檔地址如下：https://ormlite.com/sqlite_java_android_orm.shtml

該框架的文檔准備的不是特別友好，此處不再贅述。

總結，所有的框架原理幾乎都相差不大，只是操作有所差異。

視圖注入框架

在Android項目開發過程中，有太多的頁面需要布局完成，同時在代碼中需要些大量的findviewbyid的操作，來實現控制項的解析。於是就有人想能否輕松一些，解放雙手節省時間，干一些其他有意義的事情，於是ButterKnife就來了。

ButterKnife是一個專注於Android系統的View注入框架,可以減少大量的findViewById以及setOnClickListener代碼，可視化一鍵生成。

該項目在github上的地址如下：http://www.xingkongmj.com/news/id/65.html

這個框架的優勢也非常明顯：

強大的View綁定和Click事件處理功能，簡化代碼，提升開發效率方便的處理Adapter里的ViewHolder綁定問題運行時不會影響APP效率，使用配置方便代碼清晰，可讀性強
使用

首先是設置依賴，在build.gradlehttp://dachang.net/432714.html中進行依賴設置：

implementation 『com.jakewharton:butterknife:10.2.1』

annotationProcessor 『com.jakewharton:butterknife-compiler:10.2.1』

需要注意，該框架要求Java環境1.8版本以上，SDK版本在26以上，因此在使用到的mole中的build.graldle文件中，還必須添加如下代碼配置：

apply plugin: 『com.jakewharton.butterknife』

android{

//…

compileOptions {

sourceCompatibility JavaVersion.VERSION_1_8

targetCompatibility JavaVersion.VERSION_1_8

}

//…

}

另外，還必須在項目根目錄中的build.gradle文件中，添加該框架的插件，如下圖所示：

dependences{

classpath 『com.jakewharton:butterknife-gradle-plugin:10.2.1』

}

然後即可在代碼中進行使用了。

在使用該框架的頁面進行綁定諸如，如下所示代碼:

ButterKnife.bind( this) ;

主要的功能

@BindView（）：控制項id 註解，解放雙手，不用再每個控制項都寫一遍findviewById@BindViews（）:多個控制項id 的註解，括弧內使用花括弧包括多個id即可，中間用，分割開在Fragment中使用，綁定Fragment。@BindString（）：綁定字元串@BindArray：綁定數組@BindBitmap：綁定bitmap資源@OnClick、@OnLongClick：綁定點擊事件和長按事件…還有很多
插件安裝

如果是頁面很復雜，一個一個寫BindView也很費勁，在Android Studio中，可以安裝一個ButterKnife的插件，安裝該插件後，可以在Studio中直接將對應的布局中的所有控制項均給自動生成。

注意，在進行自動生成時，滑鼠要放在布局文件上。

注意事項

ButterKnife框架在使用時，要求的版本比較高，包括Java的版本也有限制。因此，如果計劃在項目中使用，要提前做好預備工作，以防止對已有項目和業務帶來不必要的麻煩，反而影響工作進度。

F. aRouter正式包不跳,測試包可以

每個需要用到跳轉的mole及主app的build.gradle中需要添加（像base、util之類的庫不用加）。
主app的build.gradle中需要依賴所有使用路由的mole，使用路由的mole之間不用相互依賴。
使用到ARouter註解跳轉的頁面類名不要一樣（就算包名不一樣，類名也要不一樣），還有這些頁面使用的XML布局名字也要不一樣。