iOS下JS與OC互相呼叫（八）--Cordova詳解+實戰

扯兩句，可以跳過

由於專案中Cordova相關功能一直是同事在負責，所以也沒有仔細的去探究Cordova到底是怎麼使用的，又是如何實現JS 與 OC 的互動。所以我基本上是從零開始研究和學習Cordova的使用，從上篇在官網實現命令列建立工程，到工程執行起來，實際專案中怎麼使用Cordova，可能還有一些人並不懂，其實我當時執行完那些命令後也不懂。 後來搜尋了一下關於Cordova 講解的文章，沒有找到一篇清晰將出如何使用Cordova，大多都是講如何將Cordova.xcodeproj拖進工程等等。我不喜歡工程裡多餘的東西太多，其實並不需要將Cordova 整個工程拖進去，只需要一部分就夠了，下面我會一一道來。

1.新建工程，新增Cordova 關鍵類

我這裡用Xcode 8 新建了一個工程，叫 JS_OC_Cordova,然後將Cordova關鍵類新增進工程。 有哪些關鍵類呢？ 這裡新增config.xml 、Private 和 Public 兩個資料夾裡的所有檔案。工程目錄結構如下：

然後執行工程，? ? ? ，你會發現報了一堆的錯誤：

為什麼有會這麼多報錯呢？

原因是Cordova 部分類中，並沒有#import <Foundation/Foundation.h>，但是它們卻使用了這個庫裡的NSArray、NSString 等型別。 為什麼用在終端裡用命令列建立的工程就正常呢？ 那是因為用命令列建立的工程裡已經包含了pch 檔案，並且已經import 了 Foundation框架。截圖為證：

其實這裡有兩種解決方案：

1、在報錯的類裡新增上 #import <Foundation/Foundation.h>；

2、新增一個pch 檔案，在pch檔案里加上 #import <Foundation/Foundation.h>。

我選擇第二種方案:

再次編譯、執行，依然報錯。 What the fuck ? ? ? !!!

不用急，這裡報錯是因為Cordova的類引用錯誤，在命令列建立的工程裡Cordova 是以子工程的形式加入到目標工程中，兩個工程的名稱空間不同，所以import 是用 類似這樣的方式#import <Cordova/CDV.h>，但是我們現在是直接在目標工程裡新增Cordova，所以要把#import <Cordova/CDV.h> 改為 #import "CDV.h"。其他的檔案引用報錯同理。

當然，如果想偷懶，也可以從後面我給的示例工程裡拷貝，我修改過的Cordova庫。

2.設定網頁控制器，新增網頁

首先將 ViewController 的父類改為 CDVViewController。如下圖所示：

這裡分兩種情況，載入本地HTML 和遠端HTML 地址。 ** 載入本地HTML ** 載入本地HTML，為了方便起見，首先新建一個叫www的資料夾，然後在資料夾裡放入要載入的HTML和cordova.js。 這裡把www新增進工程時，需要注意勾選的是create foler references,建立的是藍色資料夾。

最終的目錄結構如下：

上面為什麼說是方便起見呢？ 先說答案，因為CDVViewController有兩個屬性 wwwFolderName 和 startPage， wwwFolderName 的預設值為www，startPage 的預設值為 index.html。

在 CDVViewController 的 viewDidLoad方法中，呼叫了與網頁相關的三個方法： - loadSetting、- createGapView、- appUrl。 先看- loadSetting，這裡會對 wwwFolderName 和 startPage 設定預設值，程式碼如下：

- (void)loadSettings
{
    CDVConfigParser* delegate = [[CDVConfigParser alloc] init];

    [self parseSettingsWithParser:delegate];

    // Get the plugin dictionary, whitelist and settings from the delegate.
    self.pluginsMap = delegate.pluginsDict;
    self.startupPluginNames = delegate.startupPluginNames;
    self.settings = delegate.settings;

    // And the start folder/page.
    if(self.wwwFolderName == nil){
        self.wwwFolderName = @"www";
    }
    if(delegate.startPage && self.startPage == nil){
        self.startPage = delegate.startPage;
    }
    if (self.startPage == nil) {
        self.startPage = @"index.html";
    }

    // Initialize the plugin objects dict.
    self.pluginObjects = [[NSMutableDictionary alloc] initWithCapacity:20];
}
複製程式碼

要看- createGapView，是因為這個方法內部先呼叫了一次 - appUrl，所以關鍵還是- appUrl。原始碼如下：

