Eine Konstante in objective-c definieren

Question

Ich möchte eine Konstante in objective-c definieren.

Vorher hatte ich die folgende Funktion:

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

Ich mag würde nur einmal eine Konstante „Documents_Dir“ definieren - wenn die Funktion und danach aufgerufen wird, um ein zuvor erstelltes Wert zuzugreifen.

Ich habe den folgenden Code versucht, die nicht funktioniert hat:

#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 \ 
} \ 

Ich bin nicht stark mit Precompiler-Richtlinien, so wird jede Hilfe dankbar.

Answer 1

Vorwort: Es lohnt sich, den Unterschied zwischen Precompiler-Direktiven und wahren Konstanten zu verstehen. A #define führt nur eine Textersetzung durch, bevor der Compiler den Code erstellt. Dies funktioniert hervorragend für numerische Konstanten und typedefs, ist aber nicht immer die beste Idee für Funktions- oder Methodenaufrufe. Ich gehe davon aus, dass Sie wirklich eine echte Konstante haben wollen, dh der Code zum Erstellen des Suchpfades sollte nur einmal ausgeführt werden.

---

In Ihrer MyClass.m Datei, definieren Sie die Variable und füllt es in einer +initialize Methode wie folgt:

static NSArray *documentsDir; 

@implementation MyClass 

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

... 

@end 

Der static Modifikator macht es sichtbar nur in der Zusammenstellung Einheit, wo es erklärt wird. Für eine einfache Konstante ist das alles, was Sie brauchen.

Wenn die Klasse Unterklassen hat, wird +initialize für jede Unterklasse einmal aufgerufen werden (Standardeinstellung), so dass Sie überprüfen wollen werden, ob documentsDir ist nil vor ihm zuweisen, so dass Sie nicht Speicher dicht sind. (Oder, wie Peter Lewis hervorhebt, können Sie überprüfen, ob die gerade initialisierte Klasse die MyClass ist, entweder == oder die -isMemberOfClass:-Methode.) Wenn die Unterklassen auch direkt auf die Konstante zugreifen müssen, müssen Sie sie vorher deklarieren die Variable als extern in MyClass.h-Datei (die die untergeordneten Klassen enthalten):

extern NSArray *documentsDir; 

@interface MyClass : NSObject 
... 
@end 

Wenn Sie die Variable als extern vorge deklarieren, müssen Sie entfernen Sie das static Schlüsselwort aus der Definition der Kompilierung zu vermeiden Fehler. Dies ist notwendig, damit die Variable mehrere Übersetzungseinheiten umfassen kann. (Ah, die Freuden des C ...)

Hinweis: In Objective-C-Code, der bessere Weg etwas wie extern zu erklären ist OBJC_EXPORT zu verwenden (a #define in <objc/objc-api.h> erklärt), die gesetzt basiert ob du C++ benutzt oder nicht. Ersetzen Sie einfach extern durch OBJC_EXPORT und Sie sind fertig.

---

Edit: ich zufällig auf einem related SO question.

Answer 2

Die einfachste Lösung ist nur Pfade zu ändern, um eine statische Variable zu sein und evalutate es nur einmal, wie folgt aus:

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

Die „statische“ weist den Compiler an, die documentsDir effektiv eine globale Variable, obwohl nur zugänglich innerhalb der Funktion. Daher wird es auf null initialisiert, und der erste Aufruf von getDocumentsDir wird es evaluieren, und dann geben weitere Aufrufe den vorvalidierten Wert zurück.

Answer 3

Kleine Optimierung in Bezug auf Peter N Lewis Code:

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