iOS 本地化入门教程
iOS应用的本地化原理非常简单,是通过strings
类型的文件,为同一种语言的不同翻译设置翻译表,应用再根据用户系统语言自动检索翻译表实现的。
首先普及一些基本概念给新人看。
NSBundle
在iOS应用中,bundle的概念非常重要,可以理解为一些文件的集合,bundle中可以嵌套bundle,外在 形式是.bundle格式的文件,同时编译生成的app包,也是bundle。
为此,苹果的工程师们留下了NSBundle这个类,用于操作bundle内的文件。而NSBundle类中的一些特定方法,则是给一些特定的文件实用的。
例如infoDictionary
用于读取bundle中的info.plist文件。
@property (nullable, readonly, copy) NSDictionary<NSString *, id> *infoDictionary;
当然还有我们今天要讲的本地化方法
/* Method for retrieving localized strings. */
- (NSString *)localizedStringForKey:(NSString *)key value:(nullable NSString *)value table:(nullable NSString *)tableName NS_FORMAT_ARGUMENT(1);
这个方法就是用来读去bundle中本地化字段的方法。而在日常使用中,我们用的更多的是两个简化的宏:
NSLocalizedString(<#key#>, <#comment#>)
NSLocalizedStringFromTable(<#key#>, <#tbl#>, <#comment#>)
宏定义
#define NSLocalizedString(key, comment) \
[[NSBundle mainBundle] localizedStringForKey:(key) value:@"" table:nil]
#define NSLocalizedStringFromTable(key, tbl, comment) \
[[NSBundle mainBundle] localizedStringForKey:(key) value:@"" table:(tbl)]
#define NSLocalizedStringFromTableInBundle(key, tbl, bundle, comment) \
[bundle localizedStringForKey:(key) value:@"" table:(tbl)]
#define NSLocalizedStringWithDefaultValue(key, tbl, bundle, val, comment) \
[bundle localizedStringForKey:(key) value:(val) table:(tbl)]
key
参数必填,comment
作为注释参数,是不影响返回值的,可以传nil。
默认本地化文件
新工程中是不包含本地化文件的,如果要给应用添加本地化,首先需要添加Localizable.strings
文件。
Localizable.strings
文件就是本地化文件中的默认文件,名字不要打错哦,当你使用NSLocalizedString(<#key#>, <#comment#>)
宏时,不用输入table名称,便是默认使用Localizable.strings
文件作为翻译表。
如果你还有其他的翻译表文件,例如other.strings,你可以这样使用
NSLocalizedStringFromTable(@"你好", @"other", nil)
当然现在并不会将你好翻译成其他语言,下一步,你需要设置你的翻译表。
Localizable.strings格式
strings文件的格式非常简单,但如果格式有错,编译器会报错,并且不会提醒你到底哪里错了,所以务必要仔细。如下
"你好" = "你好";
每一行一句,等号前面是key,等号后面是value,引号前不加
@
,分号结尾。当添加多种语言后,同一个文件将会有不同语言的副本,存在工程目录下的不同本地化文件夹中,但在xcode中还是以同一个文件显示,但可以下拉切换语言进行编辑。
添加本地化语言的方法如下,先选中strings
文件,然后又边点击Localize
按钮,然后选项中会有Base和English两个选项,确认后,这里会出现多选框,选取哪种语言,便会自动生成对应的副本。
添加其他语言
如图选择Project的Info标签,设置Localization选项
实战
这里我们添加了简体中文和日本本地化,对应的Localizable.strings文件多了两个副本。
各个文件中的内容如下
//日语Localizable.strings(Japanese)文件
"你好" = "こんにちは";
//英语Localizable.strings(English)文件
"你好" = "hello";
//简体中文Localizable.strings(Simplified)文件
"你好" = "你好";
这样一来,当我们在代码中使用"你好"这个key时,系统便会自动根据我们的系统语言,进行本地化替换,当系统语言并非我们本地化支持的语言时,例如我们并未加入韩语,本地化接口便会把key的默认语言的本地化内容返回,或者根据设备的第二语言进行返回。当使用的key并不存在时,则会把key作为value返回。
开源工具
这里给大家分享一个我写的开源项目,可以自动给.m和.mm文件,生成对应的翻译表。
例如代码中使用本地化方法
NSString* a = NSLocalizedString(@"这是一个测试", nil);
NSString* b = NSLocalizedString(@"第一条是普通本地化, 翻译写入Localizable.strings文件", nil);
NSString* c = NSLocalizedString(@"第二条是带注释的语句", @"这里是这条本地化语句的注释");
NSString* d = NSLocalizedStringFromTable(@"第三条是带表名的本地化语句,写在 XXX(表名).strings文件里", @"OtherFile",nil);
NSString* e = NSLocalizedStringFromTable( @"最后一条测试书写规范,空格,特殊符号(\"{@#$)等等" , @"OtherFile" , nil);
只要将文件拖入SimpleLocalizedTool工具,便会自动生成对应的本地化文件。
上面的例子中,有使用默认的string文件语句,也有使用OtherFile
这个文件名的语句,所以会生成两个文件,内容如下,直接拷贝到工程中吧,是不是很好用呀。
//Localizable.strings
"这是一个测试" = "这是一个测试";
"第一条是普通本地化, 翻译写入Localizable.strings文件" = "第一条是普通本地化, 翻译写入Localizable.strings文件";
"第二条是带注释的语句" = "第二条是带注释的语句";
//OtherFile.strings
"第三条是带表名的本地化语句,写在 XXX(表名).strings文件里" = "第三条是带表名的本地化语句,写在 XXX(表名).strings文件里";
"最后一条测试书写规范,空格,特殊符号(\"{@#$)等等" = "最后一条测试书写规范,空格,特殊符号(\"{@#$)等等";
**粗体** _斜体_ [链接](http://example.com) `代码` - 列表 > 引用
。你还可以使用@
来通知其他用户。