NSLocalized​String

Mattt Thompson撰写、 April Peng翻译、 发布于

字符串也许是计算最通用的数据类型。他们以符号的方式传来传去,用来为数值编码,键值关联,代表资源路径,存储语言内容和格式的信息。对面向用户的字符串具有强有力的控制是营造良好的用户体验必不可少的能力。

在 Foundation 中,有一个方便的宏表示作为面向用户的字符串:NSLocalizedString

NSLocalizedString 提供本地化字符串的 “一次编译 / 随处运行” 的方式,根据用户设置的字符串表把所有本地化字符串替换成对应的翻译。但是,即使你不打算把你的应用程序本地化到任何其他市场,NSLocalizedString 在拷贝与编辑上仍然有神奇的作用。

有关本地化(l10n)和国际化(i18n)的更多信息请查看 NSHipster 有关 NSLocale 的文章


NSLocalizedString 是一个 Foundation 的宏定义,返回一个字符串的本地化版本。它有两个参数:key:进行本地化的唯一字符串标识,和 comment:用于提供用来准确翻译的足够的上下文的字符串。

在实践中,key 往往只是用来翻译的基准字符串,而 comment 通常是 nil,除非有一个模糊的上下文:

textField.placeholder = NSLocalizedString(@"Username", nil);

NSLocalizedString 也可以在 NSString +stringWithFormat: 中用来作为格式化字符串。在这种情况下,使用 comment 参数来提供达到正确翻译足够的上下文是很重要的。

self.title = [NSString stringWithFormat:NSLocalizedString(@"%@'s Profile", @"{User First Name}'s Profile"), user.name];

label.text = [NSString stringWithFormat:NSLocalizedString(@"Showing %lu of %lu items", @"Showing {number} of {total number} items"), [page count], [items count]];

NSLocalizedString & Co.

随着控制(和模糊)程度的增加,有四个种类的 NSLocalizedString

NSString * NSLocalizedString(
  NSString *key,
  NSString *comment
)

NSString * NSLocalizedStringFromTable(
  NSString *key,
  NSString *tableName,
  NSString *comment
)

NSString * NSLocalizedStringFromTableInBundle(
  NSString *key,
  NSString *tableName,
  NSBundle *bundle,
  NSString *comment
)

NSString * NSLocalizedStringWithDefaultValue(
  NSString *key,
  NSString *tableName,
  NSBundle *bundle,
  NSString *value,
  NSString *comment
)

99% 的情况下,NSLocalizedString 就足够了。如果你实现的是一个库或共享组件,应该使用 NSLocalizedStringFromTable

Localizable.strings

在运行时,NSLocalizedString 会确定首选的语言,并在应用程序包中找到相应的 Localizable.strings 文件。例如,如果用户首选法语,文件 fr.lproj/Localizable.strings 将来用作参考。

就是下面这个样子:

/* No comment provided by engineer. */
"Username"="nom d'utilisateur";
/* {User First Name}'s Profile */
"%@'s Profile"="profil de %1$@";

Localizable.strings 文件最初将由 genstrings 产生。

genstrings 程序用给定的参数从 C 或 Objective-C(.c 或 .m)的源代码文件生成一个 .strings 文件。一个 .strings 文件用于为应用程序的不同语言作本地化,正如 Cocoa 开发者文档下的 “Internationalization” 描述的那样。

genstrings 会浏览每个所选的源文件,以及每个使用 NSLocalizedString 的源文件,把键和注释追加到目标文件。这取决于开发人员是否为每个语言创建该文件的副本,并进行本地化翻译。

不要模板化

在阅读了有关本地化的格式字符串的一部分之后,你可能会采取通过聪明的,DRY 的方式创建可重复使用的诸如 @"{Noun} {Verb} {Noun}" 这样的语法模板,并分别为每一个字做翻译...

不要这样做 这件事怎么强调也不过分:不要细分本地化字符串。上下文可能会丢失,语法结构将变得非常凌乱和不合常规,动词会被错误地改变格式,你将完全搞错重点 —— 在一些事情上花大力气比你在一开始就没有尽力更糟。

数字,日期,以及类似的几乎总是可以安全替代的值。名词受到多元化和动词变形的影响,但通常作为直接或间接的对象安全的替换。

有关其他准则,请参阅苹果的国际化和本地化指南.


NSLocalizedString 是代码质量的一个非常可靠的指标。那些愿意多花一些时间到国际化的人在涉及到设计和实现的时候也很可能会一样的周到。

始终把面向用户的字符串用 NSLocalizedString 包起来。

即使你不打算把你的应用程序本地化成其他语言,能够轻松地查看所有用户将看到字符串也是 非常 有用的。如果本地化在你的计划中,把你的字符串在一开始就 NSLocalize 也将使这变得非常容易,你只需在必要的时候将它们都找出来就可以了。