Konstanta dalam Objective-C

Saya sedang mengembangkan aplikasi Kakao , dan saya menggunakan konstanta NSStrings sebagai cara untuk menyimpan nama-nama kunci untuk preferensi saya.

Saya mengerti ini adalah ide yang bagus karena memungkinkan penggantian kunci yang mudah jika perlu.
Plus, itu seluruh gagasan 'memisahkan data Anda dari logika Anda'.

Lagi pula, adakah cara yang baik untuk membuat konstanta ini didefinisikan sekali untuk seluruh aplikasi?

Saya yakin ada cara yang mudah dan cerdas, tetapi saat ini kelas saya hanya mendefinisikan kembali yang mereka gunakan.

Anda harus membuat file header seperti

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

(Anda dapat menggunakan externalih-alih FOUNDATION_EXPORTjika kode Anda tidak akan digunakan dalam lingkungan campuran C / C ++ atau pada platform lain)

Anda dapat memasukkan file ini di setiap file yang menggunakan konstanta atau dalam header yang telah dikompilasi sebelumnya untuk proyek.

Anda mendefinisikan konstanta ini dalam file .m seperti

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

Constants.m harus ditambahkan ke target aplikasi / kerangka kerja Anda sehingga dikaitkan dengan produk akhir.

Keuntungan menggunakan konstanta string daripada konstanta #defined adalah bahwa Anda dapat menguji kesetaraan menggunakan perbandingan pointer ( stringInstance == MyFirstConstant) yang jauh lebih cepat daripada perbandingan string ( [stringInstance isEqualToString:MyFirstConstant]) (dan lebih mudah dibaca, IMO).

Cara termudah:

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

Cara yang lebih baik:

// Prefs.h
extern NSString * const PREFS_MY_CONSTANT;

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

Salah satu manfaat yang kedua adalah bahwa mengubah nilai konstanta tidak menyebabkan pembangunan kembali seluruh program Anda.

Ada juga satu hal yang perlu disebutkan. Jika Anda membutuhkan konstanta non global, Anda harus menggunakan statickata kunci.

Contoh

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

Karena statickata kunci, const ini tidak terlihat di luar file.

Koreksi kecil oleh @QuinnTaylor : variabel statis terlihat di dalam unit kompilasi . Biasanya, ini adalah file .m tunggal (seperti dalam contoh ini), tetapi ini dapat menggigit Anda jika Anda mendeklarasikannya di header yang disertakan di tempat lain, karena Anda akan mendapatkan kesalahan tautan setelah kompilasi

Jawaban yang diterima (dan benar) mengatakan bahwa "Anda dapat memasukkan file [Constants.h] ini ... di header yang sudah dikompilasi untuk proyek."

Sebagai seorang pemula, saya mengalami kesulitan melakukan ini tanpa penjelasan lebih lanjut - inilah caranya: Di file YourAppNameHere-Prefix.pch Anda (ini adalah nama default untuk header yang dikompilasi sebelumnya dalam Xcode), impor Konstanta Anda. H di dalam #ifdef __OBJC__blok .

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

Juga perhatikan bahwa file Constants.h dan Constants.m harus benar-benar tidak mengandung apa pun di dalamnya kecuali apa yang dijelaskan dalam jawaban yang diterima. (Tidak ada antarmuka atau implementasi).

Saya biasanya menggunakan cara yang diposting oleh Barry Wark dan Rahul Gupta.

Meskipun, saya tidak suka mengulang kata-kata yang sama di file .h dan .m. Perhatikan, bahwa dalam contoh berikut ini, baris hampir identik di kedua file:

// file.h
extern NSString* const MyConst;

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

Oleh karena itu, yang ingin saya lakukan adalah menggunakan beberapa mesin preprosesor C. Biarkan saya jelaskan melalui contoh.

Saya memiliki file header yang mendefinisikan makro 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

