将 NSOperation 子类化为并发且可取消

Question

我无法找到有关如何将 NSOperation 子类化以实现并发并支持取消的良好文档。我阅读了苹果文档，但找不到“官方”示例。

这是我的源代码：

@synthesize isExecuting = _isExecuting;
@synthesize isFinished = _isFinished;
@synthesize isCancelled = _isCancelled;

- (BOOL)isConcurrent
{
    return YES;
}

- (void)start
{
/* WHY SHOULD I PUT THIS ?
    if (![NSThread isMainThread])
    {
        [self performSelectorOnMainThread:@selector(start) withObject:nil waitUntilDone:NO];
        return;
    }
*/

    [self willChangeValueForKey:@"isExecuting"];
    _isExecuting = YES;
    [self didChangeValueForKey:@"isExecuting"];


    if (_isCancelled == YES)
    {
        NSLog(@"** OPERATION CANCELED **");
    }
    else
    {
        NSLog(@"Operation started.");
        sleep(1);
        [self finish];
    }
}

- (void)finish
{
    NSLog(@"operationfinished.");

    [self willChangeValueForKey:@"isExecuting"];
    [self willChangeValueForKey:@"isFinished"];

    _isExecuting = NO;
    _isFinished = YES;

    [self didChangeValueForKey:@"isExecuting"];
    [self didChangeValueForKey:@"isFinished"];

    if (_isCancelled == YES)
    {
        NSLog(@"** OPERATION CANCELED **");
    }
}

在我发现的示例中，我不明白为什么使用performSelectorOnMainThread:。它会阻止我的操作同时运行。

另外，当我注释掉该行时，我的操作会同时运行。但是，即使我已调用 cancelAllOperations，isCancelled 标志也不会被修改。

Answer 1

好的，据我了解，您有两个问题：

1. 您是否需要代码注释中出现的 performSelectorOnMainThread: 段？该代码的作用是什么？

2. 当您在包含此操作的 NSOperationQueue 上调用 cancelAllOperations 时，为什么 _isCancelled 标志未修改？

让我们按顺序处理这些。为了便于解释，我假设您的 NSOperation 子类名为 MyOperation。我会解释你的误解，然后给出一个正确的例子。

1. 同时运行 NSOperations

大多数时候，您会将 NSOperation 与 NSOperationQueue 结合使用，从您的代码来看，这听起来像是您正在做的事情。在这种情况下，您的 MyOperation 将始终在后台线程上运行，无论 -(BOOL)isConcurrent 方法返回什么，因为 NSOperationQueue被明确设计为在后台运行操作。

因此，您通常不需要重写 -[NSOperation start] 方法，因为默认情况下它只是调用 -main 方法。这是您应该重写的方法。默认的 -start 方法已在适当的时间为您处理设置 isExecuting 和 isFinished。

因此，如果您希望 NSOperation 在后台运行，只需覆盖 -main 方法并将其放入 NSOperationQueue 中即可。

代码中的 performSelectorOnMainThread: 会导致 MyOperation 的每个实例始终在主线程上执行其任务。由于一个线程上一次只能运行一段代码，这意味着不能运行其他 MyOperation。 NSOperation 和 NSOperationQueue 的全部目的是在后台执行某些操作。

唯一一次你想要将事情强制到主线程上是当你更新用户界面时。如果您需要在 MyOperation 完成时更新 UI，那么您应该使用 performSelectorOnMainThread:。我将在下面的示例中展示如何做到这一点。

2. 取消 NSOperation

-[NSOperationQueue cancelAllOperations] 会调用 -[NSOperation cancel] 方法，这会导致后续调用 -[NSOperation isCancelled]返回YES。 但是，您做了两件事使其无效。

1. 您正在使用@synthesize isCancelled来覆盖NSOperation的-isCancelled方法。没有理由这样做。 NSOperation 已经以完全可接受的方式实现了 -isCancelled。

2. 您正在检查自己的_isCancelled实例变量以确定操作是否已被取消。 NSOperation 保证如果操作已被取消，[self isCancelled] 将返回 YES。它不保证您的自定义 setter 方法将被调用，也不保证您自己的实例变量是最新的。您应该检查[self isCancelled]

您应该做什么

标题：

