緣起

隨著 App 的成長(zhǎng)，我們難免會(huì)遇到以下這些需求：

H5 跳原生界面 Notification 點(diǎn)擊調(diào)相關(guān)界面 根據(jù)后臺(tái)返回?cái)?shù)據(jù)跳轉(zhuǎn)界面，例如登錄成功后跳不同界面或者根據(jù)運(yùn)營(yíng)需求跳不同界面 實(shí)現(xiàn) AppLink 的跳轉(zhuǎn)

為了解決這些問(wèn)題，App 一般都會(huì)自定義一個(gè) scheme 跳轉(zhuǎn)協(xié)議，多端都實(shí)現(xiàn)這個(gè)協(xié)議，以此來(lái)解決各種運(yùn)營(yíng)需求。今天就來(lái)解析下QMUI最新版QMUISchemeHandler的設(shè)計(jì)與實(shí)現(xiàn)。

一個(gè) scheme 的格式大概是這樣子：

schemeName://action?param1=value1¶m2=value2

例如：

qmui://home?tab=2

從技術(shù)角度來(lái)講，實(shí)現(xiàn) scheme 的跳轉(zhuǎn)并不是件很難的事情，就是下面兩個(gè)步驟：

解析 scheme 根據(jù)解析結(jié)果跳轉(zhuǎn)指定界面

但是寫代碼時(shí)如果不加以設(shè)計(jì)，就容易是堆一堆的 if else。例如：

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

每當(dāng)有新的 scheme 添加時(shí)，就去添加一個(gè) if，直到它逐漸變成一段巨長(zhǎng)的爛代碼，改都改不動(dòng)。因而我們要勤思考、多重構(gòu)，盡早通過(guò)設(shè)計(jì)出優(yōu)良的框架來(lái)解放自己的雙手。

對(duì)于 if else 這類的重構(gòu)，一個(gè)基本的方式就是用查表法，將所有的條件以及其所要執(zhí)行的行為放在一個(gè) map 里，然后使用時(shí)通過(guò)去查詢這個(gè) map 而獲取要執(zhí)行的行為。而我們可以通過(guò)注解配合代碼生成的方式構(gòu)建這個(gè) map，從而減少我們代碼的編寫量。除此之外，我們還需要考慮各種功能性需求：

可以設(shè)置攔截器 interceptor，例如跳某些界面，如果是非登錄的狀態(tài)，可能需要跳轉(zhuǎn)到登錄界面 參數(shù)可以指定一些基礎(chǔ)類型， scheme 所攜帶的參數(shù)的值都是字符串，但我們希望它可以方便的轉(zhuǎn)換成我們需要的基礎(chǔ)類型 同一個(gè) action 可以根據(jù)參數(shù)的不同而有不同的跳轉(zhuǎn)行為，例如都是跳轉(zhuǎn)書(shū)籍詳情，漫畫書(shū)籍和普通書(shū)籍要跳轉(zhuǎn)的界面可能不一樣 如果當(dāng)前界面已經(jīng)是目標(biāo)界面，可以選擇刷新當(dāng)前界面或者啟動(dòng)一個(gè)新界面 對(duì)于 QMUI，是同時(shí)支持 Activity 和 Fragment 的，因而 scheme 也要同時(shí)支持這兩者 可以自定義新界面的實(shí)例化方法

接口設(shè)計(jì)

任何一個(gè)庫(kù)的開(kāi)發(fā)，為了讓業(yè)務(wù)使用方足夠舒心，既要保證庫(kù)的功能足夠強(qiáng)大，也要保證使用的方便性，QMUI Scheme 對(duì)外主要是QMUISchemeHandler這個(gè)入口類， 以及ActivityScheme和FragmentScheme兩個(gè)注解。

QMUISchemeHandler

QMUISchemeHandler通過(guò) Builder 模式實(shí)例化：

// 設(shè)置schemeNameval instance = QMUISchemeHandler.Builder('qmui://') // 防止短時(shí)間類觸發(fā)多次相同的scheme跳轉(zhuǎn) .blockSameSchemeTimeout(1000) // scheme 參數(shù) decode .addInterpolator(new QMUISchemeParamValueDecoder()) .addInterpolator(...) // 默認(rèn) fragment 實(shí)例化 factory .defaultFragmentFactory(...) // 默認(rèn) activity 實(shí)例化 factory .defaultIntentFactory(...) // 默認(rèn) scheme 匹配器 .defaultSchemeMatcher(...) .build();if(!instance.handle('qmui://xxx')){ // scheme 未被 handle，日志記錄？}

大多數(shù)場(chǎng)景，QMUISchemeHandler采用單例模式即可。 其可以設(shè)置多個(gè)攔截器、設(shè)置 fragment、activity 的默認(rèn)實(shí)例化工廠、以及默認(rèn)的匹配器。實(shí)例工廠和匹配器都是提供了默認(rèn)實(shí)現(xiàn)的，大多數(shù)場(chǎng)景是不需要調(diào)用者關(guān)心的。而且這里都只是設(shè)置全局默認(rèn)值，到了 scheme 注解那一層，還可以為每個(gè) scheme 指定不同的值，以滿足可能的自定義需求。

ActivityScheme 與 FragmentScheme 注解

這兩個(gè)注解是非常相似的，但是因?yàn)?Fragment 有一些更多的配置項(xiàng)，因?yàn)楠?dú)立出來(lái)了。

