Flutter多语言实践

Flutter的多语言文档 英文版 中文版

官方流程

简单来讲，流程图如下
简单讲一下整个流程

1. 我们先写一个AppStrings.dart，这个文件是整个多语言的核心，生成和使用都需要这个文件。在这个文件里可以定义获得文本的api，比如

String order_list_waiting_for_review() => Intl.message(
        'Waiting for the review',
        name: "order_list_waiting_for_review",
          locale: _localeName
      );

其中，方法名和name必须保持一致（不要问我为何会有这种坑爹要求）。'Waiting for the review'是默认文案，locale是当前的locale。
这样定义的话，可以用下面的方式获得文本

String text = AppStrings.of(context).order_list_waiting_for_review();
// text == "Waiting for the review"

很好理解，AppStrings.of(context)就是通过context获得对应的locale的AppStrings，进而获得对应的文案。

1. 在上面以那种格式定义后，我们可以执行下面这个命令把AppStrings.dart生成intl_messages.arb

flutter pub pub run intl_translation:extract_to_arb --output-dir=lib/l10n lib/app_strings.dart

*.arb是个中间产物，其内就是JSON文本。其实会有更多附加信息，描述这个文本，不过在此省略。

{
  "order_list_waiting_for_review": "Waiting for the review",
}

1. 生成的arb文件只是一种语言的，我们可以把它拷贝成N种语言对应的文件，比如intl_en.arb,intl_es.arb等，并把内容的value都替换成对应语言的文案。
2. 然后再执行下面这个命令，生成messages_*.dart

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

可以看到，作为入参的是lib/app_strings.dart和lib/l10n/intl_*.arb，flutter工具党确保lib/app_strings.dart中的方法名、方法中的name参数，和lib/l10n/intl_*.arb中的json的key一致的时候，才会在生成的messages_*.dart文件中加入对应的文案，缺一不可。

我们再回过头来看这段代码

String order_list_waiting_for_review() => Intl.message(
        'Waiting for the review',
        name: "order_list_waiting_for_review",
          locale: _localeName
      );

Intl.message()方法实际上是根据locale获取对应的message_*.dart文件，然后再通过name找到对应的文案返回。

1. 当然，还需要对MaterialApp定义localizationsDelegates本地化代理和supportedLocales支持的多语言，这部分在文章最开始的文档里写的很详细了，就不再赘述了。

官方方案的问题

官方的方案虽然很长很繁琐，但还是可以实现多语言的功能的，只是对于我们来讲，它存在以下几个问题：

1. 需要在AppStrings.dart中定义文本获得的方法，一个文本就需要定义一个方法，并且方法名和name必须一致才能和arb文件一起生成最后的dart文件。一个文案对应一个方法，代码写起来很冗余，并且不利于文案的枚举使用（比如文案的key之间有关系）。和native开发之前的习惯也不同。使用和生成的逻辑放到一起，倘若有几千个文案，AppStrings.dart估计要爆表。
2. 流程太长，不利于自动化下载语言的脚本的实现。

我们的流程

起点的i18n.py是我们自己写的python脚本，一共有两个作用

1. 从美杜莎（阿里国际化文案管理平台）上获得多语言文案，并重命名成arb文件。

前面说到，arb文件其实是json格式的，美杜莎支持以json格式导出文本，所以我们做的只是重命名，不需要对内容进行更改。

1. 在arb文件处理好后，会拿默认的（英语）文本去生成一个dart文件，这个dart文件只用来作为中间产物，不会被其他dart使用的。
   其中只包含如下内容

import 'package:intl/intl.dart';

class MessagesIndex {
  String order_list_waiting_for_review() => Intl.message(
        'Waiting for the review',
        name: "order_list_waiting_for_review",
      );
  // ......
}

那么，我们继续调用生成最终产物的命令行

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

发现文件以及其内的文案已经被正确生成了。

调用方式

我之所以这样更改流程，其实只有两个目的：

1. 可以像读map一样的读取多语言文案，而不是像调用方法那样去读取。
2. 拉取、生成多语言文案的过程可以自动化。
   通过上面一顿操作，生成文案的工作都被自动化搞定了，那我们只需要在AppStrings.dart中添加一个方法，传入name，传出想要的多语言文案即可：

class AppStrings {
  final String _localeName;

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

  // AppStrings.of(context).str(stringKey)
  String str(String name) {
    return Intl.message(name, name: name, locale: _localeName);
  }

  // 重写操作符，减少代码量
  // AppStrings.of(context)[stringKey]
  operator [](String messageName) => str(messageName);

}