Константы в Objective-C

1002

Я разрабатываю приложение Какао , и я использую константы NSStrings как способы хранения имен ключей для моих предпочтений.

Я понимаю, что это хорошая идея, потому что она позволяет легко менять ключи при необходимости.
Плюс, это целое понятие «отделить ваши данные от вашей логики».

В любом случае, есть ли хороший способ сделать эти константы определенными один раз для всего приложения?

Я уверен, что есть простой и умный способ, но сейчас мои уроки просто переопределяют те, которые они используют.

Allyn
источник
7
ООП - это группировка ваших данных с вашей логикой. То, что вы предлагаете, - это просто хорошая практика программирования, то есть облегчение изменения вашей программы.
Раффи Хачадурян

Ответы:

1287

Вы должны создать заголовочный файл как

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

(вы можете использовать externвместо, FOUNDATION_EXPORTесли ваш код не будет использоваться в смешанных средах C / C ++ или на других платформах)

Вы можете включить этот файл в каждый файл, который использует константы или в предварительно скомпилированный заголовок для проекта.

Вы определяете эти константы в файле .m как

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

Constants.m должен быть добавлен к цели вашего приложения / фреймворка, чтобы он был связан с конечным продуктом.

Преимущество использования строковых констант вместо #defined-констант состоит в том, что вы можете проверить на равенство, используя сравнение указателей ( stringInstance == MyFirstConstant), которое намного быстрее, чем сравнение строк ( [stringInstance isEqualToString:MyFirstConstant]) (и легче для чтения, IMO).

