【quickhybrid】組件(自定義)API的實現

来源:https://www.cnblogs.com/dailc/archive/2017/12/27/8124036.html
-Advertisement-
Play Games

前言 前文在API規劃時就已經有提到過組件API這個概念,本文將會介紹它的原理以及實現 理解組件API這個概念 在quick hybrid中,API是按模塊劃分的,如 ,`page 組件` 為什麼叫組件?可以這樣理解,模塊更多的是H5前端的叫法(因為在前端看來不同API分別屬於不同的模塊下), 而組 ...


前言

前文在API規劃時就已經有提到過組件API這個概念,本文將會介紹它的原理以及實現

理解組件API這個概念

quick.ui.xxx
quick.page.xxx

在quick hybrid中,API是按模塊劃分的,如uipage等都是不同模塊,而模塊的另一個名稱則是組件

為什麼叫組件?可以這樣理解,模塊更多的是H5前端的叫法(因為在前端看來不同API分別屬於不同的模塊下),
而組件則是原生那邊加強的理解概念(因為,每一個組件都是可以在項目中單獨存在的,譬如項目A中有組件pay,但項目B卻不一定集成有)

框架API和組件API

回到最初,quick hybrid的使命就是服務於N個項目,那麼會遇到一個問題-N個項目中可能會有非常多的需要以API方式提供的需求,但是考慮到體積以及通用性,並不是所有的都適合直接集成到框架中

此時,就需要對框架內容和項目內容進行區分,於是就有了框架API和組件API的概念(此時可以認為原生中框架文件是單獨打成一個靜態包給項目引用的,項目無法直接修改)

框架API

  • 直接打包到框架文件中(前端的quick.native.js,原生框架包中的API都會包含)

  • 使用的時候直接quick.xx模塊.xx功能即可調用(因為前端會將框架API都預設封裝)

  • config配置時無需單獨註冊(因為預設情況會註冊好)

  • 部分框架API會有H5下的實現(如部分系統級API都是有H5下的實現的)

組件API

  • 框架中不會包含,由各自的項目自行開發或集成(如某項目單獨集成一個個性化語音組件)

  • 使用的時候必須用quick.callAPi(...)並傳入合適參數(因為框架不會集成,需要通過這個萬金油方法調用)

  • config配置時必須註冊(需要傳入組件別名註冊,因為框架內部不知道這些新組件的)

  • 所有組件API都只是quick環境下的實現(一般都是一些原生中集成的拓展功能)

項目中如何拓展組件API

項目中預設只會打包框架API,但是框架的功能是有限的(只會集成一些最常用的功能),如果遇到一些個性化的需求(如支付,語音等等),則需要項目拓展組件API,總體步驟如下:

  • 1.原生引入框架,並實現對應的API介面,編寫API的功能代碼

  • 2.原生在項目配置文件中(不是框架配置文件)聲明對應的別名和路徑關係

  • 3.H5頁面初始化時,config,並傳入對應需要註冊的組件的別名

  • 4.容器接收到config方法後,去配置文件中根據別名找路徑,然後註冊對應路徑下的API類

  • 5.註冊成功後,H5頁面中通過callAPi來調用新註冊的組件API

原生實現API介面

原生中API的定義如下(以pay組件為示例)

Android中

public class PayApi implements IBridgeImpl {

     public static void payCustom(..., JSONObject param, final Callback callback) {
        // 做對應的支付工作,做完後回調
        ...
        callback.apply(...);
    }
}

iOS中

@implementation PayApi
- (void)registerHandlers {
    [self registerHandlerName:@"payCustom" handler:^(id data, WVJBResponseCallback responseCallback) {
        // 做對應的支付工作,做完後回調
        ...
        responseCallback(...);
    }];
}

聲明別名與路徑的關係

需要註意的是,Android和iOS中別名請保持一致,一般情況下鍵值對也可

譬如以示例項目為例,

Android在app模塊下的assets/modules.properties

