Flutter国际化与数据转换插件intl_converter的使用

intl_converter #

一个帮助你在 Flutter 中管理国际化字符串的工具库，包括将 Android 的 "strings-xx.xml" 转换为 Flutter 的 arb 文件。在使用之前，你需要了解什么是 LocalizationsDelegate 和 intl_translation。

Flutter 使用 arb 文件来管理国际化字符串。有时候你可能需要重构一个旧的 Android 项目并将其转换为 Flutter。

intl_converter 可以帮助你将 Android 的 strings-xx.xml 文件转换为 Flutter 的 arb 文件，并自动生成包含所有定义字符串的 Dart 类。你只需要扩展该 Dart 类并注册它到 LocalizationsDelegate 中即可。

Flutter 的国际化参考： [https://github.com/flutter/website/tree/master/examples/internationalization/intl_example/lib](https://github.com/flutter/website/tree/master/examples/internationalization/intl_example/lib)

安装 #

dev_dependencies:
  intl_converter: version

使用构建参数 #

--scan-dir      扫描 Android 风格 strings-xx.xml 文件的路径
--out-dir       ARB 和 Dart 文件的输出路径
--gen-class     自动生成的 Dart 类名
--file-name     自动生成的 Dart 文件名，默认为："strings_define.dart"（默认值为 "strings_define.dart"）
--dev-locale    使用哪种语言环境的内容生成默认的 Dart 类

构建命令：

flutter packages pub run intl_converter:build --scan-dir=xx --out-dir=yy --gen-class=zz

使用 JSON 配置文件 'intl_converter.json' #

{
  "scan-dir": "assets/i18n",
  "out-dir": "lib/i18n/gen",
  "gen-class": "AppStringsDefine",
  "dev-locale": "zh"
}

构建命令：

flutter packages pub run intl_converter:build

example/lib/main.dart

import 'package:flutter/material.dart';
import 'i18n/app_strings.dart'; // 导入自动生成的字符串类
import 'package:flutter_localizations/flutter_localizations.dart';

void main() => runApp(MyApp());

class MyApp extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    Locale defLocale = Locale('en', ''); // 默认语言环境为英语
    return MaterialApp(
      localizationsDelegates: [
        const AppStringsDelegate(), // 注册自动生成的本地化代理
        GlobalMaterialLocalizations.delegate,
        GlobalWidgetsLocalizations.delegate
      ],
      locale: defLocale, // 设置默认语言环境
      supportedLocales: AppStrings.createSupportedLocale(false), // 支持的语言列表
      onGenerateTitle: (BuildContext context) => AppStrings.of(context).appTitle, // 动态获取标题
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: MyHomePage(defLocale), // 主页面
    );
  }
}

class MyHomePage extends StatefulWidget {
  final Locale locale;
  MyHomePage(this.locale, {Key key}) : super(key: key);

  [@override](/user/override)
  _MyHomePageState createState() => _MyHomePageState(locale); // 初始化状态
}

class _MyHomePageState extends State<MyHomePage> {
  int _counter = 0; // 计数器
  Locale _locale; // 当前语言环境

  _MyHomePageState(this._locale);

  void _incrementCounter() {
    setState(() {
      _counter++; // 增加计数器
    });
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    var scaffold = Scaffold(
      appBar: AppBar(
        title: Text(AppStrings.of(context).appTitle), // 动态设置标题
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: <Widget>[
            Text(
              AppStrings.of(context).pushedTitle, // 动态设置按钮文字
            ),
            Text(
              '$_counter',
              style: Theme.of(context).textTheme.headline3,
            ),
            ElevatedButton(
              onPressed: () {
                // 切换语言环境
                Locale nextLocale;
                if (_locale.languageCode == 'en') {
                  nextLocale = Locale('zh', ''); // 切换到中文
                } else {
                  nextLocale = Locale('en', ''); // 切换到英文
                }
                AppStrings.load(nextLocale).then((_) {
                  setState(() {
                    _locale = nextLocale; // 更新当前语言环境
                  });
                });
              },
              child: Text(AppStrings.of(context).changeLocale), // 动态设置切换语言按钮的文字
            )
          ],
        ),
      ),
      floatingActionButton: FloatingActionButton(
        onPressed: _incrementCounter, // 点击时增加计数器
        tooltip: AppStrings.of(context).increment, // 提示信息
        child: Icon(Icons.add),
      ),
    );
    return Localizations.override( // 强制覆盖当前上下文的语言环境
      context: context,
      child: scaffold,
      locale: _locale,
    );
  }
}