在 Objective-c 中定义常量

Question

我想在 Objective-C 中定义一个常量。

以前我有以下函数：

+(NSString *) getDocumentsDir {
    NSArray *paths = NSSearchPathForDirectoriesInDomains(NSDocumentDirectory , NSUserDomainMask, YES);
    NSString *documentsDir = [paths objectAtIndex: 0];
    paths = nil;
    return documentsDir;
}

我只想定义一个常量“Documents_Dir”一次 - 当函数被调用时以及之后访问先前创建的值。

我已经尝试过以下代码，但不起作用：

#define getDocumentsDir \
{   \
#ifdef Documents_Dir    \
return Documents_Dir;   \
#else   \
NSArray *paths = NSSearchPathForDirectoriesInDomains(NSDocumentDirectory , NSUserDomainMask, YES);  \
NSString *documentsDir = [paths objectAtIndex: 0];  \
#define Documents_Dir [paths objectAtIndex: 0]; \
paths = nil;    \
return Documents_Dir;   \
#endif  \
}   \

我对预编译器指令不强，因此任何帮助将不胜感激。

Answer 1

前奏：了解预编译器指令和真实常量之间的区别是值得的。 #define 只是在编译器构建代码之前进行文本替换。 这对于数值常量和 typedef 非常有用，但对于函数或方法调用来说并不总是最好的主意。 我的操作假设您确实想要一个真正的常量，这意味着创建搜索路径的代码应该只执行一次。

---

在 MyClass.m 文件中，定义变量并在 +initialize 方法中填充它，如下所示：

static NSArray *documentsDir;

@implementation MyClass

+ (void) initialize {
    if (documentsDir == nil) {
        documentsDir = [[NSSearchPathForDirectoriesInDomains(NSDocumentDirectory , NSUserDomainMask, YES) lastObject] retain];
    }
}

...

@end

static 修饰符使其仅在声明它的编译单元内可见。 对于一个简单的常量，这就是您所需要的。

如果该类有子类，+initialize 将为每个子类调用一次（默认情况下），因此您需要检查 documentsDir 是否为 nil 在分配给它之前，这样就不会泄漏内存。 （或者，正如 Peter Lewis 指出的那样，您可以使用 == 或 -isMemberOfClass: 方法。）如果子类也需要直接访问常量，则需要在 MyClass.h 文件中将变量预先声明为 extern（该文件是子类包括）：

extern NSArray *documentsDir;

@interface MyClass : NSObject
...
@end

如果您将变量预先声明为 extern，则必须从定义中删除 static 关键字以避免编译错误。 这是必要的，以便变量可以跨越多个编译单元。 （啊，C 的乐趣...）

注意： 在 Objective-C 代码中，将某些内容声明为 extern 的更好方法是使用 OBJC_EXPORT（在 中声明的 #define），根据您是否正在使用C++。 只需将 extern 替换为 OBJC_EXPORT 即可。

---

编辑：我刚刚偶然发现一个相关的SO问题。

Answer 2

最简单的解决方案是将路径更改为静态变量并仅对其求值一次，如下所示：

+(NSString *) getDocumentsDir {
    static NSString *documentsDir = nil;
    if ( !documentsDir ) {
        NSArray *paths = NSSearchPathForDirectoriesInDomains(NSDocumentDirectory , NSUserDomainMask, YES);
        documentsDir = [paths objectAtIndex: 0];
    }
    return documentsDir;
}

“static”告诉编译器，documentDir 实际上是一个全局变量，尽管只能在函数内访问。 因此它被初始化为 nil，并且第一次调用 getDocumentsDir 将对其求值，然后进一步的调用将返回预先求值的值。

Answer 3

关于 Peter N Lewis 代码的小优化：

-(NSString *) documentsDir {
    static NSString *documentsDir = nil;
    return documentsDir ?: (documentsDir = [NSSearchPathForDirectoriesInDomains(NSDocumentDirectory, NSUserDomainMask, YES) lastObject]);
}