ノウハウ アプリ開発 読了目安 約8分

Flutterアプリを多言語対応する|ARBファイルとgen-l10nの使い方

アプリを海外のストアにも出すと、思わぬ国からダウンロードされることがあります。最初から多言語対応の形にしておけば、言語を増やすのはファイルを1つ足すだけです。シンプルで管理しやすい構成を紹介します。

多言語対応の全体像

Flutterの多言語対応は、次の3つの部品でできています。

  • ARBファイル:言語ごとの翻訳文を書くファイル(JSONに似た形式)。app_ja.arb、app_en.arb のように言語ごとに1つ作ります。
  • gen-l10n:ARBファイルから、翻訳文を取り出すためのDartコードを自動で作るFlutterの機能。
  • flutter_localizations:日付の形式や「OK」「キャンセル」など、Flutterの標準の部品を各言語で表示するためのパッケージ。

画面のコードには日本語や英語を直接書かず、AppLocalizations.of(context).greeting のように「翻訳文の名前」で呼び出します。言語を増やすときは、ARBファイルを1つ追加するだけで済みます。

ちなみに、このサイトも日本語と英語に対応していて、言語ごとのファイルに翻訳文を分けて管理しています。Webでもアプリでも、「文章をコードから分離して、言語ごとのファイルにまとめる」という考え方は同じです。

手順1:pubspec.yamlとl10n.yamlを用意する

pubspec.yaml に、パッケージと自動生成の設定を追加します。

dependencies:
  flutter:
    sdk: flutter
  flutter_localizations:
    sdk: flutter
  intl: any

flutter:
  generate: true
  uses-material-design: true

intl は、flutter pub add intl で追加すると、使っているFlutterに合うバージョンが入ります。次に、プロジェクトのいちばん上(pubspec.yamlと同じ場所)に l10n.yaml を作ります。

arb-dir: lib/l10n
template-arb-file: app_ja.arb
output-localization-file: app_localizations.dart
nullable-getter: false

template-arb-file は、基準にする言語のファイルです。日本語で先に作るアプリなら、日本語のファイルを基準にしておくと書きやすくなります。nullable-getter: false を指定すると、呼び出すたびに ! を付けなくて済みます。

手順2:ARBファイルを書く

lib/l10n/app_ja.arb を作ります。

{
  "@@locale": "ja",
  "appTitle": "かんたんメモ",
  "@appTitle": {
    "description": "アプリのタイトル"
  },
  "greeting": "こんにちは、{name}さん",
  "@greeting": {
    "placeholders": {
      "name": { "type": "String" }
    }
  },
  "noteCount": "{count, plural, =0{メモはありません} other{メモが{count}件あります}}",
  "@noteCount": {
    "placeholders": {
      "count": { "type": "int" }
    }
  }
}

同じ名前で、lib/l10n/app_en.arb も作ります。

{
  "@@locale": "en",
  "appTitle": "Simple Notes",
  "greeting": "Hello, {name}",
  "noteCount": "{count, plural, =0{No notes} =1{1 note} other{{count} notes}}"
}

@ から始まる項目は、翻訳文の説明や変数の型を書くためのものです。基準のファイル(ここでは日本語)にだけ書けば十分です。description に「どの画面の、どんな場面の文か」を書いておくと、あとで翻訳を頼むときや、自分で見直すときに役立ちます。

変数と複数形

{name} のように波かっこで囲むと、変数を差し込めます。言語によって語順が違うので、文章を分割してつなげるのではなく、変数を含めた1つの文として翻訳するのがコツです。

数によって表現が変わる場合は、plural を使います。日本語は「1件」「2件」と形が変わりませんが、英語は「1 note」「2 notes」と変わります。=0、=1、other のように場合分けを書くと、数に応じて正しい文が選ばれます。

手順3:アプリに組み込む

ここまで書いて flutter pub get を実行(またはビルド)すると、lib/l10n/ に app_localizations.dart などのファイルが自動で作られます。これを MaterialApp に設定します。

