Flutter国际化翻译生成插件dhn_translation_generator的使用

Generate Translation Service class from translation file

特性

列出您的包可以做什么。也许可以包含图片、GIF或视频。

开始使用

列出先决条件并提供或指向如何开始使用该包的信息。

使用方法

为包用户提供简短且有用的示例。将更长的示例添加到/example文件夹中。

const like = 'sample';

示例代码

以下是一个完整的示例，展示如何使用dhn_translation_generator插件生成国际化翻译服务类。

1. 添加依赖

在pubspec.yaml文件中添加dhn_translation_generator作为开发依赖：

dev_dependencies:
  dhn_translation_generator: ^1.0.0

然后运行flutter pub get以安装依赖。

2. 创建翻译文件

创建一个包含所有翻译键值对的JSON文件，例如assets/i18n/en.json（英语）和assets/i18n/zh.json（中文）。

en.json

{
  "hello": "Hello",
  "welcome": "Welcome",
  "greet": "Nice to meet you"
}

zh.json

{
  "hello": "你好",
  "welcome": "欢迎",
  "greet": "很高兴见到你"
}

3. 配置生成器

在lib/main.dart文件中配置dhn_translation_generator，指定翻译文件路径和生成的服务类名。

import 'package:dhn_translation_generator/dhn_translation_generator.dart';

void main() {
  // 指定翻译文件目录
  const translationDirectory = 'assets/i18n';

  // 指定生成的服务类名
  const generatedClassName = 'AppTranslations';

  // 调用生成器
  generateTranslations(
    translationDirectory: translationDirectory,
    generatedClassName: generatedClassName,
  );
}

4. 运行生成脚本

在终端中运行以下命令以生成翻译服务类：

flutter pub run build_runner build

生成的文件会保存在lib/generated/app_translations.dart中。

5. 使用生成的翻译服务类

在项目中使用生成的翻译服务类AppTranslations来获取翻译文本。

import 'package:flutter/material.dart';
import 'package:your_project_name/generated/app_translations.dart';

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

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter Demo',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: MyHomePage(),
    );
  }
}

class MyHomePage extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text(AppTranslations.of(context).text('hello')),
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: <Widget>[
            Text(AppTranslations.of(context).text('welcome')),
            Text(AppTranslations.of(context).text('greet')),
          ],
        ),
      ),
    );
  }
}

6. 运行应用

确保在MaterialApp中设置了locale以切换语言。例如：

home: MyHomePage(),
supportedLocales: [
  Locale('en', 'US'),
  Locale('zh', 'CN'),
],
localizationsDelegates: [
  AppTranslationsDelegate(),
],