Android 路由框架ARouter最佳實踐

来源:http://www.cnblogs.com/zhaoyanjun/archive/2017/08/21/7402856.html
-Advertisement-
Play Games

轉載請標明出處：http://blog.csdn.net/zhaoyanjun6/article/details/76165252 本文出自 "【趙彥軍的博客】" 一：什麼是路由？ 說簡單點就是映射頁面跳轉關係的，當然它也包含跳轉相關的一切功能。 二：為什麼需要路由 Android系統已經給我們提供 ...


轉載請標明出處：http://blog.csdn.net/zhaoyanjun6/article/details/76165252
本文出自【趙彥軍的博客】

一：什麼是路由？

說簡單點就是映射頁面跳轉關係的，當然它也包含跳轉相關的一切功能。

二：為什麼需要路由

Android系統已經給我們提供了api來做頁面跳轉，比如startActivity，為什麼還需要路由框架呢？我們來簡單分析下路由框架存在的意義：

  • 在一些複雜的業務場景下（比如電商），靈活性比較強，很多功能都是運營人員動態配置的，比如下發一個活動頁面，我們事先並不知道具體的目標頁面，但如果事先做了約定，提前做好頁面映射，便可以自由配置。

  • 隨著業務量的增長，客戶端必然隨之膨脹，開發人員的工作量越來越大，比如64K問題，比如協作開發問題。App一般都會走向組件化、插件化的道路，而組件化、插件化的前提就是解耦，那麼我們首先要做的就是解耦頁面之間的依賴關係。

  • 簡化代碼。數行跳轉代碼精簡成一行代碼。

  • 其他...

三：ARouter 簡介

是ARouter是阿裡巴巴開源的Android平臺中對頁面、服務提供路由功能的中間件，提倡的是簡單且夠用。

GitHub：https://github.com/alibaba/ARouter

四：ARouter 優勢

從 ARouter Github 瞭解到它的優勢：

  • 支持直接解析標準URL進行跳轉，並自動註入參數到目標頁面中
  • 支持多模塊工程使用
  • 支持添加多個攔截器，自定義攔截順序
  • 支持依賴註入，可單獨作為依賴註入框架使用
  • 支持InstantRun
  • 支持MultiDex(Google方案)
  • 映射關係按組分類、多級管理，按需初始化
  • 支持用戶指定全局降級與局部降級策略
  • 頁面、攔截器、服務等組件均自動註冊到框架
  • 支持多種方式配置轉場動畫
  • 支持獲取Fragment
  • 完全支持Kotlin以及混編

典型的應用：

  • 從外部URL映射到內部頁面，以及參數傳遞與解析
  • 跨模塊頁面跳轉，模塊間解耦
  • 攔截跳轉過程，處理登陸、埋點等邏輯
  • 跨模塊API調用，通過控制反轉來做組件解耦

五：ARouter 配置

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

dependencies {
    compile 'com.alibaba:arouter-api:1.2.1.1'
    annotationProcessor 'com.alibaba:arouter-compiler:1.1.2.1'
}

api 的版本和 compiler 的版本號需要用最新的。最新的版本在 Github上可以找到。

這裡寫圖片描述

六：ARouter 初始化

public class MyApplication extends Application {

    @Override
    public void onCreate() {
        super.onCreate();

        ARouter.openLog();     // 列印日誌
        ARouter.openDebug();   // 開啟調試模式(如果在InstantRun模式下運行，必須開啟調試模式！線上版本需要關閉,否則有安全風險)
        ARouter.init( this ); // 儘可能早，推薦在Application中初始化
    }
}

七：ARouter 註解發起路由

新建一個 Activity1 作為測試 ，在 Activity1 添加註解的代碼如下：

package com.router;

import android.support.v7.app.AppCompatActivity;
import android.os.Bundle;

import com.alibaba.android.arouter.facade.annotation.Route;
// 在支持路由的頁面上添加註解(必選)
// 這裡的路徑需要註意的是至少需要有兩級，/xx/xx

@Route(path = "/com/Activity1")
public class Activity1 extends AppCompatActivity {

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_1);
    }
}

在 MainActivity 的佈局中添加一個按鈕

