緣起

隨着 App 的成長，咱們不免會遇到如下這些需求：git

H5 跳原生界面
Notification 點擊調相關界面
根據後臺返回數據跳轉界面，例如登陸成功後跳不一樣界面或者根據運營需求跳不一樣界面
實現 AppLink 的跳轉

爲了解決這些問題，App 通常都會自定義一個 scheme 跳轉協議，多端都實現這個協議，以此來解決各類運營需求。今天就來解析下 QMUI 最新版 QMUISchemeHandler 的設計與實現。github

一個 scheme 的格式大概是這樣子：設計模式

schemeName://action?param1=value1&param2=value2

例如：框架

qmui://home?tab=2

從技術角度來說，實現 scheme 的跳轉並非件很難的事情，就是下面兩個步驟：ide

解析 scheme
根據解析結果跳轉指定界面

可是寫代碼時若是不加以設計，就容易是堆一堆的 if else。例如：ui

if(action=="action1"){
    doAction1(params)
}else if(action=="action2"){
    doAction2(params)
}else {
    ...
}

每當有新的 scheme 添加時，就去添加一個 if，直到它逐漸變成一段巨長的爛代碼，改都改不動。於是咱們要勤思考、多重構，儘早經過設計出優良的框架來解放本身的雙手。編碼

對於 if else 這類的重構，一個基本的方式就是用查表法，將全部的條件以及其所要執行的行爲放在一個 map 裏，而後使用時經過去查詢這個 map 而獲取要執行的行爲。而咱們能夠經過註解配合代碼生成的方式構建這個 map，從而減小咱們代碼的編寫量。除此以外，咱們還須要考慮各類功能性需求：url

能夠設置攔截器 interceptor，例如跳某些界面，若是是非登陸的狀態，可能須要跳轉到登陸界面
參數能夠指定一些基礎類型， scheme 所攜帶的參數的值都是字符串，但咱們但願它能夠方便的轉換成咱們須要的基礎類型
同一個 action 能夠根據參數的不一樣而有不一樣的跳轉行爲，例如都是跳轉書籍詳情，漫畫書籍和普通書籍要跳轉的界面可能不同
若是當前界面已是目標界面，能夠選擇刷新當前界面或者啓動一個新界面
對於 QMUI，是同時支持 Activity 和 Fragment 的，於是 scheme 也要同時支持這二者
能夠自定義新界面的實例化方法

接口設計

任何一個庫的開發，爲了讓業務使用方足夠舒心，既要保證庫的功能足夠強大，也要保證使用的方便性，QMUI Scheme 對外主要是QMUISchemeHandler 這個入口類，以及 ActivityScheme 和 FragmentScheme 兩個註解。設計

QMUISchemeHandler

QMUISchemeHandler 經過 Builder 模式實例化：日誌

// 設置schemeName
val instance = QMUISchemeHandler.Builder("qmui://")
    // 防止短期類觸發屢次相同的scheme跳轉
    .blockSameSchemeTimeout(1000)
    // scheme 參數 decode
    .addInterpolator(new QMUISchemeParamValueDecoder())
    .addInterpolator(...)
    // 默認 fragment 實例化 factory
    .defaultFragmentFactory(...)
    // 默認 activity 實例化 factory
    .defaultIntentFactory(...)
    // 默認 scheme 匹配器
    .defaultSchemeMatcher(...)
    .build();

if(!instance.handle("qmui://xxx")){
  // scheme 未被 handle，日誌記錄？
}

大多數場景，QMUISchemeHandler 採用單例模式便可。其能夠設置多個攔截器、設置 fragment、activity 的默認實例化工廠、以及默認的匹配器。實例工廠和匹配器都是提供了默認實現的，大多數場景是不須要調用者關心的。並且這裏都只是設置全局默認值，到了 scheme 註解那一層，還能夠爲每一個 scheme 指定不一樣的值，以知足可能的自定義需求。

ActivityScheme 與 FragmentScheme 註解

這兩個註解是很是類似的，可是由於 Fragment 有一些更多的配置項，由於獨立出來了。

@Retention(RetentionPolicy.CLASS)
@Target(ElementType.TYPE)
public @interface ActivityScheme {
    // scheme action 名
    String name();
    // 必須的參數列表，用於支持同一個 action 對應多個 scheme 的場景，每一項能夠是"type=4" 來指定值，或者只傳"type"來匹配任意值
    String[] required() default {};
    // 若是當前界面就是 scheme 跳轉的目標值，能夠選擇刷新當前界面，固然當前界面必須實現 ActivitySchemeRefreshable
    boolean useRefreshIfCurrentMatched() default false;
    // 自定義當前 scheme 的匹配實現方法， 傳值爲 QMUISchemeMatcher 的實現
    Class<?> customMatcher() default void.class;
    // 自定義當前 Activity 實例工廠，傳值爲 QMUISchemeIntentFactory
    Class<?> customFactory() default void.class;
    // 指定參數的類型，支持 int/bool/long/float/double 這些基礎類型，不指定則爲 string 類型
    String[] keysWithIntValue() default {};
    String[] keysWithBoolValue() default {};
    String[] keysWithLongValue() default {};
    String[] keysWithFloatValue() default {};
    String[] keysWithDoubleValue() default {};
}

@Retention(RetentionPolicy.CLASS)
@Target(ElementType.TYPE)
public @interface FragmentScheme {
    // 這些參數都同 ActivityScheme
    String name();
    String[] required() default {};
    Class<?> customMatcher() default void.class;
    String[] keysWithIntValue() default {};
    String[] keysWithBoolValue() default {};
    String[] keysWithLongValue() default {};
    String[] keysWithFloatValue() default {};
    String[] keysWithDoubleValue() default {};