Барри Уарк
источник
67
Для целочисленной константы это будет: extern int const MyFirstConstant = 1;
Дэн Морган
180
В целом, отличный ответ, с одним очевидным предостережением: вы НЕ хотите проверять на равенство строк с помощью оператора == в Objective-C, так как он проверяет адрес памяти. Всегда используйте -isEqualToString: для этого. Вы можете легко получить другой экземпляр, сравнивая MyFirstConstant и [NSString stringWithFormat: MyFirstConstant]. Не делайте предположений о том, какой у вас экземпляр строки, даже с литералами. (В любом случае, #define является «директивой препроцессора» и подставляется перед компиляцией, так что в любом случае компилятор видит строковый литерал в конце.)
Куинн Тейлор
74
В этом случае можно использовать == для проверки на равенство с константой, если она действительно используется в качестве константного символа (т.е. используется символ MyFirstConstant вместо строки, содержащей @ "MyFirstConstant"). В этом случае вместо строки можно использовать целое число (на самом деле, это то, что вы делаете - используя указатель в качестве целого числа), но использование константной строки делает отладку немного легче, так как значение константы имеет понятное для человека значение ,
Барри Уарк
17
+1 для «Constants.m должен быть добавлен к цели вашего приложения / фреймворка, чтобы он был связан с конечным продуктом». Спасло мое здравомыслие. @amok, сделайте «Получить информацию» на Constants.m и выберите вкладку «Цели». Убедитесь, что он проверен на соответствующие цели.
PEZ
73
@ Барри: В Какао я видел несколько классов, которые определяют свои NSStringсвойства copyвместо retain. Как таковые, они могут (и должны) содержать другой экземпляр вашей NSString*константы, и прямое сравнение адресов памяти будет неудачным. Кроме того, я бы предположил, что любая разумно оптимальная реализация -isEqualToString:проверяет равенство указателей, прежде чем приступить к сравнительному анализу символов.
Бен Мошер
280

Самый простой способ:

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

Лучший путь:

// Prefs.h
extern NSString * const PREFS_MY_CONSTANT;

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

Одним из преимуществ второго является то, что изменение значения константы не приводит к перестройке всей вашей программы.

Эндрю Грант
источник
12
Я думал, что вы не должны менять значение констант.
ruipacheco
71
Эндрю ссылается на изменение значения константы во время кодирования, а не во время работы приложения.
Рэндалл
7
Есть ли какая-то дополнительная ценность extern NSString const * const MyConstant, т. Е. Сделать ее постоянным указателем на постоянный объект, а не просто постоянным указателем?
Хари Карам Сингх
4
Что произойдет, если я использую это объявление в заголовочном файле, static NSString * const kNSStringConst = @ "const value"; В чем разница между отсутствием объявления и инициализации в файлах .h и .m?
Карим
4
@ Dogweather - Где-то, где только компилятор знает ответ. То есть, если вы хотите включить в меню about информацию о том, какой компилятор использовался для компиляции сборки приложения, вы можете поместить его туда, поскольку скомпилированный код в противном случае не будет знать. Я не могу думать о многих других местах. Макросы, конечно, не должны использоваться во многих местах. Что если бы у меня был #define MY_CONST 5 и в других местах #define MY_CONST_2 25. В результате у вас может получиться ошибка компилятора, когда он попытается скомпилировать 5_2. Не используйте #define для констант. Используйте const для констант.
ArtOfWarfare
190

Есть также одна вещь, чтобы упомянуть. Если вам нужна не глобальная константа, вы должны использовать staticключевое слово.

пример

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

Из-за staticключевого слова этот констант не виден вне файла.


Незначительная коррекция @QuinnTaylor : статические переменные видны в модуле компиляции . Обычно это один файл .m (как в этом примере), но он может укусить вас, если вы объявите его в заголовке, который включен в другом месте, так как вы получите ошибки компоновщика после компиляции

Kompozer
источник
41
Незначительная коррекция: статические переменные видны в модуле компиляции . Обычно это один файл .m (как в этом примере), но он может укусить вас, если вы объявите его в заголовке, который включен в другом месте, так как вы получите ошибки компоновщика после компиляции.
Куинн Тейлор
Если я не использую ключевое слово static, будет ли kNSStringConst доступен на протяжении всего проекта?
Данял Айтекин
2
Хорошо, только что проверил ... Xcode не обеспечивает автозаполнение для него в других файлах, если вы оставите статический выключенный, но я попытался поместить одно и то же имя в двух разных местах и ​​воспроизвел ошибки компоновщика Куинна.
Данял Айтекин
1
static в заголовочном файле не создает проблем с компоновщиком Однако каждый модуль компиляции, включая файл заголовка, получит свою собственную статическую переменную, поэтому вы получите 100 из них, если включите заголовок из 100 .m файлов.
gnasher729
@kompozer В какую часть файла .m вы помещаете это?
Василий Бурк
117

В принятом (и правильном) ответе говорится, что «вы можете включить этот файл [Constants.h] ... в предварительно скомпилированный заголовок проекта».

Как новичок, мне было трудно сделать это без дальнейшего объяснения - вот как: в вашем файле YourAppNameHere-Prefix.pch (это имя по умолчанию для предварительно скомпилированного заголовка в XCode), импортируйте ваш Constants.h внутри #ifdef __OBJC__блока .

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

Также обратите внимание, что файлы Constants.h и Constants.m не должны содержать в себе абсолютно ничего, кроме того, что описано в принятом ответе. (Нет интерфейса или реализации).

Виктор Ван Хи
источник
Я сделал это, но некоторые файлы выдают ошибку при компиляции "Использование необъявленного идентификатора 'CONSTANTSNAME' Если я включаю константу.h в файл, выдающий ошибку, это работает, но это не то, что я хочу сделать. Я очистил, завершение работы xcode и build и еще проблемы ... есть идеи?
J3RM
50

Я обычно использую способ Барри Уорка и Рахула Гупты.

Хотя я не люблю повторять одни и те же слова в файлах .h и .m. Обратите внимание, что в следующем примере строка практически идентична в обоих файлах:

// file.h
extern NSString* const MyConst;

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

Поэтому мне нравится использовать некоторые препроцессорные механизмы на языке C. Позвольте мне объяснить на примере.

У меня есть заголовочный файл, который определяет макрос 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

В моей паре .h / .m, где я хочу определить константу, я делаю следующее:

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

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

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

et вуаля, у меня есть вся информация о константах только в .h файле.

Krizz
источник
Хм, однако, есть некоторая оговорка, вы не можете использовать эту технику, как этот, если файл заголовка импортируется в предварительно скомпилированный заголовок, потому что он не будет загружать файл .h в файл .m, потому что он уже скомпилирован. Хотя есть способ - посмотрите мой ответ (так как я не могу поместить хороший код в комментариях.
Скотт Литтл
Я не могу заставить это работать. Если я помещаю #define SYNTHESIZE_CONSTS перед #import "myfile.h", он выполняет NSString * ... как в .h, так и в .m (проверено с использованием представления помощника и препроцессора). Выдает ошибки переопределения. Если я ставлю его после #import "myfile.h", он выполняет extern NSString * ... в обоих файлах. Затем выдает ошибки «Неопределенный символ».
Арсений
28

У меня сам есть заголовок, предназначенный для объявления констант NSStrings, используемых для таких настроек:

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

Затем объявите их в сопроводительном файле .m:

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";

Этот подход хорошо послужил мне.

Изменить: Обратите внимание, что это работает лучше всего, если строки используются в нескольких файлах. Если его использует только один файл, вы можете просто сделать это #define kNSStringConstant @"Constant NSString"в файле .m, который использует строку.

MaddTheSane
источник
25

Небольшая модификация предложения @Krizz, чтобы он работал должным образом, если заголовочный файл констант должен быть включен в PCH, что довольно нормально. Так как оригинал импортируется в PCH, он не будет перезагружать его в .mфайл, и поэтому вы не получите никаких символов, а компоновщик недоволен.

Однако следующая модификация позволяет ему работать. Это немного запутанно, но это работает.

Вам понадобятся 3 файла, .hфайл с постоянными определениями, .hфайл и .mфайл, которые я буду использовать ConstantList.h, Constants.hи Constants.m, соответственно. содержание Constants.hпросто:

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

и Constants.mфайл выглядит так:

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

Наконец, в ConstantList.hфайле есть реальные объявления, и это все:

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

Несколько вещей, чтобы отметить:

  1. Мне пришлось переопределить макрос в .mфайле после #undef его использования для макроса, который будет использоваться.

  2. Мне также пришлось использовать #includeвместо #importэтого, чтобы это работало должным образом и чтобы компилятор не видел ранее скомпилированные значения.

  3. Это потребует перекомпиляции вашего PCH (и, вероятно, всего проекта) всякий раз, когда какие-либо значения будут изменены, что не имеет место, если они разделены (и дублированы) как обычно.

Надеюсь, что это полезно для кого-то.

Скотт Литтл
источник
1
Использование #include исправило эту головную боль для меня.
Рамсель
Имеет ли это какую-либо производительность / потерю памяти по сравнению с принятым ответом?
Гифис
В ответ на производительность по сравнению с принятым ответом, нет ни одного. Фактически это то же самое с точки зрения компилятора. Вы в конечном итоге с такими же заявлениями. Они были бы точно такими же, если бы вы заменили externвышеуказанное на FOUNDATION_EXPORT.
Скотт Литтл
14
// Prefs.h
extern NSString * const RAHUL;

// Prefs.m
NSString * const RAHUL = @"rahul";
Рахул Гупта
источник
12

Как сказал Abizer, вы можете поместить его в файл PCH. Другой способ, который не так грязен, - сделать включаемый файл для всех ваших ключей, а затем либо включить его в файл, в котором вы используете ключи, либо включить его в PCH. Имея их в отдельном включаемом файле, вы, по крайней мере, получаете одно место для поиска и определения всех этих констант.

Грант Лимберг
источник
11

Если вы хотите что-то вроде глобальных констант; быстрый грязный способ - поместить объявления констант в pchфайл.

Abizern
источник
7
Редактирование .pch обычно не лучшая идея. Вам нужно будет найти место для фактического определения переменной, почти всегда файла .m, поэтому имеет смысл объявить его в соответствующем файле .h. Принятый ответ на создание пары Constants.h / m будет хорошим, если они понадобятся вам во всем проекте. Обычно я помещаю константы как можно дальше вниз по иерархии в зависимости от того, где они будут использоваться.
Куинн Тейлор
8

Попробуйте использовать метод класса:

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

Я использую это иногда.

groumpf
источник
6
Метод класса не является константой. Он имеет стоимость во время выполнения и может не всегда возвращать один и тот же объект (он будет, если вы реализуете его таким образом, но вы не обязательно реализовали его таким образом), что означает, что вы должны использовать isEqualToString:для сравнения, которое дальнейшая стоимость во время выполнения. Когда вы хотите константы, делайте константы.
Питер Хоси
2
@Peter Hosey, хотя ваши комментарии верны, мы принимаем эту производительность один раз за LOC или больше на «высокоуровневых» языках, таких как Ruby, не беспокоясь об этом. Я не говорю, что вы не правы, а просто комментирую, как стандарты различны в разных «мирах».
Дэн Розенстарк
1
Правда на Руби. Большая часть производительности, которую кодируют люди, совершенно не нужна для типичного приложения.
Питер ДеВиз
8

Если вам нравится константа пространства имен, вы можете использовать struct, Friday Q & A 2011-08-19: Константы и функции пространства имен

// 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"
};
onmyway133
источник
1
Отличная вещь! Но в ARC вам нужно будет префикс всех переменных в объявлении структуры с __unsafe_unretainedквалификатором, чтобы он работал.
Цемен
7

Я использую одноэлементный класс, так что я могу издеваться над классом и изменять константы, если это необходимо для тестирования. Класс констант выглядит так:

#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

И он используется следующим образом (обратите внимание на использование сокращения для констант c - он сохраняет [[Constants alloc] init]каждый раз при наборе ):

#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
Говард Ловатт
источник
1

Если вы хотите вызвать что-то подобное NSString.newLine;из цели c и хотите, чтобы это было статической константой, вы можете создать что-то вроде этого в swift:

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

И у вас есть хорошее читаемое определение константы, которое доступно из любого типа по вашему выбору, в то время как стиль ограничен контекстом типа.

Renetik
источник