Flutter本地化生成注解插件locale_gen_annotation的使用

locale_gen_annotation 是一个与 locale_generator 包配合使用的注解包。它可以帮助开发者更方便地管理应用的本地化资源。本文将详细介绍如何使用 locale_gen_annotation 来实现 Flutter 应用的本地化。

环境准备

在开始之前，请确保你的开发环境中已经安装了以下依赖项：

• Flutter SDK
• Dart SDK
• flutter_localizations 和 intl 包

你可以通过在 pubspec.yaml 文件中添加这些依赖项来安装它们：

dependencies:
  flutter:
    sdk: flutter
  intl: ^0.17.0 # 请根据实际情况选择最新版本
  locale_generator: ^0.2.0 # 请根据实际情况选择最新版本
  locale_gen_annotation: ^0.1.0 # 请根据实际情况选择最新版本

dev_dependencies:
  build_runner: ^2.1.0
  locale_gen: ^0.1.0 # 请根据实际情况选择最新版本

创建本地化资源文件

首先，我们需要创建一个用于存储本地化字符串的文件。假设我们有一个名为 app_localizations.dart 的文件，并且定义了一个名为 AppLocalizations 的类。

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

class AppLocalizations {
  final Locale locale;

  AppLocalizations(this.locale);

  static AppLocalizations of(BuildContext context) {
    return Localizations.of<AppLocalizations>(context, AppLocalizations);
  }

  // 定义本地化字符串
  String get helloWorld => locale.languageCode == 'en' ? 'Hello World' : '你好世界';
}

接下来，我们需要为 AppLocalizations 类添加注解，以便 locale_gen_annotation 可以识别并生成对应的资源文件。

import 'package:locale_gen_annotation/locale_gen_annotation.dart';

@LocaleGen()
class AppLocalizations {
  // ...
}

生成本地化资源文件

为了生成本地化的资源文件，我们需要运行 build_runner 命令。在项目根目录下执行以下命令：

flutter pub run build_runner build

这将会在 lib/generated 目录下生成一个名为 app_localizations.g.dart 的文件。该文件包含了所有本地化的字符串。

使用本地化资源文件

现在我们可以在应用中使用生成的本地化资源文件了。首先，我们需要在 MaterialApp 中添加 LocalizationsDelegate。

import 'package:flutter/material.dart';
import 'package:flutter_localizations/flutter_localizations.dart';
import 'package:your_project_name/app_localizations.dart'; // 替换为实际路径

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

class MyApp extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      localizationsDelegates: [
        AppLocalizations.delegate,
        GlobalMaterialLocalizations.delegate,
        GlobalWidgetsLocalizations.delegate,
      ],
      supportedLocales: [
        Locale('en', ''), // 英语
        Locale('zh', ''), // 中文
      ],
      home: MyHomePage(),
    );
  }
}

class MyHomePage extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text(AppLocalizations.of(context).helloWorld),
      ),
      body: Center(
        child: Text(AppLocalizations.of(context).helloWorld),
      ),
    );
  }
}