PS:在任何時候都不能抱有幻想,要有自己的計劃、要有美麗的心情,要對自己和愛你的人負責。
前面兩篇文章分別介紹了 Android 組件化基礎知識以及 Android 組件化過程 Application 的相關知識,在閱讀本文之前可以先閱讀下面兩篇文章:
Android 組件化過程中涉及到不同 module 之間界面的跳轉也是分廠重要的,如果要對自己經手的項目進行組件化改造,ARouter 是一個非常容易上手的路由框架,由大廠開發團隊維護,相信質量是沒有問題的。
ARouter 是 albaba 團隊開源的一個 Android App 組件化改造的框架,支持模塊之間的路由、通信、攔截功能,相比原生跳轉來說更能適應組件化開發,本文主要通過實例總結一下 Arouter 的常用功能,具體如下:
- ARouter 的配置
- 應用內跳轉
- 應用內攜帶參數跳轉
- Activity 返回結果處理
- 通過 Uri 跳轉及參數解析
- Module 之間的跳轉
- 服務調用
- 顯示效果
ARouter 的配置#
在對應的 build.gradle 文件中配置 ARouter 的相關依賴如下:
android {
defaultConfig {
...
javaCompileOptions {
annotationProcessorOptions {
arguments = [AROUTER_MODULE_NAME: project.getName()]
}
}
}
}
dependencies {
//api與compiler匹配使用,使用最新版可以保證兼容
compile 'com.alibaba:arouter-api:1.4.0'
annotationProcessor 'com.alibaba:arouter-compiler:1.2.1'
...
}
可以選擇配置路由表自動加載,在項目下面的 build.gradle 文件中進行配置,配置方式如下:
// 路由表自動加載插件
apply plugin: 'com.alibaba.arouter'
buildscript {
repositories {
google()
jcenter()
}
dependencies {
classpath 'com.android.tools.build:gradle:3.0.1'
//ARouter
classpath "com.alibaba:arouter-register:1.0.2"
}
}
此外,還需在 Application 中初始化 ARouter,如下:
@Override
public void onCreate() {
super.onCreate();
// 必須在初始化ARouter之前配置
if (BuildConfig.DEBUG){
// 日誌開啟
ARouter.openLog();
// 調試模式開啟,如果在install run模式下運行,則必須開啟調試模式
ARouter.openDebug();
}
ARouter.init(this);
}
應用內跳轉#
使用 ARouter 進行應用內跳轉非常簡單,只需要在要跳轉的 Activity 上添加 @Route 註解即可,具體如下:
// 配置的path至少需要兩級,如/xx/xxx
@Route(path = FirstActivity.PATH)
public class FirstActivity extends AppCompatActivity {
public static final String PATH = "/test/firstActivity";
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_first);
}
}
然後使用 ARouter 提供的跳轉方式來進行應用內部之間的跳轉,具體如下:
// 應用內跳轉
ARouter.getInstance()
.build(FirstActivity.PATH)
.navigation();
應用內攜帶參數跳轉#
ARouter 通過 withString 等一系列 with 開頭的方法設置與之對應的參數來進行參數傳遞,具體如下:
// 應用內攜帶參數跳轉
ARouter.getInstance()
.build(SecondActivity.PATH)
.withString(SecondActivity.PARAM, "這是跳轉攜帶的參數")
.navigation();
然後使用 Intent 在跳轉到的 Activity 中使用 Intent 獲取傳遞過來的參數,具體如下:
@Route(path = SecondActivity.PATH)
public class SecondActivity extends AppCompatActivity {
public static final String PATH = "/test/secondActivity";
public static final String PARAM = "param";
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_second);
Intent intent = getIntent();
if (intent!=null){
String param = intent.getStringExtra(PARAM);
Toast.makeText(this, param, Toast.LENGTH_SHORT).show();
}
}
}
Activity 返回結果處理#
Activity 返回結果處理和原生幾乎一致,即在跳轉時攜帶 requestCode,具體如下:
// Activity返回結果處理
ARouter.getInstance()
.build(ThreeActivity.PATH)
.navigation(this, 100);
然後,在 Activity 返回的時候使用 Intent 攜帶參數 setResult 即可,具體如下:
@Route(path = ThreeActivity.PATH)
public class ThreeActivity extends AppCompatActivity {
public static final String PATH = "/test/threeActivity";
public static final String PARAM_RESULT = "param_result";
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_three);
Intent intent = getIntent();
//setResult
intent.putExtra(PARAM_RESULT,"這是返回攜帶的參數");
setResult(RESULT_OK,intent);
}
}
通過 Uri 跳轉及參數解析#
ARouter 還支持通過 Uri 進行跳轉,首先創建一個無界面的 Activity 用於監聽 Scheme 事件,由該 Activity 進行統一轉發 Uri,所有的 Uri 都要通過這裡然後進行分發跳轉,可以很好的進行 Uri 的控制,一定程度上提高了使用 Uri 跳轉的安全性,實行一個無界面的 Activiry 如下:
public class SchemeFilterActivity extends AppCompatActivity {
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
Uri uri = getIntent().getData();
// 統一外部跳轉的Uri,實現路由器統一分發,減少只依靠Intent屬性匹配帶來的安全風險
ARouter.getInstance().build(uri).navigation(this, new NavCallback() {
@Override
public void onArrival(Postcard postcard) {
finish();
}
});
}
}
在 AndroidManifest 文件中配置 host、scheme 以及 Action,具體如下:
<activity android:name=".SchemeFilterActivity">
<intent-filter>
<data
android:host="test.manu.com"
android:scheme="arouter" />
<action android:name="com.manu.route" />
<action android:name="android.intent.action.VIEW" />
<category android:name="android.intent.category.BROWSABLE" />
<category android:name="android.intent.category.DEFAULT" />
</intent-filter>
</activity>
然後,在 assets 文件夾中創建一個 html 文件,通過點擊跳轉鏈接完成 Uri 的跳轉,html 內容如下:
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title></title>
</head>
<body>
<h2>跳轉測試</h2>
<h2>自定義Scheme</h2>
<p>
<!--不帶參數-->
<a href="arouter://test.manu.com/test/fiveActivity">arouter://test111.manu.com/test/fiveActivity</a>
</p>
<p>
<!--攜帶參數-->
<a href="arouter://test.manu.com/test/sixActivity?name=alex&age=18&score=%7B%22score%22:%2290%22,%22rank%22:%222%22%7D">arouter://test111.manu.com/test/sixActivity?name=alex&age=18&score={"score":"90","rank":"2"}</a>
</p>
</body>
</html>
具體效果查看運行效果圖。
然後,使用 WebView 加載該 Html,就可以跳轉到對應的 Activity 了,也就是鏈接中的 fiveActivity 和 SixActivity,兩個 Activity 分別如下:
// FiveActivity
@Route(path = FiveActivity.PATH)
public class FiveActivity extends AppCompatActivity {
public static final String PATH = "/test/fiveActivity";
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_five);
}
}
// SixActivity
@Route(path = SixActivity.PATH)
public class SixActivity extends AppCompatActivity {
public static final String PATH = "/test/sixActivity";
@Autowired
public String name;
@Autowired
public int age;
@Autowired
// 如果要在Uri中傳遞自定義對象,在參數中要使用json字符串(encodeURI轉碼)傳遞,創建一個實現了SerializationService接口的類完成json的解析
public ScoreBean score;
@BindView(R.id.tvData)
TextView tvData;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_six);
ButterKnife.bind(this);
// 參數自動依賴注入
ARouter.getInstance().inject(this);
String info = "name=" + name + ",age=" + age + ",score=" + score;
tvData.setText(info);
Log.i("SixActivity", info);
}
}
Module 之間的跳轉#
主 module 和子 module 之間的跳轉也非常容易,如主 module 跳轉子 module,當然主 module 和子 module 都在配置 ARouter 才可以進行跳轉,可在主 module 中創建一個接口管理要跳轉的子 module 的路徑,具體如下:
// 管理跳轉路徑
public interface Module {
String MODULE_ONE = "/module1/module-one";
String MODULE_TWO = "/module2/module-two";
}
然後,直接進行跳轉,具體如下:
//跳轉Module-one
ARouter.getInstance()
.build(Module.MODULE_ONE)
.navigation();
服務調用#
ARouter 裡面的服務調用不能和 Android 裡面的 Service 相混淆,ARouter 裡面的服務調用實際上是對某個業務的封裝,通過 ARouter 這一層的統一封裝,使得調用起來更方便,只需知道路徑和名稱就可以隨意調用,實現 IProvider 創建一個 Service 如下:
@Route(path = "/service/singleService")
public class SingleService implements IProvider {
public static final String PATH = "/service/singleService";
private Context mContext;
//具體服務
public void showMessage() {
Toast.makeText(mContext, "這是對外提供的服務", Toast.LENGTH_SHORT).show();
}
@Override
public void init(Context context) {
this.mContext = context;
Log.i("SingleService", "SingleService has init");
}
}
然後就可以調用了,調用方式如下:
// 透過服務類class調用
ARouter.getInstance().navigation(SingleService.class).showMessage();
// 透過服務類Path調用
((SingleService) ARouter.getInstance()
.build(SingleService.PATH)
.navigation())
.showMessage();
此外,還可以使用依賴注入的方式完成服務的調用,這種方式便於多個服務進行管理,創建一個服務管理類如下:
// 服務管理類
public class ServiceManage {
@Autowired
SingleService singleService;
public ServiceManage(){
//透過依賴注入的方式獲取服務
ARouter.getInstance().inject(this);
}
public void getService(){
singleService.showMessage();
}
}
然後透過服務管理類調用具體的服務如下:
//服務管理,透過依賴注入的方式獲取服務
ServiceManage manage = new ServiceManage();
manage.getService();
顯示效果#
上述實現的測試效果如下圖所示:
ARouter 功能比較全面,使用起來也非常簡單,上面的內容也是最常使用到的,如其他功能如攔截器、降級策略、轉場動畫、映射關係分組等用到直接參考官方文檔實踐即可。