Flutter国际化翻译插件getx_translator的使用

getx_translator 是一个用于生成 GetX Flutter 语言字符串文件的命令行应用程序。它通过 Google Sheets 实现简单的翻译功能。

步骤指南

1. 设置 Google Sheets

你需要按照以下格式设置你的 Google Sheets：

• getx_translator_sheet
• 字符串应从第3行开始。

创建 Apps Script 文件

在 Google Sheets 中，创建一个新的 Apps Script 文件，并将以下代码粘贴进去（替换你的 Sheet ID 和 Sheet 名称）：

function doPost(request) {
  var error = false;
  var result;
  if (request.parameter.spreadsheetId == null) {
    error = true;
    result = { "status": "FAILED", "message": "Invalid Sheet Id" };
  }
  if (request.parameter.sheetName == null) {
    error = true;
    result = { "status": "FAILED", "message": "Please Provide Sheet Name" };
  }
  if (request.parameter.values == null) {
    error = true;
    result = { "status": "FAILED", "message": "Please Provide Values" };
  }

  var sheetId = request.parameter.spreadsheetId;
  var sheetName = request.parameter.sheetName;
  if (sheetId != 'YOUR_SHEET_ID') {
    error = true;
    result = { "status": "FAILED", "message": "Please Provide Correct Sheet Id" };
  }
  if (sheetName != 'YOUR_SHEET_NAME') {
    error = true;
    result = { "status": "FAILED", "message": "Please Provide Correct Sheet Name" };
  }
  if (error) {
    return ContentService
      .createTextOutput(JSON.stringify(result))
      .setMimeType(ContentService.MimeType.JSON);
  }
  var sheet = SpreadsheetApp.openById(sheetId).getSheetByName(sheetName);
  result = { "status": "SUCCESS" };
  if (request.parameter.deleteRow != null) {
    try {
      var deletingRow = JSON.parse(request.parameter.values);
      for (var i = 0; i < deletingRow.length; i++) {
        sheet.deleteRow((deletingRow[i] - i));
      }
    } catch (exc) {
      result = { "status": "FAILED", "message": exc.toString() };
    }
  } else {
    try {
      var values = JSON.parse(request.parameter.values);
      sheet.getRange(sheet.getLastRow() + 1, 1, values.length, 1).setValues(values);
    } catch (exc) {
      result = { "status": "FAILED", "message": exc.toString() };
    }
  }
  return ContentService
    .createTextOutput(JSON.stringify(result))
    .setMimeType(ContentService.MimeType.JSON);
}

function doGet(request) {
  var error = false;
  var result;
  if (request.parameter.spreadsheetId == null) {
    error = true;
    result = { "status": "FAILED", "message": "Invalid Sheet Id" };
  }
  if (request.parameter.sheetName == null) {
    error = true;
    result = { "status": "FAILED", "message": "Please Provide Sheet Name" };
  }
  var sheetId = request.parameter.spreadsheetId;
  var sheetName = request.parameter.sheetName;
  if (sheetId != 'YOUR_SHEET_ID') {
    error = true;
    result = { "status": "FAILED", "message": "Please Provide Correct Sheet Id" };
  }
  if (sheetName != 'YOUR_SHEET_NAME') {
    error = true;
    result = { "status": "FAILED", "message": "Please Provide Correct Sheet Name" };
  }
  if (error) {
    return ContentService
      .createTextOutput(JSON.stringify(result))
      .setMimeType(ContentService.MimeType.JSON);
  }
  var column = request.parameter.column;
  var row = request.parameter.row;
  var all = request.parameter.all ?? 'false';
  var sheet = SpreadsheetApp.openById(sheetId).getSheetByName(sheetName);
  var rowNumbers = request.parameter.rowNumbers ?? sheet.getLastRow();
  var columnNumbers = request.parameter.columnNumbers ?? 1;
  var result = { "status": "SUCCESS" };
  var values;
  if (all == 'false') {
    values = sheet.getRange(row, column, rowNumbers, columnNumbers).getValues();
  } else {
    values = sheet.getDataRange().getValues();
  }
  result['data'] = values;
  return ContentService
    .createTextOutput(JSON.stringify(result))
    .setMimeType(ContentService.MimeType.JSON);
}

2. 配置 pubspec.yaml

在 pubspec.yaml 文件中添加以下配置，并替换你的 Sheet ID、Sheet 名称和 URL：

dependencies:
  get: ^4.6.5
  flutter:
    sdk: flutter

getx_translator:
  path: "lib"
  output_path: "assets/language"
  sheet_url: "YOUR_SCRIPT_URL"
  sheet_name: "YOUR_SHEET_NAME"
  sheet_id: "YOUR_SHEET_ID"

3. 运行命令

执行以下命令来扫描、生成、上传和删除旧字符串：

flutter pub run getx_translator:main

更新语言文件后运行：

flutter pub run getx_translator:update

删除未使用的字符串：

flutter pub run getx_translator:remove

示例 Demo

以下是一个完整的示例应用，展示了如何使用 getx_translator 进行国际化翻译：

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

void main() => runApp(MyApp());

class MyApp extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return GetMaterialApp(
      title: 'Flutter Home'.tr +
          'this is for test'.tr +
          ' this is for test but for long terms'.tr,
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: MyHomePage(title: 'Flutter Home'.tr),
      translations: Messages(), // Your translations class
      locale: Locale('en', 'US'),
      fallbackLocale: Locale('en', 'US'),
    );
  }
}

class Messages extends Translations {
  [@override](/user/override)
  Map<String, Map<String, String>> get keys => {
        'en_US': {
          'Flutter Home': 'Flutter Home',
          'this is for test': 'This is a test',
          'You have pushed the button this many times:': 'You have pushed the button this many times:',
        },
        'zh_CN': {
          'Flutter Home': 'Flutter 主页',
          'this is for test': '这是一个测试',
          'You have pushed the button this many times:': '你已经按了这么多次按钮：',
        },
      };
}

class MyHomePage extends StatefulWidget {
  MyHomePage({Key? key, this.title}) : super(key: key);

  final String? title;

  [@override](/user/override)
  _MyHomePageState createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  int _counter = 0;

  void _incrementCounter() {
    setState(() {
      _counter++;
    });
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text(widget.title ?? ''),
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: <Widget>[
            Text(
              "You have pushed the button this many times:".tr,
            ),
            Text(
              '$_counter',
              style: Theme.of(context).textTheme.bodyLarge,
            ),
          ],
        ),
      ),
      floatingActionButton: FloatingActionButton(
        onPressed: _incrementCounter,
        tooltip: 'Increment'.tr,
        child: Icon(Icons.add),
      ),
    );
  }
}