Flutter 应用的国际化

如果你的应用可能会部署到使用其他语言的用户,那么你需要对其进行国际化。这意味着你需要以一种方式编写应用,以便可以为应用支持的每种语言或区域设置本地化文本和布局等值。Flutter 提供了有助于国际化的组件和类,并且 Flutter 库本身已实现国际化。

此页面介绍了使用 MaterialAppCupertinoApp 类本地化 Flutter 应用程序所需的概念和工作流,因为大多数应用都是这样编写的。但是,使用较低级别的 WidgetsApp 类编写的应用程序也可以使用相同的类和逻辑进行国际化。

Flutter 中本地化的简介

本部分提供了一个教程,介绍如何创建和国际化一个新的 Flutter 应用程序,以及目标平台可能需要的任何其他设置。

你可以在 gen_l10n_example 中找到此示例的源代码。

设置国际化应用程序:Flutter_localizations 包

默认情况下,Flutter 仅提供美国英语本地化。要添加对其他语言的支持,应用程序必须指定其他 MaterialApp(或 CupertinoApp)属性,并包含一个名为 flutter_localizations 的包。截至 2023 年 12 月,此包支持 115 种语言和语言变体。

首先,使用 flutter create 命令在你选择的目录中创建一个新的 Flutter 应用程序。

$ flutter create <name_of_flutter_app>

要使用 flutter_localizations,请将其作为依赖项添加到你的 pubspec.yaml 文件,以及 intl

$ flutter pub add flutter_localizations --sdk=flutter
$ flutter pub add intl:any

这将创建一个包含以下项的 pubspec.yml 文件

dependencies:
  flutter:
    sdk: flutter
  flutter_localizations:
    sdk: flutter
  intl: any

然后导入 flutter_localizations 库并为你的 MaterialAppCupertinoApp 指定 localizationsDelegatessupportedLocales

import 'package:flutter_localizations/flutter_localizations.dart';
return const MaterialApp(
  title: 'Localizations Sample App',
  localizationsDelegates: [
    GlobalMaterialLocalizations.delegate,
    GlobalWidgetsLocalizations.delegate,
    GlobalCupertinoLocalizations.delegate,
  ],
  supportedLocales: [
    Locale('en'), // English
    Locale('es'), // Spanish
  ],
  home: MyHomePage(),
);

在引入 flutter_localizations 包并添加之前的代码后,MaterialCupertino 包现在应该已正确本地化到 115 个受支持的语言环境之一。小组件应根据本地化消息进行调整,同时采用正确的从左到右或从右到左布局。

尝试将目标平台的语言环境切换为西班牙语 (es),消息应已本地化。

基于 WidgetsApp 的应用类似,但不需要 GlobalMaterialLocalizations.delegate

首选完整的 Locale.fromSubtags 构造函数,因为它支持 scriptCode,尽管 Locale 默认构造函数仍然完全有效。

localizationsDelegates 列表的元素是生成本地化值集合的工厂。GlobalMaterialLocalizations.delegate 为 Material Components 库提供本地化字符串和其他值。GlobalWidgetsLocalizations.delegate 为小组件库定义默认文本方向,从左到右或从右到左。

此页面介绍了有关这些应用属性、它们所依赖的类型以及国际化 Flutter 应用的典型结构的更多信息。

覆盖语言环境

Localizations.overrideLocalizations 小组件的工厂构造函数,它允许出现(通常很少见)的情况,即您应用的一部分需要本地化为与为您的设备配置的语言环境不同的语言环境。

要观察此行为,请添加对 Localizations.override 和简单的 CalendarDatePicker 的调用

Widget build(BuildContext context) {
  return Scaffold(
    appBar: AppBar(
      title: Text(widget.title),
    ),
    body: Center(
      child: Column(
        mainAxisAlignment: MainAxisAlignment.center,
        children: <Widget>[
          // Add the following code
          Localizations.override(
            context: context,
            locale: const Locale('es'),
            // Using a Builder to get the correct BuildContext.
            // Alternatively, you can create a new widget and Localizations.override
            // will pass the updated BuildContext to the new widget.
            child: Builder(
              builder: (context) {
                // A toy example for an internationalized Material widget.
                return CalendarDatePicker(
                  initialDate: DateTime.now(),
                  firstDate: DateTime(1900),
                  lastDate: DateTime(2100),
                  onDateChanged: (value) {},
                );
              },
            ),
          ),
        ],
      ),
    ),
  );
}

热重载应用,CalendarDatePicker 小组件应重新用西班牙语呈现。

添加您自己的本地化消息

