Android路由框架ARouter的使用示例

Posted on by

一、添加依賴和初始化框架

1、添加依賴

在需要使用ARouter的module中添加如下代碼:

1.1、java版本的依賴

android {
    defaultConfig {
        ...
        javaCompileOptions {
            annotationProcessorOptions {
                arguments = [moduleName :project.getName() ]
            } }
    }
}

dependencies {
    api 'com.alibaba:arouter-api:1.5.1'
    annotationProcessor 'com.alibaba:arouter-compiler:1.5.1'
}

1.2、kotlin版本的依賴

plugins {
    ...
    id 'kotlin-kapt'
}

dependencies {
    ...
    implementation 'com.alibaba:arouter-api:1.5.1'
    kapt 'com.alibaba:arouter-compiler:1.5.1'
}

題外話： implementation 和 api 關鍵字，在Android studio3.0版本中，曾經的 compile 關鍵字被棄用，而 api 則是 compile 的替代品， api 與 compile 沒有區別。但最新官方推薦使用 implementation 來代替 compile 關鍵字，據說 implementation 會使Android studio的編譯速度更快呦。

而 implementation 和 api 關鍵字的區別則在於用 implementation 來聲明的依賴包隻限於當前module內部使用，對於依賴其module的模塊是無法使用到該依賴包的。而用 api 來聲明依賴包時，依賴於該module的模塊可以正常使用其模塊內的依賴包。

在這裡，由於我是將其放入一個公共的module，來讓app module進行依賴，因此使用 api 關鍵字。若沒有對項目進行組件化，則可以使用 implementation 關鍵字進行依賴。

2、初始化SDK

//初始化ARouter框架
private boolean isDebugARouter = true;//ARouter調試開關
if (isDebugARouter) {
    //下面兩行必須寫在init之前，否則這些配置在init中將無效
    ARouter.openLog();
    //開啟調試模式（如果在InstantRun模式下運行，必須開啟調試模式！
    // 線上版本需要關閉，否則有安全風險）
    ARouter.openDebug();
}
//官方推薦放到Application中初始化
ARouter.init((Application) mContext);

二、ARouter的簡單使用

1、界面跳轉

1.1、Activity界面跳轉

目標Activity添加註釋（跳轉語句，路由路徑建議寫成常量，創建路由表進行統一管理。）

@Route(path = "/app/login")
public class LoginActivity extends AppCompatActivity {

發送Activity實現跳轉到

ARouter.getInstance().build("/app/login").navigation();

1.2、獲取fragment實例

//目標界面
@Route(path = "/app/fragment")
public class EmptyFragment extends BaseFragment {
}

//啟動界面
Fragment fragment= (Fragment) ARouter.getInstance().build("/app/fragment").navigation();
FragmentManager manager = getSupportFragmentManager();
FragmentTransaction transaction = manager.beginTransaction();
transaction.add(R.id.fl_fragment_content, fragment);
transaction.commit();

1.3、註意事項

如果像我一樣對項目進行瞭組件化的同學就會發現，此時跳轉並沒有成功，而是彈出錯誤提示。

這是因為組件化後，即時我們使用瞭 api 作為依賴的關鍵字，但仍需在使用ARouter的其他module中配置代碼。這裡一般習慣的做法是把arouter-api的依賴放在基礎服務的module裡面，因為既然用到瞭組件化，那麼肯定是所有的module都需要依賴arouter-api庫的，而arouter-compiler的依賴需要放到每一個module裡面。

java

android {
    defaultConfig {
        ...
        javaCompileOptions {
            annotationProcessorOptions {
                arguments = [moduleName :project.getName() ]
            } }
    }
}

dependencies {
    annotationProcessor 'com.alibaba:arouter-compiler:1.5.1'
}

kotlin

plugins {
    ...
    id 'kotlin-kapt'
}

dependencies {
    ...
    kapt 'com.alibaba:arouter-compiler:1.5.1'
}

否則無法匹配路由，並且在使用withObject方法攜帶對象時也會報錯，這個後面再說，再試一次發現界面成功跳轉。關於註釋 @Route 的 path 參數，也需要註意規范，必須要以“/”開頭，並且路徑至少為兩級，不然會編譯不通過或者報錯。

意思是路徑必須以“/”開頭，並且包含的值超過2個“/”。

2、攜帶基本參數的界面跳轉

使用方法如下，傳入鍵值對

Bundle bundle = new Bundle();
bundle.putString("bundleStringKey", "bundleStringValue");

ARouter.getInstance().build("/app/login")
             .withString("stringKey", "stringValue")
             .withInt("intKey", 100)
             .withBoolean("booleanKey", true)
             .withBundle("bundle", bundle)
             .navigation();

目標界面使用 @Autowired 註解進行註入

@Route(path = "/app/login")
public class LoginActivity extends AppCompatActivity {
    @Autowired
    String stringKey;
    @Autowired
    int intKey;
    @Autowired
    boolean booleanKey;
    @Autowired
    Bundle bundle;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_login);
        //註入ARouter
        ARouter.getInstance().inject(this);
        
