1.路由介紹
什么是路由框架?
說簡單點就是映射頁面跳轉關系的,當然它也包含跳轉相關的一切功能
為什么使用ARouter?
我們先從適用場景來分析:
動態跳轉:一般來說復雜的電商跳轉多頁面需要很強的靈活性,很多情況下是運營人員動態配置的下發活動頁面,需要靈活的進行跳轉。
組件化:隨著業務量的不斷增長,app也會不斷的膨脹,開發團隊的規模和工作量也會逐漸增大,面對所衍生的64K問題、協作開發問題等,app一般都會走向組件化。組件化就是將APP按照一定的功能和業務拆分成多個組件module,不同的組件獨立開發,組件化不僅能夠提供團隊的工作效率,還能夠提高應用性能。而組件化的前提就是解耦,那么我們首先要做的就是解耦頁面之間的依賴關系
Native與H5的問題:現在的APP很少是純Native的,也很少會有純H5的,一般情況下都是將兩者進行結合。這時候就需要非常便捷并且統一的跳轉方案,因為在H5中是無法使用StartActivity()跳轉到Native頁面的,而從Native跳轉到H5頁面也只能通過配置瀏覽器的方式實現
其他等場景
原生跳轉方式的不足
- 顯式跳轉, Intent intent = new Intent(activity, XXActivity.class);
由于需要直接持有對應class,從而導致了強依賴關系,提高了耦合度
- 隱式跳轉,譬如 Intent intent = new Intent(); intent.setAction(“com.android.activity.MY_ACTION”);
action等屬性的定義在Manifest,導致了擴展性較差
規則集中式管理,導致協作變得非常困難。
- 原生的路由方案會出現跳轉過程無法控制的問題,因為一旦使用了StartActivity()就無法插手其中任何環節了,只能交給系統管理,這就導致了在跳轉失敗的情況下無法降級,而是會直接拋出運行時的異常。
2.ARouter的使用
1.添加框架的依賴和配置
在各個模塊的build.gradle中添加編譯參數和依賴的框架
android {
defaultConfig {
...
javaCompileOptions {
annotationProcessorOptions {
arguments = [ moduleName : project.getName() ]
}
}
}
}
dependencies {
// 替換成最新版本, 需要注意的是api
// 要與compiler匹配使用,均使用最新版可以保證兼容
compile 'com.alibaba:arouter-api:1.2.2'
annotationProcessor 'com.alibaba:arouter-compiler:1.1.3'
...
}
// 舊版本gradle插件(< 2.2),可以使用apt插件,在根build.gradle中配置方法
apply plugin: 'com.neenbedankt.android-apt'
buildscript {
repositories {
jcenter()
}
dependencies {
classpath 'com.neenbedankt.gradle.plugins:android-apt:1.4'
}
}
2.添加注解
// 在支持路由的頁面上添加注解(必選)
// 這里的路徑需要注意的是至少需要有兩級,/xx/xx
@Route(path = "/test/activity")
public class YourActivity extend Activity {
...
}
3.初始化SDK
if (isDebug()) { // 這兩行必須寫在init之前,否則這些配置在init過程中將無效
ARouter.openLog(); // 打印日志
ARouter.openDebug(); // 開啟調試模式(如果在InstantRun模式下運行,必須開啟調試模式!線上版本需要關閉,否則有安全風險)
}
ARouter.init(mApplication); // 盡可能早,推薦在Application中初始化
4.路由操作
// 1.普通跳轉
ARouter.getInstance().build("/test/activity").navigation();
// 2.跳轉并攜帶參數
ARouter.getInstance().build("/test/activity2").navigation();
// 3.跳轉并攜帶請求碼
ARouter.getInstance().build("/test/activity2").navigation(this, requestCode);
// 4.URI跳轉
/*這種使用URi的方式中,URi的Scheme 和 host不影響結果,可以隨便設,關鍵的是path
* - build(URI)會把URI解析為path,并把當前URI存入PostCard
* - build(String)構造的PostCard不存儲URI*/
Uri testUriMix = Uri.parse("xx://xxx/test/activity2");
ARouter.getInstance().build(testUriMix)
.withString("name", "老王")
.withInt("age", 18)
.withBoolean("boy", true)
.withLong("high", 180)
.withString("url", "https://a.b.c")
.withParcelable("pac", testParcelable)
.withObject("obj", testObj)
.navigation();
// 5.跳轉包含回調 單次降級策略可以在這里使用
ARouter.getInstance().build("/test/activity2").navigation(Context mContext, int requestCode, NavigationCallback callback);
5.配置自定義序列化方式
上訴的代碼中有withObject進行傳參,沒有定義序列化方式是無法進行解析因此需要定義一個序列化方式,以下采用FastJson進行序列化
// 如果需要傳遞自定義對象,需要實現 SerializationService,并使用@Route注解標注(方便用戶自行選擇序列化方式),例如:
@Route(path = "/service/json")
public class JsonServiceImpl implements SerializationService {
@Override
public void init(Context context) {
}
@Override
public <T> T json2Object(String text, Class<T> clazz) {
return JSON.parseObject(text, clazz);
}
@Override
public String object2Json(Object instance) {
return JSON.toJSONString(instance);
}
}
6.聲明攔截器(攔截跳轉過程,面向切面編程)
// 比較經典的應用就是在跳轉過程中處理登陸事件,這樣就不需要在目標頁重復做登陸檢查
// 攔截器會在跳轉之間執行,多個攔截器會按優先級順序依次執行
@Interceptor(priority = 8, name = "測試用攔截器")
public class TestInterceptor implements IInterceptor {
@Override
public void process(Postcard postcard, InterceptorCallback callback) {
...
callback.onContinue(postcard); // 處理完成,交還控制權
// callback.onInterrupt(new RuntimeException("我覺得有點異常")); // 覺得有問題,中斷路由流程
// 以上兩種至少需要調用其中一種,否則不會繼續路由
}
@Override
public void init(Context context) {
// 攔截器的初始化,會在sdk初始化的時候調用該方法,僅會調用一次
}
}
// 我們經常需要在目標頁面中配置一些屬性,比方說"是否需要登陸"之類的
// 可以通過 Route 注解中的 extras 屬性進行擴展,這個屬性是一個 int值,換句話說,單個int有4字節,也就是32位,可以配置32個開關
// 剩下的可以自行發揮,通過字節操作可以標識32個開關,通過開關標記目標頁面的一些屬性,在攔截器中可以拿到這個標記進行業務邏輯判斷
@Route(path = "/test/activity", extras = Consts.XXXX)
7.通過依賴注入解耦:服務管理(一) 暴露服務
// 聲明接口,其他組件通過接口來調用服務
public interface HelloService extends IProvider {
String sayHello(String name);
}
// 實現接口
@Route(path = "/service/hello", name = "測試服務")
public class HelloServiceImpl implements HelloService {
@Override
public String sayHello(String name) {
return "hello, " + name;
}
@Override
public void init(Context context) {
}
}
8.通過依賴注入解耦:服務管理(二) 發現服務
public class Test {
@Autowired
HelloService helloService;
@Autowired(name = "/service/hello")
HelloService helloService2;
HelloService helloService3;
HelloService helloService4;
public Test() {
ARouter.getInstance().inject(this);
}
public void testService() {
// 1. (推薦)使用依賴注入的方式發現服務,通過注解標注字段,即可使用,無需主動獲取
// Autowired注解中標注name之后,將會使用byName的方式注入對應的字段,不設置name屬性,會默認使用byType的方式發現服務(當同一接口有多個實現的時候,必須使用byName的方式發現服務)
helloService.sayHello("Vergil");
helloService2.sayHello("Vergil");
// 2. 使用依賴查找的方式發現服務,主動去發現服務并使用,下面兩種方式分別是byName和byType
helloService3 = ARouter.getInstance().navigation(HelloService.class);
helloService4 = (HelloService) ARouter.getInstance().build("/service/hello").navigation();
helloService3.sayHello("Vergil");
helloService4.sayHello("Vergil");
}
小結
官方的文檔Github很詳細可以去看看
以上方式可以進行簡單的入門使用了,下一步我們從源碼分析。