Flutter国际化插件blizzard_intl的使用

Flutter国际化插件blizzard_intl的使用

Blizzard Intl 提供了一种方便的方法来实现 Flutter 应用程序的国际化，通过提供一组与文本相关的部件，这些部件接受 Map<T, String> 类型的数据而不是 String 类型，允许你传递多语言翻译而不是单一语言文本。

基本设置

1. 创建一个枚举来表示支持的语言。
2. 可选：为每种语言创建别名。
3. 可选：为语言映射创建一个类型别名。
4. 将应用包装在 LanguageWrapper 中，并设置默认语言。

步骤 1

创建一个枚举来表示应用程序支持的语言。

enum Language {
  english,
  german,
}

步骤 2（可选）

建议为每个语言枚举值创建缩写形式的别名。

const de = Language.german;
const en = Language.english;

步骤 3（可选）

建议为语言映射创建一个类型别名。

typedef Translation = Map<Language, String>;

步骤 4

将应用包装在 LanguageWrapper 中，并设置默认语言。可以选择设置选定语言。

LanguageWrapper<Language>(
  defaultLanguage: en,
  child: MaterialApp(
    home: Scaffold(
      appBar: AppBar(
        title: const intl.Text({
          de: 'Meine App',
          en: 'My App',
        }),
      ),
    ),
  ),
);

注意：如果 selectedLanguage 为 null，则会使用 defaultLanguage 作为文本部件的默认语言。如果选定语言缺少翻译，则会使用默认语言的翻译。

完整示例

import 'package:blizzard_intl/blizzard_intl.dart' as intl;
import 'package:flutter/material.dart';

enum Language {
  english,
  german,
}

const de = Language.german;
const en = Language.english;

typedef Translation = Map<Language, String>;

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

class MyApp extends StatelessWidget {
  const MyApp({super.key});

  @override
  Widget build(BuildContext context) {
    return intl.LanguageWrapper<Language>(
      defaultLanguage: en,
      child: MaterialApp(
        home: Scaffold(
          appBar: AppBar(
            title: const intl.Text({
              de: 'Meine App',
              en: 'My App',
            }),
          ),
        ),
      ),
    );
  }
}

获取语言

可以通过 LanguageManager 获取默认或选定的语言。

final defaultLanguage = LanguageManager.of<Language>(context).defaultLanguage;
final selectedLanguage = LanguageManager.of<Language>(context).selectedLanguage;

注意：通常不需要这样做，因为提供的文本部件会在底层处理这个问题。

选择语言

可以通过调用 LanguageManager 的 onLanguageSelected 方法来选择语言。

LanguageManager.of<Language>(context).onLanguageSelected(de);

分离关注点

鉴于 Blizzard Intl 更加注重行为的局部性（LoB），建议将翻译分为本地翻译和全局翻译，优先使用本地翻译，只有必要时才提升到全局翻译。

本地翻译

本地翻译直接在文本应出现的部件上定义翻译。

class ConfirmButton extends StatelessWidget {
  const ConfirmButton();

  @override
  Widget build(BuildContext context) {
    return TextButton(
      onPressed: () {},
      child: intl.Text({
        de: 'Bestätigen',
        en: 'Confirm',
      }),
    );
  }
}

全局翻译

全局翻译在全局文件中定义翻译，然后在本地导入。

translations.dart

const Translation confirmText = {
  de: 'Bestätigen',
  en: 'Confirm',
};

confirm_button.dart

import 'package:blizzard_intl/blizzard_intl.dart' as intl;
import 'package:flutter/material.dart';

import 'translations.dart' as translations;

class ConfirmButton extends StatelessWidget {
  const ConfirmButton();

  @override
  Widget build(BuildContext context) {
    return TextButton(
      onPressed: () {},
      child: intl.Text(translations.confirmText),
    );
  }
}

导入冲突

Blizzard Intl 提供的文本部件在命名和参数方面与 Flutter 的等效部件完全相同。这意味着它们的功能完全相同，唯一的区别是任何 String 参数应该替换为 Map<T, String>。这包括 semanticsLabel。

在某些情况下，提供多个翻译可能是不必要的，例如在向用户显示计数器时。因此，Blizzard Intl 并不会使 Flutter 的基于 String 的部件过时。

建议对 Blizzard Intl 使用限定导入，如下所示：

import 'package:blizzard_intl/blizzard_intl.dart' as intl;

对于很少使用单语言文本的项目，可以创建一个预导入文件，如 prelude.dart，导出所需的默认值，然后在使用单语言文本时使用限定导入，如下所示：

prelude.dart

export 'package:blizzard_intl/blizzard_intl.dart';
export 'package:flutter/material.dart'
    hide InlineSpan, RichText, Text, TextSpan, WidgetSpan;

my_app.dart

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

import 'prelude.dart';