pay = com.quick.quickhybrid.api.PayApi
...

同理iOS中也類似,只不過右側的路徑值可以換為iOS中的,如

pay = PayApi

可以看到,Android和iOS中的別名名稱相同,但是路徑不一致(因為各種的包機制不一樣)

H5中config註冊

H5中需要在config註冊拓展的組件,需要傳入別名(別名有對應的文檔說明-一般情況下同類型組件的別名是固定的)

quick.config({
   jsApiList: ['pay']
});

// error代表發生錯誤
quick.error(...);

// ready中是註冊成功
quick.ready(...);

原生容器註冊組件API

原生容器接收到config請求後就開始註冊組件,如下

// RegisterName: ui,page,pay之類的組件(模塊)名
// RegisterNclass: 對應的路徑,Android中和iOS中不一致

// RegisterNclass: 如com.quick.quickhybrid.api.PayApi
JSBridge.register(RegisterName, RegisterNclass);
// RegisterNclass: 如PayApi
[self registerHandlersWithClassName:@"RegisterNclass" moduleName:@"RegisterName"];

H5中調用組件API

註冊成功後,H5中通過特定方法調用

quick.callApi({
    name: 'testPay',
    mudule: 'pay',
    // 額外參數經常都需要
    data: {...},
    success: function(result) {
        quick.ui.toast(JSON.stringify(result));
    },
    error: function(error) {},
});

結束語

實際情況下,當項目足夠多時,拓展組件API是一種非常常見的場景,因此制定規範是很有必要的。

另外,一般情況下,很多相同功能的組件都是可以一起積累,多個項目復用的(比如支付,特定業務組件等等)

返回根目錄

源碼

github上這個框架的實現

quickhybrid/quickhybrid


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

-Advertisement-
Play Games
更多相關文章
  • [20171225]查看並行執行計劃註意的問題.txt--//如果使用dbms_xplan.display_cursor查看並行執行計劃註意一些問題,通過例子說明:1.環境:SCOTT@book> @ &r/ver1PORT_STRING VERSION BANNER x86_64/Linux 2. ...
  • MySQL事務 MySQL事務主要用於處理操作量大,複雜度高的數據。 比如說,在人員管理系統中,你刪除一個人員,你既需要刪除人員的基本資料,也要刪除和該人員相關的信息,如信箱,文章等等,這些資料庫操作語句就構成一個事務。 (1)在MySQL中只有使用了Innodb資料庫引擎的資料庫或表才支持事務。  ...
  • 概要 react native 環境搭建 hello react native react native 發佈 react native 優勢 1. 不用再學習 OC,Swift,Java,Kotlin 等 2. 復用 react 開發的種種好處 3. 開發體驗好(即時編譯) 4. 編譯出來的是原生 ...
  • 幾天前去物管交物業費,物管工作人員說小區引進高新產品,使用銀行卡消費後,不需要拿筆在銀聯機上簽名,直接用手指觸摸實現消費簽名,當時心想,果然是高科技,機子外形如下左圖,簽名如下右圖。 仔細一看,其實就是一個觸摸屏,用戶在上面直接手動簽名,實現這個功能其實並不複雜,我們自定義一個控制項,繼承view,使 ...
  • 解決方法: 修改這個文件 assets/data/dcloud_control.xml <msc version="1.9.9.39354" debug="true"><apps><app appid="yourapp" appver="1.0.3"/></apps></msc> 設置debug就可 ...
  • 在接入FaceBook第三方登錄的時候,需要獲取Android Hash Key。 Android Hash Key即密鑰散列有兩種,一種是開發秘鑰散列,一種是發佈秘鑰散列。這裡主要介紹如何獲取開發秘鑰散列Debug Android Hash Key。 步驟如下: 1、到https://code.g ...
  • 一.移動客服端實現對PC端數據的操作 在PC端模擬一個資料庫,實現用戶的增刪改查,然後在移動客服端實現對PC端資料庫的操作 在PC端建立三個表 用戶表(Users),員工表(Emp), 部門表(Dept), User表對應欄位,並設置對應的set/get方法,這裡不一一寫出 Emp表對應欄位 Dep ...
  • 參考自http://blog.csdn.net/u010752082/article/details/50810190 代碼先貼出來: 首先說明一下,要搜索到歌詞,需要先搜索歌曲,得到歌曲對應的id和accesskey後才能進行歌詞的獲取。 那麼我們先從搜索歌曲的URL開始說起: 其中的name為搜 ...
