JavaScriptCore

iOS 7中加入了JavaScriptCore框架,该框架让Objective-CJavaScript代码直接交互变得更加简单方便。

JavaScriptCore 总览

在学习 JavaScriptCore 的使用之前,需要先了解JavaScriptCore 当中的重要类型以及协议,包括JSValue 、 JSContext 、 JSVirtualMachine 、 JSManagedValue 以及 JSExport

先对这5个类简单介绍

  • JSVirtualMachine

Javascript 代码是在虚拟机当中运行的,每一个虚拟机由一个JSVirtualMachine来表示。一般情况下我们不用去手动创建 JSVirtualMachine 实例,使用系统提供的就足够了。需要手动创建 JSVirtualMachine的一个主要场景就是当我们需要并发地运行Javascript 代码时,在单一的JSVirtualMachine里面是没办法 同时 运行多个线程的。

  • JSContext

代表JavaScript的运行环境,是一个全局对象,可以理解为Web开发中的 window 对象。所有的 JSValue都与 JSContext 相关联。
JSContext也用于管理JavaScript虚拟机中对象的生命周期,每一个JSValue实例都将与JSContext通过强引用相关联。只要JSValue存在,JSContext就会保持引用,当JSContext中所有的JSValue被释放掉,那么JSContext也将会被释放,除非之前有被retained。

  • JSValue

JSValue可以说是JavaScriptObject-C或Swift之间数据互换的桥梁。为了在原生代码(native code)和JavaScript代码之间传递数据,JSContext里的不同的Javascript值都可以封装在JSValue的对象里,包括字符串、数值、数组、函数等,甚至还有Error以及nullundefined;同时这个类型的对象可以方便快速地转化为OC里常用的数据类型,如toBool()、toInt32()、toArray()、toDictionary()等。我们也可以使用JSValue创建JavaScript对象来包装原生自定义类中的对象,或者通过原生的方法或block来提供JavaScript函数的实现。
每一个JSValue实例都是来自于JSContextJSValue则包含了对context对象的强应用,这点需要特别注意,如果不注意可能会造成内存泄露。当我们通过JSValue调用方法时,返回的新JSValue跟之前的JSValue是属于同一个context的。

  • JSManagedValue

Objective-C 或者 Swift 的对象都是使用引用计数,而 Javascript 则是使用垃圾回收机制。为了避免两种语言交互时产生的循环引用,需要使用 JSManagedValue进行内存辅助管理。

  • JSExport

这是一个协议而不是对象。正如名字含义一样,我们可以使用这个协议暴露原生对象,实例方法,类方法,和属性给JavaScript,这样JavaScript就可以调用相关暴露的方法和属性。遵守JSExport协议,就可以定义我们自己的协议,在协议中声明的API都会在JS中暴露出来。

OC调用 Javascript

使用需要导入框架#import

示例1:
   JSContext *context = [[JSContext alloc]init];
    NSString *jsStr = @"function add(a,b) {return a+b}";
    [context evaluateScript:jsStr];
    JSValue *function = context[@"add"];
    JSValue *value = [function callWithArguments:@[@(2), @(3)]];
    NSLog(@"%@", [value toNumber]);

创建一个JSContext对象,然后将JS代码加载到context里面,最后取到这个函数对象,调用callWithArguments这个方法进行参数传值.

示例2:

NSString*JSStr=[[NSString alloc] initWithContentsOfFile: [[NSBundle mainBundle] pathForResource:@"TestJS.js" ofType:nil] encoding:NSUTF8StringEncoding error:nil];
    [context evaluateScript:JSStr];
    JSValue *jsFunction = context[@"factorial"];
    JSValue *resultValue = [jsFunction callWithArguments:@[@10]];
    NSLog(@"--  %@", [resultValue toNumber]);
    // JacaScript环境中异常检测,一旦出现错误,闭包将会被执行
    [context setExceptionHandler:^(JSContext *context, JSValue *exception) {
        [JSContext currentContext].exception = exception;
        NSLog(@"exception:%@",exception);
    }];

其中TestJS.js:

