Android組件化之ARouter的使用

原文首發於微信公衆號：躬行之(jzman-blog)

前面兩篇文章分別介紹了 Android 組件化基礎知識以及 Android 組件化過程 Application 的相關知識，在閱讀本文以前能夠先閱讀下面兩篇文章：

• Android組件化基礎
• Android組件化之Application

Android 組件化過程當中涉及到不一樣 module 之間界面的跳轉也是分廠重要的，若是要對本身經手的項目進行組件化改造，ARouter 是一個很是容易上手的路由框架，由大廠開發團隊維護，相信質量是沒有問題的。

ARouter 是 albaba 團隊開源的一個 Android App 組件化改造的一個框架，支持模塊之間的路由、通訊、攔截功能，相比原生跳轉來講更能適應組件化開發，本文主要經過實例總結一下 Arouter 的經常使用功能，具體以下：

1. ARouter的配置
2. 應用內跳轉
3. 應用內攜帶參數跳轉
4. Activity返回結果處理
5. 經過Uri跳轉及參數解析
6. Module之間的跳轉
7. 服務調用
8. 顯示效果

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 和子 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();
複製代碼

顯示效果

上述實現的測試效果以下圖所示：

route.gif

ARouter 功能比較全面，使用起來也很是簡單，上面的內容也是最常使用到的，如其餘功能如攔截器、降級策略、轉場動畫、映射關係分組等用到直接參考官方文檔實踐便可。