一周排行
    -Advertisement-
    Play Games
  • 示例項目結構 在 Visual Studio 中創建一個 WinForms 應用程式後,項目結構如下所示: MyWinFormsApp/ │ ├───Properties/ │ └───Settings.settings │ ├───bin/ │ ├───Debug/ │ └───Release/ ...
  • [STAThread] 特性用於需要與 COM 組件交互的應用程式,尤其是依賴單線程模型(如 Windows Forms 應用程式)的組件。在 STA 模式下,線程擁有自己的消息迴圈,這對於處理用戶界面和某些 COM 組件是必要的。 [STAThread] static void Main(stri ...
  • 在WinForm中使用全局異常捕獲處理 在WinForm應用程式中,全局異常捕獲是確保程式穩定性的關鍵。通過在Program類的Main方法中設置全局異常處理,可以有效地捕獲並處理未預見的異常,從而避免程式崩潰。 註冊全局異常事件 [STAThread] static void Main() { / ...
  • 前言 給大家推薦一款開源的 Winform 控制項庫,可以幫助我們開發更加美觀、漂亮的 WinForm 界面。 項目介紹 SunnyUI.NET 是一個基於 .NET Framework 4.0+、.NET 6、.NET 7 和 .NET 8 的 WinForm 開源控制項庫,同時也提供了工具類庫、擴展 ...
  • 說明 該文章是屬於OverallAuth2.0系列文章,每周更新一篇該系列文章(從0到1完成系統開發)。 該系統文章,我會儘量說的非常詳細,做到不管新手、老手都能看懂。 說明:OverallAuth2.0 是一個簡單、易懂、功能強大的許可權+可視化流程管理系統。 有興趣的朋友,請關註我吧(*^▽^*) ...
  • 一、下載安裝 1.下載git 必須先下載並安裝git,再TortoiseGit下載安裝 git安裝參考教程:https://blog.csdn.net/mukes/article/details/115693833 2.TortoiseGit下載與安裝 TortoiseGit,Git客戶端,32/6 ...
  • 前言 在項目開發過程中,理解數據結構和演算法如同掌握蓋房子的秘訣。演算法不僅能幫助我們編寫高效、優質的代碼,還能解決項目中遇到的各種難題。 給大家推薦一個支持C#的開源免費、新手友好的數據結構與演算法入門教程:Hello演算法。 項目介紹 《Hello Algo》是一本開源免費、新手友好的數據結構與演算法入門 ...
  • 1.生成單個Proto.bat內容 @rem Copyright 2016, Google Inc. @rem All rights reserved. @rem @rem Redistribution and use in source and binary forms, with or with ...
  • 一:背景 1. 講故事 前段時間有位朋友找到我,說他的窗體程式在客戶這邊出現了卡死,讓我幫忙看下怎麼回事?dump也生成了,既然有dump了那就上 windbg 分析吧。 二:WinDbg 分析 1. 為什麼會卡死 窗體程式的卡死,入口門檻很低,後續往下分析就不一定了,不管怎麼說先用 !clrsta ...
  • 前言 人工智慧時代,人臉識別技術已成為安全驗證、身份識別和用戶交互的關鍵工具。 給大家推薦一款.NET 開源提供了強大的人臉識別 API,工具不僅易於集成,還具備高效處理能力。 本文將介紹一款如何利用這些API,為我們的項目添加智能識別的亮點。 項目介紹 GitHub 上擁有 1.2k 星標的 C# ...