參考文獻:
superxlcr的ARouter學(xué)習(xí)筆記
碼字農(nóng)民工的文章
繁華落盡666的文章
本文主要介紹的知識點
- 關(guān)于android路由框架解決的問題
- android路由框架的使用(這里只是介紹ARouter的使用)
- 關(guān)于使用ARouter框架的注意事項
- 總結(jié)
1.Android路由框架解決的問題
相信大家在工作中都會遇到這樣的問題,通過其他App或者通過網(wǎng)頁跳轉(zhuǎn)到指定的自己的App或者跳轉(zhuǎn)到指定的頁面中去,一般都是在推送中或者通過Banner點擊之后的操作,一般的操作都是像下面這樣的
- 設(shè)置相應(yīng)的intent-filter
<intent-filter>
<action android:name="com.hejin.arouter.Main2Activity"/>
<category android:name="android.intent.category.DEFAULT"/>
</intent-filter>
- 通過Intent隱式跳轉(zhuǎn)到相應(yīng)的Activity
Intent intent = new Intent();
intent.setAction("com.hejin.arouter.Main2Activity");
startActivity(intent);
其實這里我要說明一下,如果你是正規(guī)的開發(fā)公司我覺得一般都不會這么去寫,其實這個跳轉(zhuǎn)完全能實現(xiàn),但是一般正規(guī)的公司都會定一些協(xié)議和端口號,也就是說會添加scheme來指定一些數(shù)據(jù)的協(xié)議部分和path進行匹配,但是隨著時間的推移和團隊的擴大,會慢慢的暴露出很多問題:
- 集中式的URL管理:談到集中式的管理,總是比較蛋疼,多人協(xié)同開發(fā)的時候,大家都去AndroidManifest.xml中定義各種IntentFilter,使用隱式Intent,最終發(fā)現(xiàn)AndroidManifest.xml中充斥著各種Schame,各種Path,需要經(jīng)常解決Path重疊覆蓋、過多的Activity被導(dǎo)出,引發(fā)安全風險等問題
- 可配置性較差:Manifest限制于xml格式,書寫麻煩,配置復(fù)雜,可以自定義的東西也較少
- 跨模塊無法顯式依賴:在App小有規(guī)模的時候,我們會對App做水平拆分,按照業(yè)務(wù)拆分成多個子模塊,之間完全解耦,通過打包流程控制App功能,這樣方便應(yīng)對大團隊多人協(xié)作,互相邏輯不干擾,這時候只能依賴隱式Intent跳轉(zhuǎn),書寫麻煩,成功與否難以控制。
尤其是在項目演進的時候都會進行組件化開發(fā),所以這里網(wǎng)上有很多大神就研究出路由框架這么一個東西,解決了上面的相應(yīng)問題,這里接觸的就是阿里巴巴開源的ARouter在GitHub上已經(jīng)已經(jīng)有3.+k的start了,相對來說應(yīng)該比較穩(wěn)定,所以讓我們開始吧!
2.ARouter的簡單使用
2.1首先是把ARouter引入到項目中去
- 首先在在module中配置相應(yīng)的參數(shù)
defaultConfig {
.......
javaCompileOptions {
annotationProcessorOptions {
arguments = [ moduleName : project.getName() ]
}
}
}
- 然后配置api和compiler(這個也是在module中)
dependencies {
compile 'com.alibaba:arouter-api:x.x.x'
annotationProcessor 'com.alibaba:arouter-compiler:x.x.x'
...
}
- 上面是github上面寫的內(nèi)容,但是有一點他沒有寫,但是就是一定要在項目的gradle中添加下面這段代碼:
dependencies {
classpath 'com.android.tools.build:gradle:2.3.3'
classpath 'com.neenbedankt.gradle.plugins:android-apt:1.8' //路由需要
// NOTE: Do not place your application dependencies here; they belong
// in the individual module build.gradle files
}
這句話一定要加上否則根本就跳轉(zhuǎn)不過去,具體為什么我還真是不知道....
有了以上的內(nèi)容就完成了基本的配置,就可以進行相應(yīng)的跳轉(zhuǎn)了...
2.2代碼中的簡單使用
- 在Application中初始化ARouter
/*初始化路由框架*/
ARouter.init(this);
- 首先要在你要跳轉(zhuǎn)的Activity(或者說是目標的Activity)添加注釋
@Route(path = "XXX/XXX")
這里面要注意兩點首先這個注解里面的內(nèi)容必須是二級菜單,這個在github上面有解釋,其次就是這個注解要寫在Activity的類上邊
- 通過代碼進行跳轉(zhuǎn)(發(fā)起路由)
ARouter.getInstance().build("/XXX/XXX").navigation();
//跳轉(zhuǎn)中攜帶參數(shù)
ARouter.getInstance().build("/XXX/XXX")
.withLong("key", "value")
.withString("key", "value")
.navigation
這里面的參數(shù)要和你要跳轉(zhuǎn)的Activity注解中的參數(shù)保持一致,當你傳遞參數(shù)的時候,你直接通過Intent去取就可以了.
通過以上步驟就能實現(xiàn)基本的跳轉(zhuǎn)傳遞參數(shù)了,但是身為有逼格的程序員我們怎么能這樣就滿足了呢?
3.ARouter進階使用
3.1 利用Uri進行跳轉(zhuǎn)
Uri uri = Uri.parse("/test/activity");
ARouter.getInstance()
.build(uri)
.navigation();
3.2傳遞參數(shù)的獲取問題
當你傳遞參數(shù)的時候你可以通過Intent取獲取,當然也可以通過相應(yīng)的注解進行獲取,就像下面這樣:
@Autowired(name = "xxx")
public String text;
這里呢要注意,修飾符必須是public并且key值要相互對應(yīng).還要在目標的Activtiy中添加ARouter.getInstance().inject(this);才可以使用相應(yīng)的值,否則取值的時候會失敗,但是不會報空指針.
3.3關(guān)于轉(zhuǎn)場動畫的跳轉(zhuǎn)處理
有沒有想過,之前在Activity跳轉(zhuǎn)的時候可以使用overridePendingTransition();,但是現(xiàn)在通過路由跳轉(zhuǎn)的話,沒有地方取設(shè)置動畫了,然后ARouter為我們想到了這個問題.
- 舊動畫:使用withTransition方法即可(相當于之前的overridePendingTransition()方法設(shè)置)
ARouter.getInstance().build(path).withTransition(R.anim_slide_in,R.anim_slide_out);
- 新動畫:使用withOptionsCompat方法即可(Android5.0新出的轉(zhuǎn)場動畫)
ActivityOptionsCompat compat = ActivityOptionsCompat.
makeScaleUpAnimation(view, view.getWidth() / 2, view.getHeight() / 2, 0, 0);
ARouter.getInstance().build("path").withOptionsCompat(compat)
.navigation();
3.4ARouter處理跳轉(zhuǎn)過程的結(jié)果
ARouter可以讓我們處理跳轉(zhuǎn)過程的結(jié)果,什么用呢?就是你找到目標之后要進行什么操作.
ARouter.getInstance().build("/module/jumpTestActivity2").navigation(null,
new NavigationCallback() {
@Override
public void onFound(Postcard postcard) {
// 找到目標后進行的操作
}
@Override
public void onLost(Postcard postcard) {
// 找不到目標進行的操作
}
});
補充說明:
在最新api中已經(jīng)是四個方法了!
ARouter.getInstance().build("/test/activity").navigation(this, new NavigationCallback() {
@Override
public void onFound(Postcard postcard) {
//找到隊應(yīng)的內(nèi)容的時候
Log.e("done", "onFound: ");
}
@Override
public void onLost(Postcard postcard) {
//沒有找到對應(yīng)的內(nèi)容的時候
Log.e("done", "onLost: ");
}
@Override
public void onArrival(Postcard postcard) {
//跳轉(zhuǎn)成功
Log.e("done", "onArrival: ");
}
@Override
public void onInterrupt(Postcard postcard) {
//攔截操作
Log.e("done", "onInterrupt: ");
}
});
這里可以在onLost中去處理"位置頁面"的跳轉(zhuǎn)結(jié)果,比如升級APP之類的話術(shù).
3.5攜帶結(jié)果的Activity
ARouter.getInstance().build("/test/activity").navigation(this,10);
后面那個參數(shù)就是請求碼,別的和之前的都一樣.
3.6組的概念
在ARouter中有個組的概念,什么意思呢?就是在構(gòu)建路由請求的時候,可以指定分組.
其實這個分組本來就是有個你像path=/test/activity test就相當是分組,但是也可以使用group進行分組,像下面這段代碼:
@Route(path = "/test/activity", group = "app")
這里需要強調(diào)一下,如果你設(shè)置了相應(yīng)的分組,那么在進行跳轉(zhuǎn)的時候,一定要使用ARouter.getInstance().build(path, group)進行跳轉(zhuǎn),否則無法找到相應(yīng)的跳轉(zhuǎn)
3.7重寫跳轉(zhuǎn)URL實現(xiàn)重定向
可以重新定向你的URL地址
@Route(path = "/test/activity2")
public class PathReplaceServerImp implements PathReplaceService {
@Override
public String forString(String path) {
path = "/test/activity2";
return path;
}
@Override
public Uri forUri(Uri uri) {
return null;
}
@Override
public void init(Context context) {
Log.e("done", "init: 這里是初始化的時候執(zhí)行的方法");
}
}
這里說明一下:上面得path一定要加上一個任意項目中出現(xiàn)得注解即可,如果項目中沒有出現(xiàn)得話會報空指針異常的.通過上面的代碼,就可以更改項目中跳轉(zhuǎn)時候的path和URL地址了.
3.8ARouter攔截器
ARouter的攔截器可以在navigation的過程中攔截請求,并進行一系列的處理 ,是一種AOP的編程模式(應(yīng)用場景為檢查登陸狀態(tài)等)要實現(xiàn)攔截器,首先我們需要實現(xiàn)IInterceptor接口,并使用Interceptor注解標記我們的攔截器,并傳入priority優(yōu)先級參數(shù)(數(shù)字越小,優(yōu)先級越高),其實攔截器就是實現(xiàn)了一個接口去進行回調(diào)的!
public class TestInterceotor implements IInterceptor {
@Override
public void process(Postcard postcard, final InterceptorCallback callback) {
if (postcard.getPath().equals("/test/activity")) {
callback.onContinue(postcard);
} else {
callback.onContinue(postcard);
}
}
@Override
public void init(Context context) {
Log.e("done", "init: 初始化調(diào)用");
}
}
這里說明幾點內(nèi)容:
- 首先process這個方法是處理攔截內(nèi)容的,這里我判斷了一個相應(yīng)的注解路由,如果跳轉(zhuǎn)的是相應(yīng)的路徑,那么進行攔截.
- 其次callback.onContinue(postcard)這個要注意,這句話的含義就是交由路由去處理,如果這里不寫這句話的話,路由就終止了.
- init方法是全局只執(zhí)行一次,這里為什么這么設(shè)計我也不知道,應(yīng)該是用到相應(yīng)的內(nèi)容了吧!原諒我是一個菜鳥
- 如果你想加入相應(yīng)的等級的話在類的上面加入如下注解@Interceptor(priority = 7)其實就是設(shè)置攔截器等級的,這里為什么又攔截器的等級呢?主要是為了讓攔截器一級一級的向下傳遞.這樣就有了多級的攔截器.
上面的內(nèi)容只是簡單的用到了攔截器,但是理解起來畢竟又一些晦澀,當直接說讓你實現(xiàn)登陸的攔截,你怎么實現(xiàn),開始的時候我也覺得簡單,但是當自己寫的時候,我發(fā)現(xiàn)這個問題真不是看上去那么簡單.這里我先把內(nèi)容攔截器的代碼都放上,然后我在講解!
- 首次跳轉(zhuǎn)的邏輯
ARouter.getInstance().build("/test/activity").navigation(this, new NavCallback() {
@Override
public void onArrival(Postcard postcard) {
}
@Override
public void onInterrupt(Postcard postcard) {
Log.e(TAG, "onInterrupt: 這個方法是攔截器執(zhí)行之后才執(zhí)行的");
}
});
- 攔截器的代碼:
@Interceptor(priority = 7)
public class TestInterceotor implements IInterceptor {
@Override
public void process(Postcard postcard, final InterceptorCallback callback) {
if (postcard.getPath().equals("/test/activity")) {
Log.e("done", "process: main2Activity");
if (APP.isLogin) {/*已經(jīng)登陸*/
callback.onContinue(postcard);
} else {/*沒有登陸*/
ARouter.getInstance().build("/test/activity2")
.withString("name", postcard.getPath()).navigation();
}
Log.e("done", "process: 執(zhí)行完了");
} else {
Log.e("done", "process: 這個方法什么時候執(zhí)行");
callback.onContinue(postcard);
}
}
@Override
public void init(Context context) {
Log.e("done", "init: 初始化調(diào)用");
}
}
- 模擬登陸的Activity
@Route(path = "/test/activity2")
public class Main3Activity extends AppCompatActivity {
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main3);
ARouter.getInstance().inject(this);
}
public void click(View view) {
APP.isLogin = true;
ARouter.getInstance().build("/test/activity").navigation();
finish();
}
}
這里第一次跳轉(zhuǎn)的時候,由于攔截器使得沒有登陸的邏輯就跳轉(zhuǎn)到了登陸頁面,之后我在登陸頁面模擬了一次登陸的操作,然后關(guān)閉這個頁面之前,我又重新跳轉(zhuǎn)了目標頁面,這次由于已經(jīng)登陸了,所以會直接繼續(xù)執(zhí)行跳轉(zhuǎn)了目標頁面.這里說的挺簡單的,有一個回調(diào)我還沒有搞清楚,onInterrupt這個回調(diào)之后有什么用,其實這里也可以傳入一個字段,然后跳轉(zhuǎn)的時候直接傳入這個字段,這個字段主要是保存要跳轉(zhuǎn)的頁面的數(shù)據(jù),之后就能直接跳轉(zhuǎn)了.這樣就解決了耦合的問題.
3.9在攔截器中添加額外的參數(shù)
@Route(path = "/test/activity", extras = 0;/*注意這里是int類型的參數(shù)*/)
說明一下:這個是在目標的Activity頁面添加的額外參數(shù),之后會在攔截器內(nèi)生效.
總結(jié)
其實關(guān)于這個框架還有很多問題我沒有理解,但是基本的一些內(nèi)容都已經(jīng)講解了,其實接觸這個框架主要是當初看見組件化開發(fā)的時候,看到了這個框架,其實在項目中使用也可以,整體管理了跳轉(zhuǎn).寫的挺亂的,感謝大家抽出寶貴時間來閱讀,有什么不對的地方希望指正.