- (NSURL*)appUrl
{
    NSURL* appURL = nil;

    if ([self.startPage rangeOfString:@"://"].location != NSNotFound) {
        appURL = [NSURL URLWithString:self.startPage];
    } else if ([self.wwwFolderName rangeOfString:@"://"].location != NSNotFound) {
        appURL = [NSURL URLWithString:[NSString stringWithFormat:@"%@/%@", self.wwwFolderName, self.startPage]];
    } else if([self.wwwFolderName hasSuffix:@".bundle"]){
        // www folder is actually a bundle
        NSBundle* bundle = [NSBundle bundleWithPath:self.wwwFolderName];
        appURL = [bundle URLForResource:self.startPage withExtension:nil];
    } else if([self.wwwFolderName hasSuffix:@".framework"]){
        // www folder is actually a framework
        NSBundle* bundle = [NSBundle bundleWithPath:self.wwwFolderName];
        appURL = [bundle URLForResource:self.startPage withExtension:nil];
    } else {
        // CB-3005 strip parameters from start page to check if page exists in resources
        NSURL* startURL = [NSURL URLWithString:self.startPage];
        NSString* startFilePath = [self.commandDelegate pathForResource:[startURL path]];

        if (startFilePath == nil) {
            appURL = nil;
        } else {
            appURL = [NSURL fileURLWithPath:startFilePath];
            // CB-3005 Add on the query params or fragment.
            NSString* startPageNoParentDirs = self.startPage;
            NSRange r = [startPageNoParentDirs rangeOfCharacterFromSet:[NSCharacterSet characterSetWithCharactersInString:@"?#"] options:0];
            if (r.location != NSNotFound) {
                NSString* queryAndOrFragment = [self.startPage substringFromIndex:r.location];
                appURL = [NSURL URLWithString:queryAndOrFragment relativeToURL:appURL];
            }
        }
    }

    return appURL;
}
複製程式碼

此時執行效果圖：

載入遠端HTML

專案裡一般都是這種情況，介面返回H5地址，然後用網頁載入H5地址。 只需要設定下 self.startPage就好了。

這裡有幾個需要注意的地方：

1. self.startPage的賦值，必須在[super viewDidLoad]之前，否則self.startPage 會被預設賦值為index.html。
2. 需要在config.xml中修改一下配置，否則載入遠端H5時，會自動開啟瀏覽器載入。 需要新增的配置是：

<allow-navigation href="https://*/*" />
<allow-navigation href="http://*/*"  />
複製程式碼

3. 遠端H5中也要引用cordova.js檔案。
4. 在 info.plist 中新增 App Transport Security Setting的設定。

執行效果圖：

3.建立外掛，配置外掛

在外掛中實現JS要呼叫的原生方法，外掛要繼承自CDVPlugin，示例程式碼如下：

#import "CDV.h"

@interface HaleyPlugin : CDVPlugin

- (void)scan:(CDVInvokedUrlCommand *)command;

- (void)location:(CDVInvokedUrlCommand *)command;

- (void)pay:(CDVInvokedUrlCommand *)command;

- (void)share:(CDVInvokedUrlCommand *)command;

- (void)changeColor:(CDVInvokedUrlCommand *)command;

- (void)shake:(CDVInvokedUrlCommand *)command;

- (void)playSound:(CDVInvokedUrlCommand *)command;

@end
複製程式碼

配置外掛，是在config.xml的widget中新增自己建立的外掛。 如下圖所示：

關於外掛中方法的實現有幾個注意點：

1、如果你發現類似如下的警告：

THREAD WARNING: ['scan'] took '290.006104' ms. Plugin should use a background thread.
複製程式碼

那麼直需要將實現改為如下方式即可：

[self.commandDelegate runInBackground:^{
      // 這裡是實現
}];
複製程式碼

示例程式碼：

- (void)scan:(CDVInvokedUrlCommand *)command
{
    [self.commandDelegate runInBackground:^{
        dispatch_async(dispatch_get_main_queue(), ^{
            UIAlertView *alertView = [[UIAlertView alloc] initWithTitle:@"原生彈窗" message:nil delegate:nil cancelButtonTitle:@"知道了" otherButtonTitles:nil, nil];
            [alertView show];
        });
    }];
}
複製程式碼

2、如何獲取JS 傳過來的引數呢？

CDVInvokedUrlCommand 引數，其實有四個屬性，分別是arguments、callbackId、className、methodName。其中arguments，就是引數陣列。