添加 flutter_localizations 包后,您可以配置本地化。要向您的应用添加本地化文本,请完成以下说明

  1. 添加 intl 包作为依赖项,提取 flutter_localizations 固定下来的版本

    $ flutter pub add intl:any
    
  2. 打开 pubspec.yaml 文件并启用 generate 标志。此标志位于 pubspec 文件中的 flutter 部分。

    # The following section is specific to Flutter.
    flutter:
      generate: true # Add this line
  3. 向 Flutter 项目的根目录添加一个新的 yaml 文件。将此文件命名为 l10n.yaml 并包含以下内容

    arb-dir: lib/l10n
    template-arb-file: app_en.arb
    output-localization-file: app_localizations.dart

    此文件配置了本地化工具。在此示例中,您已执行以下操作

    • App Resource Bundle (.arb) 输入文件放入 ${FLUTTER_PROJECT}/lib/l10n 中。 .arb 为您的应用提供本地化资源。
    • 将英语模板设置为 app_en.arb
    • 告诉 Flutter 在 app_localizations.dart 文件中生成本地化内容。
  4. ${FLUTTER_PROJECT}/lib/l10n 中,添加 app_en.arb 模板文件。例如

    {
      "helloWorld": "Hello World!",
      "@helloWorld": {
        "description": "The conventional newborn programmer greeting"
      }
    }
  5. 在同一目录中添加另一个名为 app_es.arb 的捆绑文件。在此文件中,添加相同消息的西班牙语翻译。

    {
        "helloWorld": "¡Hola Mundo!"
    }
  6. 现在,运行 flutter pub getflutter run,codegen 会自动执行。您应该在 ${FLUTTER_PROJECT}/.dart_tool/flutter_gen/gen_l10n 中找到生成的文件。或者,您还可以运行 flutter gen-l10n 来生成相同的文件,而无需运行该应用。

  7. 在对 MaterialApp 的构造函数调用中添加对 app_localizations.dartAppLocalizations.delegate 的导入语句

    import 'package:flutter_gen/gen_l10n/app_localizations.dart';
    return const MaterialApp(
      title: 'Localizations Sample App',
      localizationsDelegates: [
        AppLocalizations.delegate, // Add this line
        GlobalMaterialLocalizations.delegate,
        GlobalWidgetsLocalizations.delegate,
        GlobalCupertinoLocalizations.delegate,
      ],
      supportedLocales: [
        Locale('en'), // English
        Locale('es'), // Spanish
      ],
      home: MyHomePage(),
    );

    AppLocalizations 类还提供了自动生成的 localizationsDelegatessupportedLocales 列表。您可以使用这些列表,而不是手动提供它们。

    const MaterialApp(
      title: 'Localizations Sample App',
      localizationsDelegates: AppLocalizations.localizationsDelegates,
      supportedLocales: AppLocalizations.supportedLocales,
    );
  8. Material 应用启动后,您可以在应用的任何位置使用 AppLocalizations

    appBar: AppBar(
      // The [AppBar] title text should update its message
      // according to the system locale of the target platform.
      // Switching between English and Spanish locales should
      // cause this text to update.
      title: Text(AppLocalizations.of(context)!.helloWorld),
    ),

此代码生成一个 Text 小组件,如果目标设备的语言环境设置为英语,则显示“Hello World!”;如果目标设备的语言环境设置为西班牙语,则显示“¡Hola Mundo!”。在 arb 文件中,每个条目的键用作 getter 的方法名,而该条目的值包含本地化消息。

gen_l10n_example 使用此工具。

要本地化设备应用说明,请将本地化字符串传递给 MaterialApp.onGenerateTitle

