iOS CocoaPods 子模块实现多语言

子模块做了一个功能,这个功能需要用到多语言,为了不与主工程其它模块耦合,需要把多语言功能放在当前子模块里面。

一、知识储备

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):
2-1
  • 此处以添加法语为例,如下图:

    2-2
  • 弹出如下对话框,直接点击finish,如下图:

2-3
  • 同理,添加简体中文、繁体中文、韩语,最终结果如下图:

    2-4

三、在项目中添加本地化文件

项目中可以添加以下本地化文件:

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], @"");

这样就可以独立在子模块使用自己的多语言环境了,别人一引用什么都不用做就可以实现多语言了。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 206,126评论 6 481
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,254评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 152,445评论 0 341
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,185评论 1 278
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,178评论 5 371
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,970评论 1 284
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,276评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,927评论 0 259
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,400评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,883评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,997评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,646评论 4 322
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,213评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,204评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,423评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,423评论 2 352
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,722评论 2 345

推荐阅读更多精彩内容

  • 一、接入多语言文件 xxx.strings 该步骤是初始化多语言文件,和配置我们想要的语言类型。 1.comman...
    任性不认命ToT阅读 622评论 3 5
  • 一、说明 多语言一般为了实现下面两个目标: App展示的语言为目标客户的第一语言,如繁体中文、英语 在其它国家,默...
    cyh老崔阅读 13,915评论 0 16
  • iOS 多语言版本的开发(一) 引言 多语言 & 本地化,随你怎么叫,道理差不多;一个App 要想走出国门,只支持...
    Jimmy_阿达阅读 5,534评论 5 24
  • 目录 概览 各种资源的国际化 1.文本2.图片3.nib4.其他资源 特定模块/功能的国际化 1.APP图标2.应...
    十拿九稳啦阅读 3,565评论 0 6
  • 久违的晴天,家长会。 家长大会开好到教室时,离放学已经没多少时间了。班主任说已经安排了三个家长分享经验。 放学铃声...
    飘雪儿5阅读 7,492评论 16 22