看一個獲取引數的示例程式碼：

- (void)share:(CDVInvokedUrlCommand *)command
{
    NSUInteger code = 1;
    NSString *tip = @"分享成功";
    NSArray *arguments = command.arguments;
    if (arguments.count < 3) {;
        code = 2;
        tip = @"引數錯誤";
        NSString *jsStr = [NSString stringWithFormat:@"shareResult('%@')",tip];
        [self.commandDelegate evalJs:jsStr];
        return;
    }
    
    NSLog(@"從H5獲取的分享引數:%@",arguments);
    NSString *title = arguments[0];
    NSString *content = arguments[1];
    NSString *url = arguments[2];
    
    // 這裡是分享的相關程式碼......
    
    // 將分享結果返回給js
    NSString *jsStr = [NSString stringWithFormat:@"shareResult('%@','%@','%@')",title,content,url];
    [self.commandDelegate evalJs:jsStr];
}
複製程式碼

3、如何將Native的結果回撥給JS ？

這裡有兩種方式：第一種是直接執行JS，呼叫UIWebView 的執行js 方法。示例程式碼如下：

 // 將分享結果返回給js
    NSString *jsStr = [NSString stringWithFormat:@"shareResult('%@','%@','%@')",title,content,url];
    [self.commandDelegate evalJs:jsStr];
複製程式碼

第二種是，使用Cordova 封裝好的物件CDVPluginResult和API。 使用這種方式時，在JS 呼叫原生功能時，必須設定執行成功的回撥和執行失敗的回撥。即設定cordova.exec(successCallback, failCallback, service, action, actionArgs)的第一個引數和第二個引數。像這樣：

function locationClick() { 
    cordova.exec(setLocation,locationError,"HaleyPlugin","location",[]);
}
複製程式碼

然後，Native 呼叫JS 的示例程式碼：

- (void)location:(CDVInvokedUrlCommand *)command
{
    // 獲取定位資訊......
    
    // 下一行程式碼以後可以刪除
//    NSString *locationStr = @"廣東省深圳市南山區學府路XXXX號";
    NSString *locationStr = @"錯誤資訊";
    
//    NSString *jsStr = [NSString stringWithFormat:@"setLocation('%@')",locationStr];
//    [self.commandDelegate evalJs:jsStr];
    
    [self.commandDelegate runInBackground:^{
        CDVPluginResult *result = [CDVPluginResult resultWithStatus:CDVCommandStatus_ERROR messageAsString:locationStr];
        [self.commandDelegate sendPluginResult:result callbackId:command.callbackId];
    }];
}
複製程式碼

4.JS 呼叫Native 功能

終於到重點了，JS想要呼叫原生程式碼，如何操作呢？我用本地HTML 來演示。 首先，HTML中需要載入 cordova.js，需要注意該js 檔案的路徑，因為我的cordova.js與HTML放在同一個資料夾，所以src 是這樣寫：

<script type="text/javascript" src="cordova.js"></script>
複製程式碼

然後，在HTML中建立幾個按鈕，以及實現按鈕的點選事件，示例程式碼如下：

<input type="button" value="掃一掃" onclick="scanClick()" />
        <input type="button" value="獲取定位" onclick="locationClick()" />
        <input type="button" value="修改背景色" onclick="colorClick()" />
        <input type="button" value="分享" onclick="shareClick()" />
        <input type="button" value="支付" onclick="payClick()" />
        <input type="button" value="搖一搖" onclick="shake()" />
        <input type="button" value="播放聲音" onclick="playSound()" />
複製程式碼

點選事件對應的關鍵的JS程式碼示例：

function scanClick() {
    cordova.exec(null,null,"HaleyPlugin","scan",[]);
}

function shareClick() {
    cordova.exec(null,null,"HaleyPlugin","share",['測試分享的標題','測試分享的內容','http://m.rblcmall.com/share/openShare.htm?share_uuid=shdfxdfdsfsdfs&share_url=http://m.rblcmall.com/store_index_32787.htm&imagePath=http://c.hiphotos.baidu.com/image/pic/item/f3d3572c11dfa9ec78e256df60d0f703908fc12e.jpg']);
}

function locationClick() {
    cordova.exec(setLocation,locationError,"HaleyPlugin","location",[]);
}

function locationError(error) {
    asyncAlert(error);
    document.getElementById("returnValue").value = error;
}