        Log.e(TAG, stringKey + "..." + intKey + "..." + booleanKey);
        Log.e(TAG, bundle.getString("bundleStringKey"));
    }
}

註意：註入的屬性名要和之前攜帶的key值完全相同，並且要在需要註入的界面通過ARouter.getInstance().inject(this)註入ARouter，否則無法註入成功。建議將ARouter.getInstance().inject(this)操作放在BaseActivity的onCreate方法中進行。既然有註入，就一定有資源的釋放，因此釋放資源在Application中進行。

    @Override
    public void onTerminate() {
        super.onTerminate();
        ARouter.getInstance().destroy();
    }

如果釋放資源放在BaseActivity的onDestroy方法中調用瞭 ARouter.getInstance().destroy( ) ; 在進入目標Activity之後，然後按back鍵返回原界面的時候，APP會報錯崩潰，下面是崩潰日志：

3、攜帶對象的界面跳轉

3.1、攜帶序列化對象的界面跳轉

攜帶 Serializable 和 Parcelable 序列化的對象

TestSerializableBean serializableBean = new TestSerializableBean();
serializableBean.setName("serializable");

TestParcelableBean parcelableBean = new TestParcelableBean();
parcelableBean.setName("parcelable");

ARouter.getInstance().build("/app/login")
        .withParcelable("parcelableBean", parcelableBean)
        .withSerializable("serializableBean", serializableBean)
        .navigation();

目標界面

@Autowired
TestParcelableBean parcelableBean;
@Autowired
TestSerializableBean serializableBean;

@Override
protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_login);
        Log.e(TAG, parcelableBean + "");
        Log.e(TAG, serializableBean + "");
}

我們發現Serializable序列化的對象為null，我們查看withSerializable方法發現其被裝進瞭Bundle

public Postcard withSerializable(@Nullable String key, @Nullable Serializable value) {
        mBundle.putSerializable(key, value);
        return this;
    }

因此換一種方法來取值，發現打印成功

TestSerializableBean serializableBean = (TestSerializableBean) getIntent().getExtras().getSerializable("serializableBean");
Log.e(TAG, serializableBean + "");

3.2、攜帶無序列化對象的界面跳轉

沒有進行過序列化的對象也可以通過withObject對象進行傳遞，接收方式相同

NormalTest normalTest = new NormalTest();
normalTest.setName("normal");
ARouter.getInstance().build("/app/login")
        .withObject("normalTest", normalTest)
        .navigation();

但是我們直接使用該方法運行會報錯，分析源碼發現該方法中用到瞭SerializationService

    public Postcard withObject(@Nullable String key, @Nullable Object value) {
        serializationService = ARouter.getInstance().navigation(SerializationService.class);
        mBundle.putString(key, serializationService.object2Json(value));
        return this;
    }

因此我們需要實現該服務

@Route(path = "/service/json")
public class JsonServiceImpl implements SerializationService {
    private Gson gson;

    @Override
    public <T> T json2Object(String input, Class<T> clazz) {
        return gson.fromJson(input, clazz);
    }

    @Override
    public String object2Json(Object instance) {
        return gson.toJson(instance);
    }

    @Override
    public <T> T parseObject(String input, Type clazz) {
        return gson.fromJson(input, clazz);
    }

    @Override
    public void init(Context context) {
        gson = new Gson();
    }
}

我們可以在裡面定義所需的json解析器，再次運行成功打印該對象。那序列化的對象可以使用該方法傳遞嗎？

TestParcelableBean objParcelableBean = new TestParcelableBean();
objParcelableBean.setName("objParcelable");

TestSerializableBean objSerializableBean = new TestSerializableBean();
objSerializableBean.setName("objSerializable");

NormalTest normalTest = new NormalTest();
normalTest.setName("normal");

ARouter.getInstance().build("/app/login")
        .withObject("objParcelableBean", objParcelableBean)
        .withObject("objSerializableBean", objSerializableBean)
        .withObject("normalTest", normalTest)
        .navigation();

