如何使用来自 ObjC 类的 std::function 回调在 C++ 中进行异步工作？

Question

大图

我有一个 C++ 库，它可以执行包括网络在内的异步工作。它有一个特定于达尔文的后端，它使用 Grand Central Dispatch 的 C API 将工作委托给其他线程。现在我想通过一个薄薄的 ObjC++ 层从一个用 Swift 编写的新 iOS 应用程序中使用该库。

我在 OS X 10.10 上使用 Xcode 6.3.2。

---

在这个最小的示例中，我重新创建了上述架构。问题是当操作通过 std::function 回调返回时，启动异步操作的 ObjC 类实例以某种方式“损坏”。只有当 std::function 被声明为 [&] 而不是 [=] 时才会发生这种情况。我不能使用后者，因为“真正的”C++ 代码不支持它。

调用 ObjC++ 的 Swift 代码如下所示：

class MyViewController : UIViewController {
    var test = ObjectiveTest()

    override func viewDidAppear(animated: Bool) {
        test.testAsyncWork("some data", withHandler: { (result: Int32) -> Void in
            println("Work result: \(result)")
        })
    }
}

如果我注释掉该代码，视图控制器会显示并保持可见，因此它不应该杀死 ObjectiveTest 实例。那就是 ObjC++ 粘合层：

@interface ObjectiveTest () {
    __block Test *test;
    __block int _a;
}
@end

@implementation ObjectiveTest
- (id)init
{
    self = [super init];
    if (self) {
        test = new Test();
        _a = 42;
        if (!test)
            self = nil;
    }
    return self;
}

- (void)deinit
{
    delete test;
}

- (void)testAsyncWork:(NSString *)someData withHandler:(WorkBlock)handler
{
    _a++;
    NSLog(@"_a = %i", _a); // valid
    NSLog(@"handler = %@", handler); // valid
    test->testAsyncWork(someData.UTF8String, [&](int result) {
        _a++;
        NSLog(@"result = %i", result); // Expected: "result = 666" - valid
        NSLog(@"_a = %i", _a); // Expected: "_a = 44" - invalid
        NSLog(@"handler = %@", handler); // invalid, crashes here
    });
}
@end

最后，完成“工作”的 C++ 方法：

void Test::testAsyncWork(std::string someData, std::function<Handler> handler) {
    dispatch_async(dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_DEFAULT, 0), ^{
        printf("Data received: %s, calling handler on other thread\n", someData.c_str());
        sleep(1); // This is hard work!

        dispatch_async(dispatch_get_main_queue(), ^{
            printf("Hello, main thread here, calling back now!\n");
            handler(666); // into ObjectiveTest
        });
    });
}

观察

正如我所说，如果我将 [=] 用于 std::function，这不会中断。

ObjectiveTest 的 ivar _a 似乎在回调函数中具有随机值，尽管它是用 __block 声明的。程序在尝试访问（打印/调用）块handler 时崩溃，该块回调到 Swift 代码中。 Xcode 显示如下：

handler WorkBlock & error: summary string parsing error 0xbffa50cc
&handler    __block_literal_generic *   0x7c000000  0x0ae08500
__isa   void *  NULL    0x00000000
__flags int 0   0
__reserved  int 2080876705  2080876705
__FuncPtr   void (*)(int)   0x7c000000  0x7c000000
__descriptor    __block_descriptor *    0x7c085b10  0x7c085b10

由此，我得到的印象是 ObjectiveTest 实例在过程中的某个地方中断了，但由于它保存在 MyViewController 中，我看不出这是怎么发生的。我可能错过了其他东西吗？

Answer 1

[&] 通过引用捕获变量。如果原始变量在任务完成之前过期，则捕获的引用将悬空。

由于异步调用可能旨在异步完成¹，因此您基本上可以保证悬空引用。

进行异步调用时，您几乎总是希望按值捕获。您甚至可能想要明确地列出您正在捕获的内容，以便了解您引入的依赖项。 （多线程代码足够难，没有隐藏/隐式依赖）

[&] 捕获的唯一有效用途是创建“访问者”类型的对象以传递给将使用 lambda 的函数，然后在返回之前丢弃它及其所有副本。除了你应该通过价值来捕捉之外的任何东西，或者非常仔细地挑选你通过引用捕捉到的东西，并证明涵盖了生命周期的问题。

---

¹ 可能想要[&] 的异步方法的一个示例是“在 UI 泵线程上运行”异步调用，您希望在其中让工作线程暂停进度，直到结果出现从 UI 线程返回。在那里，您将[&]，并在您离开当前范围之前阻止返回的std::future（或等效项）。