function setLocation(location) {
    asyncAlert(location);
    document.getElementById("returnValue").value = location;
}
複製程式碼

JS 要呼叫原生，執行的是:

// successCallback : 成功的回撥方法
// failCallback : 失敗的回撥方法
// server : 所要請求的服務名字，就是外掛類的名字
// action : 所要請求的服務具體操作，其實就是Native 的方法名，字串。
// actionArgs : 請求操作所帶的引數，這是個陣列。
cordova.exec(successCallback, failCallback, service, action, actionArgs);
複製程式碼

cordova，是cordova.js裡定義的一個 var結構體，裡面有一些方法以及其他變數，關於exec ，可以看 iOSExec這個js 方法。 大致思想就是，在JS中定義一個陣列和一個字典（鍵值對）。 陣列中存放的就是:

callbackId與服務、操作、引數的對應關係轉成json 存到上面全域性陣列中。
 var command = [callbackId, service, action, actionArgs];

    // Stringify and queue the command. We stringify to command now to
    // effectively clone the command arguments in case they are mutated before
    // the command is executed.
 commandQueue.push(JSON.stringify(command));
複製程式碼

而字典裡存的是回撥，當然回撥也是與callbackId對應的，這裡的callbackId與上面的callbackId是同一個：

callbackId = service + cordova.callbackId++;
cordova.callbacks[callbackId] =
            {success:successCallback, fail:failCallback};
複製程式碼

iOSExec 裡又是如何呼叫到原生方法的呢？

依然是做一個假的URL 請求，然後在UIWebView的代理方法中攔截請求。

JS 方法 iOSExec中會呼叫 另一個JS方法 pokeNative，而這個pokeNative，看到他的程式碼實現就會發現與UIWebView 開啟一個URL 的操作是一樣的：

function pokeNative() {
    // CB-5488 - Don't attempt to create iframe before document.body is available.
    if (!document.body) {
        setTimeout(pokeNative);
        return;
    }
    
    // Check if they've removed it from the DOM, and put it back if so.
    if (execIframe && execIframe.contentWindow) {
        execIframe.contentWindow.location = 'gap://ready';
    } else {
        execIframe = document.createElement('iframe');
        execIframe.style.display = 'none';
        execIframe.src = 'gap://ready';
        document.body.appendChild(execIframe);
    }
    failSafeTimerId = setTimeout(function() {
        if (commandQueue.length) {
            // CB-10106 - flush the queue on bridge change
            if (!handleBridgeChange()) {
                pokeNative();
             }
        }
    }, 50); // Making this > 0 improves performance (marginally) in the normal case (where it doesn't fire).
}
複製程式碼

看到這裡，我們只需要去搜尋一下攔截URL 的代理方法，然後驗證我們的想法介面。 我搜尋webView:shouldStartLoadWIthRequest:navigationType 方法，然後打上斷點，看如下的堆疊呼叫：

關鍵程式碼是這裡，判斷url 的scheme 是否等於 gap。

    if ([[url scheme] isEqualToString:@"gap"]) {
        [vc.commandQueue fetchCommandsFromJs];
        // The delegate is called asynchronously in this case, so we don't have to use
        // flushCommandQueueWithDelayedJs (setTimeout(0)) as we do with hash changes.
        [vc.commandQueue executePending];
        return NO;
    }
複製程式碼

fetchCommandsFromJs 是呼叫js 中的nativeFetchMessages()，獲取commandQueue裡的json 字串； executePending中將json 字串轉換為CDVInvokedUrlCommand物件，以及利用runtime，將js 裡的服務和 方法，轉換物件，然後呼叫objc_msgSend 直接呼叫執行，這樣就進入了外掛的對應的方法中了。

這一套思想與WebViewJavascriptBridge的思想很相似。

5. Native 呼叫 JS 方法

這個非常簡單，如果是在控制器中，那麼只需要像如下這樣既可：

- (void)testClick
{
    // 方式一：
    NSString *jsStr = @"asyncAlert('哈哈啊哈')";
    [self.commandDelegate evalJs:jsStr];
    
}
複製程式碼

這裡的evalJs內部呼叫的其實是 UIWebView 的 stringByEvaluatingJavaScriptFromString 方法。

6.如果你在使用Xcode 8時，覺得控制檯裡大量的列印很礙眼，可以這樣設定來去掉。

首先:

然後，新增一個環境變數：

好了，到這裡關於Cordova 的講解就結束了。

示例工程的github地址：JS_OC_Cordova

Have Fun!