//目標界面
@Autowired(name = "objParcelableBean")
TestParcelableBean objParcelableBean;
@Autowired(name = "objSerializableBean")
TestSerializableBean objSerializableBean;
@Autowired(name = "normalTest")
NormalTest normalTest;

Log.e(TAG, objParcelableBean + "");
Log.e(TAG, objSerializableBean + "");
Log.e(TAG, normalTest + "");

我們發現用 Parcelable 序列化的對象為空，分析build的編譯文件

@Override
  public void inject(Object target) {
    serializationService = ARouter.getInstance().navigation(SerializationService.class);
    LoginActivity substitute = (LoginActivity)target;
    substitute.objParcelableBean = substitute.getIntent().getParcelableExtra("objParcelableBean");
    if (null != serializationService) {
      substitute.objSerializableBean = serializationService.parseObject(substitute.getIntent().getStringExtra("objSerializableBean"), new com.alibaba.android.arouter.facade.model.TypeWrapper<TestSerializableBean>(){}.getType());
    } else {
      Log.e("ARouter::", "You want automatic inject the field 'objSerializableBean' in class 'LoginActivity' , then you should implement 'SerializationService' to support object auto inject!");
    }
    if (null != serializationService) {
      substitute.normalTest = serializationService.parseObject(substitute.getIntent().getStringExtra("normalTest"), new com.alibaba.android.arouter.facade.model.TypeWrapper<NormalTest>(){}.getType());
    } else {
      Log.e("ARouter::", "You want automatic inject the field 'normalTest' in class 'LoginActivity' , then you should implement 'SerializationService' to support object auto inject!");
    }
  }

我們可以看到唯獨通過 Parcelable 方式序列化的對象沒有使用SerializationService進行解析，而是直接從Bundle去取，但我們並不是通過withParcelable方法去設置的值，因此取得的數據為null。

小結：因此，為瞭方便我們的操作，沒有序列化和使用 Serializable 序列化的對象使用 withObject 方法傳遞，使用 Parcelable 方式序列化的對象則采用 withParcelable 方法進行傳遞。

3.3、攜帶集合和數組的界面跳轉

集合和數組的界面跳轉統一使用 withObject 方法傳遞，並且能夠支持成員的各種序列化方式。

 List<NormalTest> listNormal = new ArrayList<>();
 listNormal.add(new NormalTest());
 listNormal.add(new NormalTest());

 List<TestSerializableBean> listSerializable = new ArrayList<>();
 listSerializable.add(new TestSerializableBean());
 listSerializable.add(new TestSerializableBean());

 List<TestParcelableBean> listParcelable = new ArrayList<>();
 listParcelable.add(new TestParcelableBean());
 listParcelable.add(new TestParcelableBean());

 Map<String, NormalTest> map = new HashMap<>();
 map.put("1", new NormalTest());
 map.put("2", new NormalTest());

 ARouter.getInstance().build("/app/login")
         .withObject("listNormal", listNormal)
         .withObject("listSerializable",listSerializable)
         .withObject("listParcelable",listParcelable)
         .withObject("map", map)
         .navigation();

 //目標界面
 @Autowired
 List<NormalTest> listNormal;
 @Autowired
 List<TestSerializableBean> listSerializable;
 @Autowired
 List<TestParcelableBean> listParcelable;
 @Autowired
 Map<String, NormalTest> map;

 Log.e(TAG, listNormal + "");
 Log.e(TAG, listSerializable + "");
 Log.e(TAG, listParcelable + "");
 Log.e(TAG, map + "");

4、界面跳轉回調

//啟動界面
ARouter.getInstance().build("/app/login")
        .navigation(MainActivity.this, REQUEST_CODE);

@Override
    protected void onActivityResult(int requestCode, int resultCode, @Nullable Intent data) {
        super.onActivityResult(requestCode, resultCode, data);
        if (requestCode == REQUEST_CODE&& resultCode == RESULT_CODE) {
            LogUtils.e(data.getStringExtra("data"));
        }
    }


//目標界面
Intent intent = new Intent();
intent.putExtra("data", "resultData");
setResult(RESULT_CODE, intent);
finish();

5、未用到的知識點

由於項目中沒有用到ARouter攔截器、ARouter自定義分組，這兩塊知識點，所以就沒研究。

以上就是Android路由框架ARouter的使用示例的詳細內容，更多關於Android路由框架ARouter的使用的資料請關註WalkonNet其它相關文章！

推薦閱讀：