iOS開發日記28-OC與JS的交互(JavaScriptCore)

今天博主有一個OC與JS的交互的需求,遇到了一些困難點,在此和大家分享,希望能夠共同進步.

上一篇博文與大家分享了如何使用webview與JS進行交互,但是隨著新的API的開放,我們不僅僅需要在webview中與JS進行交互,也需要在很多其他的框架中與JS進行交互,有兩種方法提供給大家:

1.蘋果在7.0之后新開放得API javaScriptCore框架,讓我們能夠更簡便的使用OC與JS進行交互.

JavaScriptCore中的類

在項目中引入JavaScriptCore后，鏈到頭文件中，除了大段的Copyright注釋可以看到里面只要引入了5個文件，每個文件里都定義跟文件名對應的類：

JSContext
JSValue
JSManagedValue
JSVirtualMachine
JSExport

JavaScriptCore_Head

雖說代碼中的注釋介紹的也比較詳細了，但是如同一圖頂萬言，對程序員來說代碼更有說服力。本文就先來說說這些類相對比較好理解但又很常用的JSContext和JSValue以及它們方法的使用方式和效果。

JSContext和JSValue

JSVirtualMachine為JavaScript的運行提供了底層資源，JSContext就為其提供著運行環境，通過- (JSValue *)evaluateScript:(NSString *)script;方法就可以執行一段JavaScript腳本，并且如果其中有方法、變量等信息都會被存儲在其中以便在需要的時候使用。而JSContext的創建都是基于JSVirtualMachine：- (id)initWithVirtualMachine:(JSVirtualMachine *)virtualMachine;，如果是使用- (id)init;進行初始化，那么在其內部會自動創建一個新的JSVirtualMachine對象然后調用前邊的初始化方法。

JSValue則可以說是JavaScript和Object-C之間互換的橋梁，它提供了多種方法可以方便地把JavaScript數據類型轉換成Objective-C，或者是轉換過去。其一一對應方式可見下表：

Objective-C	JavaScript	JSValue Convert	JSValue Constructor
nil	undefined		valueWithUndefinedInContext
NSNull	null		valueWithNullInContext:
NSString	string	toString
NSNumber	number, boolean	toNumber toBool toDouble toInt32 toUInt32	valueWithBool:inContext: valueWithDouble:inContext: valueWithInt32:inContext: valueWithUInt32:inContext:
NSDictionary	Object object	toDictionary	valueWithNewObjectInContext:
NSArray	Array object	toArray	valueWithNewArrayInContext:
NSDate	Date object	toDate
NSBlock	Function object
id	Wrapper object	toObject toObjectOfClass:	valueWithObject:inContext:
Class	Constructor object

基本類型轉換

先看個簡單的例子：

1     JSContext *context = [[JSContext alloc] init];2     JSValue *jsVal = [context evaluateScript:@"21+7"];3     int iVal = [jsVal toInt32];4     NSLog(@"JSValue: %@, int: %d", jsVal, iVal);5      6     //Output:7     // JSValue: 28, int: 28

很簡單吧，還可以存一個JavaScript變量在JSContext中，然后通過下標來獲取出來。而對于Array或者Object類型，JSValue也可以通過下標直接取值和賦值。

 1     JSContext *context = [[JSContext alloc] init]; 2     [context evaluateScript:@"var arr = [21, 7 , 'iderzheng.com'];"]; 3     JSValue *jsArr = context[@"arr"]; // Get array from JSContext 4       5     NSLog(@"JS Array: %@; Length: %@", jsArr, jsArr[@"length"]); 6     jsArr[1] = @"blog"; // Use JSValue as array 7     jsArr[7] = @7; 8       9     NSLog(@"JS Array: %@; Length: %d", jsArr, [jsArr[@"length"] toInt32]);10      11     NSArray *nsArr = [jsArr toArray];12     NSLog(@"NSArray: %@", nsArr);13      14     //Output:15     // JS Array: 21,7,iderzheng.com Length: 316     // JS Array: 21,blog,iderzheng.com,,,,,7 Length: 817     // NSArray: (18     // 21,19     // blog,20     // "iderzheng.com",21     // "<null>",22     // "<null>",23     // "<null>",24     // "<null>",25     // 726     // )

通過輸出結果很容易看出代碼成功把數據從Objective-C賦到了JavaScript數組上，而且JSValue是遵循JavaScript的數組特性：無下標越位，自動延展數組大小。并且通過JSValue還可以獲取JavaScript對象上的屬性，比如例子中通過"length"就獲取到了JavaScript數組的長度。在轉成NSArray的時候，所有的信息也都正確轉換了過去。

