Constantes en Objective-C

Estoy desarrollando una aplicación Cocoa , y estoy usando NSStrings constantes como formas de almacenar nombres clave para mis preferencias.

Entiendo que esta es una buena idea porque permite cambiar fácilmente las claves si es necesario.
Además, es toda la noción de 'separar sus datos de su lógica'.

De todos modos, ¿hay una buena manera de definir estas constantes una vez para toda la aplicación?

Estoy seguro de que hay una manera fácil e inteligente, pero en este momento mis clases simplemente redefinen las que usan.

Debe crear un archivo de encabezado como

// Constants.h
FOUNDATION_EXPORT NSString *const MyFirstConstant;
FOUNDATION_EXPORT NSString *const MySecondConstant;
//etc.

(puede usar en externlugar de FOUNDATION_EXPORTsi su código no se usará en entornos mixtos C / C ++ o en otras plataformas)

Puede incluir este archivo en cada archivo que use las constantes o en el encabezado precompilado para el proyecto.

Define estas constantes en un archivo .m como

// Constants.m
NSString *const MyFirstConstant = @"FirstConstant";
NSString *const MySecondConstant = @"SecondConstant";

Constants.m debe agregarse al objetivo de su aplicación / marco para que esté vinculado al producto final.

La ventaja de usar constantes de cadena en lugar de constantes #define'd es que puede probar la igualdad usando la comparación de puntero ( stringInstance == MyFirstConstant), que es mucho más rápido que la comparación de cadena ( [stringInstance isEqualToString:MyFirstConstant]) (y más fácil de leer, IMO).

La manera más fácil:

// Prefs.h
#define PREFS_MY_CONSTANT @"prefs_my_constant"

Mejor manera:

// Prefs.h
extern NSString * const PREFS_MY_CONSTANT;

// Prefs.m
NSString * const PREFS_MY_CONSTANT = @"prefs_my_constant";

Una ventaja del segundo es que cambiar el valor de una constante no causa una reconstrucción de todo su programa.

También hay una cosa para mencionar. Si necesita una constante no global, debe usar la staticpalabra clave.

Ejemplo

// In your *.m file
static NSString * const kNSStringConst = @"const value";

Debido a la staticpalabra clave, este const no es visible fuera del archivo.

Corrección menor por @QuinnTaylor : las variables estáticas son visibles dentro de una unidad de compilación . Por lo general, este es un único archivo .m (como en este ejemplo), pero puede morderte si lo declaras en un encabezado que se incluye en otro lugar, ya que obtendrás errores de enlace después de la compilación

La respuesta aceptada (y correcta) dice que "puede incluir este archivo [Constants.h] ... en el encabezado precompilado para el proyecto".

Como novato, tuve dificultades para hacerlo sin más explicaciones: así es cómo: en su archivo YourAppNameHere-Prefix.pch (este es el nombre predeterminado para el encabezado precompilado en Xcode), importe sus Constantes.h dentro del #ifdef __OBJC__bloque .

#ifdef __OBJC__
  #import <UIKit/UIKit.h>
  #import <Foundation/Foundation.h>
  #import "Constants.h"
#endif

También tenga en cuenta que los archivos Constants.h y Constants.m no deben contener absolutamente nada más que lo que se describe en la respuesta aceptada. (Sin interfaz o implementación).

Generalmente estoy usando la forma publicada por Barry Wark y Rahul Gupta.

Aunque, no me gusta repetir las mismas palabras en los archivos .h y .m. Tenga en cuenta que en el siguiente ejemplo la línea es casi idéntica en ambos archivos:

// file.h
extern NSString* const MyConst;

//file.m
NSString* const MyConst = @"Lorem ipsum";

Por lo tanto, lo que me gusta hacer es utilizar alguna maquinaria de preprocesador C. Déjame explicarte a través del ejemplo.

Tengo un archivo de encabezado que define la macro STR_CONST(name, value):

// StringConsts.h
#ifdef SYNTHESIZE_CONSTS
# define STR_CONST(name, value) NSString* const name = @ value
#else
# define STR_CONST(name, value) extern NSString* const name
#endif

En mi par .h / .m donde quiero definir la constante, hago lo siguiente:

// myfile.h
#import <StringConsts.h>

STR_CONST(MyConst, "Lorem Ipsum");
STR_CONST(MyOtherConst, "Hello world");

// myfile.m
#define SYNTHESIZE_CONSTS
#import "myfile.h"

et voila, tengo toda la información sobre las constantes en el archivo .h solamente.

Yo mismo tengo un encabezado dedicado a declarar NSStrings constantes utilizados para preferencias de esta manera:

extern NSString * const PPRememberMusicList;
extern NSString * const PPLoadMusicAtListLoad;
extern NSString * const PPAfterPlayingMusic;
extern NSString * const PPGotoStartupAfterPlaying;

Luego declarándolos en el archivo .m adjunto:

NSString * const PPRememberMusicList = @"Remember Music List";
NSString * const PPLoadMusicAtListLoad = @"Load music when loading list";
NSString * const PPAfterPlayingMusic = @"After playing music";
NSString * const PPGotoStartupAfterPlaying = @"Go to startup pos. after playing";

Este enfoque me ha servido bien.

