objective-c - CF_RETURNS_RETAINED 或 CF_RETURNS_NOT_RETAINED : which to use when?

Question

我不确定对于返回 CFDataProviderRef 的自定义函数是使用 CF_RETURNS_RETAINED 还是 CF_RETURNS_NOT_RETAINED。

根据 the documentation at the location where the macros are defined ，两者都应该只在特殊情况下使用，正确的修复应该是修复我的命名约定。但是 swift/objective-c 文档 suggests using它们注释任何返回 CoreFoundation 指针的函数，而没有真正解释何时使用哪个 --- 如果我不注释它们，我需要每次在 swift 代码中手动指定行为。

我能找到的更多文档解释了如何使用 +1 的 ARC 值和 0 的另一个 ARC 值，但恐怕这对我的理解没有多大帮助。

我的问题:

1. 我应该使用它们，还是按照 Base.h 的建议改进我的命名？
2. 那里使用的确切命名约定是什么？
3. 如果我希望返回对象使用的内存一超出调用者的范围就释放它，我应该使用一个，如果我不希望这种情况发生，我是否正确地假设我应该使用另一个(因为我在其他地方使用指向它的指针，或者自己清理)？
4. 我的函数所做的只是返回一个 CFDataProviderRef，这是我通过调用 CGDataProviderCreateSequential 获得的。我想这意味着我想要 CGDataProviderCreateSequential 的行为(对吗？)。我如何才能找到该函数是使用 CF_RETURNS_RETAINED 还是 CF_RETURNS_NOT_RETAINED(它不在 CGDataProvider.h 文件中)？

Answer 1

这一切都与所有权有关。命名约定是 Core Foundation 的命名约定，描述为 here . Create Rule 表示名称中带有“Create”和“Copy”的函数让调用者拥有返回对象的所有权(尽管不一定唯一所有权)。这意味着调用者有责任使用 CFRelease() 最终释放返回的对象。 . Get 规则指出，创建或复制函数以外的函数不会向调用者提供对象的所有权，因此调用者不得调用 CFRelease()。在它上面(当然，除了平衡对 CFRetain() 的任何显式调用)。

如果一个函数在语义上是一个创建或复制函数，将所有权返回给调用者，但它的名字没有表明这一点，你应该使用 CF_RETURNS_RETAINED表明。类似地，如果一个函数的名称包含“Create”或“Copy”但它没有与 Create 规则匹配的语义，您应该使用 CF_RETURNS_NOT_RETAINED表明。 (尽量避免这种情况。)

由于您的代码正在调用 CGDataProviderCreateSequential()由于名称中有“Create”，您的代码负责释放返回的 CGDataProvider目的。如果您在函数中就在那里释放它，那么您的调用者将无法访问它。您想要将对象返回给调用者。您还希望将释放对象的责任传递给调用者，因为您不知道调用者何时会用完它。因此，您应该在函数名称中使用“Create”来命名您的函数，以向调用者和自动化系统表明调用者负责释放对象。或者，您可以使用 CF_RETURNS_RETAINED 注释您的函数来表示这一点，但遵循命名约定更好。

Swift 可能只遵守系统头文件的命名约定。我不知道。在这种情况下，您必须使用 CF_RETURNS_RETAINED 进行注释即使您的函数名称中包含“Create”。注释名称已遵循约定的函数没有任何坏处。这是多余但无害的。