方法的轉換

各種數據類型可以轉換，Objective-C的Block也可以傳入JSContext中當做JavaScript的方法使用。比如在前端開發中常用的log方法，雖然JavaScritpCore沒有自帶（畢竟不是在網頁上運行的，自然不會有window、document、console這些類了），仍然可以定義一個Block方法來調用NSLog來模擬：

 1     JSContext *context = [[JSContext alloc] init]; 2     context[@"log"] = ^() { 3     NSLog(@"+++++++Begin Log+++++++"); 4       5     NSArray *args = [JSContext currentArguments]; 6     for (JSValue *jsVal in args) { 7     NSLog(@"%@", jsVal); 8     } 9      10     JSValue *this = [JSContext currentThis];11     NSLog(@"this: %@",this);12     NSLog(@"-------End Log-------");13     };14      15     [context evaluateScript:@"log('ider', [7, 21], { hello:'world', js:100 });"];16      17     //Output:18     // +++++++Begin Log+++++++19     // ider20     // 7,2121     // [object Object]22     // this: [object GlobalObject]23     // -------End Log-------

通過Block成功的在JavaScript調用方法回到了Objective-C，而且依然遵循JavaScript方法的各種特點，比如方法參數不固定。也因為這樣，JSContext提供了類方法來獲取參數列表(+ (JSContext *)currentContext;)和當前調用該方法的對象(+ (JSValue *)currentThis)。對于"this"，輸出的內容是GlobalObject，這也是JSContext對象方法- (JSValue *)globalObject;所返回的內容。因為我們知道在JavaScript里，所有全局變量和方法其實都是一個全局變量的屬性，在瀏覽器中是window，在JavaScriptCore是什么就不得而知了。

Block可以傳入JSContext作方法，但是JSValue沒有toBlock方法來把JavaScript方法變成Block在Objetive-C中使用。畢竟Block的參數個數和類型已經返回類型都是固定的。雖然不能把方法提取出來，但是JSValue提供了- (JSValue *)callWithArguments:(NSArray *)arguments;方法可以反過來將參數傳進去來調用方法。

 1     JSContext *context = [[JSContext alloc] init]; 2     [context evaluateScript:@"function add(a, b) { return a + b; }"]; 3     JSValue *add = context[@"add"]; 4     NSLog(@"Func: %@", add); 5       6     JSValue *sum = [add callWithArguments:@[@(7), @(21)]]; 7     NSLog(@"Sum: %d",[sum toInt32]); 8     //OutPut: 9     // Func: function add(a, b) { return a + b; }10     // Sum: 28

JSValue還提供- (JSValue *)invokeMethod:(NSString *)method withArguments:(NSArray *)arguments;讓我們可以直接簡單地調用對象上的方法。只是如果定義的方法是全局函數，那么很顯然應該在JSContext的globalObject對象上調用該方法；如果是某JavaScript對象上的方法，就應該用相應的JSValue對象調用.

下面貼上代碼,我們還是以webview作為示例,各位看官自行深究.

首先我們添加協議

@interface ViewController ()<UIWebViewDelegate>

實現代理方法

#PRagma mark --webViewDelegate

-(BOOL)webView:(UIWebView *)webView shouldStartLoadWithRequest:(NSURLRequest *)request navigationType:(UIWebViewNavigationType)navigationType

{

//網頁加載之前會調用此方法

//retrun YES 表示正常加載網頁返回NO 將停止網頁加載

return YES;

}

-(void)webViewDidStartLoad:(UIWebView *)webView

{

//開始加載網頁調用此方法

}

-(void)webViewDidFinishLoad:(UIWebView *)webView

{

//網頁加載完成調用此方法

}

-(void)webView:(UIWebView *)webView didFailLoadWithError:(NSError *)error

{

//網頁加載失敗調用此方法

}

每個方法是什么時候調用都在注釋里面

1.我們先嘗試用oc調用一下js方法

-(void)webViewDidFinishLoad:(UIWebView *)webView

{

//網頁加載完成調用此方法

//首先創建JSContext 對象（此處通過當前webView的鍵獲取到jscontext）

JSContext *context=[webView valueForKeyPath:@"documentView.webView.mainFrame.javaScriptContext"];

NSString *alertJS=@"alert('test js OC')"; //準備執行的js代碼

[context evaluateScript:alertJS];//通過oc方法調用js的alert

}

2.下來我們使用js調用iOS