<?xml version="1.0" encoding="utf-8"?>
<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:tools="http://schemas.android.com/tools"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    tools:context="com.router.MainActivity">

    <TextView
        android:id="@+id/bt1"
        android:layout_width="match_parent"
        android:layout_height="wrap_content"
        android:text="應用內跳轉"
        android:gravity="center"
        android:padding="10dp"
        android:background="#666666"
        />

</LinearLayout>

MainActivity 裡面的跳轉邏輯是：

public class MainActivity extends AppCompatActivity implements View.OnClickListener {

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);

        findViewById( R.id.bt1).setOnClickListener( this );

    }

    @Override
    public void onClick(View v) {
        switch ( v.getId() ){
            case R.id.bt1 :
                //發起路由跳轉
                ARouter.getInstance().build("/com/Activity1").navigation();
                break;
        }
    }
}

效果圖如下：

這裡寫圖片描述

如果你想實現像 startActivityForResult（） 功能，可以這樣使用：

navigation(Activity mContext, int requestCode)

具體使用如下：

ARouter.getInstance()
       .build("/com/Activity1")
       .navigation( this , 100 );

如果 Path 路徑不正確會發生什麼，我們來測試一下，現在我們把路由操作改為

 ARouter.getInstance().build("/com/Test").navigation();

效果如下：

這裡寫圖片描述

可以看到有一個 Toast 提示我們找不到 "/com/Test" 路徑，我們來看看源碼

這裡寫圖片描述

通過源碼我們可以看到在 debug 狀態下，當找不到路由路徑目標是，會有 Toast 提示。

八：監聽路由過程

在路由跳轉的過程中，我們可以監聽路由的過程，只需要使用：

navigation(Context context, NavigationCallback callback)

NavigationCallback 的源碼如下：

public interface NavigationCallback {

    /**
     * Callback when find the destination.
     * 找到了
     * @param postcard meta
     */
    void onFound(Postcard postcard);

    /**
     * Callback after lose your way.
     * 找不到了
     * @param postcard meta
     */
    void onLost(Postcard postcard);

    /**
     * Callback after navigation.
     * 跳轉完了
     * @param postcard meta
     */
    void onArrival(Postcard postcard);

    /**
     * Callback on interrupt.
     * 被攔截了
     * @param postcard meta
     */
    void onInterrupt(Postcard postcard);
}

具體使用如下

ARouter.getInstance()
       .build("/com/Activity1")
       .navigation(this, new NavCallback() {

             @Override
              public void onFound(Postcard postcard) {
                   Log.e("zhao", "onArrival: 找到了 ");
              }

             @Override
              public void onLost(Postcard postcard) {
                   Log.e("zhao", "onArrival: 找不到了 ");
              }

             @Override
              public void onArrival(Postcard postcard) {
                   Log.e("zhao", "onArrival: 跳轉完了 ");
              }

             @Override
              public void onInterrupt(Postcard postcard) {
                    Log.e("zhao", "onArrival: 被攔截了 ");
              }
              });

九：發起路由並且傳遞參數

ARouter.getInstance()
       .build("/com/Activity1")
       .withString( "key" , "123")  //參數：鍵：key 值：123
       .navigation();

ARouter 提供了豐富大量的參數類型，供我們選擇。

//基礎類型

.withString( String key, String value )
.withBoolean( String key, boolean value)
.withChar( String key, char value )
.withShort( String key, short value)
.withInt( String key, int value)
.withLong( String key, long value)
.withDouble( String key, double value)
.withByte( String key, byte value)
.withFloat( String key, float value)
.withCharSequence( String key,  CharSequence value)

//數組類型

.withParcelableArrayList( String key, ArrayList<? extends Parcelable > value)
.withStringArrayList( String key,  ArrayList<String> value)
.withIntegerArrayList( String key, ArrayList<Integer> value)
.withSparseParcelableArray( String key, SparseArray<? extends Parcelable> value)
.withCharSequenceArrayList( String key, ArrayList<CharSequence> value)
.withShortArray( String key,  short[] value)
.withCharArray( String key, char[] value)
.withFloatArray( String key, float[] value)
.withCharSequenceArray( String key,  CharSequence[] value)

//Bundle 類型

.with( Bundle bundle )
         
//Activity 跳轉動畫

