Android路由框架ARouter的集成、基本使用以及踩坑全過程

?? 對項目進行過組件化的同學肯定也都經歷過這樣的痛苦，在模塊之間通過原生路由方案的界面跳轉存在很多的約束，例如子模塊向主模塊顯示跳轉無法引用類依賴，又或者是隱式跳轉時繁瑣的規則定義。并且在項目中如果涉及到需要根據用戶的角色或者權限來展示不同內容時，就會在各個界面產生大量的邏輯代碼，后期很難進行統一維護，因此，一套類似于前端的路由框架就能解決我們這一系列的煩惱，而對于Android，如今其實已經有相當多成熟的路由框架了，剛好這次項目中準備使用阿里開發的ARouter框架，因此詳細來說說這個框架的集成、使用和一些踩坑的過程。

ARouter官方項目傳送門

1.集成配置及初始化框架

1.1添加依賴

在需要集成的module中添加依賴和配置

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

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

?? 這里順便說一下 implementation 和 api 關鍵字，在Android studio3.0版本中，曾經的 compile 關鍵字被棄用，而 api 則是 compile 的替代品， api 與 compile 沒有區別。但最新官方推薦使用 implementation 來代替 compile 關鍵字，據說 implementation 會使Android studio的編譯速度更快呦。
?? 而 implementation 和 api 關鍵字的區別則在于用 implementation 來聲明的依賴包只限于當前module內部使用，對于依賴其module的模塊是無法使用到該依賴包的。而用 api 來聲明依賴包時，依賴于該module的模塊可以正常使用其模塊內的依賴包。
?? 除此之外 testCompile 要用 testImplementation 或 testApi 替換，androidTestCompile 要用 androidTestImplementation 或 androidTestApi 替換。
?? 在這里，由于我是將其放入一個公共的module，來讓app module進行依賴，因此使用 api 關鍵字。若沒有對項目進行組件化，則可以使用 implementation 關鍵字進行依賴。

1.2初始化SDK

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

2.ARouter的簡單使用

2.1界面跳轉

目標Activity添加注釋

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

跳轉語句，路由路徑建議寫成常量，創建路由表進行統一管理。

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

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

There's no route matched

?? 這是因為組件化后，即時我們使用了 api 作為依賴的關鍵字，但仍需在使用ARouter的其他module中配置代碼

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

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

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

error

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

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();
        CommonApplication.getInstance().destroy(mContext);
    }

如果釋放資源放在BaseActivity的onDestroy方法中進行會報錯。最終得到打印結果：

成功輸出打印結果

2.3攜帶對象的界面跳轉

2.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 + "");

打印結果

2.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 方法進行傳遞。

2.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 + "");

打印結果

2.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();

有同學說resultCode的值為0，我想說這和框架無關，一定是你setResult后沒有進行finish操作導致的。

3.ARouter獲取fragment實例

??有的人給我說ARouter可以跳轉fragment，還在想是怎么一回事，看了之后發現其實是獲取fragment的實例。用法和跳轉Activity類似，只需要把結果進行強轉即可。

//目標界面
@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();

4.ARouter攔截器

??也可以設置攔截器，對跳轉的路由進行統一的控制，這就非常適合我們實現不同角色權限對應的不同展示效果，而且后期維護起來也比較方便，不會在各個界面中產生大量跳轉邏輯。
??我們先來定義兩個攔截器：

@Interceptor(priority = 1)
public class FirstRouterInterceptor implements IInterceptor {
    @Override
    public void init(Context context) {
        LogUtils.e("first init");
    }

    @Override
    public void process(Postcard postcard, InterceptorCallback callback) {
        LogUtils.e("first process start");
        callback.onContinue(postcard);
        LogUtils.e("first process end");
    }
}
//-------------------------------------------------------------------------
@Interceptor(priority = 2)
public class SecondRouterInterceptor implements IInterceptor {
    @Override
    public void init(Context context) {
        LogUtils.e("second init");
    }