// MyOperation.h
@interface MyOperation : NSOperation {
}
@end

和实现：

// MyOperation.m
@implementation MyOperation

- (void)main {
    if ([self isCancelled]) {
        NSLog(@"** operation cancelled **");
    }

    // Do some work here
    NSLog(@"Working... working....")

    if ([self isCancelled]) {
        NSLog(@"** operation cancelled **");
    }
    // Do any clean-up work here...

    // If you need to update some UI when the operation is complete, do this:
    [self performSelectorOnMainThread:@selector(updateButton) withObject:nil waitUntilDone:NO];

    NSLog(@"Operation finished");
}

- (void)updateButton {
    // Update the button here
}
@end

请注意，您不需要对 isExecuting、isCancelled 执行任何操作 或 isFinished。这些都是自动为您处理的。只需重写 -main 方法即可。就是这么简单。

（注意：从技术上讲，这不是“并发”NSOperation，因为 -[MyOperation isConcurrent] 在实现时会返回 NO但是，它将在后台线程上运行。isConcurrent 方法确实应该命名为-willCreateOwnThread，因为这是一个更准确的名称。该方法意图的描述。）

Answer 2

@BJHomer 的出色答案值得更新。

并发操作应该重写 start 方法而不是 main。

正如 Apple 文档中所述：

如果您正在创建并发操作，您至少需要重写以下方法和属性：

• start
• asynchronous
• executing
• finished

A正确的实现还需要覆盖cancel。使子类线程安全并获得正确的所需语义也相当棘手。

因此，我将一个完整且工作的子类作为 在代码审查中用 Swift 实现的提案。欢迎提出意见和建议。

该类可以轻松用作自定义操作类的基类。

Answer 3

我知道这是一个老问题，但我最近一直在调查这个问题，遇到了同样的例子，也有同样的疑问。

如果您的所有工作都可以在 main 方法内同步运行，则不需要并发操作，也不需要覆盖 start，只需完成您的工作并在完成后从 main 返回。

但是，如果您的工作负载本质上是异步的 - 即加载 NSURLConnection，则必须子类化 start。当您的 start 方法返回时，操作尚未完成。仅当您手动向 isFinished 和 isExecuting 标志发送 KVO 通知时（例如，一旦异步 URL 加载完成或失败），NSOperationQueue 才会认为已完成。

最后，当您要启动的异步工作负载需要在主线程上进行运行循环侦听时，您可能希望将启动分派到主线程。由于工作本身是异步的，因此它不会限制并发性，但在工作线程中启动工作可能没有准备好适当的运行循环。

Answer 4

看一下 ASIHTTPRequest。它是一个 HTTP 包装类，作为子类构建在 NSOperation 之上，并且似乎实现了这些。请注意，截至 2011 年中期，开发人员建议不要在新项目中使用 ASI。

Answer 5

关于在 NSOperation 子类中定义“cancelled”属性（或定义“_cancelled”iVAR），通常这是不必要的。仅仅是因为当 USER 触发取消时，自定义代码应始终通知 KVO 观察者您的操作现在已完成。换句话说，isCancelled =>

特别是，当 NSOperation 对象依赖于其他操作对象的完成时，它会监视这些对象的 isFinished 键路径。因此，未能生成完成通知（发生取消情况）可能会阻止应用程序中其他操作的执行。

---

顺便说一句，@BJ Homer 的回答：“isConcurrent 方法确实应该命名为 -willCreateOwnThread”，很有道理！

因为如果你不重写start-method，只需手动调用NSOperation-Object的default-start-method，调用线程本身默认是同步的；所以，NSOperation-Object只是一个非并发操作。

但是，如果您确实重写了启动方法，在启动方法实现中，自定义代码应该生成一个单独的线程...等等，那么您就成功地打破了“调用线程默认是同步的”的限制，因此，使 NSOperation-Object 成为并发操作，之后可以异步运行。

Answer 6

此博客文章：

http://www.dribin.org/ dave/blog/archives/2009/09/13/snowy_concurrent_operations/

解释了为什么您可能需要：

if (![NSThread isMainThread])
{
    [self performSelectorOnMainThread:@selector(start) withObject:nil waitUntilDone:NO];
    return;
}

在您的 start 方法中。