@Retention(RetentionPolicy.CLASS)@Target(ElementType.TYPE)public @interface ActivityScheme { // scheme action 名 String name(); // 必須的參數(shù)列表，用于支持同一個(gè) action 對(duì)應(yīng)多個(gè) scheme 的場(chǎng)景，每一項(xiàng)可以是'type=4' 來(lái)指定值，或者只傳'type'來(lái)匹配任意值 String[] required() default {}; // 如果當(dāng)前界面就是 scheme 跳轉(zhuǎn)的目標(biāo)值，可以選擇刷新當(dāng)前界面，當(dāng)然當(dāng)前界面必須實(shí)現(xiàn) ActivitySchemeRefreshable boolean useRefreshIfCurrentMatched() default false; // 自定義當(dāng)前 scheme 的匹配實(shí)現(xiàn)方法， 傳值為 QMUISchemeMatcher 的實(shí)現(xiàn) Class<?> customMatcher() default void.class; // 自定義當(dāng)前 Activity 實(shí)例工廠，傳值為 QMUISchemeIntentFactory Class<?> customFactory() default void.class; // 指定參數(shù)的類型，支持 int/bool/long/float/double 這些基礎(chǔ)類型，不指定則為 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 { // 這些參數(shù)都同 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，但當(dāng)前UI必須實(shí)現(xiàn) FragmentSchemeRefreshable boolean useRefreshIfCurrentMatched() default false; // 同 ActivityScheme, 但傳值是 QMUISchemeFragmentFactory 的實(shí)現(xiàn)類 Class<?> customFactory() default void.class; // 可以承載目標(biāo) Fragment 的 activity 列表，如果當(dāng)前 activity 不在列表里，則用 activities 的第一項(xiàng)啟動(dòng)新的 activity Class<?>[] activities(); // 是否強(qiáng)制啟動(dòng)新的 Activity boolean forceNewActivity() default false; // 可以通過(guò) scheme 里的參數(shù)來(lái)控制是否強(qiáng)制啟動(dòng)新的 Activity String forceNewActivityKey() default ''; }

可以看出，我們前面所羅列的各種需求，都在 SchemeHandler 以及兩個(gè) scheme 里體現(xiàn)出來(lái)了。

使用

對(duì)于業(yè)務(wù)使用者，我們只需要在Activity或者Fragment上加上注解。QMUISchemeHandler默認(rèn)會(huì)將參數(shù)解析出來(lái)并放到Activity的 intent 里或者Fragment的 arguments 里，因而我們可以在onCreate里將我們關(guān)心的值取出來(lái)：

@ActivityScheme(name='activity1')class Activity1: QMUIActivity{ override fun onCreate(...){ ... if(isStartedByScheme()){ // 通過(guò) intent extra 獲取參數(shù)的值 val param1 = getIntent().getStringExtra(paramName) } }}@FragmentScheme(name='activity1', activities = {QDMainActivity.class})class Fragment1: QMUIFragment{ override fun onCreate(...){ ... if(isStartedByScheme()){ // 通過(guò) arguments 獲取參數(shù)的值 val param1 = getArguments().getString(paramName) } }}

這種傳值方法很符合 Android 官方設(shè)計(jì)的做法了，這也要求Fragment遵循無(wú)參構(gòu)造器的使用方式。

對(duì)于 WebView， 我們可以通過(guò)重寫WebViewClient#shouldOverrideUrlLoading來(lái)處理 scheme 跳轉(zhuǎn)：

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); }}

實(shí)現(xiàn)

QMUISchemeHandler采用代碼生成的方式，在編譯期生成一個(gè)SchemeMapImpl類，其實(shí)現(xiàn)了SchemeMap類

public interface SchemeMap { // 通過(guò) action 和參數(shù)尋找 SchemeItem SchemeItem findScheme(QMUISchemeHandler handler, String schemeAction, Map<String, String> params); // 判斷 schemeAction 是否存在 boolean exists(QMUISchemeHandler handler, String schemeAction);}

而每個(gè) scheme 的注解對(duì)應(yīng)一個(gè)SchemeItem:

ActivityScheme對(duì)應(yīng)實(shí)例化一個(gè)ActivitySchemeItem類，并加入到 map 中 FragmentScheme對(duì)應(yīng)實(shí)例化一個(gè)FragmentSchemeItem類，并加入到 map 中

在編譯期通過(guò)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); }}

整體的設(shè)計(jì)以及實(shí)現(xiàn)思路就是這樣，剩下的就是各種編碼細(xì)節(jié)了。有興趣的可以通過(guò)QMUISchemeHandler#handle()進(jìn)行追蹤下，或者看看SchemeProcessor是如何做代碼生成的。這個(gè)功能看上去簡(jiǎn)單，其實(shí)也包括了 Builder 模式、責(zé)任鏈模式、工廠方法等設(shè)計(jì)模式的運(yùn)用，還有 SchemeMatcher、 SchemeItem 等對(duì)面向?qū)ο蟮慕涌凇⒗^承、多態(tài)等的運(yùn)用。讀一讀或許對(duì)你有所啟迪，或許你也能幫我發(fā)現(xiàn)某些潛在的 Bug。

總結(jié)

到此這篇關(guān)于Android scheme 跳轉(zhuǎn)的設(shè)計(jì)與實(shí)現(xiàn)的文章就介紹到這了,更多相關(guān)Android scheme 跳轉(zhuǎn)的設(shè)計(jì)與實(shí)現(xiàn)內(nèi)容請(qǐng)搜索好吧啦網(wǎng)以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持好吧啦網(wǎng)！