Pasangan saya .h / .m di mana saya ingin mendefinisikan konstanta saya melakukan hal berikut:

// 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, saya memiliki semua informasi tentang konstanta dalam file .h saja.

Saya sendiri memiliki header yang didedikasikan untuk mendeklarasikan NSStrings konstan yang digunakan untuk preferensi seperti:

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

Kemudian mendeklarasikannya dalam file .m yang menyertainya:

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

Pendekatan ini sangat membantu saya.

Sunting: Perhatikan bahwa ini berfungsi paling baik jika string digunakan dalam banyak file. Jika hanya satu file yang menggunakannya, Anda bisa melakukannya #define kNSStringConstant @"Constant NSString"di file .m yang menggunakan string.

Sedikit modifikasi dari saran @Krizz, sehingga berfungsi dengan baik jika file header konstanta dimasukkan dalam PCH, yang agak normal. Karena aslinya diimpor ke PCH, itu tidak akan memuatnya kembali ke dalam .mfile dan dengan demikian Anda tidak mendapatkan simbol dan linker tidak senang.

Namun, modifikasi berikut memungkinkannya berfungsi. Agak berbelit-belit, tetapi berhasil.

Anda harus 3 file, .hberkas yang memiliki definisi konstan, .hfile dan .mberkas, saya akan menggunakan ConstantList.h, Constants.hdan Constants.mmasing-masing. isinya Constants.hsederhana:

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

dan Constants.mfile tersebut terlihat seperti:

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

Akhirnya, ConstantList.hfile tersebut memiliki deklarasi aktual di dalamnya dan itu saja:

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

Beberapa hal yang perlu diperhatikan:

1. Saya harus mendefinisikan ulang makro dalam .mfile setelah #undef itu untuk makro yang akan digunakan.

2. Saya juga harus menggunakan #includealih-alih #importagar ini berfungsi dengan baik dan menghindari kompilator melihat nilai yang sebelumnya dikompilasi.

3. Ini akan membutuhkan kompilasi ulang PCH Anda (dan mungkin seluruh proyek) setiap kali ada nilai yang berubah, yang tidak terjadi jika mereka dipisahkan (dan digandakan) seperti biasa.

Semoga bermanfaat bagi seseorang.

// Prefs.h
extern NSString * const RAHUL;

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

Seperti kata Abizer, Anda bisa memasukkannya ke file PCH. Cara lain yang tidak begitu kotor adalah dengan membuat file include untuk semua kunci Anda dan kemudian memasukkannya ke dalam file yang Anda gunakan kunci tersebut, atau, memasukkannya ke dalam PCH. Dengan mereka di file sertakan mereka sendiri, yang setidaknya memberi Anda satu tempat untuk mencari dan mendefinisikan semua konstanta ini.

Jika Anda menginginkan sesuatu seperti konstanta global; cara cepat yang kotor adalah dengan meletakkan deklarasi konstan ke dalam pchfile.

Coba gunakan metode kelas:

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

Terkadang saya menggunakannya.

Jika Anda suka namespace konstan, Anda dapat memanfaatkan struct, Friday Q&A 2011-08-19: Konstanta dan Fungsi Bernama Tingkatan

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

Saya menggunakan kelas singleton, sehingga saya bisa mengejek kelas dan mengubah konstanta jika perlu untuk pengujian. Kelas konstanta terlihat seperti ini:

#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

Dan ini digunakan seperti ini (perhatikan penggunaan steno untuk konstanta c - menghemat mengetik [[Constants alloc] init]setiap waktu):

#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

Jika Anda ingin memanggil sesuatu seperti ini NSString.newLine;dari objektif c, dan Anda ingin itu konstan statis, Anda dapat membuat sesuatu seperti ini dengan cepat:

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

Dan Anda memiliki definisi konstan yang dapat dibaca, dan tersedia dari dalam jenis pilihan Anda sementara masih terikat ke konteks jenis.