Flutter多语言支持插件multiple_localization的使用

multiple_localization 插件简介

multiple_localization 是一个为 intl 包提供多个 arb 和消息本地化文件支持的插件。它解决了当您想要注册多个 arb 文件，每个文件对应不同的委托时，intl 不允许多次调用 initializeMessages 的问题。只有第一次调用会被处理并使用其消息，后续的调用将被忽略。这在您想添加带有 arb 文件的国际化到单独包中并在项目中使用自己的本地化文件时是一个常见问题。

为什么需要多个 arb 文件？

通常情况下，我们不需要多个 arb 文件，只需将所有本地化字符串放在单个文件中即可。但如果您希望将 intl 国际化与 arb 文件添加到单独的包中，并在项目中使用这些包以及项目的自有本地化文件，这就成了一个问题。

MultipleLocalizations 支持使用 Localizations.override(delegates: [SomeLocalizationsDelegate(), ...]) widget。

使用方法

要使用此插件，请按照以下步骤操作：

1. 在 pubspec.yaml 文件中添加 multiple_localization 作为依赖项。
2. 使用 MultipleLocalizations.load 方法代替显式调用 initializeMessages 来加载您的委托。

示例代码

主应用入口 (main.dart)

import 'package:flutter/material.dart';
import 'package:intl/intl.dart';
import 'package:multiple_localization/multiple_localization.dart';
import './app/l10n/messages_all.dart'; // 应用的本地化文件
import './package/l10n/messages_all.dart' as package; // 包的本地化文件

void main() {
  runApp(
    const MaterialApp(
      supportedLocales: [Locale('en')],
      localizationsDelegates: [
        AppLocalizations.delegate, // 应用的本地化代理
        PackageLocalizations.delegate, // 包的本地化代理
        DefaultCupertinoLocalizations.delegate,
      ],
      home: HomeScreen(),
    ),
  );
}

class HomeScreen extends StatelessWidget {
  const HomeScreen({Key? key}) : super(key: key);

  @override
  Widget build(BuildContext context) {
    final appLocalization = AppLocalizations.of(context);
    final packageLocalization = PackageLocalizations.of(context);
    return Scaffold(
      appBar: AppBar(
        title: Text(appLocalization.title),
      ),
      body: Padding(
        padding: const EdgeInsets.all(18.0),
        child: Center(
          child: Column(
            children: [
              Text(appLocalization.messageFromApp),
              Text(packageLocalization.messageFromPackage),
              Text(packageLocalization.messageFromPackageForOverride),
            ],
          ),
        ),
      ),
    );
  }
}

应用程序本地化类 (AppLocalizations)

class _AppLocalizationsDelegate extends LocalizationsDelegate<AppLocalizations> {
  const _AppLocalizationsDelegate();

  @override
  bool isSupported(Locale locale) => ['en'].contains(locale.languageCode);

  @override
  Future<AppLocalizations> load(Locale locale) {
    return MultipleLocalizations.load(
        initializeMessages, locale, AppLocalizations.new,
        setDefaultLocale: true);
  }

  @override
  bool shouldReload(LocalizationsDelegate<AppLocalizations> old) => false;
}

/// 应用程序本地化
class AppLocalizations {
  /// 代理
  static const LocalizationsDelegate<AppLocalizations> delegate =
      _AppLocalizationsDelegate();

  static AppLocalizations of(BuildContext context) =>
      Localizations.of<AppLocalizations>(context, AppLocalizations)!;

  final String locale;

  AppLocalizations(this.locale);

  String get title => Intl.message('Multiple localization', name: 'title');

  String get messageFromApp =>
      Intl.message('Default Message from App', name: 'messageFromApp');

  String get messageFromPackageForOverride =>
      Intl.message('This translation override package translation',
          name: 'messageFromPackageForOverride');
}

包的本地化类 (PackageLocalizations)

class _PackageLocalizationsDelegate extends LocalizationsDelegate<PackageLocalizations> {
  const _PackageLocalizationsDelegate();

  @override
  bool isSupported(Locale locale) => ['en'].contains(locale.languageCode);

  @override
  Future<PackageLocalizations> load(Locale locale) {
    return MultipleLocalizations.load(
        package.initializeMessages, locale, PackageLocalizations.new);
  }

  @override
  bool shouldReload(LocalizationsDelegate<PackageLocalizations> old) => false;
}

/// 包的本地化
class PackageLocalizations {
  /// 代理
  static const LocalizationsDelegate<PackageLocalizations> delegate =
      _PackageLocalizationsDelegate();

  static PackageLocalizations of(BuildContext context) =>
      Localizations.of<PackageLocalizations>(context, PackageLocalizations)!;

  final String locale;

  PackageLocalizations(this.locale);

  String get messageFromPackage =>
      Intl.message('Default Message from Package', name: 'messageFromPackage');

  String get messageFromPackageForOverride =>
      Intl.message('Default Message from Package for override',
          name: 'messageFromPackageForOverride');
}

覆盖包中的字符串

如果要覆盖包中的字符串（例如更改包小部件中的某些标签），则需要在应用程序的本地化类中定义具有所需名称的字符串。确保将应用程序的本地化代理添加到包的本地化代理之前。

// 如果包中有如下字符串:
String get messageFromPackageForOverride =>
      Intl.message('Package', name: 'messageFromPackageForOverride');

// 则在 AppLocalizations 中定义同名字符串:
String get messageFromPackageForOverride =>
      Intl.message('App', name: 'messageFromPackageForOverride');

设置回退语言

还可以在加载应用程序的本地化代理时指定回退语言。使用 fallbackLocale 参数设置在当前语言找不到某些键时使用的语言。请注意，仅第一个 load 调用会设置回退语言，因此请确保应用程序的本地化代理是代理列表中的第一个元素。

此外，注意如果提供了 fallbackLocale，那么所有消息将在应用程序启动时加载到内存中，而不仅仅是当前语言的消息。

通过以上步骤和示例代码，您可以轻松地在Flutter项目中实现多语言支持，同时能够灵活管理来自不同来源的本地化资源。