Objective-C “私有”的命名约定是什么？方法？

Question

继承其他开发人员的代码使我坚信通过类扩展的方式将尽可能多的消息保留在类的公共接口之外。我还坚信对类的私有、特定于实现的成员采用特殊的命名约定。我真的很喜欢能够一眼看出正在发送的消息以及在实现上下文中引用的哪些成员不适合公共使用，反之亦然。如果不出意外的话，它使我更容易更快地掌握类的整体语义，这是值得的。

撇开理由不谈，我已经编写了大量带有私有方法²的类，但我从未真正想出一种我真正喜欢的命名模式（就像我为有争议的 ivar_ 约定所做的那样）伊瓦尔）。值得注意的例子：

@interface myClass()

// I like this, but as we all know, Apple has dibs on this one, 
// and method name collisions are nasty.
- (void)_myPrivateMessage;

// The suffix version promoted by Google for ivars doesn't really translate
// well to method names in Objective-C, because of the way the method
// signature can be broken into several parts.
- (void)doWork_; // That's okay...
- (void)doWork_:(id)work with_:(id)something; // That's just ugly and tedious...
- (void)doWork_:(id)work with_:(id)something and_:(id)another; // My eyes...

// This version is suggested by Apple, and has the benefit of being officially 
// recommended. Alas, I don't like it: The capital letter is ugly. I don't like 
// underscores in the middle of the name. Worst of all, I have to type three characters 
// before code-sense does anything more useful than inform me that I am typing.
- (void)BF_doWork;

@end

此时，我可以通过多种不同的方式来破坏我的私有方法名称，但我认为我不会编造一些东西，而是首先对我可能不知道的任何流行约定进行民意调查。那么，你用过什么？

Answer 1

我不通过名称来区分私有方法。相反，我通过在 .m 文件的类扩展部分中声明它们来将它们排除在公共接口之外，因此：

@interface MyClass ()
- (void)doWork;
@end

Answer 2

我对我的私有方法使用双下划线：

- (void)__doSomethingPrivate;

它几乎看起来像单下划线语法（可读性好），同时确认了 Apple 指南。

Answer 3

我使用前缀，没有下划线。前缀通常与相关项目的名称相关。如果您确实使用下划线，则无需使用多个下划线。

Answer 4

我使用两个级别的私有方法：轻微私有和非常私有。轻微私有方法是可以变为公开的方法，但目前还没有。它们通常是我在内部使用的便捷方法，除非我决定将其公开，否则我通常不会提供太多的保护。对于非常私有的方法，我忽略 apple 并使用下划线前缀。由于 99% 的代码都在我创建的类中，并且我的类名通常有前缀，因此遇到命名问题的可能性很小。当向我没有创建的类添加代码时，我很少创建私有方法，但在极少数情况下会添加一个短前缀。

Answer 5

我在私有方法前加上“p”前缀：

• (void) pDoWork;
• (void) pDoWork:(id) 与:(id) 一起工作；

同样，我使用 's' 表示静态（或类）方法：

• (Universe*)sGet; // 用于返回单例 Universe 对象。

除了命名约定之外，我还在 .m 文件而不是 .h 文件中声明私有方法。

Answer 6

使用固定前缀将有助于从外界“隐藏”该方法，但它不会阻止方法被意外覆盖。例如，我曾经扩展了一个类并创建了一个方法：

- (void)private_close
{
    // ...
}

结果是该类的行为以可怕的方式破坏了。 但是为什么？事实证明，超类也有一个方法名称private_close，并且我不小心重写了它而没有调用super！我怎么知道？没有编译器警告！

无论您的前缀是 _ 或 __ 或 p 或 private_，如果它始终相同，那么您最终会遇到这样的问题。

因此，我使用类似于类名的前缀为私有方法（和属性！）添加前缀。因此，我采用类名的大写字母来形成“私有前缀”：

• ComplexFileParser -> CFP
• URLDownloadTask -> URLDT
• SessionController -> SC

这仍然不是完全安全的，但具有不同名称的子类不太可能具有相同的私有前缀。

另外，当您创建框架时，您应该为所有类和其他符号添加框架前缀（就像 Apple 的 NS...、CF...、一样CA...、SC...、UI... 等），因此该类前缀也是私有前缀的一部分冲突的可能性更小：

• Framework DecodingUtils.framework -> DU
  • 框架中的类ComplexFileDecoder -> DUComplexFileDecoder
    • 私人前缀 -> DUCFD
      • 私有方法关闭 -> - (void)DUCFD_close

或者在第一个方法参数名称的末尾附加前缀，以获得更好的自动完成功能：

- (void)doSomethingWith:(Type1)var1 parameters:(Type2)var2

将成为

- (void)doSomethingWith_DUCFD:(Type1)var1 parameters:(Type2)var2

或始终仅将其附加到最后一个参数名称：

- (void)doSomethingWith:(Type1)var1 parameters_DUCFD:(Type2)var2

或（现在它变得非常疯狂） - 添加一个假虚拟参数只是为了命名：

- (void)doSomethingWith:(Type1)var1 parameters:(Type2)var2 DUCFD:(id)x

其中 x 实际上从未在方法中使用，并且您为它传递 nil ：

[self doSomethingWith:var1 parameters:var2 DUCFD:nil];

并且它将永远如此最后，使用预处理器宏：

#define priv DUCFD:nil
#define PRIVATE DUCFD:nil

// ...

[self doSomethingWith:var1 parameters:var2 priv];
[self doSomethingWith:var1 parameters:var2 PRIVATE];

前缀和后缀也适用于属性（以及它们的 ivar、getter/setter 方法），当然，上面的预处理器技巧不会。

Answer 7

关于苹果的建议。您可能对 Apple 如何编写自己的代码感兴趣。

如果你检查私有 API，你会发现它们到处都使用下划线表示私有方法。 iOS 中的所有 Obj-C 代码都使用它们。在许多情况下，这些方法会经历多个 iOS 版本而无需重构或重命名，这意味着这不是它们的临时解决方案，而是一种约定。事实上，他们广泛使用了三个级别的私有方法——无下划线、单下划线和双下划线。

至于其他解决方案，例如“私有”、类或项目名称前缀 - 他们根本不使用它们。只是下划线。