Flutter本地化映射插件localization_mapper_annotation的使用

Flutter本地化映射插件localization_mapper_annotation的使用

1. 整理后的内容中关于“Flutter本地化映射插件localization_mapper_annotation的使用”的完整示例demo

// 示例代码：app_localizations.dart
import 'package:flutter/material.dart';
import 'package:localization_mapper_annotation/localization_mapper_annotation.dart';

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Localization Mapper Example',
      locale: Locale('en', 'es'), // 设置默认语言为西班牙语
      localizationsDelegates: [
        DefaultLocalizationsDelegate(),
        AppLocalizationsDelegate(context),
      ],
      supportedLocales: [Locale('en', 'es')],
      builder: (context, widget) => Localizations.delegate,
    );
  }
}

class AppLocalizationsDelegate extends LocalizationsDelegate<AppLocalizations> {
  final BuildContext context;

  AppLocalizationsDelegate(this.context);

  @override
  bool isSupported(Locale locale) => true;

  @override
  Future<AppLocalizations> getLocalizationsFuture(
      Locale locale, Locales locales, int version) async {
    return AppLocalizations.of(context);
  }
}

// 示例代码：generate_localization.sh
#!/bin/bash

# grant executable permissions (you should grant executable permissions at your will and not via scripts)
chmod +x ./replace_string.sh

# generate localization
(cd ../ && flutter gen-l10n)

# mapper generator-config options:
# preferrably, you can choose what to generate as part of localization extension on build-context by parsing 
# required parameters in the `[@LocalizationMapperAnnotation](/user/LocalizationMapperAnnotation)` annotation
# 
# [@LocalizationMapperAnnotation](/user/LocalizationMapperAnnotation)(mapperExtension: MapperExtension(l10n: true, locale: true, l10nParser: true))

filePath="../lib/localization/gen-l10n/app_localizations.dart"
searchParameter="abstract class AppLocalizations {"
requiredImports=$(cat << EOM
import 'package:localization_mapper_annotation/localization_mapper_annotation.dart';\n\
part 'app_localizations.g.dart';\n\n\
[@LocalizationMapperAnnotation](/user/LocalizationMapperAnnotation)()\n\
abstract class AppLocalizations {
EOM
)

# write imports and annotations to app_localization.dart file
echo "\nAdding required imports to generated app_localizations"
bash ./replace_string.sh "$filePath" "$searchParameter" "$requiredImports"

echo "\nGenerating app_localizations mapper files"
(cd ../ && flutter pub run build_runner build --delete-conflicting-outputs)
EOM
)

// 示例代码：replace_string.sh
#!/bin/bash

# check if enough arguments were provided
if [ $# -lt 3 ]; then
    echo "Error: Not enough arguments provided."
    echo "Usage: $0 <input_file> <search_pattern> <replacement_string>"
    exit 1
fi

# assign input arguments to variables
input_file=$1
search_pattern=$2
replacement_string=$3

# check if the input file exists
if [ ! -f $input_file ]; then
    echo "Error: Input file does not exist."
    exit 1
fi

# backup the original file
cp $input_file "$input_file.bak"

# perform the search and replace and write the result to a new file
sed "s/$search_pattern/$replacement_string/i" $input_file &gt; "$input_file.tmp"

# check if the replacement was successful
if [ $? -ne 0 ]; then
    echo "Error: Replacement failed."
    exit 1
fi

# overwrite the original file with the new file
mv "$input_file.tmp" "$input_file"

echo "Replacement completed successfully."

// 示例代码：app_localizations.g.dart
// GENERATED CODE - DO NOT MODIFY BY HAND

part of 'app_localizations.dart';

// **************************************************************************
// LocalizationMapperGenerator
// **************************************************************************

extension AppLocalizationsExtension on BuildContext {
  AppLocalizations get l10n => AppLocalizations.of(this)!;
  Locale get locale => Localizations.localeOf(this);
  String l10nParser(String translationKey, {List<Object>? arguments}) {
    const mapper = AppLocalizationsMapper();
    final object = mapper.toLocalizationMap(this)[translationKey];
    if (object is String) return object;
    assert(arguments != null, 'Arguments should not be null!');
    assert(arguments!.isNotEmpty, 'Arguments should not be empty!');
    return Function.apply(object, arguments);
  }
}

class AppLocalizationsMapper {
  const AppLocalizationsMapper();
  Map<String, dynamic> toLocalizationMap(BuildContext context) {
    return {
      'localeName': AppLocalizations.of(context)!.localeName,
      'application_name': AppLocalizations.of(context)!.application_name,
      'deposit_timeframe': AppLocalizations.of(context)!.deposit_timeframe,
      'balance_reverted': (currency) =>
          AppLocalizations.of(context)!.balance_reverted(currency),
      'convert_before_withdraw': (convertFrom, convertTo) =>
          AppLocalizations.of(context)!
              .convert_before_withdraw(convertFrom, convertTo),
      'convert_before_withdraw_again': (convertFrom, convertTo) =>
          AppLocalizations.of(context)!
              .convert_before_withdraw_again(convertFrom, convertTo),
    };
  }
}

// 示例代码：app_localizations.dart
import 'package:flutter/material.dart';
import 'package:localization_mapper_annotation/localization_mapper_annotation.dart';

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Localization Mapper Example',
      locale: Locale('en', 'es'), // 设置默认语言为西班牙语
      localizationsDelegates: [
        DefaultLocalizationsDelegate(),
        AppLocalizationsDelegate(context),
      ],
      supportedLocales: [Locale('en', 'es')],
      builder: (context, widget) => Localizations.delegate,
    );
  }
}