    @Override
    public void process(Postcard postcard, InterceptorCallback callback) {
        LogUtils.e("second process start");
        callback.onContinue(postcard);
        LogUtils.e("second process end");
    }
}

??可以在跳轉邏輯中添加回調，方便我們控制跳轉邏輯：

ARouter.getInstance().build("/app/login")
                        .navigation(mContext, new NavigationCallback() {
                    @Override
                    public void onFound(Postcard postcard) {
                        LogUtils.e("", postcard.getGroup(), postcard.getPath(), "onFound");
                    }

                    @Override
                    public void onLost(Postcard postcard) {
                        LogUtils.e("", postcard.getGroup(), postcard.getPath(), "onLost");
                    }

                    @Override
                    public void onArrival(Postcard postcard) {
                        LogUtils.e("", postcard.getGroup(), postcard.getPath(), "onArrival");
                    }

                    @Override
                    public void onInterrupt(Postcard postcard) {
                        LogUtils.e("", postcard.getGroup(), postcard.getPath(), "onInterrupt");
                    }
                });

??看下打印效果：

打印效果

??我們可以看到對于攔截器的 priority 屬性，值越小，優先級越高，并且需要注意，該屬性的值不能設置為相同的，否則編譯時會直接報錯。
??整個流程我們會按照優先級先初始化兩個攔截器，當我們的路由被發現時，攔截器按照優先級開始進行攔截，若都通過，最后到達我們指定的界面。現在我們來模擬一下兩個攔截器分別進行攔截的打印效果，我們可以通過把callback.onContinue(postcard);改為callback.onInterrupt(new Throwable());來進行攔截，我們先看下SecondRouterInterceptor被攔截的效果：

打印效果

??我們看到，這時界面已經無法成功跳轉，回調觸發了onInterrupt方法。并且，即使SecondRouterInterceptor進行了攔截，攔截之后，依舊會回到FirstRouterInterceptor攔截器中執行剩下的代碼，并非直接阻斷。
??我們恢復對SecondRouterInterceptor進行的攔截，將FirstRouterInterceptor攔截來看下效果：

打印效果

??頁面依舊無法進行跳轉，并且不會再觸發SecondRouterInterceptor攔截器。

5.ARouter轉場動畫

??使用ARouter跳轉也可以直接給界面設置轉場動畫

ARouter.getInstance().build(RouterUrl.ACTIVITY_URL_LOGIN)
        .withTransition(R.anim.dialog_bottom_in, R.anim.dialog_bottom_out)
        .navigation();

??但是我們發現，設置的轉場動畫并沒有生效，這是怎么一回事？我們看下源碼：

                // Navigation in main looper.
                new Handler(Looper.getMainLooper()).post(new Runnable() {
                    @Override
                    public void run() {
                        if (requestCode > 0) {  // Need start for result
                            ActivityCompat.startActivityForResult((Activity) currentContext, intent, requestCode, postcard.getOptionsBundle());
                        } else {
                            ActivityCompat.startActivity(currentContext, intent, postcard.getOptionsBundle());
                        }

                        if ((0 != postcard.getEnterAnim() || 0 != postcard.getExitAnim()) && currentContext instanceof Activity) {    // Old version.
                            ((Activity) currentContext).overridePendingTransition(postcard.getEnterAnim(), postcard.getExitAnim());
                        }

                        if (null != callback) { // Navigation over.
                            callback.onArrival(postcard);
                        }
                    }
                });

就是注釋寫的Old version.的那一段，網上很多人說這是為了兼容老版本，那我們換一種方式再試下：

  ActivityOptionsCompat compat = ActivityOptionsCompat
          .makeCustomAnimation(mContext, R.anim.dialog_bottom_in, R.anim.dialog_bottom_out);
  ARouter.getInstance().build(RouterUrl.ACTIVITY_URL_LOGIN)
          .withOptionsCompat(compat)
          .navigation();

??我們發現入場動畫生效了，難道真的是 withTransition 方法過時了嘛？但是并沒有標注這是過時方法啊？我們再仔細看下這段源碼：

