Flutter本地化CSV文件支持插件csv_localizations的使用

Flutter本地化CSV文件支持插件csv_localizations的使用

标题

csv_localizations

内容

一个用于Flutter的最小CSV本地化包。

安装

在pubspec.yaml中添加csv_localizations和flutter_localizations。

dependencies:
  flutter_localizations:
    sdk: flutter
  csv_localizations: <last-version>

将单个CSV文件资产添加到pubspec.yaml中。

flutter:
  assets:
    - assets/translations.csv

在MaterialApp中添加CsvLocalizationsDelegate和支持的语言。

MaterialApp(
  localizationsDelegates: [
    // delegate from flutter_localization
    ...GlobalMaterialLocalizations.delegates,
    // delegate from csv_localizations
    CsvLocalizationsDelegate(path: 'assets/translations.csv'),
  ],
  supportedLocales: [
    Locale('en'),
    Locale('nb'),
  ],
)

iOS 注意事项

在ios/Runner/Info.plist中添加支持的语言，如：

<key>CFBundleLocalizations</key>
<array>
	<string>en</string>
	<string>nb</string>
</array>

格式

CSV文件是一个简单的表格文本文件，列由逗号分隔，行由换行符分隔。每列代表特定语言的翻译，每行代表给定键的翻译。

示例表：

提示1：多行字符串应包裹在引号中。

示例CSV：

key,en,nb
Hi,Hi,Hei
Dog,Dog,Hund
Cat,Cat,Katt
my_img,assets/en.png,assets/nb.png

提示2：键可以指向本地资源，如图像。

API

使用以下代码进行翻译：

CsvLocalizations.instance.string('Hi')

或添加一个String扩展：

extension LocalizedString on String {
  String tr(BuildContext context) => CsvLocalizations.instance.string(this);
}

注意：如果某个值不存在于给定的键，则返回该键本身。

我们还支持num、int和double通过以下方式：

CsvLocalizations.instance.numValue('my_num')

CsvLocalizations.instance.intValue('my_int')

CsvLocalizations.instance.doubleValue('my_double')

配置

支持csv包的所有配置。

可以通过CsvLocalizationsConfigurations设置它。

默认配置如下：

const CsvLocalizationsConfigurations({
  this.fieldDelimiter = ',',
  this.textDelimiter = '"',
  this.textEndDelimiter = '"',
  this.eol = '\n',
  this.convertEmptyTo = '',
  this.allowInvalid = true,
  this.shouldParseNumbers = true,
});

示例

查看example

import 'package:csv_localizations/csv_localizations.dart';
import 'package:flutter/material.dart';
import 'package:flutter_localizations/flutter_localizations.dart';

import 'string_ext.dart';

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

class MyApp extends StatelessWidget {
  const MyApp({Key? key}) : super(key: key);

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      localizationsDelegates: const [
        ...GlobalMaterialLocalizations.delegates,
        CsvLocalizationsDelegate(
          path: 'assets/translations.csv',
          configurations: CsvLocalizationsConfigurations(
            eol: '\n',
            fieldDelimiter: ',',
            shouldParseNumbers: true,
          ),
        ),
      ],
      supportedLocales: const [
        Locale('en', 'GB'),
        Locale('en', 'US'),
        Locale('en'),
        Locale('nb'),
      ],
      theme: ThemeData(
        primarySwatch: Colors.blue,
        visualDensity: VisualDensity.adaptivePlatformDensity,
      ),
      home: const MyHomePage(),
    );
  }
}

class MyHomePage extends StatefulWidget {
  const MyHomePage({Key? key}) : super(key: key);

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

class MyHomePageState extends State<MyHomePage> {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: const Text('csv_localizations'),
      ),
      body: Column(
        mainAxisAlignment: MainAxisAlignment.start,
        crossAxisAlignment: CrossAxisAlignment.start,
        children: <Widget>[
          Text(
            'Hi'.tr,
            style: const TextStyle(
              fontSize: 24,
            ),
          ),
          Image.asset(
            'my_img'.tr,
            width: 64,
            height: 64,
            fit: BoxFit.contain,
            filterQuality: FilterQuality.none,
          ),
          Text(
            'Multiline'.tr,
            style: const TextStyle(
              fontSize: 24,
            ),
          ),
          Text(
            'num'.numValue.toString(),
            style: const TextStyle(
              fontSize: 24,
            ),
          ),
          Text(
            'int'.intValue.toString(),
            style: const TextStyle(
              fontSize: 24,
            ),
          ),
          Text(
            'double'.doubleValue.toString(),
            style: const TextStyle(
              fontSize: 24,
            ),
          ),
          Text(
            'someStringWeHaventTranslatedYet'.tr,
            style: const TextStyle(
              fontSize: 24,
            ),
          ),
        ],
      ),
    );
  }
}