javascript - iOS 用 JavascriptCore 实现“window.setTimeout”

Question

我在 iOS 应用程序中使用 JavaScriptCore 库，我正在尝试实现 setTimeout 函数。

setTimeout(func, period)

启动应用程序后，将创建具有全局上下文的 JSC 引擎，并将两个函数添加到该上下文中：

_JSContext = JSGlobalContextCreate(NULL);

[self mapName:"iosSetTimeout" toFunction:_setTimeout];
[self mapName:"iosLog" toFunction:_log];

这是将具有所需名称的全局 JS 函数映射到静态目标 C 函数的本机实现：

- (void) mapName:(const char*)name toFunction:(JSObjectCallAsFunctionCallback)func
{
  JSStringRef nameRef = JSStringCreateWithUTF8CString(name);
  JSObjectRef funcRef = JSObjectMakeFunctionWithCallback(_JSContext, nameRef, func);
  JSObjectSetProperty(_JSContext, JSContextGetGlobalObject(_JSContext), nameRef, funcRef, kJSPropertyAttributeNone, NULL);
  JSStringRelease(nameRef);
}

这是目标C setTimeout 函数的实现：

JSValueRef _setTimeout(JSContextRef ctx,
                     JSObjectRef function,
                     JSObjectRef thisObject,
                     size_t argumentCount,
                     const JSValueRef arguments[],
                     JSValueRef* exception)
{
  if(argumentCount == 2)
  {
    JSEngine *jsEngine = [JSEngine shared];
    jsEngine.timeoutCtx =  ctx;
    jsEngine.timeoutFunc = (JSObjectRef)arguments[0];
    [jsEngine performSelector:@selector(onTimeout) withObject:nil afterDelay:5];
  }
  return JSValueMakeNull(ctx);
}

延迟一段时间后应该在 jsEngine 上调用的函数：

- (void) onTimeout
{
  JSValueRef excp = NULL;
  JSObjectCallAsFunction(timeoutCtx, timeoutFunc, NULL, 0, 0, &excp);
  if (excp) {
    JSStringRef exceptionArg = JSValueToStringCopy([self JSContext], excp, NULL);
    NSString* exceptionRes = (__bridge_transfer NSString*)JSStringCopyCFString(kCFAllocatorDefault, exceptionArg);  
    JSStringRelease(exceptionArg);
    NSLog(@"[JSC] JavaScript exception: %@", exceptionRes);
  }
}

用于 javascript 评估的本机函数：

- (NSString *)evaluate:(NSString *)script
{
    if (!script) {
        NSLog(@"[JSC] JS String is empty!");
        return nil;
    }


    JSStringRef scriptJS = JSStringCreateWithUTF8CString([script UTF8String]);
    JSValueRef exception = NULL;

    JSValueRef result = JSEvaluateScript([self JSContext], scriptJS, NULL, NULL, 0, &exception);
    NSString *res = nil;

    if (!result) {
        if (exception) {
            JSStringRef exceptionArg = JSValueToStringCopy([self JSContext], exception, NULL);
            NSString* exceptionRes = (__bridge_transfer NSString*)JSStringCopyCFString(kCFAllocatorDefault, exceptionArg);

            JSStringRelease(exceptionArg);
            NSLog(@"[JSC] JavaScript exception: %@", exceptionRes);
        }

        NSLog(@"[JSC] No result returned");
    } else {
        JSStringRef jstrArg = JSValueToStringCopy([self JSContext], result, NULL);
        res = (__bridge_transfer NSString*)JSStringCopyCFString(kCFAllocatorDefault, jstrArg);

        JSStringRelease(jstrArg);
    }

    JSStringRelease(scriptJS);

    return res;
}

在整个设置之后，JSC 引擎应该评估这个：

[jsEngine evaluate:@"iosSetTimeout(function(){iosLog('timeout done')}, 5000)"];

JS执行调用native _setTimeout，五秒后调用native， onTimeoutcrash发生在JSObjectCallAsFunction. timeoutCtx变为无效。听起来超时函数上下文是本地的，并且在此期间垃圾收集器会在 JSC 端删除该上下文。

有趣的是，如果_setTimeout为了JSObjectCllAsFunction立即调用而更改函数，而不等待超时，那么它会按预期工作。

如何防止在这种异步回调中自动删除上下文？

score 4 · Accepted Answer

我最终setTimeout像这样添加到特定的 JavaScriptCore 上下文中，并且效果很好：

JSVirtualMachine *vm = [[JSVirtualMachine alloc] init];
JSContext *context = [[JSContext alloc] initWithVirtualMachine: vm];

// Add setTimout
context[@"setTimeout"] = ^(JSValue* function, JSValue* timeout) {
    dispatch_after(dispatch_time(DISPATCH_TIME_NOW, (int64_t)([timeout toInt32] * NSEC_PER_MSEC)), dispatch_get_main_queue(), ^{
        [function callWithArguments:@[]];
    });
};

就我而言，这允许我cljs.core.async/timeout在 JavaScriptCore 内部使用。

score 2 · Accepted Answer

对于已注册的 iOS 开发人员，请观看 wwdc 2013 中有关 javascript 核心的新视频，名为“将 JavaScript 集成到本机应用程序中”。您将在那里找到最新 iOS 版本的解决方案。

对于当前的 iOS 版本，我的替代解决方案是在 JSC 中创建一个全局数组，用于存储应该受到垃圾收集器保护的对象。因此，您可以在不再需要时控制从数组中弹出变量。

score 2 · Accepted Answer