return MaterialApp(
  onGenerateTitle: (context) => DemoLocalizations.of(context).title,

占位符、复数和选择

您还可以在消息中包含应用程序值,这些值使用特殊语法,该语法使用占位符来生成方法,而不是 getter。占位符(必须是有效的 Dart 标识符名称)将成为 AppLocalizations 代码中生成方法中的位置参数。通过用大括号将其括起来定义占位符名称,如下所示

"{placeholderName}"

在应用的 .arb 文件中 placeholders 对象中定义每个占位符。例如,要使用 userName 参数定义 hello 消息,请将以下内容添加到 lib/l10n/app_en.arb

"hello": "Hello {userName}",
"@hello": {
  "description": "A message with a single parameter",
  "placeholders": {
    "userName": {
      "type": "String",
      "example": "Bob"
    }
  }
}

此代码片段向 AppLocalizations.of(context) 对象添加了一个 hello 方法调用,并且该方法接受类型为 String 的参数; hello 方法返回一个字符串。重新生成 AppLocalizations 文件。

将传递给 Builder 的代码替换为以下内容

// Examples of internationalized strings.
return Column(
  children: <Widget>[
    // Returns 'Hello John'
    Text(AppLocalizations.of(context)!.hello('John')),
  ],
);

您还可以使用数字占位符来指定多个值。不同的语言有不同的单词复数形式。该语法还支持指定单词的复数形式。复数消息必须包含一个 num 参数,指示如何在不同情况下对单词进行复数形式处理。例如,英语将“person”复数形式化为“people”,但这还不够。 message0 复数形式可能是“no people”或“zero people”。 messageFew 复数形式可能是“several people”、“some people”或“a few people”。 messageMany 复数形式可能是“most people”、“many people”或“a crowd”。只有更通用的 messageOther 字段是必需的。以下示例显示了可用的选项

"{countPlaceholder, plural, =0{message0} =1{message1} =2{message2} few{messageFew} many{messageMany} other{messageOther}}"

前一个表达式将替换为与 countPlaceholder 的值相对应的消息变体(message0message1、…)。仅需要 messageOther 字段。

以下示例定义了一个对单词“wombat”进行复数形式处理的消息

"nWombats": "{count, plural, =0{no wombats} =1{1 wombat} other{{count} wombats}}",
"@nWombats": {
  "description": "A plural message",
  "placeholders": {
    "count": {
      "type": "num",
      "format": "compact"
    }
  }
}

通过传入 count 参数使用复数方法

// Examples of internationalized strings.
return Column(
  children: <Widget>[
    ...
    // Returns 'no wombats'
    Text(AppLocalizations.of(context)!.nWombats(0)),
    // Returns '1 wombat'
    Text(AppLocalizations.of(context)!.nWombats(1)),
    // Returns '5 wombats'
    Text(AppLocalizations.of(context)!.nWombats(5)),
  ],
);

与复数形式类似,您还可以根据 String 占位符选择一个值。这通常用于支持按性别划分的语言。语法如下

"{selectPlaceholder, select, case{message} ... other{messageOther}}"

下一个示例定义了一个根据性别选择代词的消息

"pronoun": "{gender, select, male{he} female{she} other{they}}",
"@pronoun": {
  "description": "A gendered message",
  "placeholders": {
    "gender": {
      "type": "String"
    }
  }
}

通过将性别字符串作为参数传递使用此功能

// Examples of internationalized strings.
return Column(
  children: <Widget>[
    ...
    // Returns 'he'
    Text(AppLocalizations.of(context)!.pronoun('male')),
    // Returns 'she'
    Text(AppLocalizations.of(context)!.pronoun('female')),
    // Returns 'they'
    Text(AppLocalizations.of(context)!.pronoun('other')),
  ],
);

请记住,在使用 select 语句时,参数与实际值之间的比较区分大小写。也就是说,AppLocalizations.of(context)!.pronoun("Male") 默认情况下为“other”情况,并返回“they”。

转义语法

有时,您必须将令牌(例如 {})用作普通字符。要忽略此类令牌的解析,请通过将以下内容添加到 l10n.yaml 来启用 use-escaping 标志

use-escaping: true

解析器将忽略用一对单引号包装的任何字符字符串。要使用普通的单引号字符,请使用一对连续的单引号。例如,以下文本将转换为 Dart String

{
  "helloWorld": "Hello! '{Isn''t}' this a wonderful day?"
}

结果字符串如下

"Hello! {Isn't} this a wonderful day?"

包含数字和货币的消息

数字(包括表示货币值的数字)在不同的区域显示方式非常不同。flutter_localizations 中的本地化生成工具使用 intl 包中的 NumberFormat 类根据区域设置和所需的格式设置数字格式。

intdoublenumber 类型可以使用以下任何 NumberFormat 构造函数

消息“格式”值 1200000 的输出
紧凑 “120万”
紧凑货币* “120万美元”
紧凑简单货币* “120万美元”
紧凑长 “120万”
货币* “1,200,000.00美元”
十进制模式 “1,200,000”
十进制模式数字* “1,200,000”
十进制百分比模式* “120,000,000%”
百分比模式 “120,000,000%”
科学模式 “1E6”
简单货币* “$1,200,000”

表中带星号的 NumberFormat 构造函数提供可选的命名参数。这些参数可以指定为占位符的 optionalParameters 对象的值。例如,要为 compactCurrency 指定可选的 decimalDigits 参数,请对 lib/l10n/app_en.arg 文件进行以下更改

"numberOfDataPoints": "Number of data points: {value}",
"@numberOfDataPoints": {
  "description": "A message with a formatted int parameter",
  "placeholders": {
    "value": {
      "type": "int",
      "format": "compactCurrency",
      "optionalParameters": {
        "decimalDigits": 2
      }
    }
  }
}

带日期的消息

根据语言环境和应用需求,日期字符串以多种不同方式进行格式化。

类型为 DateTime 的占位符值使用 intl 包中的 DateFormat 进行格式化。

共有 41 种格式变体,由其 DateFormat 工厂构造函数的名称标识。在以下示例中,出现在 helloWorldOn 消息中的 DateTime 值使用 DateFormat.yMd 进行格式化

"helloWorldOn": "Hello World on {date}",
"@helloWorldOn": {
  "description": "A message with a date parameter",
  "placeholders": {
    "date": {
      "type": "DateTime",
      "format": "yMd"
    }
  }
}

在语言环境为美式英语的应用中,以下表达式将生成“7/9/1959”。在俄语语言环境中,它将生成“9.07.1959”。

AppLocalizations.of(context).helloWorldOn(DateTime.utc(1959, 7, 9))

针对 iOS 进行本地化:更新 iOS 应用包

通常,iOS 应用程序在内置于应用程序包中的 Info.plist 文件中定义关键的应用程序元数据,包括受支持的语言环境。要配置应用支持的语言环境,请使用以下说明

  1. 打开项目的 ios/Runner.xcworkspace Xcode 文件。

  2. 项目导航器中,打开 Runner 项目的 Runner 文件夹下的 Info.plist 文件。

  3. 选择信息属性列表项。然后从编辑器菜单中选择添加项,并从弹出菜单中选择本地化

  4. 选择并展开新创建的 本地化 项。对于应用程序支持的每种语言环境,添加新项,并从字段中的弹出菜单中选择要添加的语言环境。此列表应与 supportedLocales 参数中列出的语言一致。

  5. 添加完所有受支持的语言环境后,保存文件。

高级主题以作进一步自定义

本部分介绍自定义本地化 Flutter 应用程序的其他方法。

高级语言环境定义

某些具有多个变体的语言需要不仅仅是语言代码才能正确区分。

例如,要完全区分所有中文变体,需要指定语言代码、脚本代码和国家代码。这是因为存在简体和繁体脚本,以及在同一脚本类型中书写字符的方式存在区域差异。

为了完全表达国家代码 CNTWHK 的所有中文变体,受支持的语言环境列表应包括

supportedLocales: [
  Locale.fromSubtags(languageCode: 'zh'), // generic Chinese 'zh'
  Locale.fromSubtags(
      languageCode: 'zh',
      scriptCode: 'Hans'), // generic simplified Chinese 'zh_Hans'
  Locale.fromSubtags(
      languageCode: 'zh',
      scriptCode: 'Hant'), // generic traditional Chinese 'zh_Hant'
  Locale.fromSubtags(
      languageCode: 'zh',
      scriptCode: 'Hans',
      countryCode: 'CN'), // 'zh_Hans_CN'
  Locale.fromSubtags(
      languageCode: 'zh',
      scriptCode: 'Hant',
      countryCode: 'TW'), // 'zh_Hant_TW'
  Locale.fromSubtags(
      languageCode: 'zh',
      scriptCode: 'Hant',
      countryCode: 'HK'), // 'zh_Hant_HK'
],

这种明确的完整定义可确保您的应用能够区分这些国家代码的所有组合,并为其提供完全细致的本地化内容。如果未指定用户的首选语言环境,Flutter 会选择最接近的匹配项,该匹配项可能与用户期望的内容存在差异。Flutter 仅解析 supportedLocales 中定义的语言环境,并为常用语言提供按脚本代码区分的本地化内容。有关如何解析受支持的语言环境和首选语言环境的信息,请参阅 Localizations

虽然中文是一个主要示例,但其他语言(如法语 (fr_FRfr_CA))也应进行完全区分,以实现更加细致的本地化。

跟踪语言环境:Locale 类和 Localizations 小组件

Locale 类标识用户的语言。移动设备支持为所有应用程序设置语言环境,通常使用系统设置菜单。国际化应用程序通过显示特定于语言环境的值来响应。例如,如果用户将设备的语言环境从英语切换为法语,那么最初显示“Hello World”的 Text 小部件将使用“Bonjour le monde”重建。

Localizations 小部件定义其子项的语言环境和子项依赖的本地化资源。 WidgetsApp 小部件创建一个 Localizations 小部件,并在系统的语言环境发生变化时重建它。

您始终可以使用 Localizations.localeOf() 查找应用程序当前的语言环境

Locale myLocale = Localizations.localeOf(context);

指定应用程序的 supported­Locales 参数

尽管 flutter_localizations 库当前支持 115 种语言和语言变体,但默认情况下仅提供英语翻译。由开发人员决定具体支持哪些语言。

MaterialApp supportedLocales 参数限制语言环境更改。当用户更改其设备上的语言环境设置时,应用程序的 Localizations 小部件仅在新的语言环境是此列表中的成员时才随之更改。如果找不到与设备语言环境完全匹配的语言环境,则使用第一个具有匹配 languageCode 的受支持语言环境。如果失败,则使用 supportedLocales 列表的第一个元素。

希望使用不同的“语言环境解析”方法的应用程序可以提供 localeResolutionCallback。例如,让您的应用程序无条件接受用户选择的任何语言环境

MaterialApp(
  localeResolutionCallback: (
    locale,
    supportedLocales,
  ) {
    return locale;
  },
);

配置 l10n.yaml 文件

l10n.yaml 文件允许您配置 gen-l10n 工具,以指定以下内容

  • 所有输入文件所在的位置
  • 所有输出文件应创建的位置
  • 为本地化委托提供哪个 Dart 类名

有关选项的完整列表,请在命令行中运行 flutter gen-l10n --help 或参考下表

选项 说明
arb-dir 模板和翻译的 arb 文件所在的目录。默认值为 lib/l10n
output-dir 生成本地化类的目录。仅当您希望在 Flutter 项目的其他位置生成本地化代码时,此选项才相关。您还需要将 synthetic-package 标志设置为 false。

应用程序必须从该目录导入 output-localization-file 选项中指定的文件。如果未指定,则默认为 arb-dir 中指定的输入目录的同一目录。
template-arb-file 用作生成 Dart 本地化和消息文件的模板 arb 文件。默认值为 app_en.arb
output-localization-file 输出本地化和本地化委托类的文件名。默认值为 app_localizations.dart
untranslated-messages-file 描述尚未翻译的本地化消息的文件的位置。使用此选项会在目标位置创建 JSON 文件,格式如下

"locale": ["message_1", "message_2" ... "message_n"]

如果未指定此选项,则会在命令行上打印尚未翻译的消息的摘要。
output-class 用于输出本地化和本地化委托类的 Dart 类名。默认值为 AppLocalizations
preferred-supported-locales 应用程序首选支持的语言环境列表。默认情况下,该工具按字母顺序生成支持的语言环境列表。使用此标志可将默认值设为其他语言环境。

例如,传入 [ en_US ] 以在设备支持时默认使用美式英语。
header 要预置到生成的 Dart 本地化文件中的页眉。此选项采用字符串。

例如,传入 "/// All localized files." 以将此字符串预置到生成的 Dart 文件中。

或者,查看 header-file 选项以传入文本文件来获取更长的页眉。
header-file 要预置到生成的 Dart 本地化文件中的页眉。此选项的值是包含页眉文本的文件名,该文本插入到每个生成的 Dart 文件的顶部。

或者,查看 header 选项以传入字符串来获取更简单的页眉。

此文件应放置在 arb-dir 中指定的目录中。
[no-]use-deferred-loading 指定是否生成将区域设置导入为延迟的 Dart 本地化文件,从而允许在 Flutter Web 中延迟加载每个区域设置。

通过减小 JavaScript 捆绑包的大小,这可以减少 Web 应用程序的初始启动时间。当此标志设置为 true 时,特定区域设置的消息仅在 Flutter 应用程序需要时才下载和加载。对于包含大量不同区域设置和许多本地化字符串的项目,延迟加载可以提高性能。对于区域设置较少的项目,差异可以忽略不计,并且与将本地化与应用程序的其余部分捆绑在一起相比,可能会减慢启动速度。

请注意,此标志不会影响其他平台,例如移动或桌面。
gen-inputs-and-outputs-list 指定后,该工具将生成一个 JSON 文件,其中包含该工具的输入和输出,名为 gen_l10n_inputs_and_outputs.json

这对于跟踪在生成最新一组本地化时使用了 Flutter 项目的哪些文件很有用。例如,Flutter 工具的构建系统使用此文件来跟踪何时在热重载期间调用 gen_l10n。

此选项的值是生成 JSON 文件的目录。为 null 时,不会生成 JSON 文件。
synthetic-package 确定生成的输出文件是作为合成包生成,还是生成在 Flutter 项目中的指定目录中。此标志默认值为 true。当 synthetic-package 设置为 false 时,它会在 arb-dir 指定的目录中生成本地化文件(默认)。如果指定了 output-dir,则会在此处生成文件。
项目目录 指定时,该工具会将传递给此选项的路径用作根 Flutter 项目的目录。

为 null 时,将使用当前工作目录的相对路径。
[no-]required-resource-attributes 要求所有资源 ID 都包含相应的资源属性。

默认情况下,简单消息不需要元数据,但强烈建议使用元数据,因为这为读者提供了消息含义的上下文。

复数消息仍然需要资源属性。
[no-]nullable-getter 指定本地化类 getter 是否可为 null。

默认情况下,此值为 true,以便 Localizations.of(context) 返回一个可为 null 的值,以实现向后兼容性。如果此值为 false,则会对 Localizations.of(context) 的返回值执行 null 检查,从而无需在用户代码中执行 null 检查。
[no-]format 指定时,在生成本地化文件后运行 dart format 命令。
use-escaping 指定是否启用使用单引号作为转义语法。
[no-]suppress-warnings 指定时,将禁止所有警告。

Flutter 中的国际化工作原理

本部分介绍了 Flutter 中本地化的技术细节。如果您计划支持自己的一组本地化消息,以下内容将很有帮助。否则,您可以跳过本部分。

加载和检索本地化值

使用 Localizations 窗口小部件加载和查找包含本地化值集合的对象。应用通过 Localizations.of(context,type) 引用这些对象。如果设备的语言环境发生变化,Localizations 窗口小部件会自动加载新语言环境的值,然后重建使用它的窗口小部件。这是因为 Localizations 的工作原理类似于 InheritedWidget。当构建函数引用继承的窗口小部件时,将创建对继承的窗口小部件的隐式依赖关系。当继承的窗口小部件发生变化(当 Localizations 窗口小部件的语言环境发生变化时),其依赖的上下文将被重建。

本地化值由 Localizations 窗口小部件的 LocalizationsDelegate 列表加载。每个委托都必须定义一个异步 load() 方法,该方法生成一个封装本地化值集合的对象。通常,这些对象为每个本地化值定义一个方法。

在大型应用中,不同的模块或软件包可能使用自己的本地化进行捆绑。这就是 Localizations 窗口小部件管理一个对象表的原因,每个对象对应一个 LocalizationsDelegate。要检索 LocalizationsDelegateload 方法之一生成的对象,请指定 BuildContext 和对象类型。

例如,Material Components 窗口小部件的本地化字符串由 MaterialLocalizations 类定义。此类的实例由 MaterialApp 类提供的 LocalizationDelegate 创建。它们可以使用 Localizations.of() 检索

Localizations.of<MaterialLocalizations>(context, MaterialLocalizations);

此特定 Localizations.of() 表达式经常使用,因此 MaterialLocalizations 类提供了一个方便的简写

static MaterialLocalizations of(BuildContext context) {
  return Localizations.of<MaterialLocalizations>(context, MaterialLocalizations);
}

/// References to the localized values defined by MaterialLocalizations
/// are typically written like this:

tooltip: MaterialLocalizations.of(context).backButtonTooltip,

为应用的本地化资源定义一个类

将国际化的 Flutter 应用组合在一起通常从封装应用本地化值的类开始。以下示例是此类类的典型示例。

此应用的 intl_example 的完整源代码。

此示例基于 intl 软件包提供的 API 和工具。应用的本地化资源的备用类 部分介绍了 一个示例,该示例不依赖于 intl 软件包。

在以下代码片段中定义的 DemoLocalizations 类(包含应用字符串(示例中仅一个)翻译成应用支持的语言环境。它使用 Dart 的 intl 包生成的 initializeMessages() 函数,Intl.message(),来查找它们。

class DemoLocalizations {
  DemoLocalizations(this.localeName);

  static Future<DemoLocalizations> load(Locale locale) {
    final String name =
        locale.countryCode == null || locale.countryCode!.isEmpty
            ? locale.languageCode
            : locale.toString();
    final String localeName = Intl.canonicalizedLocale(name);

    return initializeMessages(localeName).then((_) {
      return DemoLocalizations(localeName);
    });
  }

  static DemoLocalizations of(BuildContext context) {
    return Localizations.of<DemoLocalizations>(context, DemoLocalizations)!;
  }

  final String localeName;

  String get title {
    return Intl.message(
      'Hello World',
      name: 'title',
      desc: 'Title for the Demo application',
      locale: localeName,
    );
  }
}

基于 intl 包的类导入生成的 message catalog,该 catalog 提供 initializeMessages() 函数和 Intl.message() 的按语言环境存储的后备存储。message catalog 由 intl 工具 生成,该工具分析包含 Intl.message() 调用的类的源代码。在这种情况下,这仅仅是 DemoLocalizations 类。

添加对新语言的支持

需要支持 GlobalMaterialLocalizations 中未包含的语言的应用必须执行一些额外工作:它必须为语言环境的单词或短语以及日期模式和符号提供大约 70 个翻译(“本地化”)。

请参阅以下内容,了解如何添加对挪威新挪威语语言的支持的示例。

一个新的 GlobalMaterialLocalizations 子类定义 Material 库所依赖的本地化。还必须定义一个新的 LocalizationsDelegate 子类,该子类用作 GlobalMaterialLocalizations 子类的工厂。

以下是完整 add_language 示例的源代码,减去实际的新挪威语翻译。

特定于语言环境的 GlobalMaterialLocalizations 子类称为 NnMaterialLocalizations,而 LocalizationsDelegate 子类为 _NnMaterialLocalizationsDelegateNnMaterialLocalizations.delegate 的值为委托实例,并且是使用这些本地化的应用程序所需的一切。

委托类包括基本日期和数字格式本地化。所有其他本地化均由 NnMaterialLocalizations 中的 String 值属性 getter 定义,如下所示

@override
String get moreButtonTooltip => r'More';

@override
String get aboutListTileTitleRaw => r'About $applicationName';

@override
String get alertDialogLabel => r'Alert';

当然,这些是英语翻译。要完成这项工作,您需要将每个 getter 的返回值更改为适当的挪威语新挪威语字符串。

getter 返回具有 r 前缀的“原始”Dart 字符串,例如 r'About $applicationName',因为有时字符串包含带有 $ 前缀的变量。这些变量由参数化本地化方法扩展

@override
String get pageRowsInfoTitleRaw => r'$firstRow–$lastRow of $rowCount';

@override
String get pageRowsInfoTitleApproximateRaw =>
    r'$firstRow–$lastRow of about $rowCount';

还需要指定语言环境的日期模式和符号,它们在源代码中定义如下

const nnLocaleDatePatterns = {
  'd': 'd.',
  'E': 'ccc',
  'EEEE': 'cccc',
  'LLL': 'LLL',
  // ...
}
const nnDateSymbols = {
  'NAME': 'nn',
  'ERAS': <dynamic>[
    'f.Kr.',
    'e.Kr.',
  ],
  // ...
}

需要修改这些值以使语言环境使用正确的日期格式。遗憾的是,由于 intl 库不具有相同的数字格式灵活性,因此必须在 _NnMaterialLocalizationsDelegate 中使用现有语言环境的格式作为替代

class _NnMaterialLocalizationsDelegate
    extends LocalizationsDelegate<MaterialLocalizations> {
  const _NnMaterialLocalizationsDelegate();

  @override
  bool isSupported(Locale locale) => locale.languageCode == 'nn';

  @override
  Future<MaterialLocalizations> load(Locale locale) async {
    final String localeName = intl.Intl.canonicalizedLocale(locale.toString());

    // The locale (in this case `nn`) needs to be initialized into the custom
    // date symbols and patterns setup that Flutter uses.
    date_symbol_data_custom.initializeDateFormattingCustom(
      locale: localeName,
      patterns: nnLocaleDatePatterns,
      symbols: intl.DateSymbols.deserializeFromMap(nnDateSymbols),
    );

    return SynchronousFuture<MaterialLocalizations>(
      NnMaterialLocalizations(
        localeName: localeName,
        // The `intl` library's NumberFormat class is generated from CLDR data
        // (see https://github.com/dart-lang/i18n/blob/main/pkgs/intl/lib/number_symbols_data.dart).
        // Unfortunately, there is no way to use a locale that isn't defined in
        // this map and the only way to work around this is to use a listed
        // locale's NumberFormat symbols. So, here we use the number formats
        // for 'en_US' instead.
        decimalFormat: intl.NumberFormat('#,##0.###', 'en_US'),
        twoDigitZeroPaddedFormat: intl.NumberFormat('00', 'en_US'),
        // DateFormat here will use the symbols and patterns provided in the
        // `date_symbol_data_custom.initializeDateFormattingCustom` call above.
        // However, an alternative is to simply use a supported locale's
        // DateFormat symbols, similar to NumberFormat above.
        fullYearFormat: intl.DateFormat('y', localeName),
        compactDateFormat: intl.DateFormat('yMd', localeName),
        shortDateFormat: intl.DateFormat('yMMMd', localeName),
        mediumDateFormat: intl.DateFormat('EEE, MMM d', localeName),
        longDateFormat: intl.DateFormat('EEEE, MMMM d, y', localeName),
        yearMonthFormat: intl.DateFormat('MMMM y', localeName),
        shortMonthDayFormat: intl.DateFormat('MMM d'),
      ),
    );
  }

  @override
  bool shouldReload(_NnMaterialLocalizationsDelegate old) => false;
}

有关本地化字符串的更多信息,请查看 flutter_localizations 自述文件

一旦您实现了 GlobalMaterialLocalizationsLocalizationsDelegate 的特定于语言的子类,您需要将语言和委托实例添加到您的应用程序。以下代码将应用程序的语言设置为新挪威语,并将 NnMaterialLocalizations 委托实例添加到应用程序的 localizationsDelegates 列表

const MaterialApp(
  localizationsDelegates: [
    GlobalWidgetsLocalizations.delegate,
    GlobalMaterialLocalizations.delegate,
    NnMaterialLocalizations.delegate, // Add the newly created delegate
  ],
  supportedLocales: [
    Locale('en', 'US'),
    Locale('nn'),
  ],
  home: Home(),
),

其他国际化工作流

本部分介绍了国际化 Flutter 应用程序的不同方法。

应用程序本地化资源的替代类

前面的示例是根据 Dart intl 包定义的。你可以选择自己的方法来管理本地化值,以简化操作或与不同的 i18n 框架集成。

minimal 应用程序的完整源代码。

在以下示例中,DemoLocalizations 类直接在其语言映射中包含所有翻译

class DemoLocalizations {
  DemoLocalizations(this.locale);

  final Locale locale;

  static DemoLocalizations of(BuildContext context) {
    return Localizations.of<DemoLocalizations>(context, DemoLocalizations)!;
  }

  static const _localizedValues = <String, Map<String, String>>{
    'en': {
      'title': 'Hello World',
    },
    'es': {
      'title': 'Hola Mundo',
    },
  };

  static List<String> languages() => _localizedValues.keys.toList();

  String get title {
    return _localizedValues[locale.languageCode]!['title']!;
  }
}

在 minimal 应用程序中,DemoLocalizationsDelegate 略有不同。它的 load 方法返回 SynchronousFuture,因为无需进行异步加载。

class DemoLocalizationsDelegate
    extends LocalizationsDelegate<DemoLocalizations> {
  const DemoLocalizationsDelegate();

  @override
  bool isSupported(Locale locale) =>
      DemoLocalizations.languages().contains(locale.languageCode);

  @override
  Future<DemoLocalizations> load(Locale locale) {
    // Returning a SynchronousFuture here because an async "load" operation
    // isn't needed to produce an instance of DemoLocalizations.
    return SynchronousFuture<DemoLocalizations>(DemoLocalizations(locale));
  }

  @override
  bool shouldReload(DemoLocalizationsDelegate old) => false;
}

使用 Dart intl 工具

在使用 Dart intl 包构建 API 之前,请查看 intl 包的文档。以下列表总结了依赖于 intl 包的应用程序的本地化流程

演示应用程序依赖于名为 l10n/messages_all.dart 的生成源文件,该文件定义了应用程序使用的所有可本地化字符串。

重新构建 l10n/messages_all.dart 需要两个步骤。

  1. 以应用程序的根目录作为当前目录,从 lib/main.dart 生成 l10n/intl_messages.arb

    $ dart run intl_translation:extract_to_arb --output-dir=lib/l10n lib/main.dart
    

    intl_messages.arb 文件是一个 JSON 格式的映射,其中每条 Intl.message() 函数在 main.dart 中定义一个条目。此文件用作英语和西班牙语翻译的模板,intl_en.arbintl_es.arb。这些翻译由你(开发者)创建。

  2. 以应用程序的根目录作为当前目录,为每个 intl_<locale>.arb 文件生成 intl_messages_<locale>.dart,以及导入所有消息文件的 intl_messages_all.dart

    $ dart run intl_translation:generate_from_arb \
        --output-dir=lib/l10n --no-use-deferred-loading \
        lib/main.dart lib/l10n/intl_*.arb
    

    Windows 不支持文件名通配符。相反,列出由 intl_translation:extract_to_arb 命令生成的 .arb 文件。

    $ dart run intl_translation:generate_from_arb \
        --output-dir=lib/l10n --no-use-deferred-loading \
        lib/main.dart \
        lib/l10n/intl_en.arb lib/l10n/intl_fr.arb lib/l10n/intl_messages.arb
    

    DemoLocalizations 类使用生成的 initializeMessages() 函数(在 intl_messages_all.dart 中定义)加载本地化消息,并使用 Intl.message() 查找它们。

更多信息

如果您通过阅读代码学习效果最好,请查看以下示例。

如果您不熟悉 Dart 的 intl 包,请查看 使用 Dart intl 工具