Editar: tenga en cuenta que esto funciona mejor si las cadenas se utilizan en varios archivos. Si solo lo usa un archivo, puede hacerlo #define kNSStringConstant @"Constant NSString"en el archivo .m que usa la cadena.

Una ligera modificación de la sugerencia de @Krizz, para que funcione correctamente si el archivo de encabezado de constantes se va a incluir en la PCH, lo cual es bastante normal. Dado que el original se importa a la PCH, no lo volverá a cargar en el .marchivo y, por lo tanto, no obtendrá símbolos y el enlazador no está satisfecho.

Sin embargo, la siguiente modificación le permite funcionar. Es un poco complicado, pero funciona.

Necesitará 3 archivos, .harchivo que tiene las definiciones constantes, el .harchivo y el .marchivo, usaré ConstantList.h, Constants.hy Constants.m, respectivamente. los contenidos de Constants.hson simplemente:

// Constants.h
#define STR_CONST(name, value) extern NSString* const name
#include "ConstantList.h"

y el Constants.marchivo se ve así:

// Constants.m
#ifdef STR_CONST
    #undef STR_CONST
#endif
#define STR_CONST(name, value) NSString* const name = @ value
#include "ConstantList.h"

Finalmente, el ConstantList.harchivo tiene las declaraciones reales y eso es todo:

// ConstantList.h
STR_CONST(kMyConstant, "Value");
…

Un par de cosas a anotar:

1. Tuve que redefinir la macro en el .marchivo después de #undef haberla usado para que se usara la macro.

2. También tuve que usar en #includelugar de #importesto para que funcione correctamente y evitar que el compilador vea los valores previamente compilados.

3. Esto requerirá una recompilación de su PCH (y probablemente de todo el proyecto) cada vez que se modifiquen los valores, lo que no es el caso si están separados (y duplicados) como es normal.

Espero que sea útil para alguien.

// Prefs.h
extern NSString * const RAHUL;

// Prefs.m
NSString * const RAHUL = @"rahul";

Como dijo Abizer, puede ponerlo en el archivo PCH. Otra forma que no es tan sucia es hacer un archivo de inclusión para todas sus claves y luego incluirlo en el archivo en el que está utilizando las claves o incluirlo en la PCH. Con ellos en su propio archivo de inclusión, que al menos le brinda un lugar para buscar y definir todas estas constantes.

Si quieres algo como constantes globales; una forma rápida y sucia es colocar las declaraciones constantes en el pcharchivo.

Intenta usar un método de clase:

+(NSString*)theMainTitle
{
    return @"Hello World";
}

Lo uso a veces.

Si le gusta la constante de espacio de nombres, puede aprovechar struct, Friday Q&A 2011-08-19: Constantes y funciones de espacios de nombres

// in the header
extern const struct MANotifyingArrayNotificationsStruct
{
    NSString *didAddObject;
    NSString *didChangeObject;
    NSString *didRemoveObject;
} MANotifyingArrayNotifications;

// in the implementation
const struct MANotifyingArrayNotificationsStruct MANotifyingArrayNotifications = {
    .didAddObject = @"didAddObject",
    .didChangeObject = @"didChangeObject",
    .didRemoveObject = @"didRemoveObject"
};

Utilizo una clase singleton, para poder burlarme de la clase y cambiar las constantes si es necesario para las pruebas. La clase de constantes se ve así:

#import <Foundation/Foundation.h>

@interface iCode_Framework : NSObject

@property (readonly, nonatomic) unsigned int iBufCapacity;
@property (readonly, nonatomic) unsigned int iPort;
@property (readonly, nonatomic) NSString * urlStr;

@end

#import "iCode_Framework.h"

static iCode_Framework * instance;

@implementation iCode_Framework

@dynamic iBufCapacity;
@dynamic iPort;
@dynamic urlStr;

- (unsigned int)iBufCapacity
{
    return 1024u;
};

- (unsigned int)iPort
{
    return 1978u;
};

- (NSString *)urlStr
{
    return @"localhost";
};

+ (void)initialize
{
    if (!instance) {
        instance = [[super allocWithZone:NULL] init];
    }
}

+ (id)allocWithZone:(NSZone * const)notUsed
{
    return instance;
}

@end

Y se usa así (tenga en cuenta el uso de una abreviatura para las constantes c: ahorra escribir [[Constants alloc] init]cada vez):

#import "iCode_FrameworkTests.h"
#import "iCode_Framework.h"

static iCode_Framework * c; // Shorthand

@implementation iCode_FrameworkTests

+ (void)initialize
{
    c  = [[iCode_Framework alloc] init]; // Used like normal class; easy to mock!
}

- (void)testSingleton
{
    STAssertNotNil(c, nil);
    STAssertEqualObjects(c, [iCode_Framework alloc], nil);
    STAssertEquals(c.iBufCapacity, 1024u, nil);
}

@end

Si desea llamar a algo como esto NSString.newLine;desde el objetivo c, y desea que sea constante estática, puede crear algo como esto rápidamente:

public extension NSString {
    @objc public static let newLine = "\n"
}

Y tiene una definición constante agradable y legible, y está disponible desde el tipo de su elección, mientras que el estilo está limitado al contexto de tipo.