.withTransition(int enterAnim, int exitAnim)
                
//其他類型
       
.withParcelable( String key, Parcelable value)
.withParcelableArray( String key,  Parcelable[] value)
.withSerializable( String key, Serializable value)
.withByteArray( String key, byte[] value)
.withTransition(int enterAnim, int exitAnim)

十：路由分組

在前面我們講到在對 Activity1 做註解的時候，用到了

@Route(path = "/com/Activity1")
public class Activity1 extends AppCompatActivity {

}

在 path 這個字元串裡面，"com" 就代表組的標識；“Activity1" 代表是 Activity1 類的具體表示。組的標識和類的標識都可以自己定義的，需要記住的是組標識和類標識之間用斜杠來區分 '''' .

什麼是組？

這裡就需要提下，ARouter框架是分組管理，按需載入。提起來很高深的樣子呢！其實解釋起來就是，在編譯期框架掃描了所有的註冊頁面／服務／欄位／攔截器等，那麼很明顯運行期不可能一股腦全部載入進來，這樣就太不和諧了。所以就分組來管理，ARouter在初始化的時候只會一次性地載入所有的root結點，而不會載入任何一個Group結點，這樣就會極大地降低初始化時載入結點的數量。比如某些Activity分成一組，組名就叫test，然後在第一次需要載入組內的某個頁面時再將test這個組載入進來。

測試一下：

ARouter.getInstance()
       .build("/com/Activity1")
       .navigation(this, new NavCallback() {
            @Override
            public void onArrival(Postcard postcard) {
                String group = postcard.getGroup();
                Log.e("zhao", "分組是: " + group);
            }
        });

結果是

07-27 17:32:17.880 19449-19449/com.router E/zhao: 分組是: com

ARouter 預設情況下的分組就是第一個 / / 之間的內容。

自定義分組：

創建 CustomGroupActivity 並且添加 註解，並且指定路由分組。自定義分組的就是在原來的註解上添加 group 欄位， 如下所示。

@Route(path = "/com/CustomGroupActivity" , group = "customGroup")
public class CustomGroupActivity extends AppCompatActivity {

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_custom_group);
    }
}

自定義分組，發起路由：第二個參數就是路由的分組

build(String path, String group)

具體實現如下所示：

 ARouter.getInstance().build("/com/CustomGroupActivity", "customGroup").navigation();

十一：Fragment 路由

創建 Fragment 類，並且添加路由註解

@Route(path = "/com/TestFragment")
public class TestFragment extends Fragment {

    @Override
    public View onCreateView(LayoutInflater inflater, ViewGroup container,
                             Bundle savedInstanceState) {
        View view = inflater.inflate(R.layout.fragment_test, container, false);
        return view ;
    }
}

獲取 Fragment 實例

Fragment fragment = (Fragment) ARouter.getInstance().build( "/com/TestFragment" ).navigation();

十二：URL 跳轉

web url 跳轉流程圖

這裡寫圖片描述

創建URL 中間跳轉頁

創建 URLReceiveActivity

/**
 * URL 中轉Activity
 */
public class URLReceiveActivity extends AppCompatActivity {

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);

        setContentView( R.layout.activity_url_receive );

        //對URI 數據分發
        Uri uri = getIntent().getData();
        ARouter.getInstance().build(uri).navigation(this, new NavCallback() {
            @Override
            public void onArrival(Postcard postcard) {
                finish();
            }
        });
    }
}

URLReceiveActivity 添加註冊

<activity android:name=".URLReceiveActivity">
      <!-- Schame -->
      <intent-filter>
            <data
                android:host="zhaoyanjun"
                android:scheme="arouter" />

          <action android:name="android.intent.action.VIEW" />
          <category android:name="android.intent.category.DEFAULT" />
          <category android:name="android.intent.category.BROWSABLE" />

       </intent-filter>

</activity>

這裡面的 host 、scheme 欄位很重要。點擊 url 會根據這兩個欄位會調起本地的 Activity 。

下麵是一段 HTML 片段

<h2>1:URL普通跳轉</h2>

<p><a href="arouter://zhaoyanjun/com/URLActivity1">arouter://zhaoyanjun/com/URLActivity1 </a>
</p>

<h2>2:URL普通跳轉攜帶參數</h2>

