ChatGPT解决这个技术问题 Extra ChatGPT

Constants in Objective-C

I'm developing a Cocoa application, and I'm using constant NSStrings as ways to store key names for my preferences.

I understand this is a good idea because it allows easy changing of keys if necessary. Plus, it's the whole 'separate your data from your logic' notion.

Anyway, is there a good way to make these constants defined once for the whole application?

I'm sure that there's an easy and intelligent way, but right now my classes just redefine the ones they use.

OOP is about grouping your data with your logic. What are you proposing is just a good programming practice, i.e., making your program easy to change.

P
Paulo Mattos

You should create a header file like:

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

(You can use extern instead of FOUNDATION_EXPORT if your code will not be used in mixed C/C++ environments or on other platforms.)

You can include this file in each file that uses the constants or in the pre-compiled header for the project.

You define these constants in a .m file like:

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

Constants.m should be added to your application/framework's target so that it is linked in to the final product.

The advantage of using string constants instead of #define'd constants is that you can test for equality using pointer comparison (stringInstance == MyFirstConstant) which is much faster than string comparison ([stringInstance isEqualToString:MyFirstConstant]) (and easier to read, IMO).


For an integer constant would it be: extern int const MyFirstConstant = 1;
Overall, great answer, with one glaring caveat: you DO NOT want to test for string equality with the == operator in Objective-C, since it tests memory address. Always use -isEqualToString: for this. You can easily get a different instance by comparing MyFirstConstant and [NSString stringWithFormat:MyFirstConstant]. Make no assumptions about what instance of a string you have, even with literals. (In any case, #define is a "preprocessor directive", and is substituted before compilation, so either way the compiler sees a string literal in the end.)
In this case, it's OK to use == to test for equality with the constant, if it's truly used as a constant symbol (i.e. the symbol MyFirstConstant instead of a string containing @"MyFirstConstant" is used). An integer could be used instead of a string in this case (really, that's what you're doing--using the pointer as an integer) but using a constant string makes debugging slightly easier as the value of the constant has human-readable meaning.
+1 for "Constants.m should be added to your application/framework's target so that it is linked in to the final product." Saved my sanity. @amok, do "Get info" on Constants.m and choose the "Targets" tab. Make sure it's checked for the relevant target(s).
@Barry: In Cocoa, I have seen a number of classes that define their NSString properties with copy instead of retain. As such, they could (and should) be holding a different instance of your NSString* constant, and direct memory address comparison would fail. Also, I would presume that any reasonably optimal implementation of -isEqualToString: would check for pointer equality before getting into the nitty-gritty of character comparison.
A
Andrew Grant

Easiest way:

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

Better way:

// Prefs.h
extern NSString * const PREFS_MY_CONSTANT;

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

One benefit of the second is that changing the value of a constant does not cause a rebuild of your entire program.


I thought you were not supposed to change the value of constants.
Andrew is refering to changing the value of the constant while coding, not while the application is running.
Is there any added value in doing extern NSString const * const MyConstant, ie, making it a constant pointer to a constant object rather than just a constant pointer?
What happen, if I use this declaration in the header file, static NSString * const kNSStringConst = @"const value"; What's the difference between not declaring and init separately in .h and .m files?
@Dogweather - Someplace where only the compiler knows the answer. IE, if you wanted to include in an about menu which compiler was used to compile a build of an application, you could place it there since the compiled code otherwise wouldn't have anyway of knowing. I can't think of many other places. Macros certainly shouldn't be used in many places. What if I had #define MY_CONST 5 and elsewhere #define MY_CONST_2 25. The result is that you may very well end up with a compiler error when it tries to compile 5_2. Do not use #define for constants. Use const for constants.
C
Community

There is also one thing to mention. If you need a non global constant, you should use static keyword.

Example

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

Because of the static keyword, this const is not visible outside of the file.

Minor correction by @QuinnTaylor: static variables are visible within a compilation unit. Usually, this is a single .m file (as in this example), but it can bite you if you declare it in a header which is included elsewhere, since you'll get linker errors after compilation


Minor correction: static variables are visible within a compilation unit. Usually, this is a single .m file (as in this example), but it can bite you if you declare it in a header which is included elsewhere, since you'll get linker errors after compilation.
If I don't use the static keyword, will kNSStringConst be available throughout the project?
Ok, just checked... Xcode doesn't provide autocompletion for it in other files if you leave static off, but I tried putting the same name in two different places, and reproduced Quinn's linker errors.
static in a header file doesn't give linker problems. However, each compilation unit including the header file will get its own static variable, so you get 100 of them if you include the header from 100 .m files.
@kompozer In which part of the .m file do you place this?
P
Peter Mortensen

The accepted (and correct) answer says that "you can include this [Constants.h] file... in the pre-compiled header for the project."

As a novice, I had difficulty doing this without further explanation -- here's how: In your YourAppNameHere-Prefix.pch file (this is the default name for the precompiled header in Xcode), import your Constants.h inside the #ifdef __OBJC__ block.

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

Also note that the Constants.h and Constants.m files should contain absolutely nothing else in them except what is described in the accepted answer. (No interface or implementation).


I did this but some files throw error on compile "Use of undeclared identifier 'CONSTANTSNAME' If I include the constant.h in the file throwing the error, it works, but that is not what I want to do. I have cleaned, shutdown xcode and build and still problems... any ideas?
R
Regexident

I am generally using the way posted by Barry Wark and Rahul Gupta.

Although, I do not like repeating the same words in both .h and .m file. Note, that in the following example the line is almost identical in both files:

// file.h
extern NSString* const MyConst;

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

Therefore, what I like to do is to use some C preprocessor machinery. Let me explain through the example.

I have a header file which defines the 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

The in my .h/.m pair where I want to define the constant I do the following:

// 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, I have all the information about the constants in .h file only.


Hmm, there is a bit of a caveat however, you cannot use this technique like this if the header file is imported into the precompiled header, because it won't load the .h file into the .m file because it was already compiled. There is a way though - see my answer (since I can't put nice code in the comments.
I can't get this working. If I put #define SYNTHESIZE_CONSTS before #import "myfile.h" it does NSString*... in both the .h and .m (Checked using the assistant view and preprocessor). It throws redefinition errors. If I put it after #import "myfile.h" it does extern NSString*... in both files. Then it throws "Undefined symbol" errors.
M
MaddTheSane

I myself have a header dedicated to declaring constant NSStrings used for preferences like so:

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

Then declaring them in the accompanying .m file:

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

This approach has served me well.

Edit: Note that this works best if the strings are used in multiple files. If only one file uses it, you can just do #define kNSStringConstant @"Constant NSString" in the .m file that uses the string.


S
Scott Little

A slight modification of the suggestion of @Krizz, so that it works properly if the constants header file is to be included in the PCH, which is rather normal. Since the original is imported into the PCH, it won't reload it into the .m file and thus you get no symbols and the linker is unhappy.

However, the following modification allows it to work. It's a bit convoluted, but it works.

You'll need 3 files, .h file which has the constant definitions, the .h file and the .m file, I'll use ConstantList.h, Constants.h and Constants.m, respectively. the contents of Constants.h are simply:

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

and the Constants.m file looks like:

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

Finally, the ConstantList.h file has the actual declarations in it and that is all:

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

A couple of things to note:

I had to redefine the macro in the .m file after #undefing it for the macro to be used. I also had to use #include instead of #import for this to work properly and avoid the compiler seeing the previously precompiled values. This will require a recompile of your PCH (and probably the entire project) whenever any values are changed, which is not the case if they are separated (and duplicated) as normal.

Hope that is helpful for someone.


Using #include fixed this headache for me.
Does this have any performance/memory loss when compared to the accepted answer?
In answer to the performance compared to the accepted answer, there is none. It is effectively the exact same thing from the point of view of the compiler. You end up with the same declarations. They'd be EXACTLY the same if you replaced the extern above with the FOUNDATION_EXPORT.
a
axel22
// Prefs.h
extern NSString * const RAHUL;

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

G
Grant Limberg

As Abizer said, you could put it into the PCH file. Another way that isn't so dirty is to make a include file for all of your keys and then either include that in the file you're using the keys in, or, include it in the PCH. With them in their own include file, that at least gives you one place to look for and define all of these constants.


F
Forge

If you want something like global constants; a quick an dirty way is to put the constant declarations into the pch file.


Editing the .pch is usually not the best idea. You'll have to find a place to actually define the variable, almost always a .m file, so it makes more sense to declare it in the matching .h file. The accepted answer of creating a Constants.h/m pair is a good one if you need them across the whole project. I generally put constants as far down the hierarchy as possible, based on where they will be used.
P
P.J.Radadiya

If you like namespace constant, you can leverage struct, Friday Q&A 2011-08-19: Namespaced Constants and Functions

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

A great thing! But under ARC you will need to prefix all variables in struct declaration with __unsafe_unretained qualifier to get it working.
P
Peter Mortensen

Try using a class method:

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

I use it sometimes.


A class method isn't a constant. It has a cost at run time, and may not always return the same object (it will if you implement it that way, but you haven't necessarily implemented it that way), which means you have to use isEqualToString: for the comparison, which is a further cost at run time. When you want constants, make constants.
@Peter Hosey, while your comments are right, we take that performance hit once per LOC or more in "higher-level" languages like Ruby without every worrying about it. I'm not saying you're not right, but rather just commenting on how standards are different in different "worlds."
True on Ruby. Most of the performance people code for is quite unnecessary for the typical app.
H
Howard Lovatt

I use a singleton class, so that I can mock the class and change the constants if necessary for testing. The constants class looks like this:

#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

And it is used like this (note the use of a shorthand for the constants c - it saves typing [[Constants alloc] init] every time):

#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

R
Renetik

If you want to call something like this NSString.newLine; from objective c, and you want it to be static constant, you can create something like this in swift:

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

And you have nice readable constant definition, and available from within a type of your choice while stile bounded to context of type.