import 'package:flutter/material.dart';

import 'l10n/app_localizations.dart';

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

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

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      onGenerateTitle: (context) => AppLocalizations.of(context).appTitle,
      localizationsDelegates: AppLocalizations.localizationsDelegates,
      supportedLocales: AppLocalizations.supportedLocales,
      // 対応していない言語の端末では英語で表示する
      localeResolutionCallback: (locale, supported) {
        for (final s in supported) {
          if (s.languageCode == locale?.languageCode) return s;
        }
        return const Locale('en');
      },
      home: const HomePage(),
    );
  }
}

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

  @override
  Widget build(BuildContext context) {
    final l10n = AppLocalizations.of(context);
    return Scaffold(
      appBar: AppBar(title: Text(l10n.appTitle)),
      body: Center(
        child: Column(
          mainAxisSize: MainAxisSize.min,
          children: [
            Text(l10n.greeting('カオス')),
            Text(l10n.noteCount(3)),
          ],
        ),
      ),
    );
  }
}

localizationsDelegates には、自分の翻訳に加えて、Flutterの標準部品の翻訳も含まれています。localeResolutionCallback を書いておくと、たとえばフランス語の端末でも、英語で表示されるようにできます。

なお、以前のFlutterでは生成されたファイルを package:flutter_gen/gen_l10n/app_localizations.dart から読み込んでいました。現在のFlutterではこの方法は使われなくなり、arb-dir に指定したフォルダの中にファイルが作られます。古い解説記事を参考にするときは注意してください。

手順4:iOSとAndroidの設定

iOS:対応言語を宣言する

iOSでは、ios/Runner/Info.plist に対応する言語を書いておかないと、端末の言語が英語でもアプリが英語で表示されないことがあります。

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

ホーム画面のアプリ名や、カメラ・写真の許可を求める説明文も言語ごとに変えたい場合は、Xcodeで InfoPlist.strings を言語ごとに作り、CFBundleDisplayName や NSCameraUsageDescription の翻訳を書きます。

Android:アプリ名を言語ごとに変える

Androidでは、android/app/src/main/res/values/strings.xml(基本)と values-ja/strings.xml(日本語)にアプリ名を書き、AndroidManifest.xml の android:label を @string/app_name にします。

翻訳を管理するコツ

  • 名前は意味で付ける:button1 ではなく saveButton のように、何の文かが分かる名前にします。
  • 同じ言葉でも場面が違えば分ける:日本語では同じ「開く」でも、英語では「Open」「Expand」と訳し分けることがあります。
  • 翻訳漏れに気づく:基準のファイルにあって他の言語にない項目があると、ビルド時に警告が出ます。l10n.yaml に untranslated-messages-file: untranslated.json を追加すると、未翻訳の一覧をファイルに書き出せます。
  • 文字の長さに余裕を持たせる:英語やドイツ語は、日本語より文字数が長くなりがちです。ボタンや見出しが2行になっても崩れないレイアウトにしておきます。
  • 機械翻訳は確認してから:機械翻訳は下書きとして便利ですが、短いUIの文言は文脈がないぶん誤訳しやすいので、実際の画面で見て確認します。

ストアの掲載情報も忘れずに

アプリの中を多言語にしても、ストアの説明文やスクリーンショットが日本語だけだと、海外の利用者には伝わりません。App Store ConnectとPlay Consoleでは、言語ごとに説明文やスクリーンショットを登録できます。アプリ名やキーワードも、その国で検索されやすい言葉にすると見つけてもらいやすくなります。

まとめ

  1. flutter_localizations と intl を追加し、generate: true と l10n.yaml を用意する。
  2. 言語ごとにARBファイルを作り、変数や複数形は1つの文として書く。
  3. MaterialApp に delegates と supportedLocales を設定し、未対応言語の扱いを決める。
  4. iOSは CFBundleLocalizations、アプリ名や許可の説明文もそれぞれ翻訳する。
  5. ストアの掲載情報も言語ごとに用意する。