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

getx_multilang_generator 是一个用于在开发基于 GetX 框架的多语言功能时，自动或半自动生成/修改代码的工具。

功能

该插件包含两个主要功能：

1. 从 .csv 文件生成翻译文件。
2. 将所有 'string'.tr 的格式替换为 MultiLangKeys.string.tr。

开始使用

在你的 pubspec.yaml 文件中添加 getx_multilang_generator：

dev_dependencies:
  getx_multilang_generator:

然后运行以下命令以安装依赖项：

flutter pub get

使用说明

1. 从 .csv 文件生成翻译文件

运行以下命令来生成翻译文件：

flutter pub run getx_multilang_generator import-csv

或者指定 .csv 文件的路径：

flutter pub run getx_multilang_generator import-csv folder/file.csv

命令会生成两种文件：

• multilang.dart：存储翻译内容。
• multilang_keys.dart：定义键值。

默认情况下，.csv 文件路径为 multilang/multilang.csv。以下是 multilang.csv 的示例：

key,en,id,
add,add,tambah,
warningMessage,there is unexpected error,terjadi kesalahan,

生成的 multilang.dart 文件内容如下：

import 'multilang_keys.dart';
import 'package:peppermint_sdk/peppermint_sdk.dart';

class Multilang extends Translations {
  [@override](/user/override)
  Map<String, Map<String, String>> get keys => {
        'en': {
          MultiLangKeys.add: 'add',
          MultiLangKeys.warningMessage: 'there is unexpected error',
        },
        'id': {
          MultiLangKeys.add: 'tambah',
          MultiLangKeys.warningMessage: 'terjadi kesalahan',
        },
      };
}

生成的 multilang_keys.dart 文件内容如下：

class MultiLangKeys {
  MultiLangKeys._();
  static const String add = 'add';
  static const String warningMessage = 'warningMessage';
}

2. 替换 'string'.tr 格式为 MultiLangKeys.string.tr

运行以下命令将所有 'string'.tr 替换为 MultiLangKeys.string.tr：

flutter pub run getx_multilang_generator convert-tr

或者指定 multilang_keys.dart 文件路径：

flutter pub run getx_multilang_generator convert-tr my_project/core/translation/multilang_keys.dart

以下是替换示例：

• 'add'.tr → MultiLangKeys.add.tr
• 'warning'.tr → MultiLangKeys.warning.tr

完整示例代码

以下是一个完整的示例项目结构及代码，展示如何使用 getx_multilang_generator 实现多语言支持。

1. 创建项目并配置依赖

初始化一个 Flutter 项目：

flutter create my_multi_lang_app
cd my_multi_lang_app

在 pubspec.yaml 中添加 getx_multilang_generator：

dependencies:
  get: ^4.6.5

dev_dependencies:
  getx_multilang_generator:

安装依赖：

flutter pub get

2. 准备 .csv 文件

创建一个 multilang/multilang.csv 文件，内容如下：

key,en,id,
add,add,tambah,
warningMessage,there is unexpected error,terjadi kesalahan,

3. 生成翻译文件

运行以下命令生成翻译文件：

flutter pub run getx_multilang_generator import-csv multilang/multilang.csv

生成的文件如下：

lib/core/translation/multilang.dart

import 'multilang_keys.dart';
import 'package:peppermint_sdk/peppermint_sdk.dart';

class Multilang extends Translations {
  [@override](/user/override)
  Map<String, Map<String, String>> get keys => {
        'en': {
          MultiLangKeys.add: 'add',
          MultiLangKeys.warningMessage: 'there is unexpected error',
        },
        'id': {
          MultiLangKeys.add: 'tambah',
          MultiLangKeys.warningMessage: 'terjadi kesalahan',
        },
      };
}

lib/core/translation/multilang_keys.dart

class MultiLangKeys {
  MultiLangKeys._();
  static const String add = 'add';
  static const String warningMessage = 'warningMessage';
}

4. 修改代码以使用 MultiLangKeys

将所有 'string'.tr 替换为 MultiLangKeys.string.tr：

运行以下命令：

flutter pub run getx_multilang_generator convert-tr lib/core/translation/multilang_keys.dart

示例修改前后的对比：

• 'add'.tr → MultiLangKeys.add.tr
• 'warningMessage'.tr → MultiLangKeys.warningMessage.tr

5. 初始化多语言功能

在 main.dart 文件中初始化 GetMaterialApp 并设置默认语言：

import 'package:flutter/material.dart';
import 'package:get/get.dart';
import 'core/translation/multilang.dart';

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

class MyApp extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return GetMaterialApp(
      title: 'Multi Language App',
      translations: Multilang(), // 设置翻译类
      locale: Locale('en'), // 默认语言
      fallbackLocale: Locale('en'), // 回退语言
      home: HomePage(),
    );
  }
}

class HomePage extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text('Home Page'),
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: [
            Text(
              MultiLangKeys.add.tr, // 使用 MultiLangKeys
            ),
            ElevatedButton(
              onPressed: () {
                Get.updateLocale(Locale('id')); // 切换到印尼语
              },
              child: Text('Switch to Indonesian'),
            ),
          ],
        ),
      ),
    );
  }
}