不要挂在一个 JSContextRefs 上，除了你用 JSGlobalContextCreate 创建的那个

具体来说，这很糟糕：

jsEngine.timeoutCtx =  ctx;
....
JSObjectCallAsFunction(timeoutCtx

不要保存 ctx，而是将全局上下文传递给 JSObjectCallAsFunction。

你必须 JSValueProtect 任何你想保留的值比你的回调更长

JavaScriptCore 垃圾收集器可以在您调用 JavaScriptCore 函数的任何时候运行。在您的示例中，作为 setTimeout 的单个参数创建的匿名函数没有被 JavaScript 中的任何内容引用，这意味着它可以在 setTimeout 调用完成后的任何时间点被垃圾收集。因此 setTimeout 必须通过 JSValueProtect 函数告诉 JavaScriptCore 不要收集它。在使用 JSObjectCallAsFunction 调用该函数后，您应该使用 JSValueUnprotect 它，否则该匿名函数将在内存中徘徊，直到全局上下文被破坏。

奖励：如果您不想从函数返回任何内容，通常应该返回 JSValueMakeUndefined(ctx)

JSValueMakeNull(ctx) 与未定义不同。我的一般规则是，如果我在 Objective-C 中返回 void，则返回 JSValueMakeUndefined；如果我返回 nil 对象，则返回 JSValueMakeNull。但是，如果您想像 window 对象一样实现 setTimeout，则它需要返回一个 ID/句柄，可以将其传递给 clearTimeout 以取消计时器。

score 2 · Accepted Answer

我已经实现setTimout，setInterval并clearTimeout在 Swift 上解决了这个问题。通常，示例仅显示setTimeout没有使用选项的函数clearTimeout。如果您正在使用 JS 依赖项，那么您很有可能也需要clearTimeoutandsetInterval函数。

import Foundation
import JavaScriptCore

let timerJSSharedInstance = TimerJS()

@objc protocol TimerJSExport : JSExport {

    func setTimeout(_ callback : JSValue,_ ms : Double) -> String

    func clearTimeout(_ identifier: String)

    func setInterval(_ callback : JSValue,_ ms : Double) -> String

}

// Custom class must inherit from `NSObject`
@objc class TimerJS: NSObject, TimerJSExport {
    var timers = [String: Timer]()

    static func registerInto(jsContext: JSContext, forKeyedSubscript: String = "timerJS") {
        jsContext.setObject(timerJSSharedInstance,
                            forKeyedSubscript: forKeyedSubscript as (NSCopying & NSObjectProtocol))
        jsContext.evaluateScript(
            "function setTimeout(callback, ms) {" +
            "    return timerJS.setTimeout(callback, ms)" +
            "}" +
            "function clearTimeout(indentifier) {" +
            "    timerJS.clearTimeout(indentifier)" +
            "}" +
            "function setInterval(callback, ms) {" +
            "    return timerJS.setInterval(callback, ms)" +
            "}"
        )       
    }

    func clearTimeout(_ identifier: String) {
        let timer = timers.removeValue(forKey: identifier)

        timer?.invalidate()
    }


    func setInterval(_ callback: JSValue,_ ms: Double) -> String {
        return createTimer(callback: callback, ms: ms, repeats: true)
    }

    func setTimeout(_ callback: JSValue, _ ms: Double) -> String {
        return createTimer(callback: callback, ms: ms , repeats: false)
    }

    func createTimer(callback: JSValue, ms: Double, repeats : Bool) -> String {
        let timeInterval  = ms/1000.0

        let uuid = NSUUID().uuidString

        // make sure that we are queueing it all in the same executable queue...
        // JS calls are getting lost if the queue is not specified... that's what we believe... ;)
        DispatchQueue.main.async(execute: {
            let timer = Timer.scheduledTimer(timeInterval: timeInterval,
                                             target: self,
                                             selector: #selector(self.callJsCallback),
                                             userInfo: callback,
                                             repeats: repeats)
            self.timers[uuid] = timer
        })


        return uuid
    }

使用示例：

jsContext = JSContext()
TimerJS.registerInto(jsContext: jsContext)

我希望这会有所帮助。:)

score 1 · Accepted Answer

基于@ninjudd的回答，这是我在swift中所做的

    let setTimeout: @objc_block (JSValue, Int) -> Void = {
        [weak self] (cb, wait) in

        let callback = cb as JSValue

        dispatch_after(dispatch_time(DISPATCH_TIME_NOW, Int64(UInt64(wait) * NSEC_PER_MSEC)), dispatch_get_main_queue(), { () -> Void in
            callback.callWithArguments([])
        })
    }
    context.setObject(unsafeBitCast(setTimeout, AnyObject.self), forKeyedSubscript: "setTimeout")

score 0 · Accepted Answer

这是我的两分钱。

我认为没有必要在_setTimeout. 您可以利用全局上下文稍后调用计时器函数。

您JSValueProtect应该jsEngine.timeoutFunc在_setTimeout. 否则它可能会变成无效的引用并在以后导致崩溃。

javascript - iOS 用 Ja​​vascriptCore 实现“window.setTimeout”

6 回答 6

不要挂在一个 JSContextRefs 上，除了你用 JSGlobalContextCreate 创建的那个

你必须 JSValueProtect 任何你想保留的值比你的回调更长

奖励：如果您不想从函数返回任何内容，通常应该返回 JSValueMakeUndefined(ctx)

Related

Reference

javascript - iOS 用 JavascriptCore 实现“window.setTimeout”