class AppLocalizationsDelegate extends LocalizationsDelegate<AppLocalizations> {
  final BuildContext context;

  AppLocalizationsDelegate(this.context);

  @override
  bool isSupported(Locale locale) => true;

  @override
  Future<AppLocalizations> getLocalizationsFuture(
      Locale locale, Locales locales, int version) async {
    return AppLocalizations.of(context);
  }
}

使用说明

1. 安装依赖：

   dependencies:
     flutter:
       sdk: flutter
   
     flutter_localizations:
       sdk: flutter
   
     localization_mapper_annotation: ^latest-version
   
   dev_dependencies:
     build_runner: ^2.3.3
   
     localization_mapper_generator: ^latest-version
   

2. 定义shell脚本：

   # replace_string.sh
   # 检查是否提供了足够的参数
   if [ $# -lt 3 ]; then
       echo "错误：提供的参数不足。"
       echo "用法：$0 <输入文件> <搜索模式> <替换字符串>"
       exit 1
   fi
   
   # 将输入参数分配给变量
   input_file=$1
   search_pattern=$2
   replacement_string=$3
   
   # 检查输入文件是否存在
   if [ ! -f $input_file ]; then
       echo "错误：输入文件不存在。"
       exit 1
   fi
   
   # 备份原始文件
   cp $input_file "$input_file.bak"
   
   # 执行搜索和替换，并将结果写入新文件
   sed "s/$search_pattern/$replacement_string/i" $input_file &gt; "$input_file.tmp"
   
   # 检查替换是否成功
   if [ $? -ne 0 ]; then
       echo "错误：替换失败。"
       exit 1
   fi
   
   # 用新文件覆盖原始文件
   mv "$input_file.tmp" "$input_file"
   
   echo "替换完成成功。"
   

3. 生成本地化文件：

   # generate_localization.sh
   # 授予replace_string.sh可执行权限（根据需要授予，而不是通过脚本来实现）
   chmod +x ./replace_string.sh
   
   # 生成本地化文件
   (cd ../ && flutter gen-l10n)
   
   # mapper生成配置选项：
   # 最好选择在构建上下文中生成本地化扩展部分，通过解析
   # 在注解中的所需参数
   # [@LocalizationMapperAnnotation](/user/LocalizationMapperAnnotation)(mapperExtension: MapperExtension(l10n: true, locale: true, l10nParser: true))
   
   filePath="../lib/localization/gen-l10n/app_localizations.dart"
   searchParameter="abstract class AppLocalizations {"
   requiredImports=$(cat << EOM
   import 'package:localization_mapper_annotation/localization_mapper_annotation.dart';\n\
   part 'app_localizations.g.dart';\n\n\
   [@LocalizationMapperAnnotation](/user/LocalizationMapperAnnotation)()\n\
   abstract class AppLocalizations {
   EOM
   )
   
   # 将导入和 注释写入生成的app_localizations文件
   echo "\n添加所需的导入到生成的app_localizations"
   bash ./replace_string.sh "$filePath" "$searchParameter" "$requiredImports"
   
   echo "\n生成app_localizations映射文件"
   (cd ../ && flutter pub run build_runner build --delete-conflicting-outputs)