子模块做了一个功能,这个功能需要用到多语言,为了不与主工程其它模块耦合,需要把多语言功能放在当前子模块里面。
一、知识储备
Objective-C 提供的多语言宏,苹果一共提供了四个宏供开发者使用:
1. NSLocalizedString(key, comment)
2. NSLocalizedStringFromTable(key, tbl, comment)
3. NSLocalizedStringFromTableInBundle(key, tbl, bundle, comment)
4. NSLocalizedStringWithDefaultValue(key, tbl, bundle, val, comment)
- NSLocalizedString(key, comment) 宏只有两个参数,第一个是 key,第二个是给翻译人员看的注释,可以为 nil 或者空字符串。这个宏书写起来比较简洁,只能从 main bundle 中对应语言的 Localizable.strings 文件里取到对应 key 的显示语言。
- NSLocalizedStringFromTable(key, tbl, comment) 比上一个宏多一个 table 参数,可以从 main bundle 中指定的 .strings 文件中获取 key-value 值,table 名称就是 .strings 文件的名称。
- NSLocalizedStringFromTableInBundle(key, tbl, bundle, comment) 比上一个宏多一个 bundle 参数,可以从指定 bundle 而不是默认的 main bundle 中的 .strings 文件获取 key-value 值。
- NSLocalizedStringWithDefaultValue(key, tbl, bundle, val, comment) 比上一个宏多一个 val 参数用于指定默认值,当在对应的文件中取不到对应 key-value 将使用 val 的值返回。
因为目前产品需要在APP内切换语言 ,所以前两个只能跟随系统语言的宏就不在考虑范围了,而后面两个宏可以指定 bundle ,这就可以在 APP 内设置不同于系统语言时从不同的 bundle 取相应的语言提供了可能。
项目采用的是NSBundle的这个方法(等同于NSLocalizedStringFromTableInBundle(key, tbl, bundle, comment) 这个宏),因为项目不会有指定默认值的场景。:
- (NSString *)localizedStringForKey:(NSString *)key value:(NSString *)value table:(NSString *)tableName;
对于 NSLocalizedStringFromTableInBundle(key, tbl, bundle, comment) 这个宏,我们需要关心的就是 tbl(table) 和 bundle 这两个值,由于公司 iOS 项目全部实现了业务层级的组件化,所以我们的 .strings 文件可以根据组件来划分,以组件名作为 table 的名称,如订单组件 Contact.strings,table 值即为 Contact。 bundle 的值是实现 APP 内切换语言的关键所在,我们需要用一个专门的类来管理 APP 显示语言。
二、国际化前的准备工作
配置项目中需要添加的国际化语言,这也是国际化之前的准备工作,无论我们是国际化App名称、代码中的字符串、图片、还是storyboard和xib,都需要进行这一步的准备工作(一个项目中需要且仅需要配置一次)。
- 选中project->Info->Localizations,然后点击"+",添加需要国际化/本地化的语言,如下图(默认需要勾选Use Base Internationalization):
-
此处以添加法语为例,如下图:
弹出如下对话框,直接点击finish,如下图:
-
同理,添加简体中文、繁体中文、韩语,最终结果如下图:
三、在项目中添加本地化文件
项目中可以添加以下本地化文件:
1、App名称本地化(默认文件名为:InfoPlist.strings,且必须是这个名字)
2、代码中字符串本地化(默认文件名为:Localizable.strings,且必须是这个名字)
3、自定义代码中字符串本地化(可以自定义文件名和位置)
因为这个多语言功能是在子模块的,所以只能使用第三种。
3.1 新建自定义本地化文件
- 首先需要command + N,选择iOS -> Resource -> Strings File,文件名(可自定义)为:Contact.strings
- 文件创建成功,查看Xcode左侧导航列表,发现多了一个名为Contact.strings的文件(此时文件左边还没有可以点击的三角箭头)
- 选中Contact.strings文件,在Xcode的File inspection中点击Localize,目的是选择我们需要本地化的语言,先选择一个语言;然后我们发现Xcode右侧的File inspection变成了可以选择其他语言了,选择所需的多语言。
- 此时Xcode左侧的Contact.strings左侧多了一个三角箭头
- 在Contact.strings(English) 和 Contact.strings(Chinese(xxx)) 中编写对应的key-value 值。(注意最后的 分号 ,如果不加分号会加载不到文字哦 !)
"test"="this is test";
详细步骤请参考:3分钟实现iOS语言本地化/国际化(图文详解)
3.2 配置.podspec
私有库配置文件定义在podspec 文件中,指定资源打包的方式 resource_bundles Sample 如下(注意后面的路径是/**/*
):
s.resource_bundles = {
'ContactBundle' => ['ContactSDK/Assets/**/*'],
}
3.3 指定方式获取多语言文件
在代码中调用,不能按通常的方式。 一般的调用方式,程序会在main Bundle 的根目录下查找语言文件。而我们的语言文件被打包到私有库中(xxxx.framewok),该framework 中有二进制程序和xxxx.bundle 文件,所有的资源文件都会被打包到(xxxx.bundle)中。
所以我们要加载资源的时候要指定加载的bundle,下面是找到指定的bundle和使用方法。
// 此方法放在子模块的类中,用于定位SDK中的语言文件
+ (NSBundle *) ContactBundle {
static dispatch_once_t onceToken;
static NSBundle * bundle = nil;
dispatch_once(&onceToken, ^{
bundle = [NSBundle bundleWithPath:[[NSBundle bundleForClass:[self class]] pathForResource:@"ContactBundle" ofType:@"bundle"]];
});
return bundle;
}
// 最终使用方法如下:
NSLocalizedStringFromTableInBundle(@"test", @"Contact", [self ContactBundle], @"");
这样就可以独立在子模块使用自己的多语言环境了,别人一引用什么都不用做就可以实现多语言了。