if ((0 != postcard.getEnterAnim() || 0 != postcard.getExitAnim()) && currentContext instanceof Activity) {    // Old version.
        ((Activity) currentContext).overridePendingTransition(postcard.getEnterAnim(), postcard.getExitAnim());
}

是上下文引用 overridePendingTransition 方法設置的出入場動畫，需要設置上下文！對了！如果不設置上下文，框架會使用一個自定義的context，但是無法作用在目標界面上，我們把跳轉代碼改成這樣：

ARouter.getInstance().build(RouterUrl.ACTIVITY_URL_LOGIN)
        .withTransition(R.anim.dialog_bottom_in, R.anim.dialog_bottom_out)
        .navigation(MainActivity.this);

入場動畫生效。這里需要注意一下，無論用哪種方法，出場動畫都不會生效，所以在設置出場動畫時，建議在目標界面添加如下代碼設置出場動畫。

    @Override
    public void finish() {
        super.finish();
        overridePendingTransition(R.anim.anim_none, R.anim.dialog_bottom_out);
    }

6.ARouter自定義分組

定義分組比較簡單，首先在注釋上多加一個group屬性

  @Route(path = RouterUrl.ACTIVITY_URL_LOGIN, group = "group")

然后跳轉時攜帶分組信息

  ARouter.getInstance().build(RouterUrl.ACTIVITY_URL_LOGIN,"group")
          .navigation(SplashActivity.this);

如果目標界面設置了分組屬性，在跳轉時一定要攜帶分組信息，否則會找不到該路由。另外，該方法已經過時了，建議用下列方法設置分組信息：

  Postcard build = ARouter.getInstance().build(RouterUrl.ACTIVITY_URL_LOGIN);
  build.setGroup("group");
  build.navigation(SplashActivity.this);

7.小結

??再順帶一提這篇文章是如何誕生的，因為在踩坑的過程中去查閱了一些文章，大概是由于框架更新的原因，很多老文章提出的方案并不能解決我所有遇到的問題，而且還有很多文章地址失效，所以導致我踩坑花費了較多的精力。但這些文章依舊提供給我解決問題的思路，而在寫文章的過程中也使我能更加清晰的梳理思路和深刻的了解原理，因此使我意識到寫文章帶來的多重好處，也希望我這篇文章能給使用該框架的開發者們帶來幫助，并向寫文章幫助到我的各位前輩們致敬。

三个男躁一个女,国精产品一区一手机的秘密,麦子交换系列最经典十句话,欧美国产综合欧美视频

Android路由框架ARouter的集成、基本使用以及踩坑全過程

Android路由框架ARouter的集成、基本使用以及踩坑全過程

Android路由框架ARouter的集成、基本使用以及踩坑全過程

1.集成配置及初始化框架

1.1添加依賴

1.2初始化SDK

2.ARouter的簡單使用

2.1界面跳轉

2.2攜帶基本參數的界面跳轉

2.3攜帶對象的界面跳轉

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

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

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

2.4界面跳轉回調

3.ARouter獲取fragment實例

4.ARouter攔截器

5.ARouter轉場動畫

6.ARouter自定義分組

7.小結

8.相關參考文獻

三个男躁一个女,国精产品一区一手机的秘密,麦子交换系列最经典十句话,欧美 国产 综合 欧美 视频

Android路由框架ARouter的集成、基本使用以及踩坑全過程

Android路由框架ARouter的集成、基本使用以及踩坑全過程

1.集成配置及初始化框架

1.1添加依賴

1.2初始化SDK

2.ARouter的簡單使用

2.1界面跳轉

2.2攜帶基本參數的界面跳轉

2.3攜帶對象的界面跳轉

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

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

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

2.4界面跳轉回調

3.ARouter獲取fragment實例

4.ARouter攔截器

5.ARouter轉場動畫

6.ARouter自定義分組

7.小結

8.相關參考文獻

三个男躁一个女,国精产品一区一手机的秘密,麦子交换系列最经典十句话,欧美国产综合欧美视频