function factorial(n){
    if(n < 0)
        return
    if(n === 0)
        return 1
    return n * factorial(n - 1) 
}

运行结果:3628800

Javascript调用OC

JS调用OC有两个方法:blockJSExport protocol

block
//创建block
    NSInteger(^AddBlock)(NSInteger, NSInteger) addBlock = ^(NSInteger a, NSInteger b){
        return a+b;
    };
    JSContext *context = [[JSContext alloc]init];
    context[@"add"] = addBlock;
    JSValue *value = [context evaluateScript:@"add(11, 21)"];
    NSLog(@"%@", [value toNumber]);

我们定义一个block,然后保存到context里面,其实就是转换成了JS的function。然后我们直接执行这个function,调用的就是我们的block里面的内容了。

JSExport protocol:
//定义一个JSExport protocol,哪些属性或方法需要给JS使用,就要在这个协议中暴露哪些
@protocol JSExportTest 
- (NSInteger)add:(NSInteger)num1 num2:(NSInteger)num2 num3:(NSInteger)num3;
@property (nonatomic, assign) NSInteger sum;
@end

//建一个对象去实现这个协议:
@interface JSProtocolObj : NSObject
@end
@implementation JSProtocolObj
@synthesize sum = _sum;
//实现协议方法
- (NSInteger)add:(NSInteger)num1 num2:(NSInteger)num2  num3:(NSInteger)num3{
    return num1 + num2 + num3;
}
//重写setter方法方便打印信息,
- (void)setSum:(NSInteger)sum{
    NSLog(@"--%@", @(sum));
    _sum = sum;
}
@end

然后在控制器:

    JSProtocolObj *obj = [[JSProtocolObj alloc] init];
    JSContext *context = [[JSContext alloc] init];
    //设置异常处理
    context.exceptionHandler = ^(JSContext *context, JSValue *exception) {
        [JSContext currentContext].exception = exception;
        NSLog(@"exception:%@",exception);
    };
    context[@"OCObj"] = obj;
    [context evaluateScript:@"OCObj.sum = OCObj.addNum2Num3(2,3, 4)"];

注意:
当公开一个selector并拥有一个或者多个参数,JavaScriptCore将采用下列转换生成对应的函数名:

  • All colons are removed from the selector. selector中所有的冒号都将被去除
  • Any lowercase letter that had followed a colon is capitalized.所有冒号之后的小写字母都将变为大写字母

为了重命名selector暴露给JavaScript,,我们可以使用JSExportAs宏,如下:

@protocol JSExportTest 
//用宏转换下,将JS函数名字指定为add;
JSExportAs(add,
           - (NSInteger)add:(NSInteger)num1 num2:(NSInteger)num2 num3:(NSInteger)num3
           );

@property (nonatomic, assign) NSInteger sum;
@end

使用时:

 [context evaluateScript:@"OCObj.sum = OCObj.add(2,3, 4)"];

最后:

现在来说说内存管理的注意点,OC使用的ARC,JS使用的是垃圾回收机制,并且所有的引用是都强引用,不过JS的循环引用,垃圾回收会帮它们打破。JavaScriptCore里面提供的API,正常情况下,OC和JS对象之间内存管理都无需我们去关心。不过还是有几个注意点需要我们去留意下
不要在block里面直接使用context,或者使用外部的JSValue对象。

//错误代码:
self.context[@"block"] = ^(){
     JSValue *value = [JSValue valueWithObject:@"aaa" inContext:self.context];
};

这个代码,不用自己看了,编译器都会提示你的。这个block里面使用self,很容易就看出来了。

//一个比较隐蔽的
     JSValue *value = [JSValue valueWithObject:@"ssss" inContext:self.context];

    self.context[@"log"] = ^(){
        NSLog(@"%@",value);
    };

这个是block里面使用了外部的value``,valuecontext和它管理的JS对象都是强引用。这个valueblock所捕获,这边同样也会内存泄露,context是销毁不掉的。

//正确的做法,str对象是JS那边传递过来。
self.context[@"log"] = ^(NSString *str){
        NSLog(@"%@",str);
    };

你可能感兴趣的:(JavaScriptCore)