<p>
<a href="arouter://zhaoyanjun/com/URLActivity2?name=alex&age=18&boy=true&high=180&obj=%7b%22name%22%3a%22jack%22%2c%22id%22%3a666%7d">arouter://zhaoyanjun/test/URLActivity2?name=alex&age=18&boy=true&high=180&obj={"name":"jack","id":"666"}
</a>
</p>

註意 a 標簽裡面的 arouter://zhaoyanjun 分別代表著 scheme 、host ；/com/URLActivity1 就是目標 Activity 的註解。

如果需要接收 URL 中的參數，需要在 Activity 調用自動註入初始化方法；

ARouter.getInstance().inject(this);

需要註意的是，如果不使用自動註入，那麼可以不寫 ARouter.getInstance().inject(this)，但是需要取值的欄位仍然需要標上 @Autowired 註解，因為 只有標上註解之後，ARouter才能知道以哪一種數據類型提取URL中的參數並放入Intent中，這樣您才能在intent中獲取到對應的參數

具體的代碼如下：

@Route(path = "/com/URLActivity2")
public class URLActivity2 extends AppCompatActivity{

    private TextView textView;

    @Autowired
    String name;

    @Autowired
    int age;

    @Autowired
    boolean boy;

    @Autowired
    int high;

    @Autowired
    String obj ;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        ARouter.getInstance().inject(this);
        setContentView(R.layout.activity_url2);

        textView = (TextView) findViewById(R.id.tv);

        //解析參數
        Bundle bundle = getIntent().getExtras();
        String name1 = bundle.getString("name");

        textView.setText("參數是： " + "name: " + name + "  age: " + age
                + " boy: " + boy + " name1: " + name1 + " obj: " + obj.toString() );
    }
}

效果圖如下：

這裡寫圖片描述

十三：暴露服務

這裡說到的服務不是Android四大組件中的Service，這裡的服務是介面開發的概念，就是將一部分功能和組件封裝起來成為介面，以介面的形式對外提供能力，所以在這部分就可以將每個功能作為一個服務，而服務的實現就是具體的業務功能。

我們先自定義一個介面 IService 並且繼承 IProvider 。IService 介面裡面有一個 sayHello() 方法，具體代碼如下。

public interface IService extends IProvider {
    void sayHello(Context context );
}

先定義一個 IService 的實現類 MyService 並且添加註解，代碼如下

@Route(path = "/service/hello", name = "測試服務")
public class MyService implements IService {

    @Override
    public void sayHello( Context context ) {
        Toast.makeText(  context , "hello", Toast.LENGTH_SHORT).show();
    }

    @Override
    public void init(Context context) {

    }
}

發現服務，首先定義服務對象，並且添加註解，我們不需要知道介面的具體實現類。

@Autowired(name = "/service/hello")
IService service;

然後添加註解初始化，自動賦值。

ARouter.getInstance().inject(this);

最後我們調用 service 裡面的 sayHello() 方法。

service.sayHello(this);

效果圖如下：

這裡寫圖片描述

發現服務這個功能的特點在於，我們只需要知道介面，不需要關心介面的實現類，很好了實現瞭解耦。

十四：其他

  • 關閉路由，這個操作慎用
ARouter.getInstance().destroy();

十五：混淆說明

-keep public class com.alibaba.android.arouter.routes.**{*;}
-keep class * implements com.alibaba.android.arouter.facade.template.ISyringe{*;}

總結

所有的代碼都上傳至Github: https://github.com/zyj1609wz/Router

參考資料

ARouter解析一：基本使用及頁面註冊源碼解析
ARouter解析二：頁面跳轉源碼分析

