这是一个 Flutter 开发依赖工具，用于将 Excel 文件转换为 JSON 文件和 Dart LocaleKeys 类。特别适合需要国际化配置和多语言支持的 Flutter 项目。
本工具基于 excel2x（Go 语言编写的 Excel 转换工具）封装，提供了 Flutter/Dart 友好的使用方式。
主要功能：
- 📊 读取 Excel 表格数据
- 🔤 使用拼音库自动转换中文 key 为拼音
- 📄 为每一行数据生成独立的 JSON 文件
- 🎯 自动生成 Dart 语言的 LocaleKeys 类文件
- 🔧 跨平台支持（macOS、Windows、Linux）
- 📦 作为 Flutter 开发依赖使用，无需手动下载二进制文件
在 Flutter 项目的 pubspec.yaml 中添加开发依赖：
dev_dependencies:
excel2json: ^1.0.8然后运行：
flutter pub get安装完成后，可以使用 dart run excel2json 或直接使用 excel2json 命令。
# 使用默认参数
dart run excel2json
# 或者直接使用
excel2json -file=./assets/abc.xlsx无（所有参数都有默认值）
| 参数 | 简写 | 默认值 | 说明 |
|---|---|---|---|
-file |
- | ./assets/abc.xlsx |
输入的 Excel 文件路径 |
-output_path |
- | ./ |
JSON 文件的输出目录路径 |
-dart_file_path |
- | ./ |
Dart 文件输出目录（文件名固定为 locale_keys.dart） |
-version |
- | false |
显示版本信息、构建时间和 Git 提交哈希 |
指定要转换的 Excel 文件路径。文件必须是 .xlsx 格式，且包含名为 Sheet1 的工作表。
示例：
dart run excel2json -file=/path/to/your/file.xlsx
dart run excel2json -file=./data/translations.xlsx指定生成的 JSON 文件的输出目录。如果目录不存在，程序会尝试创建（需要权限）。
示例：
dart run excel2json -output_path=./output/
dart run excel2json -output_path=/tmp/json_files/指定生成的 Dart LocaleKeys 类文件的输出目录。文件名固定为 locale_keys.dart。
示例：
dart run excel2json -dart_file_path=./lib
dart run excel2json -dart_file_path=./generated显示程序的版本信息，包括版本号、构建时间和 Git 提交哈希。
示例：
dart run excel2json -version输出示例：
Version: 1.0.8
Build Time: 2026-01-19 13:19:00
Git Commit: a1b2c3d
# 使用默认参数（assets 目录下的 abc.xlsx）
dart run excel2json# 指定 Excel 文件和输出目录
dart run excel2json -file=./data/translations.xlsx -output_path=./output/# 指定所有参数
dart run excel2json \
-file=./data/translations.xlsx \
-output_path=./output/json/ \
-dart_file_path=./lib# Windows 命令行
dart run excel2json -file=C:\data\translations.xlsx -output_path=C:\output\Excel 文件必须包含名为 Sheet1 的工作表，格式要求如下：
- 第一行：作为输出 JSON 文件的文件名（不含扩展名），必须是英文标识（如：
zh、en、ja等） - 第一列：作为 JSON 的 key，支持中文，程序会自动转换为拼音
- 数据区域：从第二行第二列开始，每行对应一个 JSON 文件
| （第一列，用于生成key） | zh（第一行，JSON文件名） | en | ja |
|---|---|---|---|
| 中文标题 | 你好 | Hello | こんにちは |
| 世界 | 世界 | World | 世界 |
| 测试 | 测试 | Test | テスト |
说明：
- 第一行：必须是英文标识（如
zh、en、ja），用于生成 JSON 文件名（如zh.json、en.json） - 第一列：是中文标题，用于生成 JSON 的 key（程序会自动转换为拼音，去掉空格和特殊字符）
生成的 JSON 文件：
zh.json:
{
"zhongwenbiaoti": "你好",
"shijie": "世界",
"ceshi": "测试"
}en.json:
{
"zhongwenbiaoti": "Hello",
"shijie": "World",
"ceshi": "Test"
}ja.json:
{
"zhongwenbiaoti": "こんにちは",
"shijie": "世界",
"ceshi": "テスト"
}生成的 Dart 文件 (locale_keys.dart):
class LocaleKeys {
static const zhongwenbiaoti = 'zhongwenbiaoti';
static const shijie = 'shijie';
static const ceshi = 'ceshi';
}- 文件名：使用 Excel 第一行的值作为文件名（
.json扩展名） - 内容：每列数据转换为一个 JSON 对象，key 为第一列的值（中文转拼音），value 为对应单元格的值
- 位置：保存在
-output_path指定的目录中
- 文件名：
locale_keys.dart（固定文件名，不可自定义） - 输出目录：通过
-dart_file_path参数指定 - 内容：包含所有表头转换后的拼音 key，作为静态常量
- 用途：用于 Flutter/Dart 项目的国际化配置
本工具支持以下平台：
- ✅ macOS (Intel 和 Apple Silicon/M1/M2/M3)
- ✅ Windows
- ✅ Linux (x64 和 ARM64)
工具会自动检测运行平台并选择对应的二进制文件执行。
A: 检查 -file 参数指定的路径是否正确，使用绝对路径或相对路径都可以。
A: 目前程序自动将中文表头转换为拼音。如需自定义 key，建议在 Excel 第一行直接使用英文或拼音。
A: 目前仅支持 .xlsx 格式（Excel 2007 及以上版本）。
A: 使用 -version 参数：dart run excel2json -version
A: 将本包添加为 dev_dependencies，然后使用 dart run excel2json 命令执行。
- Flutter SDK >= 1.17.0
- Dart SDK ^3.9.0
# 克隆项目
git clone https://github.com/your-username/excel2json.git
cd excel2json
# 安装依赖
flutter pub get
# 运行测试
flutter test
# 本地测试执行
dart run bin/excel2json.dart -file=./assets/abc.xlsx本工具基于 excel2x 项目，使用预编译的二进制文件（Go 语言编写），二进制文件位于：
bin/macos/arm64/excel2json- macOS Apple Siliconbin/macos/intel/excel2json- macOS Intelbin/windows/excel2json.exe- Windowsbin/linux/x64/excel2json- Linux x64bin/linux/arm64/excel2json- Linux ARM64
注意： 二进制文件需要从 excel2x 项目构建并放置到对应目录中。
本工具基于以下项目：
- excel2x - Go 语言编写的 Excel 转换工具，支持转换为 JSON、Dart、Java、Go map 等格式
查看 LICENSE 文件了解详情。