メッセージと言語

アプリのテキストは、lib/resources/ のメッセージファイルにあります。英語は messages.properties、日本語は messages_ja.properties などです。ウィジェットは、context.message、またはジェネレーターが書き出す context.messages の型付きのゲッターで、アプリの現在の言語のテキストを読みます。アプリのロケールは自動的にファイルに従います。

使う理由

Flutter 自身のローカリゼーションには、ARB ファイル、コードジェネレーター、アプリごとのデリゲートが必要です。ここではテキストは Spring のメッセージファイル、つまり Spring のサーバーも使うものなので、チームはそれを共有でき、同じ MessageSource Bean がサービス (メール、通知) とウィジェットにテキストを渡します。

例

# lib/resources/messages.properties
basket.total=Total: {0}
basket.empty=Your basket is empty.
# lib/resources/messages_ja.properties
basket.total=合計:{0}
basket.empty=カゴは空です。
// コードで、{0}、{1} などの引数とともに。
Text(context.message('basket.total', args: [total]));

// 同じファイルから生成された型付きのもの。
Text(context.messages.basket.total(total));
Text(context.messages.basket.empty);

context.message

context.message(code, args:, defaultMessage:) は、アプリの現在の言語 (Localizations のロケール、なければデバイスのもの) でメッセージファイルのテキストを返します。args は {0}、{1} などのプレースホルダーを埋めます。

存在しないコードは、defaultMessage: を渡すか spring.messages.use-code-as-default-message=true を設定しない限り (その場合はコード自体が表示されます)、NoSuchMessageException を投げます。

型付きのメッセージ: context.messages

ジェネレーターは、同じファイルから context.messages を lib/spring_gen/messages.spring.keys.dart に書き出します (spring_gen/main.spring.dart をインポートしてください)。

ある言語にないキーはビルドの警告になり、二つの言語で引数の数が異なるとビルドが失敗します。名前を変えたキーはコンパイルできなくなります。実行時に組み立てるキーには context.message('...') を使い続けます。型付きのキー を参照してください。

アプリのロケール

アプリは、テキストを持つ言語をサポートします。messages.properties は英語とみなされ、各 messages_<locale>.properties がそのロケールを追加します (messages_ja は ja を、messages_pt_BR は pt_BR を追加します)。spring.flutter.app.locales が設定されている場合は、代わりにそれが列挙します。

spring:
  flutter:
    app:
      locales: en, ja      # YAML のリストではなく、一つのカンマ区切りの値

アプリの種類に応じた Flutter 自身の翻訳 (すべての言語でのそのウィジェットのテキスト) が追加されます。アプリのウィジェット を参照してください。

プロパティ

メッセージファイルはアプリケーションの MessageSource が読み、Spring Boot のキーで設定します。

キー 型 デフォルト 意味
spring.messages.basename カンマ区切りの名前 messages lib/resources/ のメッセージファイルのベース名。Flutter アプリでは、スターターがそれらのファイルのロケールを見つけられるよう、/ を区切りとする一つのカンマ区切りの値 (i18n/messages,i18n/errors) で書く
spring.messages.use-code-as-default-message bool false 存在しないコードで、エラーの代わりにコード自体を返す
spring.messages.fallback-to-system-locale bool true ある言語のファイルがない場合、言語のないファイルより前にデバイスの言語を試す
spring.messages.always-use-message-format bool false 引数のないメッセージにも {0} の書式化のルール (とその引用) を適用する
spring.messages.encoding 文字セット UTF-8 ファイルのエンコーディング。未知のものは起動を失敗させる
spring.messages.cache-duration 期間 (単なる数値は秒) 永久に保持 読み込んだファイルを再び読むまで保持する時間
spring.messages.default-locale ロケール なし デバイスのものより前に試すロケール (Spring Boot にはない)
spring.messages.common-messages 場所のリスト なし すべての言語で共有するテキスト。後のファイルが優先される

形式と MessageSource そのものについては、spring_core_dart のメッセージ を参照してください。

既知の制限

Web での他の文字体系のフォント

Web では、Flutter は日本語、中国語、絵文字のテキストを初めてレイアウトするときにそのフォントをダウンロードするため、最初の言語の切り替えがカクつきます。テキストのウォームアップを有効にして、スプラッシュの表示中にそれらをダウンロードしてください (スプラッシュと起動 を参照)。

関連項目