Flutter插件inu的使用_Inu是一个用于 Flutter 应用程序的简单本地化工具

Inu 🐕 #

特性 #

Inu 是一个用于 Flutter 应用程序的简单本地化工具。它基于从包含应用程序所有字符串的结构化 YAML 文件生成的类。

每个区域文件都会生成一个区域类。
一旦生成，您就可以通过一个继承自 Inu 的类实例来访问这些字符串。

开始使用 #

所有的本地化文件应该具有相同的 YAML-map 结构。每个键的值应该包含每种语言的翻译字符串。

• 将您的本地化文件放在目录 assets/translations/ 中
• 在您的 Flutter 应用中将 Inu 添加到依赖项中，使用命令 flutter pub add inu
• 运行 dart run inu:init 来首次生成区域类

使用方法 #

Inu 创建了一个名为 Inu 的抽象类，每个其他区域类都实现该类。该类是从开发过程中使用的主语言生成的。

如果您没有提供任何翻译，则会使用 Inu 类中的字符串（就像一个“回退区域”）。

类生成 #</h>

如果您向您的区域文件中添加了更多的字符串，可以运行以下命令：

dart run inu:gen_classes

或者如果您使用 just，可以运行：

just inu

Inu 在生成过程中检查区域文件的完整性。一旦发现未翻译的字符串，您可以在终端提示中立即翻译它们或跳过该过程。

一旦类已经生成，您可以通过使用 Inu 的实例作为所有字符串的容器来继续使用。

特定语言的翻译可以通过 InuLocale 枚举选择。

Inu chooseLocale() {
  final String locale = Locale(Platform.localeName).languageCode;
  return InuLocale.select(locale) ?? InuLocale.en_US.inu;
}

字符串插入 #

您也可以在形式为 List<String> 的参数或命名参数的 Map<String, String> 中使用字符串，并使用 String 和 Text() 扩展的 tr() 方法。
只需在您的区域文件中的字符串值中添加花括号，如下所示：

arguments: 这个字符串包含 {} 和 {}
namedArguments: 你好，我的名字是 {firstname} {surname}

然后使用 tr() 扩展的方法如下：

Text(inu.arguments).tr(args: ['有趣的', '单词']);
String greeting = inu.namedArguments.tr(namedArgs: { 
    'firstname' : '瑞安',
    'surname' : '斯特肯'});

查看 示例 以获取 Flutter 演示应用的翻译版本！

区域文件的结构 #

您应该按简单的映射形式（没有列表或纯文本）来组织您的文件。所有文件的映射结构必须相同。

英语区域文件 #

title: 应用
section1:
  undersection1:
    key1 : 值
    key2: "很棒的值"
  anotherKey : 另一个值

section2:
  supriseKey: ""吓人的!"
  arguments: 这个字符串包含 {} 和 {}
  namedArguments: 你好，我的名字是 {firstname} {surname}

end: 这是结束

德语区域文件 #

title: 应用
section1:
  undersection1:
    key1 : 值
    key2: "很棒的值"
  anotherKey : 另一个值

section2:
  supriseKey: ""吓人的!"
  arguments: 这个字符串包含 {} 和 {}
  namedArguments: 你好，我的名字是 {firstname} {surname}

end: 这是结束

示例代码

import 'dart:io';

import 'package:flutter/material.dart';

import 'inu_classes/de-DE.g.dart';
import 'inu_classes/en-US.g.dart';
import 'inu_classes/inu.g.dart';

late final Inu inu;

Inu chooseLocale() {
  final String langCode =
      Locale(Platform.localeName).languageCode.replaceAll('_', '-');

  switch (langCode) {
    case 'de-DE':
      return DeDE();
    default:
      return EnUS();
  }
}

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

class MyApp extends StatelessWidget {
  const MyApp({super.key});

  [@override](/user/override)
  Widget build(BuildContext context) {
    inu = chooseLocale();
    return MaterialApp(
      title: inu.general.appTitle,
      theme: ThemeData(
        colorScheme: ColorScheme.fromSeed(seedColor: Colors.deepPurple),
        useMaterial3: true,
      ),
      home: MyHomePage(title: inu.general.appBar),
    );
  }
}

class MyHomePage extends StatefulWidget {
  const MyHomePage({super.key, required this.title});

  final String title;

  [@override](/user/override)
  State<MyHomePage> 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(
        backgroundColor: Theme.of(context).colorScheme.inversePrimary,
        title: Text(widget.title),
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: <Widget>[
            Text(
              inu.mainPage.buttonCounterMsg,
            ),
            Text(
              '$_counter',
              style: Theme.of(context).textTheme.headlineMedium,
            ),
          ],
        ),
      ),
      floatingActionButton: FloatingActionButton(
        onPressed: _incrementCounter,
        tooltip: inu.mainPage.increment,
        child: const Icon(Icons.add),
      ),
    );
  }
}