iOS 本地化简明指南

iOS

07 Jun 2018

Comments

概括

iOS 本地化主要包含这几部分的工作：

InfoPlist 中属性的本地化。
storyboard/xib 本地化。
字符串本地化。
图片本地化。
本地化原理。
相关脚本。

本地化准备工作

InfoPlist 中属性的本地化

新建 String File，命名为 InfoPlist.strings。当然这些资源可以放在某个目录下，方便管理，比如说 Resources 目录。

然后进行本地化设置。

其中 CFBundleDisplayName 是 InfoPlist 文件中的属性，用于展示 App 的名称。其他的属性也同样设置。注意层级关系。

storyboard/xib 本地化

注意，一定要选中 storyboard 的某个控件，然后进行勾选。否则新建的本地化文件无法出现控件的 ObjectID。

然后在 Main.string 相关文件中进行修改。

字符串本地化

这里是重点。

为了方便进行统一管理，本地化的内容不会在 storyboard 或 xib 中进行，而是在代码中设置。

新建 String File，命名为 Localizable.strings。

在右边勾选本地化配置。

分别在三个配置中设置：

// Localizable.strings(English)
"本地化文本" = "Localizable Text";

// Localizable.strings(Simplified)
"本地化文本" = "本地化文本";

// Localizable.strings(Base)
"本地化文本" = "本地化文本";

完成后，可以在代码中测试：

NSString *string = NSLocalizedString(@"本地化文本", nil);
NSLog(@"%@", string);

本地化文件的名字可以自定，只要加载时对应就行，后缀当然必须是 .strings。比如说 Language.strings。

加载的时候需要添加以下代码，然后用 LocalizableBundle(@"xxxx") 这样的代码加载。

#define LocalizableBundle [NSBundle mainBundle]

#define LocalizedString(key) \
NSLocalizedStringFromTableInBundle(key, @"Language", LocalizableBundle, nil)

使用时代码变为：

NSString *string = LocalizedString(@"本地化文本");
NSLog(@"%@", string);

图片本地化

原理是根据不同的本地化配置加载不同图片名称的字符串，就可以初始化成不同的图片。

新建 ImageLocalizable.strings 文件，并进行本地化。

在以上宏的前提下，再定义宏：

#define LocalizedImage(key) \
NSLocalizedStringFromTableInBundle(key, @"ImageLocalizable", LocalizableBundle, nil)

代码中加载时：

NSString *path = [[NSBundle mainBundle] pathForResource:LocalizedImage(@"girl") ofType:@"jpg"];
self.girlImageView.contentMode = UIViewContentModeScaleAspectFill;
self.girlImageView.image = [UIImage imageWithContentsOfFile:path];

本地化原理

应用启动时，首先会读取 NSUserDefaults 中以 AppleLanguages 为 key 的内容，得到一个对象，通过对这个对象进行类型分析，可以得到当前的本地化环境。只有一个本地化环境时，value 实际上是一个 NSString。

代码：

id localizables = [[NSUserDefaults standardUserDefaults] valueForKey:@"AppleLanguages"];
NSLog(@"本地化：%@", localizables);
NSString *currentLocalizable = nil;
if ([localizables isKindOfClass:[NSString class]]) {
    currentLocalizable = (NSString *)localizables;
} else if ([localizables isKindOfClass:[NSArray class]]) {
    currentLocalizable = ((NSArray *)localizables).firstObject;
}
NSLog(@"当前本地化：%@", currentLocalizable);

如果是 NSArray，则这个 NSArray 的内容对应着手机设置中的“首选语言顺序”。

第一个即为当前的语言环境。

基于此可以修改 App 的本地化环境。

[[NSUserDefaults standardUserDefaults] setObject:@[@"zh-Hans"] forKey:@"AppleLanguages"];
[[NSUserDefaults standardUserDefaults] synchronize];

这必须在重新启动 App 后才会生效。

当然，可以更进一步，修改加载本地化文件的方法，配合上面修改本地化环境的方法，实现动态的加载本地化资源。代码如下：

id dynamicLocalizables = [[NSUserDefaults standardUserDefaults] valueForKey:@"AppleLanguages"];
NSString *currentDynamicLocalizable = nil;
if ([dynamicLocalizables isKindOfClass:[NSString class]]) {
    currentDynamicLocalizable = (NSString *)dynamicLocalizables;
} else if ([dynamicLocalizables isKindOfClass:[NSArray class]]) {
    currentDynamicLocalizable = ((NSArray *)dynamicLocalizables).firstObject;
}
path = [[NSBundle mainBundle] pathForResource:currentDynamicLocalizable ofType:@"lproj"];
NSLog(@"%@", [[NSBundle bundleWithPath:path] localizedStringForKey:@"本地化文本" value:@"" table:nil]);

当然这只是实验性质的，如果项目中有类似需求，还可以进一步封装成类似 NSLocalizedString 的调用方式。

其他

调试技巧：可以在 Edit Scheme 中将 Application Language 改成所需要的语言，这样就不需要在虚拟机或真机的设置中修改了。

Notes and thoughts from Tony