如何修复此 clang 警告：“将具有“0 保留计数的对象返回给调用者，其中需要 1（拥有）保留计数””？

Question

我有一段 Objective-C 代码，如下所示：

- (NSString *)copyData:(NSData *)data
{
    NSString *path = [[[self outputDirectory] stringByAppendingPathComponent:@"archive"] stringByAppendingPathExtension:@"zip"];
    NSLog(@"Copying data to %@", path);
    [data writeToFile:path atomically:NO];
    return path;
}

该代码是从如下所示的初始化程序调用的：

- (id)initWithData:(NSData *)data
{
    if ((self = [super init]) != nil) {
        NSString *path = [self copyData:data];        // Line 41 (referenced in warning, shown below)
        return [self initWithContentsOfFile:path];
    }
    return self;
}

当运行 clang 静态分析器时，我收到以下关于 path 变量的警告:

第 41 行分配并存储到“path”中的对象的潜在泄漏

将 +0 保留计数的对象返回给调用者，其中期望 +1（拥有）保留计数

我很困惑。我的理解是，stringByAppendingPathComponent 应该返回一个自动释放的字符串，因此它应该的净保留计数为0。（显然我不想要保留它。）

我尝试更改 copyData: 以返回以下内容，但它没有消除警告：

return [[path retain] autorelease];

那么这个警告是怎么回事？

Answer 1

我怀疑它只是注意到一个带有前缀 copy 的方法，并将其标记为应该返回调用者拥有的东西，因为它认为它遵循 Cocoa 命名约定。

当然，就您而言，您指的是文件之类的东西，因此这是一个可以忽略的警告。如果您将方法的名称更改为 saveData: 之类的名称，我敢打赌警告将会消失。

Answer 2

另外，当你确实想用“copy”或其他东西来命名一个方法时，因为无论 Cocoa 内存管理指南如何，copy 是该方法的最佳名称，你可以使用 NS_RETURNS_NOT_RETAINED 然后 Clang 不会给你警告。所以：

// Copies data from data to string; does not follow the copy rule
- (NSString*)copyData:(NSData*)data NS_RETURNS_NOT_RETAINED;

Answer 3

由于该方法的名称为 copy，根据 内存管理指南。

Answer 4

不，这是不正确的；除非该方法包含“alloc”、“copy”、“new”或暗示该对象将由调用者拥有的其他关键字之一，否则该方法返回一个自动释放或其他托管对象，因此 stringByAppendingPathComponent 返回一个自动释放的字符串。

最重要的是，您的方法“copyData”包含单词“copy”，这意味着结果应该由调用者拥有（并释放）。但是，您返回的结果已自动发布，因此它会向您显示错误消息。如果您想修复错误，请不要自动释放。那就是：

 return [path retain]

当然，这意味着函数的调用者需要释放它。或者，您可以更改函数的名称，以使其符合内存管理准则。

恕我直言，“copyData”这个名字无论如何都是不直观的。我建议您将函数重命名为“pathToSavedDataWithData”或类似名称。说出它实际上在做什么的东西。

Answer 5

我将对此进行尝试，并猜测无论您的例程名称是否以“copy ...”开头，您都会收到完全相同的错误消息。我刚刚遇到了类似的情况，并且“复制”不是我所调用的例程名称的一部分。 Clang 给出错误消息只是因为我返回了一个自动释放的对象，这是一种危险的情况。 做这个技巧就解决了这个问题。

  return [path retain]  

最后按照迈克尔的建议