原文链接：https://www.didierboelens.com/2018/04/internationalization—make-an-flutter-application-multi-lingual/
这篇文章介绍了一种让你的Flutter App支持多语言的方法，用户可以选择一种不同于手机设置中设置的语言。
难度：中等
前言
国际化已经被讨论了很多次了，官方关于国际化的文档可以看 这里。因为想要理解国际化的概念，同时满足我的项目需要，我决定写下这篇文章来分享我的经验，也希望可以给你们一些提示。
需求
- 默认情况下，工作语言是在手机的系统设置中配置的。
- 如果App不支持设置的语言，那么默认值为“en”。
- 翻译文件被当作资源文件（asset）存放在Json文件“language specific”中。
- 用户可以从支持的语言列表中选择另一种工作语言。
- 当用户选择来另一种工作语言时，为了展示最新选择的语言，整个App布局刷新。
内部依赖
Flutter本身就支持地区化（即Locale的概念），Locale类的languageCode用来判断用户所使用的语言。
使用这个地区化的包，需要用到flutter_localizations包，我们在pubspec.yaml文件中添加如下依赖内容：
dependencies:
flutter:
sdk: flutter
flutter_localizations:
sdk: flutter
我们保存pubspec.yaml文件，编译器会提示你load/import这个新依赖。
翻译文件
下一步就是创建翻译文件，然后将它们定义为资源文件（asset）。
根据我以前开发网站的经验，我将这些资源文件存放在名为“/locale”的文件夹下，命名惯例为“i18n_{lang}.json”，在这篇文章中我也使用这些规则。
我们新建一个和“/lib”同级别的文件夹“/locale”，然后在这个文件夹中新建两个文件，分别为“i18n_en.json” 和“ i18n_fr.json”。
文件夹树现在是这个样子的：
MyApplication
|
+- android
+- build
+- images
+- ios
+- lib
+- locale
|
+- i18n_en.json
+- i18n_fr.json
+- test
接下来我们需要将这两个文件设置为资源文件的一部分，编辑pubspec.yaml文件，然后将它们都添加进assets部分：
dependencies:
flutter:
sdk: flutter
flutter_localizations:
sdk: flutter
flutter:
assets:
- locale/i18n_en.json
- locale/i18n_fr.json
实现
现在我们可以开始实现我们的需求了。
首先在 main.dart 中初始化App的地方添加相关配置：
import 'package:flutter/material.dart';
import 'package:flutter_localizations/flutter_localizations.dart'; // 导入flutter的包
import 'translations.dart'; // 导入我们自定义的处理翻译逻辑的包（后面会讲）
void main() => runApp(new MyApp());
class MyApp extends StatelessWidget {
// This widget is the root of your application.
@override
Widget build(BuildContext context) {
return new MaterialApp(
title: 'My Application',
theme: new ThemeData(
primarySwatch: Colors.blue,
),
localizationsDelegates: [ // 提供地区数据和默认的文字布局
const TranslationsDelegate(), // 指向默认的处理翻译逻辑的库（后面会讲）
GlobalMaterialLocalizations.delegate,
GlobalWidgetsLocalizations.delegate,
],
supportedLocales: [ // 支持的语言列表
const Locale('en', ''),
const Locale('fr', ''),
],
home: new Scaffold(
appBar: new AppBar(
title: new Text('My Title'),
),
body: new Container(
),
),
);
}
}
接着我们看下处理翻译的自定义库 translations.dart。
在 /lib 目录下新建一个translations.dart文件：
import 'dart:async';
import 'dart:convert';
import 'package:flutter/material.dart';
import 'package:flutter/services.dart' show rootBundle;
/// 自定义的Translations类
class Translations {
Translations(Locale locale) {
this.locale = locale;
_localizedValues = null;
}
Locale locale;
static Map<dynamic, dynamic> _localizedValues;
static Translations of(BuildContext context){
return Localizations.of<Translations>(context, Translations);
}
String text(String key) {
return _localizedValues[key] ?? '** $key not found';
}
static Future<Translations> load(Locale locale) async {
Translations translations = new Translations(locale);
String jsonContent = await rootBundle.loadString("locale/i18n_${locale.languageCode}.json");
_localizedValues = json.decode(jsonContent);
return translations;
}
get currentLanguage => locale.languageCode;
}
/// 自定义的localization代表，它的作用是在验证支持的语言前，初始化我们的自定义Translations类
class TranslationsDelegate extends LocalizationsDelegate<Translations> {
const TranslationsDelegate();
@override
bool isSupported(Locale locale) => ['en','fr'].contains(locale.languageCode);
@override
Future<Translations> load(Locale locale) => Translations.load(locale);
@override
bool shouldReload(TranslationsDelegate old) => false;
}
这个类的主要目的有：
- 当TranslationsDelegate初始化时，这个类会接收一个用于翻译的Locale。在第一次初始化的时候，Locale被当作参数传递给构造函数，这个Locale就是手机设置中的地区信息。
- 构造器简单记忆Locale信息，然后重置保存了Locale.languageCode的Map。
- TranslationsDelegate中的call()方法初始化了一个新的Translations类实例，加载i18n_{language}.json文件中的内容，同时将Json数据转化为Map，然后 返回一个新的类实例。
- Translations of(BuildContext context)返回了这个类实例的指针，当我们需要获取一串特定字符串的翻译的时候会用到它（后面会讲到）。
- text(String key)用来返回一串特定字符串的翻译，以Map的内容为基础（后面会讲到）。
- currentLanguage是一个getter，返回当前使用的语言。
i18n_{language}.json文件的结构
因为都是Json文件，所以需要遵循Json文件的语法规则。文件包含一系列的键值对(i18n_en.json)：
{
"app_title": "My Application Title",
"main_title": "My Main Title"
}
i18n_fr.json:
{
"app_title": "Le titre de mon application",
"main_title": "Mon titre principal"
}
如何获取翻译
获取翻译时，传递context和你想要翻译的值给方法Translations.of(context).text(”)：
@override
Widget build(BuildContext context) {
return new Scaffold(
appBar: new AppBar(
title: new Text(Translations.of(context).text('main_title')),
...
如何自动改变工作语言
我们现在知道类如何定义语言、翻译和使用翻译，那么我们怎么让用户去选择工作语言呢？
当用户选择了另一种工作语言的时候，我们需要一个办法去刷新整个App的布局，所以我们需要让我们的App去处理setState()。
我们新建一个文件application.dart，这个文件有两个目的：保存应用设置和分享globals：
typedef void LocaleChangeCallback(Locale locale);
class APPLIC {
// 支持的语言列表
final List<String> supportedLanguages = ['en','fr'];
// 支持的Locales列表
Iterable<Locale> supportedLocales() => supportedLanguages.map<Locale>((lang) => new Locale(lang, ''));
// 当语言改变时调用的方法
LocaleChangeCallback onLocaleChanged;
///
/// Internals
///
static final APPLIC _applic = new APPLIC._internal();
factory APPLIC(){
return _applic;
}
APPLIC._internal();
}
APPLIC applic = new APPLIC();
这是一个自初始化（self-initializing）的类，每次导入的都是同一个实例。
现在我们可以让我们的App变得可刷新：
import 'package:flutter/material.dart';
import 'package:flutter_localizations/flutter_localizations.dart';
import 'translations.dart';
import 'application.dart';
void main() => runApp(new MyApp());
/// 将App设置为Stateful，这让它可以响应刷新事件，调用应用的SetState()
class MyApp extends StatefulWidget {
@override
_MyAppState createState() => new _MyAppState();
}
class _MyAppState extends State<MyApp> {
SpecificLocalizationDelegate _localeOverrideDelegate;
@override
void initState(){
super.initState();
/// 初始化一个新的Localization Delegate，有了它，当用户选择一种新的工作语言时，可以强制初始化一个新的Translations
_localeOverrideDelegate = new SpecificLocalizationDelegate(null);
/// 保存这个方法的指针，当用户改变语言时，我们可以调用applic.onLocaleChanged(new Locale('en',''));，通过SetState()我们可以强制App整个刷新
applic.onLocaleChanged = onLocaleChange;
}
/// 改变语言时的应用刷新核心，每次选择一种新的语言时，都会创造一个新的SpecificLocalizationDelegate实例，强制Translations类刷新。
onLocaleChange(Locale locale){
setState((){
_localeOverrideDelegate = new SpecificLocalizationDelegate(locale);
});
}
// This widget is the root of your application.
@override
Widget build(BuildContext context) {
return new MaterialApp(
title: 'My Application',
theme: new ThemeData(
primarySwatch: Colors.blue,
),
localizationsDelegates: [
_localeOverrideDelegate, // 注册一个新的delegate
const TranslationsDelegate(),
GlobalMaterialLocalizations.delegate,
GlobalWidgetsLocalizations.delegate,
],
supportedLocales: applic.supportedLocales(), // 我们有了一个全局的APPLIC类来存放设置
home: new MyHomePage(),
);
}
}
class MyHomePage extends StatefulWidget {
_MyHomePageState createState() => new _MyHomePageState();
}
class _MyHomePageState extends State<MyHomePage>{
@override
Widget build(BuildContext context){
return new Scaffold(
appBar: new AppBar(
title: new Text(Translations.of(context).text('main_title')), // 试着使用下翻译库
),
body: new Container(),
);
}
}
我们还需要改变下Translations.dart文件（最终版）：
import 'dart:async';
import 'dart:convert';
import 'package:flutter/material.dart';
import 'package:flutter/services.dart' show rootBundle;
import 'application.dart';
class Translations {
Translations(Locale locale) {
this.locale = locale;
_localizedValues = null;
}
Locale locale;
static Map<dynamic, dynamic> _localizedValues;
static Translations of(BuildContext context){
return Localizations.of<Translations>(context, Translations);
}
String text(String key) {
return _localizedValues[key] ?? '** $key not found';
}
static Future<Translations> load(Locale locale) async {
Translations translations = new Translations(locale);
String jsonContent = await rootBundle.loadString("locale/i18n_${locale.languageCode}.json");
_localizedValues = json.decode(jsonContent);
return translations;
}
get currentLanguage => locale.languageCode;
}
class TranslationsDelegate extends LocalizationsDelegate<Translations> {
const TranslationsDelegate();
/// 改这里是为了不硬编码支持的语言
@override
bool isSupported(Locale locale) => applic.supportedLanguages.contains(locale.languageCode);
@override
Future<Translations> load(Locale locale) => Translations.load(locale);
@override
bool shouldReload(TranslationsDelegate old) => false;
}
/// Delegate类的实现，每次选择一种新的语言时，强制初始化一个新的Translations类
class SpecificLocalizationDelegate extends LocalizationsDelegate<Translations> {
final Locale overriddenLocale;
const SpecificLocalizationDelegate(this.overriddenLocale);
@override
bool isSupported(Locale locale) => overriddenLocale != null;
@override
Future<Translations> load(Locale locale) => Translations.load(overriddenLocale);
@override
bool shouldReload(LocalizationsDelegate<Translations> old) => true;
}
如何应用工作语言的改变
接下来的内容是锦上添花。为了强制切换另一种工作语言，只需要一行代码，可以在App的任何地方调用：
applic.onLocaleChanged(new Locale('fr',''));
多亏了全局的applic实例，我们可以调用Main App中的onLocaleChange方法，这个方法会新建一个Delegate实例，Delegate实例又会强制新建一个使用了新语言的Translations类实例。
接下来，整个App将会被刷新。
写在最后
我知道肯定还有其他的实现方法，可能实现的比我更好。这篇文章的目的是分享一种对我来说有用的解决方法，希望可以帮到其他人。