js調用iOS分兩種情況

一，js里面直接調用方法

二，js里面通過對象調用方法

首先我們看第一種，直接調用方法。

其中用到了iOS的block

-(void)webViewDidFinishLoad:(UIWebView *)webView

{

//網頁加載完成調用此方法

//iOS調用js

//首先創建JSContext 對象（此處通過當前webView的鍵獲取到jscontext）

JSContext *context=[webView valueForKeyPath:@"documentView.webView.mainFrame.javaScriptContext"];

//js調用iOS

//第一種情況

//其中test1就是js的方法名稱，賦給是一個block 里面是iOS代碼

//此方法最終將打印出所有接收到的參數，js參數是不固定的我們測試一下就知道

context[@"test1"] = ^() {

NSArray *args = [JSContext currentArguments];

for (id obj in args) {

NSLog(@"%@",obj);

}

};

//此處我們沒有寫后臺（但是前面我們已經知道iOS是可以調用js的，我們模擬一下）

//首先準備一下js代碼，來調用js的函數test1 然后執行

//一個參數

NSString *jsFunctStr=@"test1('參數1')";

[context evaluateScript:jsFunctStr];

//二個參數

NSString *jsFunctStr1=@"test1('參數a','參數b')";

[context evaluateScript:jsFunctStr1];

}

以上代碼中給test1賦值的block要是執行了那么結果就是對的，js調用了iOS

我們看結果

我們看到參數被打印出來了，而且一個參數和兩個參數都可以，也符合js參數個數不限制

下來我們看第二種情況就是js 中是通過一個對象來調用方法的。

此處稍微復雜一點我們需要使用到

JSExport

凡事添加了JSExport協議的協議，所規定的方法，變量等就會對js開放，我們可以通過js調用到

此處有點繞。我們直接看代碼

首先創建一個類繼承NSObject 并且規定一個協議

#import <Foundation/Foundation.h>

#import <JavaScriptCore/JavaScriptCore.h>

//首先創建一個實現了JSExport協議的協議

@protocol TestJSObjectProtocol <JSExport>

//此處我們測試幾種參數的情況

-(void)TestNOParameter;

-(void)TestOneParameter:(NSString *)message;

-(void)TestTowParameter:(NSString *)message1 SecondParameter:(NSString *)message2;

@end

//讓我們創建的類實現上邊的協議

@interface TestJSObject : NSObject<TestJSObjectProtocol>

@end

類的實現

#import "TestJSObject.h"

@implementation TestJSObject

//一下方法都是只是打了個log 等會看log 以及參數能對上就說明js調用了此處的iOS 原生方法

-(void)TestNOParameter

{

NSLog(@"this is ios TestNOParameter");

}

-(void)TestOneParameter:(NSString *)message

{

NSLog(@"this is ios TestOneParameter=%@",message);

}

-(void)TestTowParameter:(NSString *)message1 SecondParameter:(NSString *)message2

{

NSLog(@"this is ios TestTowParameter=%@ Second=%@",message1,message2);

}

@end

下面我們在weibview加載完成之后調用測試一下

-(void)webViewDidFinishLoad:(UIWebView *)webView

{

//網頁加載完成調用此方法

//首先創建JSContext 對象（此處通過當前webView的鍵獲取到jscontext）

JSContext *context=[webView valueForKeyPath:@"documentView.webView.mainFrame.javaScriptContext"];

//第二種情況，js是通過對象調用的，我們假設js里面有一個對象 testobject 在調用方法

//首先創建我們新建類的對象，將他賦值給js的對象

TestJSObject *testJO=[TestJSObject new];

context[@"testobject"]=testJO;

//同樣我們也用剛才的方式模擬一下js調用方法

NSString *jsStr1=@"testobject.TestNOParameter()";

[context evaluateScript:jsStr1];

NSString *jsStr2=@"testobject.TestOneParameter('參數1')";

[context evaluateScript:jsStr2];

NSString *jsStr3=@"testobject.TestTowParameterSecondParameter('參數A','參數B')";

[context evaluateScript:jsStr3];

}

結果如下:

TestJSOC[7038:258939] this is ios TestNOParameter

TestJSOC[7038:258939] this is ios TestOneParameter=參數1

TestJSOC[7038:258939] this is ios TestTwoParameter=參數A Second=參數B

好了我們看到了結果三個方法都調用了

ok兩種方式都完成了

http://nshipster.cn/javascriptcore/

http://www.webryan.net/2013/10/about-ios7-javascriptcore-framework/