Flutter本地化插件 bd_l10n 的使用

bd_l10n 是一个用于生成Flutter项目本地化的工具，它基于Flutter的新本地化工具 gen-l10n 构建，并解决了 gen-l10n 的一些限制。本文将详细介绍如何使用 bd_l10n 插件来实现Flutter应用的多语言支持。

概述

假设你的应用有以下功能模块：

• Common（通用）
• Authentication（认证）
• Home（主页）

你希望根据这些功能模块分离本地化消息，即每个模块都有自己的本地化消息文件。Common 模块包含整个应用通用的本地化消息。

你可以通过以下方式获取相应的本地化实例：

final commonLocalization = Common.of(context);

或者

final authenticationLocalization = Authentication.of(context);

或者

final homeLocalization = Home.of(context);

配置文件 bd_l10n.yaml

首先，你需要创建一个名为 bd_l10n.yaml 的配置文件，内容如下：

project-type: flutter
features:
  - name: 'Common'
    translation-dir: translation/common
    translation-template: common_en.arb
    output-dir: lib/localizations/

  - name: 'Home'
    translation-dir: translation/home
    translation-template: home_en.arb
    output-dir: lib/localizations/

  - name: 'Authentication'
    translation-dir: translation/authentication
    translation-template: authentication_en.arb
    output-dir: lib/localizations/

安装依赖

在你的 pubspec.yaml 文件中添加必要的依赖项：

dependencies:
  flutter_localizations:
    sdk: flutter
  intl: ^0.16.1

dev_dependencies:
  bd_l10n: ^1.0.0

使用方法

bd_l10n 可以作为命令行工具或与 build_runner 结合使用。

如果你已经在项目中使用了 build_runner，只需运行 build_runner build 即可自动生成本地化类。

如果你没有使用 build_runner，可以通过命令行工具运行：

flutter pub run bd_l10n --config-file bd_l10n.yaml .

该工具具有文件监视功能，一旦运行后会自动监控翻译文件的变化并生成新的本地化类。

示例代码

以下是一个完整的示例，展示了如何在Flutter项目中使用 bd_l10n 插件。

main.dart

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

// 导入生成的本地化类
// import 'package:flutter_demo/localization/application/application_feature.dart';
// import 'package:flutter_demo/localization/authentication/authentication_feature.dart';

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

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter Demo',
      theme: ThemeData(
        primarySwatch: Colors.blue,
        visualDensity: VisualDensity.adaptivePlatformDensity,
      ),
      routes: <String, WidgetBuilder>{
        '/': (BuildContext routeContext) {
          // final ApplicationFeature localization = ApplicationFeature.of(routeContext);
          return MyHomePage(title: 'Home tool');
        },
        '/login': (BuildContext routeContext) {
          return LoginPage();
        },
      },
      localizationsDelegates: [
        // ApplicationFeature.delegate,
        // AuthenticationFeature.delegate,
        ...GlobalMaterialLocalizations.delegates
      ],
      supportedLocales: <Locale>[Locale.fromSubtags(languageCode: 'en')],
    );
  }
}

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

  final String title;

  @override
  _MyHomePageState createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  int _counter = 0;

  void _incrementCounter() {
    setState(() {
      _counter++;
      if (_counter > 5) {
        Navigator.of(context).pushNamed('/login');
      }
    });
  }

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text(widget.title),
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: <Widget>[
            Text('Clicked: '),
            Text(
              '$_counter',
              style: Theme.of(context).textTheme.headline4,
            ),
          ],
        ),
      ),
      floatingActionButton: FloatingActionButton(
        onPressed: _incrementCounter,
        tooltip: 'Incremented',
        child: Icon(Icons.add),
      ),
    );
  }
}

class LoginPage extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return SafeArea(
      child: Scaffold(
        body: Column(
          crossAxisAlignment: CrossAxisAlignment.center,
          mainAxisAlignment: MainAxisAlignment.center,
          children: [
            TextFormField(initialValue: 'Enter username'),
            const SizedBox(height: 16),
            TextFormField(initialValue: 'Enter password'),
            const SizedBox(height: 16),
            ElevatedButton(
              onPressed: null,
              child: Text('Login'),
            ),
          ],
        ),
      ),
    );
  }
}

翻译文件示例

common_en.arb

{
  "@@locale": "en",
  "applicationTitle": "Flutter Demo",
  "homeDescription": "Welcome to the Flutter demo app.",
  "incrementButton": "Increment"
}

authentication_en.arb

{
  "@@locale": "en",
  "userNameField": "Username",
  "passwordField": "Password",
  "loginButton": "Login"
}

通过以上步骤和示例代码，你应该能够成功集成 bd_l10n 插件并实现Flutter应用的多语言支持。