    //同 ActivityScheme，但當前UI必須實現 FragmentSchemeRefreshable
    boolean useRefreshIfCurrentMatched() default false;

    // 同 ActivityScheme, 但傳值是 QMUISchemeFragmentFactory 的實現類
    Class<?> customFactory() default void.class;
    // 能夠承載目標 Fragment 的 activity 列表，若是當前 activity 不在列表裏，則用 activities 的第一項啓動新的 activity
    Class<?>[] activities();
    // 是否強制啓動新的 Activity
    boolean forceNewActivity() default false;
    // 能夠經過 scheme 裏的參數來控制是否強制啓動新的 Activity
    String forceNewActivityKey() default "";    
}

能夠看出，咱們前面所羅列的各類需求，都在 SchemeHandler 以及兩個 scheme 裏體現出來了。

使用

對於業務使用者，咱們只須要在 Activity 或者 Fragment 上加上註解。 QMUISchemeHandler 默認會將參數解析出來並放到 Activity 的 intent 裏或者 Fragment 的 arguments 裏，於是咱們能夠在 onCreate 裏將咱們關心的值取出來：

@ActivityScheme(name="activity1")
class Activity1: QMUIActivity{

  override fun onCreate(...){
    ...
    if(isStartedByScheme()){
       // 經過 intent extra 獲取參數的值
       val param1 = getIntent().getStringExtra(paramName)
    }
  }
}

@FragmentScheme(name="activity1", activities = {QDMainActivity.class})
class Fragment1: QMUIFragment{
  override fun onCreate(...){
    ...
    if(isStartedByScheme()){
       // 經過 arguments 獲取參數的值
       val param1 = getArguments().getString(paramName)
    }
  }
}

這種傳值方法很符合 Android 官方設計的作法了，這也要求 Fragment 遵循無參構造器的使用方式。

對於 WebView，咱們能夠經過重寫 WebViewClient#shouldOverrideUrlLoading 來處理 scheme 跳轉：

class MyWebViewClient: WebViewClient{
    override fun shouldOverrideUrlLoading(view: WebView, url: String){
        if(schemeHandler.handle(url)){
            return true;
        }
        return super.shouldOverrideUrlLoading(view, url);
    }

    override fun shouldOverrideUrlLoading(view: WebView, request: WebResourceRequest){
        if(schemeHandler.handle(request.getUrl().toString())){
            return true;
        }
        return super.shouldOverrideUrlLoading(view, request);
    }
}

實現

QMUISchemeHandler 採用代碼生成的方式，在編譯期生成一個 SchemeMapImpl 類，其實現了 SchemeMap 類

public interface SchemeMap {

    // 經過 action 和參數尋找 SchemeItem
    SchemeItem findScheme(QMUISchemeHandler handler, String schemeAction, Map<String, String> params);
    // 判斷 schemeAction 是否存在
    boolean exists(QMUISchemeHandler handler, String schemeAction);
}

而每一個 scheme 的註解對應一個 SchemeItem:

ActivityScheme 對應實例化一個 ActivitySchemeItem 類，並加入到 map 中
FragmentScheme 對應實例化一個 FragmentSchemeItem 類，並加入到 map 中

在編譯期經過 SchemeProcessor 生成的 SchemeMapImpl 大概是這樣子的：

public class SchemeMapImpl implements SchemeMap {
  private Map<String, List<SchemeItem>> mSchemeMap;

  public SchemeMapImpl() {
    mSchemeMap = new HashMap<>();
    List<SchemeItem> elements;
    ArrayMap<String, String> required = null;
    elements = new ArrayList<>();
    required =null;
    elements.add(new FragmentSchemeItem(QDSliderFragment.class,false,new Class[]{QDMainActivity.class},null,false,"",required,null,null,null,null,null,SliderSchemeMatcher.class));
    mSchemeMap.put("slider", elements);

    elements = new ArrayList<>();
    required = new ArrayMap<>();
    required.put("aa", null);
    required.put("bb", "3");
    elements.add(new ActivitySchemeItem(ArchTestActivity.class,true,null,required,null,new String[]{"aa"},null,null,null,null));
    mSchemeMap.put("arch", elements);

  }

  @Override
  public SchemeItem findScheme(QMUISchemeHandler arg0, String arg1, Map<String, String> arg2) {
    List<SchemeItem> list = mSchemeMap.get(arg1);
    if(list == null || list.isEmpty()) {
      return null;
    }
    for (int i = 0; i < list.size(); i++) {
      SchemeItem item = list.get(i);
      if(item.match(arg0, arg2)) {
        return item;
      }
    }
    return null;
  }

  @Override
  public boolean exists(QMUISchemeHandler arg0, String arg1) {
    return mSchemeMap.containsKey(arg1);
  }
}

總體的設計以及實現思路就是這樣，剩下的就是各類編碼細節了。有興趣的能夠經過 QMUISchemeHandler#handle() 進行追蹤下，或者看看 SchemeProcessor 是如何作代碼生成的。這個功能看上去簡單，其實也包括了 Builder 模式、責任鏈模式、工廠方法等設計模式的運用，還有 SchemeMatcher、 SchemeItem 等對面向對象的接口、繼承、多態等的運用。讀一讀或許對你有所啓迪，或許你也能幫我發現某些潛在的 Bug。

從需求出發：QMUI 最新版 QMUISchemeHandler 的設計與實現解析

緣起

接口設計

QMUISchemeHandler

ActivityScheme 與 FragmentScheme 註解

使用

實現