Flutter国际化消息插件intl_messages的使用

Flutter国际化消息插件intl_messages的使用

intl_messages 是一个简单且易于使用的库，用于实现Flutter应用的消息国际化和本地化（I18N）。它支持按包/模块组织消息、动态加载消息资源文件、全局通知语言环境变化以及注册/发现本地化消息。此外，它还提供了翻译工具，包括与OpenAI和ChatGPT的集成。

主要特性

• 按包/模块组织消息：可以将不同的消息文件组织在不同的包或模块中。
• 动态加载消息资源文件：可以根据当前的语言环境动态加载相应的消息文件。
• 全局通知语言环境变化：当语言环境发生变化时，会触发全局通知。
• 注册/发现本地化消息：自动发现并注册本地化消息文件。
• 翻译工具：支持与OpenAI和ChatGPT集成，帮助进行翻译。

使用示例

1. 创建国际化文件

首先，创建两个国际化文件，分别对应英语和法语：

• msgs-en.intl (英文):

  hello=Hello world! ## A description of the key.
  

• msgs-fr.intl (法文):

  hello=Bonjour le monde!
  

2. Dart代码示例

接下来，在Dart代码中使用这些国际化文件：

import 'package:intl_messages/intl_messages.dart';

void main() async {
  // 创建一个IntlMessages实例，指定包名为"demo"
  var messages = IntlMessages.package("demo");

  // 创建一个资源发现器，指定消息文件的路径和扩展名
  IntlResourceDiscover discover = IntlResourceDiscover("assets/msgs-", ".intl");

  // 注册资源发现器，默认语言环境为'en'
  await messages.registerResourceDiscover(discover); // 默认语言环境: 'en'，发现: assets/msgs-en.intl

  // 获取消息构建器
  MessageBuilder msgHello = messages.msg("hello");

  // 打印消息
  print(msgHello.build()); // 输出: Hello world!

  // 设置语言环境为'fr'
  await messages.setLocale('fr'); // 语言环境设置为: 'fr'，发现: assets/msgs-fr.intl

  // 再次打印消息
  print(msgHello.build()); // 输出: Bonjour le monde!
}

3. 复数形式的使用

intl_messages 支持复数形式的消息。你可以在国际化文件中使用 {...} 块来定义复数条件，如 zero、one、two 和 many，并指定相应的变量名。

• msgs-en.intl (英文):

  total_emails={zero[n]:No e-mails for $user.|one[n]:One e-mail for $user.|two[n]:A pair of e-mails for $user.|many[n]:Received $n e-mails for $user.}
  

• Dart代码示例：

  import 'package:intl_messages/intl_messages.dart';
  
  void main() async {
    // 创建一个IntlMessages实例，指定包名为"demo-plural"
    var messages = IntlMessages.package("demo-plural");
  
    // 创建一个资源发现器，指定消息文件的路径和扩展名
    IntlResourceDiscover discover = IntlResourceDiscover("assets/msgs-", ".intl");
  
    // 注册资源发现器，默认语言环境为'en'
    await messages.registerResourceDiscover(discover); // 默认语言环境: 'en'，发现: assets/msgs-en.intl
  
    // 获取消息构建器
    MessageBuilder msgEmail = messages.msg("total_emails");
  
    // 打印不同数量的邮件消息
    print(msgEmail.build({'n': 0, 'user': 'john@mail.com'})); // 输出: No e-mails for john@mail.com.
    print(msgEmail.build({'n': 1, 'user': 'john@mail.com'})); // 输出: One e-mail for john@mail.com.
    print(msgEmail.build({'n': 2, 'user': 'john@mail.com'})); // 输出: A pair of e-mails for john@mail.com.
    print(msgEmail.build({'n': 8, 'user': 'john@mail.com'})); // 输出: Received 8 e-mails for john@mail.com.
  }
  

CLI工具

intl_messages 还提供了一个命令行工具，可以帮助你检查、格式化和修复 .intl 文件。以下是几个常用的命令：

• 检查 .intl 文件：

  intl_messages check --ref msgs-en.intl -f msgs-fr.intl
  

• 格式化 .intl 文件：

  intl_messages format --ref msgs-en.intl -f msgs-fr.intl --overwrite
  

• 使用 OpenAI 修复 .intl 文件：

  intl_messages fix --ref msgs-en.intl -f msgs-fr.intl -t openai --overwrite
  

完整示例Demo

以下是一个完整的示例，展示了如何在一个Flutter应用中使用 intl_messages 进行国际化和本地化：

import 'package:flutter/material.dart';
import 'package:intl_messages/intl_messages.dart';

void main() {
  runApp(MyApp());
}

class MyApp extends StatelessWidget {
  final IntlMessagesLoader intlMessagesLoader =
      IntlMessagesLoader('example', 'example/i18n/msgs-');

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter I18N Demo',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: MyHomePage(),
    );
  }
}

class MyHomePage extends StatefulWidget {
  [@override](/user/override)
  _MyHomePageState createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  final App app = App();

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text(app.messages.msg('welcome').build()),
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: <Widget>[
            Text(
              app.messages.msg('language').build(),
              style: TextStyle(fontSize: 24),
            ),
            SizedBox(height: 20),
            ElevatedButton(
              onPressed: () async {
                await app.messages.setLocale('fr');
                setState(() {});
              },
              child: Text('切换到法语'),
            ),
            SizedBox(height: 20),
            ElevatedButton(
              onPressed: () async {
                await app.messages.setLocale('en');
                setState(() {});
              },
              child: Text('切换到英语'),
            ),
          ],
        ),
      ),
    );
  }
}

class App {
  final IntlMessagesLoader intlMessagesLoader =
      IntlMessagesLoader('example', 'example/i18n/msgs-');

  IntlMessages get messages => intlMessagesLoader.intlMessages;

  String get msgWelcome => messages.msg('welcome').build();

  String get msgLanguage => messages.msg('language').build();

  String msgTotalEmails(int n, String user) =>
      messages.msg('total_emails').build({'n': n, 'user': user});

  final String? forceLocale;

  App([this.forceLocale]) {
    if (intlMessagesLoader.isLoaded) {
      run();
    } else {
      intlMessagesLoader.onLoad.listen((event) => run());
    }
  }

  void run() {
    if (forceLocale != null) {
      messages.setLocale(forceLocale);
    }

    print('----------------------------- ${messages.currentLocale}');

    print(msgWelcome);

    print('$msgLanguage: ${messages.currentLocale!.language}');

    for (var i = 0; i <= 4; i++) {
      print('$i> ${msgTotalEmails(i, 'Joe')}');
    }
  }
}