個人微信號：zhaoyanjun125 ， 歡迎關註


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • Hybrid App混合模式開發的瞭解
    Hybrid App（混合模式移動應用）是指介於web-app、native-app這兩者之間的app，兼具“Native App良好用戶交互體驗的優勢”和“Web App跨平臺開發的優勢”。 1.Hybrid App就是一個移動應用 2.同時使用網頁語言與程式語言編寫 3.通過應用商店進行分發 4 ...
  • 迴圈
    var canvas = $("#gameCanvas"); var context = canvas.get(0).getContext("2d"); //畫布尺寸 var canvasWidth = canvas.width(); var canvasHeight = canvas.height... ...
  • ListView實現簡單列表
    ListView實現簡單列表 效果圖： 啥也沒乾的ListView張這樣： fry.Activity01 /ListView/res/layout/activity01.xml ...
  • ViewPager實現引導頁
    ViewPager實現引導頁 廢話就不多說了，直接上效果圖和代碼 fry.Activity01 fry.ImagePagerAdapter /viewPager/res/layout/activity01.xml 1、多個控制項（這裡指小圓點）可以用List來一起訪問 2、可用動態的控制項設置tag來區 ...
  • 體能評定軟體開發總結（二）
    (c)hele 一、基本情況 （一）開發工具改版 在我的上篇博客里，工程構建還是Eclipse模式，但是這篇博客寫出來時工程已經改為Android Studio模式，主要是Gradle工具的應用，特別是第三方庫的引用，不用將庫放進libs文件夾下，只需要進行Gradle依賴配置，十分方便。 （二）內 ...
  • Android遠程桌面助手(Build 0787)
    Windows下的Android遠程桌面助手(Android Remote Displayer and Controller)，增加了輸入法的快速切換功能，支持通過Google拼音輸入法在PC端快速輸入中文，支持通過ARDC輸入法複製粘貼文本到Android端。 ...
  • React Native 如何做輪播圖 react-native-swiper
    歡迎各位同學加入： React-Native群：397885169 大前端群：544587175 大神超多，熱情無私幫助解決各種問題。 最近項目需求需要用到輪播圖，所以寫兩Demo練練手，不過效果不太理想，希望大牛予以指正。 不多說，先上圖。 這種輪播很常見，但是一個問題是，總感覺有點卡的感覺，最氣 ...
  • iOS----------禁止輸入漢字
    說明： ^.*[\u4e00-\u9fa5].*$ 是否包含中文^[\u4E00-\u9FA5]+$ 是否全中文 - (BOOL)textField:(UITextField *)textField shouldChangeCharactersInRange:(NSRange)range repla ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發（一）：使用.NET MAUI開發第一個安卓APP
    移動開發（一）：使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說，近來想嘗試開發一款安卓APP，考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP，畢竟是使用Visual Studio開發工具，使用起來也比較的順手，結合微軟官方的教程進行了安卓 ...
  • wpf ToggleButton選中效果和一個登錄界面
    前言 QuestPDF 是一個開源 .NET 庫，用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫，它徹底改變了我們生成 PDF 文檔的方 ...
  • 彈幕樹洞項目功能新增篇
    項目地址 項目後端地址： https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址： ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址： http://tree ...
  • 第27篇 sqlserver2022詳細安裝步驟
    話不多說，直接開乾 一.下載 1.官方鏈接下載： https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe，運行開始下載SQL server； 二. ...
  • .NET 開源高性能 MQTT 類庫
    前言 隨著物聯網（IoT）技術的迅猛發展，MQTT（消息隊列遙測傳輸）協議憑藉其輕量級和高效性，已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫，為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog文檔翻譯系列（六） - 可用的接收器、增強器、格式化輸出
    Serilog支持多種接收器用於日誌存儲，增強器用於添加屬性，LogContext管理動態屬性，支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項，適用於不同需求。 ...
  • 警惕 Visual Studio 屬性求值副作用導致邏輯不符合預期
    目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據，爬取信息時需要模擬瀏覽器行為，否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下： 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • [使用目前最新版]HybridCLR6.9.0+YooAsset2.2.4實現純C# Unity熱更新方案 (一)
    1.前言 什麼是熱更新 游戲或者軟體更新時，無需重新下載客戶端進行安裝，而是在應用程式啟動的情況下，在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR，Xlua，ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles，Addressable， ...
  • 在 ASP.NET Core Web API 中使用操作篩選器統一處理通用操作
    本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺，其實像阿裡雲，騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後，它會送 ...
  • 第28篇 如何.net中實現高效可靠數據同步api
    通過以下方式可以高效，並保證數據同步的可靠性 1.API設計 使用RESTful設計，確保API端點明確，並使用適當的HTTP方法（如POST用於創建，PUT用於更新）。 設計清晰的請求和響應模型，以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類