Flutter Excel本地化支持插件excel_localization的使用

简介

excel_localization 是一个用于自动生成Flutter本地化资源的工具，它可以从CSV和Excel文件中导入翻译内容。这使得团队成员可以方便地编辑CSV/Excel文件，并通过终端命令将这些翻译导入项目中。目前，该工具支持基本变量（字符串和整数），但不支持性别和复数形式。如果需要这些功能，建议使用 arb_generator。

开始使用

添加依赖

在 pubspec.yaml 文件中添加以下依赖：

dependencies:
  flutter_localizations:
    sdk: flutter
    
dev_dependencies: 
  excel_localization: 

确保你的 Dart SDK 版本 >= 2.12。

定义设置

在 pubspec.yaml 文件中定义 excel_localization 的配置项。input_file_path 是唯一必需的参数。

excel_localization:
  input_file_path: "lang.csv"  # 必填项：输入CSV/Excel文件路径
  output_dir: "lib"            # 输出目录，默认为 "lib"
  file_name: "i18n"            # 生成文件名，默认为 "i18n"
  class_name: "I18n"           # 生成类名，默认为 "I18n"
  delimiter: ","               # CSV文件分隔符，默认为 ","
  start_index: 1               # 翻译开始的列索引，默认为 1
  depend_on_context: true      # 是否依赖BuildContext，默认为 true
  use_single_quotes: false     # 是否使用单引号，默认为 false
  replace_no_break_spaces: false # 是否替换不间断空格，默认为 false
  expose_get_string: false     # 是否暴露getString方法，默认为 false
  expose_loca_strings: false   # 是否暴露locaStrings getter，默认为 false
  expose_locale_maps: false    # 是否暴露localeMaps getter，默认为 false
  generate_comments: false     # 是否生成注释，默认为 false
  comment_languages: []        # 注释中显示的语言，默认为空数组

运行包

确保当前工作目录是项目根目录，然后运行以下命令：

flutter pub get
flutter pub run excel_localization

更新iOS Info.plist

对于iOS平台，需要更新 ios/Runner/Info.plist 文件以包含应用支持的语言列表：

<key>CFBundleLocalizations</key>
<array>
  <string>fr</string>
  <string>en</string>
  <string>hi</string>
</array>

更多详情请参阅 国际化 Flutter 应用。

使用生成的 i18n 文件

假设你已经生成了一个名为 i18n.dart 的文件，并且类名为 I18n。接下来，你需要在应用中使用这个生成的文件。

添加 I18nDelegate 到 delegates

在 MaterialApp 中添加 I18nDelegate：

import 'package:flutter/material.dart';
import 'package:excel_localization_example/i18n.dart';

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

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      navigatorKey: I18n.languageKey, // 如果需要全局访问上下文，请添加此行
      localizationsDelegates: [
        const I18nDelegate(),
        GlobalMaterialLocalizations.delegate,
        GlobalWidgetsLocalizations.delegate,
        GlobalCupertinoLocalizations.delegate,
      ],
      supportedLocales: I18nDelegate.supportedLocals,
      home: Home(),
    );
  }
}

使用生成的 I18n 类

在页面中使用生成的 I18n 类来显示多语言文本：

import 'package:flutter/material.dart';
import 'package:excel_localization_example/i18n.dart';

class Home extends StatefulWidget {
  @override
  State<Home> createState() => _HomeState();
}

class _HomeState extends State<Home> {
  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text('Excel Localization Sample'),
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: <Widget>[
            Text(I18n.of(context).plainText),
            Text(I18n.of(context).welcome(name: 'Simran')),
            Text(I18n.of(context).favoriteColor),
            Text(I18n.translate.plainText), // 全局访问方式
            Text(I18n.translate.welcome(name: 'Simran')), // 全局访问方式
            Text(I18n.translate.favoriteColor), // 全局访问方式
            OutlinedButton(
              onPressed: () {
                setState(() {
                  I18n.load(Locale("fr"));
                });
              },
              child: Text("切换到法语"),
            )
          ],
        ),
      ),
    );
  }
}

规则与功能

Locale

Locale 在表格的第一行指定，格式为 en 或 en_US。

默认语言

默认语言从 start_index 指定的列开始。这意味着：

1. 如果该列没有值，则使用 loca key。
2. 如果其他语言没有给定 key 的翻译，则使用默认语言的值。

Keys

每个 loca key 必须以小写字母开头，后面可以是小写、大写字母、数字或下划线。

Variables

在 loca 字符串中包含变量的格式为 %<VAR NAME>$<VAR TYPE>。目前仅支持整数和字符串类型：

• %myVariable$d (d 表示 int)
• %myVariable$s (s 表示 String)

所有变量都是必需的。例如，welcome 键的生成函数签名如下：

String welcome({
  required String name,
})

如果变量名以数字开头，生成的变量名将变为 var<VAR NAME>。例如，%1$d 将变成 var1。

示例代码

以下是完整的示例代码，展示了如何使用 excel_localization 插件：

import 'package:flutter/material.dart';
import 'package:flutter_localizations/flutter_localizations.dart';
import 'package:excel_localization_example/i18n.dart';

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

class MyApp extends StatefulWidget {
  const MyApp({Key? key}) : super(key: key);

  @override
  State<MyApp> createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> {
  @override
  void initState() {
    super.initState();
  }

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      navigatorKey: I18n.languageKey,
      localizationsDelegates: const [
        I18nDelegate(),
        GlobalMaterialLocalizations.delegate,
        GlobalWidgetsLocalizations.delegate,
        GlobalCupertinoLocalizations.delegate,
      ],
      supportedLocales: I18nDelegate.supportedLocals,
      home: Home(),
    );
  }
}

class Home extends StatefulWidget {
  @override
  State<Home> createState() => _HomeState();
}

class _HomeState extends State<Home> {
  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text('Excel Localization Sample'),
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: <Widget>[
            Text(I18n.of(context).plainText),
            Text(I18n.of(context).welcome(name: 'Simran')),
            Text(I18n.of(context).favoriteColor),
            Text(I18n.translate.plainText),
            Text(I18n.translate.welcome(name: 'Simran')),
            Text(I18n.translate.favoriteColor),
            OutlinedButton(
              onPressed: () {
                setState(() {
                  I18n.load(Locale("fr"));
                });
              },
              child: Text("切换到法语"),
            )
          ],
        ),
      ),
    );
  }
}

以上就是 excel_localization 插件的详细使用说明和示例代码。希望对你有所帮助！如果你有任何问题，欢迎随时提问。